BarItemLinkActionBase.ItemLinkIndex Attached Property

Gets or sets the index of the current bar item link in the collection of bar item links in the Target object. This is an attached property, which is in effect for BarItem and BarItemLink descendants when they act as actions (when they are added to the BarManagerActionContainer.Actions collection).

Namespace: DevExpress.Xpf.Bars

Assembly: DevExpress.Xpf.Core.v19.1.dll

Declaration

See GetItemLinkIndex(DependencyObject) and SetItemLinkIndex(DependencyObject, Int32).

Returns

Type	Description
Int32	An integer value that specifies the index of the current bar item link in the collection of bar item links in the Target object.

Example

The following example demonstrates how to add a custom menu item to the context menu of a grid column. For this, it is necessary to add a corresponding bar item (e.g. BarCheckItem) to the DataViewBase.ColumnMenuCustomizations collection, and specify different item properties. Also, you can insert this item into a specific position by attaching the BarItemLinkActionBase.ItemLinkIndex property to it.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-a-grids-context-menu-e1925.

Window1.xaml

<dxg:TableView.ColumnMenuCustomizations>
    <dxb:BarCheckItem Name="checkItem1" Content="Checked" IsChecked="True" dxb:BarItemLinkActionBase.ItemLinkIndex="0" />
    <dxb:BarItemLinkSeparator dxb:BarItemLinkActionBase.ItemLinkIndex="1" />
</dxg:TableView.ColumnMenuCustomizations>

Window1.xaml.cs

private void customItem1_CheckedChanged(object sender, ItemClickEventArgs e) {
    // do something...
}

Window1.xaml.vb

Private Sub customItem1_CheckedChanged(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    ' do something...
End Sub

Related GitHub Examples

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

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-customize-the-scheduler-control-popup-menu-e2721/CS/PopupMenuCustomization/MainWindow.xaml#L28

<dxb:RemoveBarItemAndLinkAction ItemName="{x:Static local:SchedulerMenuItemName.NewRecurringAppointment}" />
<dxb:BarItemSeparator dxb:BarItemLinkActionBase.ItemLinkIndex="1" />
<dxb:BarButtonItem Name="customNavBackItem"

wpf-spreadsheet-customize-context-menu/CS/MenuCustomization/MainWindow.xaml#L36

<dxsps:SpreadsheetMenuCustomization MenuType="Cell">
    <dxb:BarButtonItemLink dxb:BarItemLinkActionBase.ItemLinkIndex="0">
        <dxb:BarButtonItemLink.BarItemName>

wpf-rich-text-editor-customize-context-menu/CS/ContextMenuCustomization/MainWindow.xaml#L42

<dxre:RemoveRichEditCommandAction Id="{x:Static dxrecore:RichEditCommandId.CutSelection}" />
<dxb:BarButtonItemLink dxb:BarItemLinkActionBase.ItemLinkIndex="0">
    <dxb:BarButtonItemLink.BarItemName>

how-to-define-bar-customization-actions-e1749/VB/BarManagerControllerExample/Window1.xaml#L20

<!--An action that adds a File submenu to the Main Menu-->
<dxb:BarSubItem x:Name="menuFile" Content="File" dxb:BarItemLinkActionBase.TargetType="MainMenu" dxb:BarItemLinkActionBase.ItemLinkIndex="0" />
<!--An action that adds a New button to the File submenu-->

wpf-docklayoutmanager-use-actions-to-customize-panel-context-menu/VB/ContextMenuCustomizations_Ex/Window1.xaml#L7

<!--Adds a new About menu command at the top-->
<dxb:BarButtonItem Name="bAbout" CategoryName="Help" Content="About" ItemClick="bAbout_ItemClick" dxb:BarItemLinkActionBase.ItemLinkIndex="0" />
<!--Add a separator-->

VB.NET

wpf-dock-layout-manager-use-events-to-dynamically-customize-context-menus/VB/DockManager_MenuCustomization/Window1.xaml.vb#L31

actionAddSeparator.ItemLink = New BarItemLinkSeparator()
actionAddSeparator.ItemLinkIndex = 1
' Add the actions to the ActionList