BarEditItemLink.ShowEditor() Method

Activates this link’s editor.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v18.2.dll

Declaration

C#

public virtual void ShowEditor()

VB.NET

Public Overridable Sub ShowEditor

Remarks

Use the ShowEditor method to activate this link’s editor programmatically. The editor is activated if the following conditions are met:

• The BarEditItemLink.CanOpenEdit property returns true.
• The link is currently visible. (For instance, the edit link may not be visible if the owning bar is oriented vertically, and its BarOptions.RotateWhenVertical option is enabled.)
• The ItemCancelEventArgs.Cancel parameter of the BarEditItem.ShowingEditor event is not set to true. This event is raised when activating the editor via the mouse, or calling the ShowEditor method. The ItemCancelEventArgs.Cancel parameter allows you to prohibit editor activation.

After the editor has been activated, the BarEditItem.ShownEditor event of the corresponding item is raised.

To access the currently active editor, use the BarManager.ActiveEditor property.

Related GitHub Examples

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

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-activate-a-specific-editor-located-in-a-bar-or-ribbon-e3793/CS/WindowsApplication1/RibbonForm1.cs#L22

    barEditItem1.Links[0].Focus();
    (barEditItem1.Links[0] as BarEditItemLink).ShowEditor();
}

links-searching-functionality-in-the-popupmenu-applicationmenu-dropdown-e4364/CS/WindowsFormsApplication1/PopupMenuSearchHelper.cs#L51

{
    (e.Link as BarEditItemLink). ShowEditor();
    editorShown = true;

VB.NET

how-to-activate-a-specific-editor-located-in-a-bar-or-ribbon-e3793/VB/WindowsApplication1/RibbonForm1.vb#L20

    barEditItem1.Links(0).Focus()
    TryCast(barEditItem1.Links(0), BarEditItemLink).ShowEditor()
End Sub

links-searching-functionality-in-the-popupmenu-applicationmenu-dropdown-e4364/VB/WindowsFormsApplication1/PopupMenuSearchHelper.vb#L48

If e.Link IsNot Nothing AndAlso e.Link.Item.Equals(searchBarItem) Then
    TryCast(e.Link, BarEditItemLink).ShowEditor()
    editorShown = True