BarManager Members
In This Article
#Constructors
Name | Description |
---|---|
Bar |
Initializes a new Bar |
Bar |
Initializes a new instance of the Bar |
#Properties
Name | Description |
---|---|
Active |
Gets the link whose editor is currently active. |
Active |
Gets the currently active editor. |
Active |
Gets the currently active multiple document interface (MDI) child window. |
Allow |
Gets or sets whether the Customization Window can be activated by the end-user. |
Allow |
Gets or sets whether bar items are disposed when removed from the Bar |
Allow |
Gets or sets whether you can activate bars when their bar manager does not contain a main menu. |
Allow |
For internal use. |
Allow |
Gets or sets whether glyphs for all Bar |
Allow |
Gets or sets the default ability to use HTML tags to format bar item text (Bar |
Allow |
Gets or sets whether bar items are highlighted with an animation effect. |
Allow |
Obsolete. Gets or sets a value that specifies whether images are highlighted when links are hot-tracked. |
Allow |
Gets or sets whether to show the MDI buttons for the maximized MDI child document. |
Allow |
Gets or sets whether invisible links can be merged. |
Allow |
Gets or sets a value indicating whether bar movement within the toolbar area is allowed. |
Allow |
Gets or sets whether quick bar customization is enabled. |
Allow |
Gets or sets a value indicating whether bars belonging to the Bar Manager allow the customization menu to be displayed. |
Auto |
Gets or sets a value indicating whether the bars’ layout is saved to and loaded from the system registry automatically. |
Bar |
Obsolete. Gets or sets the default background color for all bars that belong to the Bar |
Bar |
Obsolete. Gets the horizontal indent between the contents and borders of bar links. |
Bar |
Obsolete. Gets or sets the vertical indent between the content and borders of bar links. |
Bars |
Gets the bars collection of the Bar |
Cache |
Gets or sets whether or not this Bar |
Can |
Gets a value indicating whether the component can raise an event. Inherited from Component. |
Can |
This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. |
Categories | Gets a collection of categories used to logically organize bar items. |
Close |
This member is obsolete. It gets or sets a value specifying whether the close button of a dock window hides other windows docked onto it. |
Close |
This is an internal property that should not be used. |
Close |
This member supports the internal infrastructure, and is not intended to be used directly from your code. |
Close |
|
Container | Gets the IContainer that contains the Component. Inherited from Component. |
Controller |
Gets or sets the bar and dock controller that will provide default appearance and customization options for the bars belonging to the current Bar |
Customize |
Gets the currently customized link. |
Design |
Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
Dock |
Gets the collection of controls that provide docking for bars. |
Docking |
Gets or sets a value indicating whether the Bar |
Dock |
Gets or sets the Dock |
Dock |
Obsolete. This member is obsolete. It gets the collection of dock windows within the Bar |
Dock |
This member is obsolete. It gets or sets the font used to display tab captions when dock windows are docked to the same place. |
Editors |
Obsolete. To customize the collection of editors available for bars, use the inherited Component |
Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
External |
Gets or sets the external editors repository.
Inherited from Component |
Form |
Gets or sets the Form or User |
Hide |
Gets or sets whether bars that belong to the current child Bar Manager are hidden from the child form during a merge operation.
This option is in effect if you subscribed to the parent Bar |
Highlighted |
Gets the currently highlighted link. |
Highlight |
Gets or sets the highlight mode for hovered drop-down Bar |
Html |
Gets or sets a collection of images that can be inserted into item captions using the image tag. |
Images | Gets or sets the source of images that can be displayed within item links. |
Is |
Gets or sets a value indicating whether the Bar |
Is |
Gets or sets a value indicating whether the Bar |
Is |
Gets or sets a value indicating whether a bar is being dragged. |
Is |
Gets or sets a value indicating whether an item link is being dragged. |
Is |
Gets or sets a value indicating whether the Bar |
Is |
Gets or sets a value indicating whether the Bar |
Is |
Gets or sets a value indicating whether the Bar |
Item |
This member supports the internal infrastructure, and is not intended to be used directly from your code. |
Items |
Provides access to the Bar |
Items |
Obsolete. Gets or sets the default font used to paint link captions. |
Keyboard |
Gets the link that is currently selected in a bar using the keyboard. |
Large |
This property is obsolete. Use the Bar |
Large |
Gets or sets the source of large images that can be displayed within item links. |
Layout |
Gets or sets the version of the layout of bars. |
Main |
Gets or sets the bar that is used as the form’s main menu. |
Main |
Obsolete. Gets or sets the default background color for main menus. |
Max |
This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. |
Mdi |
Gets or sets if and when a merge mechanism is invoked in an MDI application. |
Menu |
This property is obsolete. Use the Bar |
Merged |
For internal use. |
Most |
Gets or sets the value (as a percentage) that determines which of the menu items that haven’t recently been used should be hidden |
Open |
Gets or sets whether sub-menus are automatically opened when hovered over with the mouse pointer. |
Options |
Contains options that control how the bars’ layout is stored to/restored from a stream, xml file or system registry. |
Options |
Provides access to options that modify a stub glyphs’ appearance. |
Paint |
Obsolete. Gets or sets the name of the painting style applied to bars. |
Popup |
Gets or sets how popup menus associated with this Bar |
Popup |
Gets or sets whether nested popup sub-menus are displayed in cascaded or inplace mode. |
Pressed |
Gets the currently pressed link. |
Primary |
Gets or sets whether a Bar |
Process |
Gets or sets whether shortcuts for items are in effect if the Bar Manager belongs to a hidden parent control (Form or User |
Re |
Gets or sets whether or not the last focused editor should be focused again after a user has clicked a popup menu item and this menu was closed. |
Registry |
Gets or sets the registry path to which the bar layout is saved. |
Repository |
Provides access to the component’s internal repository.
Inherited from Component |
Right |
Gets or sets a value indicating whether the Bar |
Shared |
Gets or sets the value that specifies how the display size of images is determined, when the images are obtained from a Shared |
Show |
Gets or sets whether the close button is displayed in the main menu. |
Show |
Gets or sets a value indicating whether to display both recent and non-recent links within a menu. |
Show |
Gets or sets a value indicating whether non-recent item links are displayed after a certain period of time. |
Show |
Gets or sets whether bar item link tooltips should be displayed within context menus. |
Show |
Gets or sets whether hints are enabled for bar item links displayed within toolbars. |
Show |
Gets or sets a value indicating whether a shortcut key should be displayed along with a hint for links belonging to the Bar |
Single |
Gets or sets whether users should tap editors once or twice to display the on-screen keyboard (when the application runs on touch-screen devices). |
Site | Gets or sets the ISite of the Component. Inherited from Component. |
Status |
Gets or sets the status bar for the current form. |
Status |
Obsolete. Gets or sets the background color of the status bar owned by this Bar |
Sub |
Obsolete. Gets or sets the default background color for all submenus within the Bar |
Sub |
Obsolete. Gets or sets the default background image for all submenus within the Bar |
Sub |
Obsolete. Gets or set the background color for item descriptive images. |
Submenu |
Obsolete. Gets or sets a value indicating whether a submenu casts a shadow. |
Sub |
Obsolete. Gets or set the background color of non-recent item descriptive images. |
Sub |
Returns the delay that occurs before a submenu displayed within another submenu is opened or closed, in milliseconds. |
Suppress |
Gets or sets whether to suppress the specified keyboard key for all editors. |
Tool |
Gets or sets the point relative to which tooltips are displayed for Bar |
Tool |
Gets or sets the component that controls the behavior and appearance of hints displayed for the container component’s visual elements.
Inherited from Component |
Transparent |
This property is provided for backward compatibility. Use the Bar |
Transparent |
Gets or sets whether specific in-place editors, when focused, are painted using a transparent background color. |
Update |
This member supports the internal infrastructure, and is not intended to be used directly from your code. |
Use |
Gets or sets whether the main menu is activated when the ALT key is pressed. |
Use |
Gets or sets whether the main menu is activated when the F10 key is pressed. |
Use |
This property supports internal infrastructure and is not intended to be used in code. |
#Methods
Name | Description |
---|---|
About() static | Activates the About dialog. |
Begin |
Begins the runtime initialization of the Bar |
Begin |
Locks the Bar |
Close |
Closes all dropdown and popup windows that belong to this Bar |
Create |
This member supports the internal infrastructure, and is not intended to be used directly from your code. |
Create |
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Inherited from Marshal |
Customize() |
Invokes the Customization Form. This method is obsolete. Use the Show |
Dispose() | Releases all resources used by the Component. Inherited from Component. |
End |
Notifies the component that the initialization has been completed.
Inherited from Component |
End |
Unlocks the Bar |
Equals |
Determines whether the specified object instances are considered equal. Inherited from Object. |
Equals |
Determines whether the specified object is equal to the current object. Inherited from Object. |
Force |
Forces the Bar Manager to create bar item links within the Bar |
Force |
Forces the manager to create item links based on bar items. |
Get |
Returns the Svg |
Get |
Returns the actual bar and dock controller specifying behavior and appearance settings for the corresponding bars. |
Get |
Serves as the default hash function. Inherited from Object. |
Get |
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
Inherited from Marshal |
Get |
Returns a unique name for a bar which is about to be created. |
Get |
This method is intended for internal use. Returns the new unique identifier of an item. |
Get |
Gets the popup menu assigned to a control. |
Get |
Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
Get |
Returns a localized string for the given string identifier. |
Get |
Returns the actual tooltip controller that controls the behavior and appearance of hints for a container component’s elements.
Inherited from Component |
Get |
Gets the Type of the current instance. Inherited from Object. |
Hide |
Hides the Customization Window. |
Hide |
Hides the customization menu. |
Initialize |
Obtains a lifetime service object to control the lifetime policy for this instance.
Inherited from Marshal |
Internal |
This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. |
Layout |
Forces the Bar |
Lock |
This is an internal method. Do not call it in your code. |
Memberwise |
Creates a shallow copy of the current Object. Inherited from Object. |
Memberwise |
Creates a shallow copy of the current Marshal |
Perform |
Fires the Item |
Perform |
Fires the Item |
Reference |
Determines whether the specified Object instances are the same instance. Inherited from Object. |
Reset |
Obsolete. This method is obsolete. Use the Bar |
Reset |
Clears the record of menu items recently accessed by a user in their application and restores the default set of visible item controls to menus and bars. This action will not undo any explicit customizations. |
Restore |
Restores the bars’ layout from the registry. |
Restore |
Restores the bars’ layout from the registry. |
Restore |
Restores the bars’ layout from a stream. |
Restore |
Restores the Bar |
Restore |
Restores the bars’ layout from the system registry. |
Restore |
Restores the bars’ layout from the specified system registry path. |
Restore |
Restores the bars’ layout from the specified stream. |
Restore |
Restores the bars’ layout from the specified XML file. |
Save |
Saves the bars’ layout to the system registry. |
Save |
Saves the bars’ layout to the specified system registry path. |
Save |
Saves the bars’ layout to a stream. |
Save |
Saves the bars’ layout to an XML file. |
Save |
Saves the Bar |
Save |
Saves the Bar |
Save |
Saves the Bar |
Save |
Saves the Bar |
Select |
Selects the specified link. |
Set |
Sets the popup menu for a control within a form. |
Show |
Invokes the Customization Form. |
Show |
Displays the customization menu. |
Show |
Displays the customization menu at the position of the mouse cursor. |
To |
Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component. |
Unlock |
This is an internal method. Do not call it in your code. |
Update |
This member supports the internal infrastructure, and is not intended to be used directly from your code. |
#Events
Name | Description |
---|---|
Before |
Occurs before a layout is restored from storage (a stream, xml file or the system registry). |
Before |
This member supports the internal infrastructure, and is not intended to be used directly from your code. |
Close |
Fires when the close button is clicked. |
Create |
Occurs before the Customization Window is displayed. |
Create |
Allows you to customize a bar when it is created. |
Custom |
Allows you to manually paint bar item links. |
Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
Editor |
Occurs when a key is pressed within an in-place editor that belongs to the container component.
Inherited from Component |
Editor |
Occurs when a character key is pressed within an in-place editor that belongs to the container component.
Inherited from Component |
Editor |
Occurs when a pressed key is released within an in-place editor that belongs to the container component.
Inherited from Component |
End |
Occurs when a user finishes customizing the Bar |
Highlighted |
Fires immediately after the highlighted link has been changed. |
Hyperlink |
Occurs each time an end-user clicks a hyperlink within the Bar |
Init |
This is an internal event that should not be used. |
Item |
Occurs when a link within the bar is clicked. |
Item |
Occurs when a link is double clicked. |
Item |
Fires immediately after any of the links associated with the Bar Manager has been pressed. |
Layout |
Occurs after a layout whose version doesn’t match the current layout’s version has been loaded from storage |
Load | Fires when the manager is initialized. |
Merge |
Allows you to customize menus and bars when a child MDI form is activated or maximized (depending on the Bar |
Popup | This member supports the internal infrastructure, and is not intended to be used directly from your code. |
Pressed |
Fires immediately after a link has been pressed or released. |
Query |
Occurs when a control’s Popup |
Shortcut |
Allows you to stop a bar item’s shortcut that has been pressed from being processed by Xtra |
Show |
Allows you to modify the customization menu before it is displayed onscreen. |
Start |
Occurs when a user starts customizing the Bar |
Un |
Allows you to customize menus and bars when a child MDI form becomes inactive or when it is restored or minimized from its maximized view (depending on the Bar |
See Also