NavigatorButtonBase.ImageIndex Property

Gets or sets the index of the image to display within the button.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[DefaultValue(-1)]
[ImageList("ImageList")]
[DXCategory("Appearance")]
public int ImageIndex { get; set; }

VB.NET

<DefaultValue(-1)>
<ImageList("ImageList")>
<DXCategory("Appearance")>
Public Property ImageIndex As Integer

Property Value

Type	Default	Description
Int32	-1	An integer value which specifies the zero-based index of the image within the source collection.

Remarks

The source of images is specified by the NavigatorButtonsBase.ImageList property.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ImageIndex property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-create-a-custom-button-for-the-embeddednavigator-e1127/CS/CustomButton/Form1.cs#L27

    button.Hint = "Copy to clipboard";
    button.ImageIndex = 0;
}

how-to-add-text-captions-for-the-datanavigator-controls-buttons-e2085/CS/WindowsApplication1/Form1.cs#L72

    _imageList.Images.Add(GetBitmap(button.Tag));
    button.ImageIndex = _imageList.Images.Count - 1;
}

VB.NET

how-to-create-a-custom-button-for-the-embeddednavigator-e1127/VB/CustomButton/Form1.vb#L29

    button.Hint = "Copy to clipboard"
    button.ImageIndex = 0
End Sub

how-to-add-text-captions-for-the-datanavigator-controls-buttons-e2085/VB/WindowsApplication1/Form1.vb#L76

    _imageList.Images.Add(GetBitmap(button.Tag))
    button.ImageIndex = _imageList.Images.Count - 1
Next i