EditorButton.Index Property

Gets the button’s position within the owning collection.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

[Browsable(false)]
public virtual int Index { get; }

VB.NET

<Browsable(False)>
Public Overridable ReadOnly Property Index As Integer

Property Value

Type	Description
Int32	A zero-based integer representing the button’s position.

Remarks

The ButtonEdit class and its descendants allow an unlimited number of buttons to be displayed within the editor. The collection of buttons can be accessed via the RepositoryItemButtonEdit.Buttons property. The Index property identifies the button’s position within the collection. The order of the buttons within the collection defines their visual order.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Index 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-editor-with-multiple-popup-windows-e2662/CS/Custom editor/MyCalcEdit.cs#L39

    DestroyPopupForm();
_lastClickedButton = buttonInfo.Button.Index;
base.OnPressButton(buttonInfo);

how-to-make-the-buttonedits-buttons-work-as-check-buttons-e1931/CS/RepositoryItemMyButtonEdit.cs#L104

{
    ToogleButton(buttonInfo.Button.Index);
    base.OnClickButton(buttonInfo);

how-to-show-a-panel-with-buttons-under-a-focused-row-e1957/CS/WindowsApplication1/ButtonPanelHelper.cs#L159

{
    Rectangle buttonRect = GetButtonRect(e.Bounds, button.Index);
    SkinEditorButtonPainter painter = new SkinEditorButtonPainter(linkedView.GridControl.LookAndFeel.ActiveLookAndFeel);

how-to-create-a-buttonedit-descendant-showing-editvalue-in-buttons-caption-e3469/CS/TestMyButtonEdit/MyButtonEditPainter.cs#L50

if (info.Bounds.Width == 0 || viewInfo.RightButtons.Count == 0) return;
if (info.Button.Index == 1)
{

how-to-display-buttons-with-different-captions-in-different-rows-of-gridview-e4024/CS/CS/WindowsApplication1/Form1.cs#L38

        return;
    args.ButtonText = String.Format("{0};{1};Button{2}", args.Column.VisibleIndex, args.RowHandle, args.Button.Index);
}

VB.NET

how-to-create-a-custom-editor-with-multiple-popup-windows-e2662/VB/Custom editor/MyCalcEdit.vb#L45

End If
_lastClickedButton = buttonInfo.Button.Index
MyBase.OnPressButton(buttonInfo)

how-to-make-the-buttonedits-buttons-work-as-check-buttons-e1931/VB/RepositoryItemMyButtonEdit.vb#L112

Protected Overrides Sub OnClickButton(ByVal buttonInfo As EditorButtonObjectInfoArgs)
    ToogleButton(buttonInfo.Button.Index)
    MyBase.OnClickButton(buttonInfo)

how-to-show-a-panel-with-buttons-under-a-focused-row-e1957/VB/WindowsApplication1/ButtonPanelHelper.vb#L162

Private Sub DrawButton(ByVal button As EditorButton, ByVal e As RowObjectCustomDrawEventArgs)
    Dim buttonRect As Rectangle = GetButtonRect(e.Bounds, button.Index)
    Dim painter As New SkinEditorButtonPainter(linkedView.GridControl.LookAndFeel.ActiveLookAndFeel)

how-to-create-a-buttonedit-descendant-showing-editvalue-in-buttons-caption-e3469/VB/TestMyButtonEdit/MyButtonEditPainter.vb#L50

End If
If info.Button.Index = 1 Then
    MyBase.DrawButton(viewInfo, info)

how-to-display-buttons-with-different-captions-in-different-rows-of-gridview-e4024/VB/WindowsApplication1/Form1.vb#L37

    End If
    args.ButtonText = String.Format("{0};{1};Button{2}", args.Column.VisibleIndex, args.RowHandle, args.Button.Index)
End Sub