WinForms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class BarManager

    Show / Hide Table of Contents

    Class BarManager

    The BarManager manages a form's menus and tool bars and lets it participate in the user-customization feature.

    Inheritance
    System.Object
    BaseComponent
    BarManager
    ChildFrameBarManager
    MainFrameBarManager
    Implements
    IThemeProvider
    System.IDisposable
    System.ComponentModel.ISupportInitialize
    IBarItemsRepository
    System.Runtime.Serialization.ISerializable
    System.Runtime.Serialization.IDeserializationCallback
    IIgnoreWorkingArea
    IVisualStyle
    Inherited Members
    BaseComponent.RaiseThemeChanged(Object, ThemeChangedEventArgs)
    BaseComponent.GetActiveThemeName()
    BaseComponent.OnCanApplyThemeChanged(Boolean)
    BaseComponent.OnCanOverrideStyleChanged(Boolean)
    BaseComponent.ThemeName
    BaseComponent.CanOverrideStyle
    BaseComponent.IThemeProvider.BaseThemeName
    BaseComponent.CanApplyTheme
    BaseComponent.ControlName
    BaseComponent.IsVisualStyleEnabled
    BaseComponent.ThemeNameChanged
    Namespace: Syncfusion.Windows.Forms.Tools.XPMenus
    Assembly: Syncfusion.Tools.Windows.dll
    Syntax
    public class BarManager : BaseComponent, IThemeProvider, IDisposable, ISupportInitialize, IBarItemsRepository, ISerializable, IDeserializationCallback, IIgnoreWorkingArea, IVisualStyle
    Remarks

    The BarManager should contain a reference to all the BarItems (Items property) that you intend to use in the associated form's menu structure and the tool bars. The BarItems should have a unique ID. The BarManager also has a list of tool bars (Bars property) associated with the form. There is a "Customize" verb associated with the BarManager's designer which will allow you to design your form's menu structure and tool bars visually during design-time without writing a single line of code. Use the "Activate Menus" verbs in the VS2003 designer in case the menus/toolbars don't respond to mouse clicks in the designer.

    The BarManager also allows you to set certain global settings like enabling user-customization, enable partial menus, enable large icon mode for tool bars, etc.

    You don't normally use this class directly. You would instead use one of the following derived classes based on your form type. Use a MainFrameBarManager (for the main window in an MDI and SDI scenario) or a ChildFrameBarManager(for the child windows in an MDI scenario). Since the BarManager is a component derived class, you can simple drag and drop one of the above managers on your form during design-time to bind it to your form.

    When initializing one of the derived classes in code, make sure to call BeginInit() and EndInit().

    Note: A BarManager (ChildFrameBarManager or MainFrameBarManager) cannot be simultaneously used with a CommandBarController. Use the DetachedCommandBars property to add generic tool bars to your form.

    Examples

    Take a look at our XPMenus samples under the Tools\Samples\Menus Package folder for usage example.

    Constructors

    BarManager()

    Creates an instance of the BarManager class and sets its default properties.

    Declaration
    public BarManager()

    BarManager(IContainer, Form)

    Declaration
    public BarManager(IContainer container, Form form)
    Parameters
    Type Name Description
    System.ComponentModel.IContainer container
    System.Windows.Forms.Form form

    BarManager(SerializationInfo, StreamingContext)

    Declaration
    protected BarManager(SerializationInfo info, StreamingContext context)
    Parameters
    Type Name Description
    System.Runtime.Serialization.SerializationInfo info
    System.Runtime.Serialization.StreamingContext context

    BarManager(Form)

    Declaration
    public BarManager(Form form)
    Parameters
    Type Name Description
    System.Windows.Forms.Form form

    Fields

    commandBarManager

    Declaration
    protected CommandBarManager commandBarManager
    Field Value
    Type Description
    CommandBarManager

    customizationDlg

    Declaration
    protected BarCustomizationDialog customizationDlg
    Field Value
    Type Description
    BarCustomizationDialog

    designer

    Declaration
    protected IBarManagerDesigner designer
    Field Value
    Type Description
    IBarManagerDesigner

    endInitCalled

    Declaration
    protected bool endInitCalled
    Field Value
    Type Description
    System.Boolean

    expandSubMenusAfterDelay

    Declaration
    protected bool expandSubMenusAfterDelay
    Field Value
    Type Description
    System.Boolean

    insertContainerWhileSerializing

    Declaration
    protected bool insertContainerWhileSerializing
    Field Value
    Type Description
    System.Boolean

    isScaling

    Declaration
    public bool isScaling
    Field Value
    Type Description
    System.Boolean

    m_bFormClosed

    Declaration
    protected bool m_bFormClosed
    Field Value
    Type Description
    System.Boolean

    m_bXPMenuActive

    Declaration
    protected bool m_bXPMenuActive
    Field Value
    Type Description
    System.Boolean

    m_DesignerLoaded

    Declaration
    protected bool m_DesignerLoaded
    Field Value
    Type Description
    System.Boolean

    PartialMenusExpandedStateResetDelay

    Specifies in milliseconds, the time after which an expanded partial menu will revert back to the collapsed state.

    Declaration
    public static int PartialMenusExpandedStateResetDelay
    Field Value
    Type Description
    System.Int32

    Specify the time in milliseconds. Default is 5000.

    partialMenusMode

    Declaration
    protected bool partialMenusMode
    Field Value
    Type Description
    System.Boolean

    shortcuts

    Declaration
    protected Hashtable shortcuts
    Field Value
    Type Description
    System.Collections.Hashtable

    Properties

    BarItemActiveFormCheckOverride

    Indicates whether the BarItems should check for ActiveForm before displaying tooltip. Workaround for using from MFC applications.

    Declaration
    public bool BarItemActiveFormCheckOverride { get; set; }
    Property Value
    Type Description
    System.Boolean

    BarPositionInfo

    Used to store the positional information of the tool bars by the designer.

    Declaration
    public MemoryStream BarPositionInfo { get; set; }
    Property Value
    Type Description
    System.IO.MemoryStream
    Remarks

    This property is used by the BarManager's designer to store positional information of the contained tool bars. In the case of the MainFrameBarManager, this information will be used to initialize the corresponding tool bars during runtime and design time. In the case of the ChildFrameBarManager, this information will be used to position the tool bars only during design-time.

    The structure of the MemoryStream is internal to this library and hence do not try to set/get this property.

    Bars

    Returns the list of bars representing the toolbars for the corresponding form.

    Declaration
    public Bars Bars { get; }
    Property Value
    Type Description
    Bars
    Remarks

    Specifies the list of tool bars associated with this BarManager. The BarManager's designer takes care of filling this list with one entry for each tool bar.

    Categories

    Returns the list of categories defined in this BarManager, under which the BarItems will be grouped.

    Declaration
    public ArrayList Categories { get; }
    Property Value
    Type Description
    System.Collections.ArrayList
    Remarks

    The entries in this list are strings representing the category names.

    The CategoryID property of the BarItems in this BarManager's Items list is an index into this Categories list. Also, the items in the CategoriesToIgnoreInCustDialog list are indices into this Categories list.

    The BarItems when added to a BarManager are identified by the framework based on their CategoryID and Text property. When these two properties combined is not unique for a BarItem within the BarManager then an exception will be thrown during runtime.

    CategoriesToIgnoreInCustDialog

    Returns the categories that should not be shown in the Customization Dialog.

    Declaration
    public IntList CategoriesToIgnoreInCustDialog { get; }
    Property Value
    Type Description
    IntList

    The IntList instance containing a list of category indices.

    Remarks

    The indices in this list refer to an item in the Categories list.

    Note that this list will be consulted only when the ShowItemsInCustomizationDialog property is true.

    CurrentBaseFormType

    Gets or sets the current base form type.

    Declaration
    public string CurrentBaseFormType { get; set; }
    Property Value
    Type Description
    System.String

    CustomDrag

    Declaration
    protected bool CustomDrag { get; set; }
    Property Value
    Type Description
    System.Boolean

    CustomizationDialog

    Gets the customization dialog.

    Declaration
    public BarCustomizationDialog CustomizationDialog { get; }
    Property Value
    Type Description
    BarCustomizationDialog

    CustomizationHelper

    Declaration
    protected CustomizationDndHelper CustomizationHelper { get; }
    Property Value
    Type Description
    CustomizationDndHelper

    Customizing

    Indicates whether the user is currently customizing the menus.

    Declaration
    public virtual bool Customizing { get; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    You will typically not have to use this property. Advanced users while extending the BarManager framework might find this property useful.

    CustomizingItem

    Gets or sets the item that is currently being selected or dragged by the user during customization.

    Declaration
    public virtual BarItem CustomizingItem { get; set; }
    Property Value
    Type Description
    BarItem
    Remarks

    You will typically not have to use this property. Advanced users while extending the BarManager framework might find this property useful.

    Changing this property's value will throw the CustomizingItemChanged event.

    DesignMode

    Declaration
    protected bool DesignMode { get; }
    Property Value
    Type Description
    System.Boolean

    DisabledImageList

    Gets or sets the ImageList to which the BarItems refer to when disabled.

    Declaration
    public virtual ImageList DisabledImageList { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.ImageList

    DisabledImageListAdv

    The ImageListAdv to which the BarItems refer to when disabled.

    Declaration
    public virtual ImageListAdv DisabledImageListAdv { get; set; }
    Property Value
    Type Description
    ImageListAdv

    DisabledLargeImageList

    Gets or sets the ImageList to which the BarItems refer to when disabled and using LargeIcons mode.

    Declaration
    public virtual ImageList DisabledLargeImageList { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.ImageList

    DisabledLargeImageListAdv

    Gets or sets the ImageListAdv to which the BarItems refer to when disabled and using LargeIcons mode.

    Declaration
    public virtual ImageListAdv DisabledLargeImageListAdv { get; set; }
    Property Value
    Type Description
    ImageListAdv

    DndCustomizing

    Indicates whether the DndCustomizing is true or false. (virtual property)

    Declaration
    public virtual bool DndCustomizing { get; }
    Property Value
    Type Description
    System.Boolean

    EnableCustomizing

    Enables or disables customization of menus and toolbars during run-time.

    Declaration
    public bool EnableCustomizing { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    Indicates whether customization of menus and tool bars is allowed during run-time. This property is true by default.

    If this property is set to false and if the Customize method gets called, then it will not start the customization mode.

    If this property is true and the AutoPersistCustomization is set to false, then users will be able to customize their menus, but the customized state will not be persisted for use across application instantiations.

    EnableMenuMerge

    Declaration
    public bool EnableMenuMerge { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableTouchMode

    Gets or sets value to enable or disable the Touchmode to the controls.

    Declaration
    public bool EnableTouchMode { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    Scale factor will be updated automatically if scalefactor is equal to 1

    ExpandPartialMenusAfterDelay

    Enables or disables automatic expansion of the partial menus into full menus after a delay.

    Declaration
    public virtual bool ExpandPartialMenusAfterDelay { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    Indicates whether the partial menus should be expanded automatically. This is true by default.

    If this property is false the user will have to click on the expander button to view the full menu. If true the menu will expand automatically after 5 seconds.

    Form

    Gets or sets the form to which this BarManager is associated with.

    Declaration
    public virtual Form Form { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.Form
    Remarks

    Specifies the form to which this BarManager is associated with.

    BarManagers should be associated with a form in order for the form to be adorned with menus and tool bars.

    FormName

    Gets or sets a user-friendly name that will be used to refer to a form type in the Customization dialog.

    Declaration
    public string FormName { get; set; }
    Property Value
    Type Description
    System.String
    Remarks

    Specifies the user-friendly name that will be used to refer to a form type in the Customization dialog. In an MDI scenario the Customization dialog categorizes the tool bars and bar items based on their BarManager/Form type. And its recommended to provide a user-friendly name for these BarManager/Form types. If this property is null or empty, then the form type will be used to mark these BarManagers/Forms.

    HighlightImageList

    Gets or sets the ImageList to which BarItems refer to when highlighted.

    Declaration
    public virtual ImageList HighlightImageList { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.ImageList

    HighlightImageListAdv

    Gets or sets the ImageListAdv to which BarItems refer to when highlighted.

    Declaration
    public virtual ImageListAdv HighlightImageListAdv { get; set; }
    Property Value
    Type Description
    ImageListAdv

    HighlightLargeImageList

    Gets or sets the ImageList to which BarItems refer to when highlighted.

    Declaration
    public virtual ImageList HighlightLargeImageList { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.ImageList

    HighlightLargeImageListAdv

    Gets or sets the ImageListAdv to which BarItems refer to when highlighted.

    Declaration
    public virtual ImageListAdv HighlightLargeImageListAdv { get; set; }
    Property Value
    Type Description
    ImageListAdv

    IgnoreWorkingArea

    Indicates whether to ignore working area of the display before showing popups.

    Declaration
    public bool IgnoreWorkingArea { get; set; }
    Property Value
    Type Description
    System.Boolean

    ImageList

    Gets or sets the central repository of images to which the BarItems refer to when in small icons mode.

    Declaration
    public ImageList ImageList { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.ImageList
    Remarks

    Specifies the ImageList where the images that will be used by the BarItems are stored (when in small icons mode).

    The BarItem's ImageIndex property is usually an index into this ImageList. However, if the BarItem has its own ImageList then its ImageIndex property will be an index into that ImageList.

    ImageListAdv

    Gets or sets the central repository of images to which the BarItems refer to when in small icons mode.

    Declaration
    public ImageListAdv ImageListAdv { get; set; }
    Property Value
    Type Description
    ImageListAdv

    IsCustomizationDialogCreated

    Indicates whether the customization dialog is created or not.

    Declaration
    public bool IsCustomizationDialogCreated { get; }
    Property Value
    Type Description
    System.Boolean

    IsRTL

    Declaration
    protected bool IsRTL { get; }
    Property Value
    Type Description
    System.Boolean

    Items

    Returns the list of BarItems associated with this BarManager.

    Declaration
    public BarItems Items { get; }
    Property Value
    Type Description
    BarItems
    Remarks

    Specifies the list of BarItems associated with this BarManager.

    Every item that needs to be part of the form's menu structure/tool bar should be included in this list. When included in this list, the BarItem's CategoryID and Text property, combined, should be unique.

    LargeIcons

    Enables or disables LargIcons mode for items in the tool bar.

    Declaration
    public virtual bool LargeIcons { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    Indicates whether the images in the tool bar should be drawn large or small. The default value is false.

    When in small icons mode, the images are of the size specified by the BarItem's ImageList's ImageSize property. When in large icons mode, the images are of the size specified by the BarItem's LargeImageList's ImageSize property.

    LargeImageList

    Gets or sets the central repository of images to which the BarItems refer to when in large icons mode.

    Declaration
    public ImageList LargeImageList { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.ImageList
    Remarks

    Specifies the ImageList where the images that will be used by the BarItems are stored (when in large icons mode).

    The BarItem's ImageIndex property is usually an index into this ImageList. However, if the BarItem has its own ImageList then its ImageIndex property will be an index into that ImageList.

    LargeImageListAdv

    The ImageListAdv to which the BarItems refer to when in large icons mode.

    Declaration
    public ImageListAdv LargeImageListAdv { get; set; }
    Property Value
    Type Description
    ImageListAdv

    MainFrameBarManager

    Returns the MainFrameBarManager if this is a ChildFrameBarManager.

    Declaration
    public MainFrameBarManager MainFrameBarManager { get; }
    Property Value
    Type Description
    MainFrameBarManager
    Remarks

    Specifies the MainFrameBarManager if this is a ChildFrameBarManager. If this is a MainFrameBarManager then the property will return this. If this BarManager is not associated with an mdi child form then this property will return null.

    MetroBackColor

    Gets or Sets the metrobackcolor

    Declaration
    public Color MetroBackColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    MetroColor

    Gets or Sets the metrocolor

    Declaration
    public Color MetroColor { get; set; }
    Property Value
    Type Description
    System.Drawing.Color

    Office2007Theme

    Gets or sets colorschemes for Office2007 visual style.

    Declaration
    public Office2007Theme Office2007Theme { get; set; }
    Property Value
    Type Description
    Office2007Theme

    Office2010Theme

    Gets or sets colorschemes for Office2010 visual style.

    Declaration
    public Office2010Theme Office2010Theme { get; set; }
    Property Value
    Type Description
    Office2010Theme

    PartialMenusResetDelay

    Gets or sets the delay in days after which an item's recently used setting will be reset.

    Declaration
    public virtual int PartialMenusResetDelay { get; set; }
    Property Value
    Type Description
    System.Int32
    Remarks

    Specifies the delay after which an item's recently used setting will be reset. Default value is 100 days. When a user selects an item in a partial menus enabled submenu and if the item is not a recently used item, the item will be marked as recently used (its IsRecentlyUsedItem property will be true) for the time-interval specified by this property. After this time-interval the property will be reset to false.

    PressedImageList

    Gets or sets the ImageList to which BarItems refer to when pressed.

    Declaration
    public virtual ImageList PressedImageList { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.ImageList

    PressedImageListAdv

    Gets or sets the ImageListAdv to which BarItems refer to when pressed.

    Declaration
    public virtual ImageListAdv PressedImageListAdv { get; set; }
    Property Value
    Type Description
    ImageListAdv

    PressedLargeImageList

    Gets or sets the ImageList to which BarItems refer to when pressed.

    Declaration
    public virtual ImageList PressedLargeImageList { get; set; }
    Property Value
    Type Description
    System.Windows.Forms.ImageList

    PressedLargeImageListAdv

    Gets or sets the ImageListAdv to which BarItems refer to when pressed.

    Declaration
    public virtual ImageListAdv PressedLargeImageListAdv { get; set; }
    Property Value
    Type Description
    ImageListAdv

    RightToLeft

    Reflects the RightToLeft setting of the form this BarManager is attached to.

    Declaration
    public virtual RightToLeft RightToLeft { get; }
    Property Value
    Type Description
    System.Windows.Forms.RightToLeft

    One of the RightToLeft values. The default is .

    SelectedItem

    Gets or sets the item that is currently selected by the user through the mouse or keyboard.

    Declaration
    public virtual BarItem SelectedItem { get; set; }
    Property Value
    Type Description
    BarItem

    ShouldSerializeCategoriesToIgnoreInCustDialog

    Declaration
    protected bool ShouldSerializeCategoriesToIgnoreInCustDialog { get; }
    Property Value
    Type Description
    System.Boolean

    ShowDropShadow

    Indicates whether to show shadow for BarItem's images.

    Declaration
    public bool ShowDropShadow { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowHighlightRectangle

    Indicates whether to highlight BarItem when mouse moves over it.

    Declaration
    public bool ShowHighlightRectangle { get; set; }
    Property Value
    Type Description
    System.Boolean

    ShowItemsInCustomizationDialog

    Indicates whether the BarItems in this BarManager should appear in the Customization dialog that the user invokes.

    Declaration
    public bool ShowItemsInCustomizationDialog { get; set; }
    Property Value
    Type Description
    System.Boolean

    True to indicate they should appear; false otherwise. Default is true.

    Remarks

    If the value is true, some of the BarItems will still not appear if their corresponding categories are excluded in the CategoriesToIgnoreInCustDialog list. If the value is false, then none of the BarItems will appear in the dialog irrespective of the settings in the CategoriesToIgnoreInCustDialog property.

    ShowShadow

    Indicates whether to show shadows for Popups.

    Declaration
    public bool ShowShadow { get; set; }
    Property Value
    Type Description
    System.Boolean

    Style

    Gets or sets the visual style of the toolbars and main-menus in this MainFrameBarManager.

    Declaration
    public virtual VisualStyle Style { get; set; }
    Property Value
    Type Description
    VisualStyle

    A VisualStyle value. Default is VisualStyle.OfficeXP.

    Remarks

    Note that this setting will be ignored when ThemesEnabled is turned on and themes are available in the OS. Also note that setting VisualStyle.Default will result in the same effect as VisualStyle.OfficeXP.

    ThemeStyle

    Gets or sets the BarManagerVisualStyle value used to customize the appearance of the BarManager.

    Declaration
    public BarManagerVisualStyle ThemeStyle { get; set; }
    Property Value
    Type Description
    BarManagerVisualStyle
    Remarks

    This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

    UpdateUIMFCStyle

    Indicates whether the UpdateUI events for the BarItems should be fired mfc style when the mouse moves over it or before it gets shown in a dropdown menu.

    Declaration
    public bool UpdateUIMFCStyle { get; set; }
    Property Value
    Type Description
    System.Boolean

    True to fire the UpdateUI event; false otherwise. Default is false.

    UseBackwardCompatiblity

    Declaration
    public virtual bool UseBackwardCompatiblity { get; set; }
    Property Value
    Type Description
    System.Boolean

    UsePartialMenus

    Enables or disables Partial Menus mode in submenus.

    Declaration
    public virtual bool UsePartialMenus { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    Indicates whether the Partial Menus mode should be enabled or disabled globally in all the parent items associated with this BarManager. Default is true.

    Methods

    AppendBindableBarItemProperties(PropertyDescriptorCollection)

    Looks for bindable properties in each Baritem associated with manager and create a new PD entry for it. It then creates a brand new PDC combining the PDs of the originalList and the new entries and returns the new PDC.

    Declaration
    public PropertyDescriptorCollection AppendBindableBarItemProperties(PropertyDescriptorCollection originalList)
    Parameters
    Type Name Description
    System.ComponentModel.PropertyDescriptorCollection originalList

    The original list.

    Returns
    Type Description
    System.ComponentModel.PropertyDescriptorCollection

    A collection of property descriptors.

    See Also
    AppendBindableProperties(PropertyDescriptorCollection, IList)

    ApplyScaleToControl(Single)

    Scale the control based on the scale factor passed in the argument.

    Declaration
    public void ApplyScaleToControl(float scaleFactor)
    Parameters
    Type Name Description
    System.Single scaleFactor

    value to scale the factor based upon.

    AttachCommandBarsOfForm(Form, Boolean, Boolean)

    Attaches the command bars of the form

    Declaration
    public virtual void AttachCommandBarsOfForm(Form form, bool show, bool hideImmediately)
    Parameters
    Type Name Description
    System.Windows.Forms.Form form
    System.Boolean show
    System.Boolean hideImmediately

    BarItemsCollectionChanged(Object, CollectionChangeEventArgs)

    Declaration
    protected virtual void BarItemsCollectionChanged(object sender, CollectionChangeEventArgs args)
    Parameters
    Type Name Description
    System.Object sender
    System.ComponentModel.CollectionChangeEventArgs args

    BarListCollectionChanged(Object, CollectionChangeEventArgs)

    Declaration
    protected virtual void BarListCollectionChanged(object sender, CollectionChangeEventArgs args)
    Parameters
    Type Name Description
    System.Object sender
    System.ComponentModel.CollectionChangeEventArgs args

    BeginInit()

    Begins the initialization of a BarManager that is used on a form.

    Declaration
    public virtual void BeginInit()
    Remarks

    The Visual Studio .NET design environment uses this method to start the initialization of a component that is used on a form or used by another component. The EndInit() method ends the initialization. Using the BeginInit and EndInit methods prevents the control from being used before it is fully initialized.

    CanStartDragging(BarItem)

    Returns whether the control can start dragging.

    Declaration
    public bool CanStartDragging(BarItem item)
    Parameters
    Type Name Description
    BarItem item
    Returns
    Type Description
    System.Boolean

    CopyTo(BarManager)

    Copies the properties of this BarManager into the specified BarManager.

    Declaration
    public virtual void CopyTo(BarManager barManager)
    Parameters
    Type Name Description
    BarManager barManager

    The BarManager where the values should be copied to.

    CreateCommandBarManager()

    Declaration
    protected virtual void CreateCommandBarManager()

    CreateImporter()

    Declaration
    protected BarItemsImporter CreateImporter()
    Returns
    Type Description
    BarItemsImporter

    Customize(Boolean)

    Starts or stops the Customization mode and opens the Customization dialog.

    Declaration
    public void Customize(bool start)
    Parameters
    Type Name Description
    System.Boolean start

    True to start customization; false to stop.

    Remarks

    Call this method to start Customization mode by opening the Customization dialog. If EnableCustomizing is not true then this method will return immediately without starting customization.

    Customize(IDesignerHost)

    Starts or stops the Customization mode and opens the Customization dialog.

    Declaration
    public void Customize(IDesignerHost designerHost)
    Parameters
    Type Name Description
    System.ComponentModel.Design.IDesignerHost designerHost

    designerHost is of type IDesignerHost.

    Dispose(Boolean)

    Overridden. See System.ComponentModel.Component.Dispose(System.Boolean).

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    EndInit()

    Ends the initialization of a BarManager that is used on a form.

    Declaration
    public virtual void EndInit()
    Remarks

    The Visual Studio .NET design environment uses this method to end the initialization of a component that is used on a form or used by another component. The BeginInit() method starts the initialization. Using the BeginInit and EndInit methods prevents the control from being used before it is fully initialized.

    FindBarItemInItems(BarItems, BarItem, ref Queue)

    Declaration
    protected bool FindBarItemInItems(BarItems items, BarItem item, ref Queue pbiQueue)
    Parameters
    Type Name Description
    BarItems items
    BarItem item
    System.Collections.Queue pbiQueue
    Returns
    Type Description
    System.Boolean

    Form_Layout(Object, LayoutEventArgs)

    Declaration
    protected void Form_Layout(object sender, LayoutEventArgs levent)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Forms.LayoutEventArgs levent

    FormClosed(Object, EventArgs)

    Declaration
    protected void FormClosed(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.EventArgs e

    FormDisposed(Object, EventArgs)

    Declaration
    protected void FormDisposed(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.EventArgs e

    FormLoaded(Object, EventArgs)

    Gets called when the form is loaded. (virtual method)

    Declaration
    public virtual void FormLoaded(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.EventArgs e

    GetBarControl(Bar)

    Returns the CommandBar associated with the Bar object.

    Declaration
    public CommandBar GetBarControl(Bar bar)
    Parameters
    Type Name Description
    Bar bar

    The Bar instance whose associated CommandBar is needed.

    Returns
    Type Description
    CommandBar

    The CommandBar that the bar is currently bound to. Can be null.

    Remarks

    For an MDI app, this binding is very transient as the bar gets bound and unbound frequently as the active child form changes. Hence do not cache the CommandBar returned by this method.

    A far is usually bound to a CommandBar whenever the form containing the corresponding BarManager is active. The method will return null if the bar is not bound to a CommandBar at the time this method is called.

    As an alternative, consider listening to the BarControlBindingChanged event which occurs whenever the bar is bound/unbound to a CommandBar.

    See Also
    BarControlBindingChanged

    GetBarControlForDragDrop()

    Declaration
    protected BarControlInternal GetBarControlForDragDrop()
    Returns
    Type Description
    Syncfusion.Windows.Forms.Tools.XPMenus.BarControlInternal

    GetBarControlForDragDrop(CommandDockBar)

    Declaration
    protected BarControlInternal GetBarControlForDragDrop(CommandDockBar dockBar)
    Parameters
    Type Name Description
    CommandDockBar dockBar
    Returns
    Type Description
    Syncfusion.Windows.Forms.Tools.XPMenus.BarControlInternal

    GetBarFromBarID(BarID)

    Returns the bar associated with the bar ID.

    Declaration
    public Bar GetBarFromBarID(BarID barID)
    Parameters
    Type Name Description
    BarID barID
    Returns
    Type Description
    Bar

    GetBarFromBarItem(BarItem, ref Queue)

    Returns the current working bar.

    Declaration
    protected Bar GetBarFromBarItem(BarItem item, ref Queue pbiQueue)
    Parameters
    Type Name Description
    BarItem item

    BarItem contains in searched Bar.

    System.Collections.Queue pbiQueue
    Returns
    Type Description
    Bar

    Parental Bar of specified BarItem.

    GetBarFromBarName(String)

    Returns the Bar from the Bar name.

    Declaration
    public Bar GetBarFromBarName(string barName)
    Parameters
    Type Name Description
    System.String barName

    Name of the bar

    Returns
    Type Description
    Bar

    Bar object

    GetBarItemFromBarItemID(BarItemID)

    Returns the bar associated with the bar item ID.

    Declaration
    public BarItem GetBarItemFromBarItemID(BarItemID barItemID)
    Parameters
    Type Name Description
    BarItemID barItemID
    Returns
    Type Description
    BarItem

    GetBarItemFromShortcut(Keys)

    Retrieves BarItem object by associated keyboard shortcut.

    Declaration
    public BarItem GetBarItemFromShortcut(Keys key)
    Parameters
    Type Name Description
    System.Windows.Forms.Keys key

    Keyboard shortcut.

    Returns
    Type Description
    BarItem

    BarItem object.

    GetCommandBarManager()

    Returns the CommandBarManager.

    Declaration
    public CommandBarManager GetCommandBarManager()
    Returns
    Type Description
    CommandBarManager

    GetControlName(String)

    Helps to get the ControlName settings in control

    Declaration
    public override string GetControlName(string controlName)
    Parameters
    Type Name Description
    System.String controlName
    Returns
    Type Description
    System.String
    Overrides
    BaseComponent.GetControlName(String)

    GetItemsInCategory(Int32)

    Returns a list of BarItems under the specified category ID.

    Declaration
    public BarItems GetItemsInCategory(int categoryIndex)
    Parameters
    Type Name Description
    System.Int32 categoryIndex

    An index into the Categories list.

    Returns
    Type Description
    BarItems

    A BarItems list containing BarItem objects that has the specified category ID.

    GetManagerFrom(Form)

    Declaration
    protected virtual BarManager GetManagerFrom(Form form)
    Parameters
    Type Name Description
    System.Windows.Forms.Form form
    Returns
    Type Description
    BarManager

    GetManagerFromForm(Form)

    Looks for a BarManager associated with the specified form in a global hashtable and if found returns it.

    Declaration
    public static BarManager GetManagerFromForm(Form form)
    Parameters
    Type Name Description
    System.Windows.Forms.Form form

    A form that has a BarManager associated with it.

    Returns
    Type Description
    BarManager

    The associated BarManager; Null if not found.

    Remarks

    A BarManager gets associated with a form when you create an instance of the BarManager passing in the form in it's constructor.

    GetMergedEquivalent(Bar, Bar)

    Returns the merged bar that has replaced the original in the menu structure.

    Declaration
    public Bar GetMergedEquivalent(Bar originalBar, Bar defaultReturnValue)
    Parameters
    Type Name Description
    Bar originalBar

    The original Bar.

    Bar defaultReturnValue

    The default return value if a merged Bar was not found.

    Returns
    Type Description
    Bar

    A bar if a merged equivalent was found; defaultReturnValue otherwise.

    Remarks

    Often in an MDI scenario, bars created during design-time in the MDI Parent and MDI children are merged together (if satisfying the merge criteria) into a new bar which will replace the original in the menu structure.

    Once replaced changes made to the original bar, like adding a new BarItem will not be reflected in the merged one. So, you should access the merged bar directly to add child BarItems, for example. This method lets you do the same.

    GetMergedEquivalent(ParentBarItem, ParentBarItem)

    Returns the merged ParentBarItem that has replaced the original in the menu structure.

    Declaration
    public ParentBarItem GetMergedEquivalent(ParentBarItem originalParent, ParentBarItem defaultReturnValue)
    Parameters
    Type Name Description
    ParentBarItem originalParent

    The original ParentBarItem.

    ParentBarItem defaultReturnValue

    The default return value if a merged ParentBarItem was not found.

    Returns
    Type Description
    ParentBarItem

    A ParentBarItem if a merged equivalent was found; defaultReturnValue otherwise.

    Remarks

    Often in an MDI scenario, ParentBarItems created during design-time in the MDI Parent and MDI children are merged together (if satisfying the merge criteria) into a new ParentBarItem which will replace the original in the menu structure.

    Once replaced changes made to the original ParentBarItem, like adding a new BarItem will not be reflected in the merged one. So, you should access the merged item directly to add child BarItems, for example. This method lets you do the same.

    GetObjectData(SerializationInfo, StreamingContext)

    Assists the serializer to perform serialization

    Declaration
    public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
    Parameters
    Type Name Description
    System.Runtime.Serialization.SerializationInfo info
    System.Runtime.Serialization.StreamingContext context

    GetService(Type)

    Declaration
    protected object GetService(Type serviceType)
    Parameters
    Type Name Description
    System.Type serviceType
    Returns
    Type Description
    System.Object

    HidePopup()

    Hides currently open popup.

    Declaration
    public void HidePopup()

    ImportBarItems(IBarItemsRepository)

    Imports BarItems from one BarManager to another. Not to be confused with "MDI Merging".

    Declaration
    public void ImportBarItems(IBarItemsRepository sourceRepository)
    Parameters
    Type Name Description
    IBarItemsRepository sourceRepository

    The source IBarItemsRepository from which to import bar items.

    Remarks

    Note that the BarManager class implements the IBarItemsRepository interface, due to which you can import items from an instance of BarManager.

    This method will move all BarItems from the source BarManager to the destination BarManager. The BarItems will be moved into their corresponding categories in the destination BarManager. If there is a clash in Text value of these items (no 2 items within the same category can have the same Text value), a new category will be created and the clashing item from the source BarManager will be moved to that new category.

    Init()

    Declaration
    protected virtual void Init()

    InitCustomizationDialog()

    Declaration
    protected virtual void InitCustomizationDialog()

    InitFromDesigner()

    Initializes from designer.

    Declaration
    public void InitFromDesigner()

    MenuActivationControl_AppActivate(Object, EventArgs)

    Declaration
    protected void MenuActivationControl_AppActivate(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.EventArgs e

    MenuActivationControl_AppDeactivate(Object, EventArgs)

    Declaration
    protected void MenuActivationControl_AppDeactivate(object sender, EventArgs e)
    Parameters
    Type Name Description
    System.Object sender
    System.EventArgs e

    OnAfterClone(BarManagerClonedEventArgs)

    Raises the AfterClone event.

    Declaration
    protected virtual void OnAfterClone(BarManagerClonedEventArgs args)
    Parameters
    Type Name Description
    BarManagerClonedEventArgs args

    A BarItemClickedEventArgs object containing data pertaining to this event.

    Remarks

    The OnAfterClone method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnAfterClone in a derived class, be sure to call the base class's OnAfterClone method so that registered delegates receive the event.

    Examples
    // Listen to the AfterClone event of the ChildFrameBarManager and
    // set the cloned BarManager's ImageList and LargeImageList.
    // This is necessary because cloning an ImageList (il1.ImageStream = il2.ImageStream;) seems to be broken in 1.1.
    private void childFrameBarManager_AfterClone(object sender, Syncfusion.Windows.Forms.Tools.XPMenus.BarManagerClonedEventArgs args)
    {
    	System.Resources.ResourceManager resources = new System.Resources.ResourceManager(this.GetType());
    
    	// Load the images from the resource and set it to the ImageLists. 
    	// You can typically copy the right-hand side portion of the following statements from the 
    	// designer generated code in the InitializeComponent method.
    	// imgList16 and imgList24 are the names of the ImageList instances in this Form.
    	args.ClonedBarManager.ImageList.ImageStream = ((System.Windows.Forms.ImageListStreamer)(resources.GetObject("imgList16.ImageStream")));
    	args.ClonedBarManager.LargeImageList.ImageStream = ((System.Windows.Forms.ImageListStreamer)(resources.GetObject("imgList24.ImageStream")));
    }
    ' Listen to the AfterClone event of the ChildFrameBarManager and
    ' set the cloned BarManager's ImageList and LargeImageList.
    ' This is necessary because cloning an ImageList (il1.ImageStream = il2.ImageStream;) seems to be broken in 1.1.
    Private  Sub childFrameBarManager_AfterClone(ByVal sender As Object, ByVal args As Syncfusion.Windows.Forms.Tools.XPMenus.BarManagerClonedEventArgs)
    Dim resources As System.Resources.ResourceManager =  New System.Resources.ResourceManager(Me.GetType()) 
    
    	' Load the images from the resource and set it to the ImageLists. 
    	' You can typically copy the right-hand side portion of the following statements from the 
    	' designer generated code in the InitializeComponent method.
    	args.ClonedBarManager.ImageList.ImageStream = (CType((resources.GetObject("imgList16.ImageStream")), System.Windows.Forms.ImageListStreamer))
    	args.ClonedBarManager.LargeImageList.ImageStream = (CType((resources.GetObject("imgList24.ImageStream")), System.Windows.Forms.ImageListStreamer))
    End Sub

    OnAttachForm()

    Called when a form is set using the Form property.

    Declaration
    protected virtual void OnAttachForm()

    OnBarControlBindingChanged(BarControlBindingChangedArgs)

    Raises the BarControlBindingChanged event.

    Declaration
    protected virtual void OnBarControlBindingChanged(BarControlBindingChangedArgs args)
    Parameters
    Type Name Description
    BarControlBindingChangedArgs args

    A BarControlBindingChangedArgs that contains the event data.

    Remarks

    The OnBarControlBindingChanged method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnBarControlBindingChanged in a derived class, be sure to call the base class's OnBarControlBindingChanged method so that registered delegates receive the event.

    See Also
    BarControlBindingChanged

    OnBeginCustomization(EventArgs)

    Raises the CustomizationBegin event.

    Declaration
    protected virtual void OnBeginCustomization(EventArgs args)
    Parameters
    Type Name Description
    System.EventArgs args

    An EventArgs object containing data pertaining to this event.

    Remarks

    The OnBeginCustomization method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnBeginCustomization in a derived class, be sure to call the base class's OnBeginCustomization method so that registered delegates receive the event.

    OnCustomizationDone(EventArgs)

    Raises the CustomizationDone event.

    Declaration
    protected virtual void OnCustomizationDone(EventArgs args)
    Parameters
    Type Name Description
    System.EventArgs args

    An EventArgs object containing data pertaining to this event.

    Remarks

    The OnCustomizationDone method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnCustomizationDone in a derived class, be sure to call the base class's OnCustomizationDone method so that registered delegates receive the event.

    OnCustomizingItemChanged(EventArgs)

    Raises the CustomizingItemChanged event.

    Declaration
    protected virtual void OnCustomizingItemChanged(EventArgs args)
    Parameters
    Type Name Description
    System.EventArgs args

    An System.EventArgs object containing data pertaining to this event.

    Remarks

    The OnCustomizingItemChanged method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnCustomizingItemChanged in a derived class, be sure to call the base class's OnCustomizingItemChanged method so that registered delegates receive the event.

    OnDetachForm()

    Called when the attached Form is being removed.

    Declaration
    protected virtual void OnDetachForm()

    OnFloatingFormClosed(Bar)

    Declaration
    protected virtual void OnFloatingFormClosed(Bar bar)
    Parameters
    Type Name Description
    Bar bar

    OnItemClicked(BarItemClickedEventArgs)

    Raises the ItemClicked event.

    Declaration
    protected virtual void OnItemClicked(BarItemClickedEventArgs args)
    Parameters
    Type Name Description
    BarItemClickedEventArgs args

    A BarItemClickedEventArgs object containing data pertaining to this event.

    Remarks

    The OnItemClicked method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnItemClicked in a derived class, be sure to call the base class's OnItemClicked method so that registered delegates receive the event.

    OnPropertyChanged(SyncfusionPropertyChangedEventArgs)

    Raises the PropertyChanged event.

    Declaration
    protected virtual void OnPropertyChanged(SyncfusionPropertyChangedEventArgs args)
    Parameters
    Type Name Description
    SyncfusionPropertyChangedEventArgs args

    An System.EventArgs object containing data pertaining to this event.

    Remarks

    The OnPropertyChanged method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnPropertyChanged in a derived class, be sure to call the base class's OnPropertyChanged method so that registered delegates receive the event.

    OnResetBarItem(BarItem)

    Declaration
    protected virtual void OnResetBarItem(BarItem itemToReset)
    Parameters
    Type Name Description
    BarItem itemToReset

    OnSelectedItemChanged(EventArgs)

    Raises the SelectedItemChanged event.

    Declaration
    protected virtual void OnSelectedItemChanged(EventArgs args)
    Parameters
    Type Name Description
    System.EventArgs args

    An System.EventArgs object containing data pertaining to this event.

    Remarks

    The OnSelectedItemChanged method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

    Notes to Inheritors: When overriding OnSelectedItemChanged in a derived class, be sure to call the base class's OnSelectedItemChanged method so that registered delegates receive the event.

    OnThemeNameChanged(String)

    Helps to apply the ThemeName settings in control

    Declaration
    public override void OnThemeNameChanged(string themeName)
    Parameters
    Type Name Description
    System.String themeName

    ThemeName

    Overrides
    BaseComponent.OnThemeNameChanged(String)

    OnUserChangedBarVisibility(Bar)

    Declaration
    protected virtual void OnUserChangedBarVisibility(Bar bar)
    Parameters
    Type Name Description
    Bar bar

    ProcessCmdKey(ref Message, Keys)

    Processes the command key

    Declaration
    public virtual bool ProcessCmdKey(ref Message msg, Keys keyData)
    Parameters
    Type Name Description
    System.Windows.Forms.Message msg

    reference Message.

    System.Windows.Forms.Keys keyData

    Key data of type Keys

    Returns
    Type Description
    System.Boolean

    ProcessShortcut(Keys)

    Checks whether the key can be processed for shortcut

    Declaration
    public virtual bool ProcessShortcut(Keys key)
    Parameters
    Type Name Description
    System.Windows.Forms.Keys key

    Key

    Returns
    Type Description
    System.Boolean

    true if can process

    RefreshCommandBarsAfterDesignerLoad(Boolean)

    Refreshes the command bars after the designer has loaded.

    Declaration
    public virtual void RefreshCommandBarsAfterDesignerLoad(bool saveCommandBarState)
    Parameters
    Type Name Description
    System.Boolean saveCommandBarState

    RemoveReferencesToBarItem(BarItem)

    Removes all the references for the bar item specified.

    Declaration
    public virtual void RemoveReferencesToBarItem(BarItem item)
    Parameters
    Type Name Description
    BarItem item

    RemoveReferencesToForeignItems()

    Removes all references to BarItems that are not parented by this BarManager and are in the bars and ParentBarItems of this BarManager.

    Declaration
    public virtual void RemoveReferencesToForeignItems()

    ResetFormName()

    Declaration
    protected void ResetFormName()

    ShouldSerializeFormName()

    Declaration
    protected bool ShouldSerializeFormName()
    Returns
    Type Description
    System.Boolean

    ShowPopup(ParentBarItem)

    Shows popup of specified item.

    Declaration
    public void ShowPopup(ParentBarItem item)
    Parameters
    Type Name Description
    ParentBarItem item

    Parent bar item whose popup must be shown.

    UnadviseForm()

    Declaration
    protected void UnadviseForm()

    UpdateContainer(IBarItemContainer, BarItem, BarItem, UpdateType, Object, ref Boolean)

    Updates the container

    Declaration
    public void UpdateContainer(IBarItemContainer parentItem, BarItem source, BarItem adjacentItem, UpdateType updateType, object updateData, ref bool keepUpdateInfo)
    Parameters
    Type Name Description
    IBarItemContainer parentItem

    Parent control

    BarItem source

    Source control

    BarItem adjacentItem

    Adjacent bar item

    UpdateType updateType

    Update type

    System.Object updateData

    Update data of type object

    System.Boolean keepUpdateInfo

    true if update info need to be kept

    UpdateItem(BarItem, UpdateType, Object, ref Boolean)

    Updates the bar items.

    Declaration
    public void UpdateItem(BarItem item, UpdateType updateType, object updateData, ref bool keepUpdateInfo)
    Parameters
    Type Name Description
    BarItem item
    UpdateType updateType
    System.Object updateData
    System.Boolean keepUpdateInfo

    Events

    AfterClone

    Occurs after a clone of this BarManager was created in an MDI scenario.

    Declaration
    public event BarManagerClonedEventHandler AfterClone
    Event Type
    Type Description
    BarManagerClonedEventHandler
    Remarks

    This is usually called for a ChildFrameBarManager when merging happens in an MDI scenario.

    This event is provided to workaround a 1.1 framework bug which prevents us from cloning an ImageList (The code "imageList.ImageStream = anotherImageList.ImageStream" doesn't work in 1.1).

    BarControlBindingChanged

    Occurs when a Bar object is bound or unbound to a Control.

    Declaration
    public event BarControlBindingChangedEventHanlder BarControlBindingChanged
    Event Type
    Type Description
    BarControlBindingChangedEventHanlder
    Remarks

    The Bar component (representing a toolbar and a main-menu) gets associated with a CommandBar control during runtime. This binding is static in an SDI app, but usually very transient in an MDI application. In an MDI, a bar will frequently get bound and unbound to controls as the active child form changes.

    The Bar object itself exposes some styles to affect the look-and-feel of the toolbars through it's BarStyle property. However, you might want to access the CommandBar control hosting the Bar object for some advanced customization of the toolbar.

    You can do so by handling this event which is fired whenever the bar object gets bound/unbound to a Control. For the toolbars and the main-menu, this control is an instance of the CommandBar class and hence can be cast to it.

    You could also use the GetBarControl(Bar) method to get the CommandBar currently bound to a Bar.

    See Also
    BarControlBindingChangedArgs
    OnBarControlBindingChanged(BarControlBindingChangedArgs)

    CustomizationBegin

    Occurs when the Customization dialog is about to be shown.

    Declaration
    public event EventHandler CustomizationBegin
    Event Type
    Type Description
    System.EventHandler

    CustomizationDone

    Occurs when the Customization dialog has been closed.

    Declaration
    public event EventHandler CustomizationDone
    Event Type
    Type Description
    System.EventHandler

    CustomizingItemChanged

    Occurs when the BarManager's CustomizingItem property has changed.

    Declaration
    public event EventHandler CustomizingItemChanged
    Event Type
    Type Description
    System.EventHandler
    Remarks

    This event will also be raised when it's associated MainBarManager's CustomizingItem property changes.

    FloatingFormClosed

    Occurs when the floating bar gets closed

    Declaration
    public event BarChangedEventHandler FloatingFormClosed
    Event Type
    Type Description
    BarChangedEventHandler

    ItemClicked

    Occurs when one of the items in this BarManager was clicked.

    Declaration
    public event BarItemClickedEventHandler ItemClicked
    Event Type
    Type Description
    BarItemClickedEventHandler

    PropertyChanged

    Occurs when the BarManager's LargeIcons or ThemesEnabled property has changed.

    Declaration
    public event SyncfusionPropertyChangedEventHandler PropertyChanged
    Event Type
    Type Description
    SyncfusionPropertyChangedEventHandler
    Remarks

    This event will also be raised when it's associated MainBarManager's LargeIcons or ThemesEnabled property changes.

    ResetBarItemClicked

    Occurs when reset BarItem is clicked.

    Declaration
    public event BarItemClickedEventHandler ResetBarItemClicked
    Event Type
    Type Description
    BarItemClickedEventHandler

    SelectedItemChanged

    Occurs when a new BarItem is selected or unselected by the user.

    Declaration
    public event EventHandler SelectedItemChanged
    Event Type
    Type Description
    System.EventHandler
    Remarks

    This is a good event to listen to if you want to, for example, show a selected item's tooltip in the status bar. Use the SelectedItem property to get a reference to the selected BarItem.

    UserChangedBarVisibility

    Occurs when bar visibility is changed by the user.

    Declaration
    public event BarChangedEventHandler UserChangedBarVisibility
    Event Type
    Type Description
    BarChangedEventHandler

    Explicit Interface Implementations

    IVisualStyle.VisualTheme

    Declaration
    string IVisualStyle.VisualTheme { get; set; }
    Returns
    Type Description
    System.String

    IBarItemsRepository.Bars

    Declaration
    Bars IBarItemsRepository.Bars { get; }
    Returns
    Type Description
    Bars

    IBarItemsRepository.Categories

    Declaration
    ArrayList IBarItemsRepository.Categories { get; }
    Returns
    Type Description
    System.Collections.ArrayList

    IBarItemsRepository.CategoriesToIgnoreInCustDialog

    Declaration
    IntList IBarItemsRepository.CategoriesToIgnoreInCustDialog { get; }
    Returns
    Type Description
    IntList

    IBarItemsRepository.ClearItemsAfterImport

    Declaration
    bool IBarItemsRepository.ClearItemsAfterImport { get; }
    Returns
    Type Description
    System.Boolean

    IBarItemsRepository.ImageList

    Declaration
    ImageList IBarItemsRepository.ImageList { get; }
    Returns
    Type Description
    System.Windows.Forms.ImageList

    IBarItemsRepository.Items

    Declaration
    BarItems IBarItemsRepository.Items { get; }
    Returns
    Type Description
    BarItems

    IBarItemsRepository.LargeImageList

    Declaration
    ImageList IBarItemsRepository.LargeImageList { get; }
    Returns
    Type Description
    System.Windows.Forms.ImageList

    IDeserializationCallback.OnDeserialization(Object)

    Declaration
    void IDeserializationCallback.OnDeserialization(object sender)
    Parameters
    Type Name Description
    System.Object sender

    Implements

    IThemeProvider
    System.IDisposable
    System.ComponentModel.ISupportInitialize
    IBarItemsRepository
    System.Runtime.Serialization.ISerializable
    System.Runtime.Serialization.IDeserializationCallback
    IIgnoreWorkingArea
    IVisualStyle

    See Also

    ChildFrameBarManager
    MainFrameBarManager
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved