Class AuiToolbar

Namespace: Alternet.UI

Assembly: Alternet.UI.dll

Dockable toolbar, managed by AuiManager.

[ControlCategory("MenusAndToolbars")]
public class AuiToolbar : Control, IBaseObject, IDisposableObject, IInputElement, ISupportInitialize, IFocusable, IWin32Window, ITextProperty, IComponent, IDisposable

Inheritance: object

BaseObject

DisposableObject

DispatcherObject

DependencyObject

UIElement

FrameworkElement

Control

AuiToolbar

Implements: IBaseObject

IDisposableObject

IInputElement

ISupportInitialize

IFocusable

IWin32Window

ITextProperty

IComponent

IDisposable

Extension Methods: UixmlPortObjectExtensions.Bind(DependencyObject, DependencyProperty, Binding, object?)

Remarks

Example of how a AuiToolbar can look:

AuiToolbar

Fields

DefaultSpacerWidth: Defines spacer width which is used in AddSpacer(int?).

Properties

ArtProvider: Gets or sets the associated art provider.

ControlKind: Returns control identifier.

CreateStyle: Defines visual style and behavior of the AuiToolbar control.

DefaultCreateStyle: Defines default visual style for the newly created AuiToolbar controls.

EventClickPoint: Gets mouse click point passed in the event handler.

EventIsDropDownClicked: Gets whether is drop down part of the tool was clicked when event is fired.

EventItemRect: Gets tool item rectangle passed in the event handler.

EventToolId: Gets id of the tool passed in the event handler.

EventToolNameOrId: Gets name of the tool passed in the event handler. If name is empty, tool id is returned.

GripperVisible: Gets or sets whether toolbar gripper is visible.

OverflowVisible: Gets or sets whether toolbar overflow button is visible.

ToolBitmapSizeInPixels: Gets or sets the default size of each tool bitmap.

ToolBorderPadding: Gets or sets tool border padding.

ToolPacking: Gets or sets the value used for packing tools.

ToolSeparation: Gets or sets the default separator size.

ToolTextOrientation: Gets or sets tool text orientation.

Methods

AddControl(Control): Adds any control to the toolbar, typically e.g. a ComboBox or TextBox.

AddLabel(string, int): Adds a text label to the toolbar.

AddSeparator(): Adds a separator for spacing groups of tools.

AddSpacer(int?): Adds an empty space for spacing groups of tools.

AddStretchSpacer(int): Adds a stretchable space to the toolbar.

AddTool(string?, ImageSet?, string?, AuiToolbarItemKind?, ImageSet?, string?): Adds a tool to the toolbar.

AddToolOnClick(int, EventHandler): Registers event handler which is called when tool is clicked.

Clear(): Deletes all the tools in the toolbar.

DeleteTool(int): Removes the specified tool from the toolbar and deletes it.

EnableTool(int, bool): Enables or disables the tool.

GetToolAlignment(int): Gets alignment of the toolbar item.

GetToolBarFits(): Gets whether all tools are inside visible area of the toolbar.

GetToolCount(): Returns the number of tools in the toolbar.

GetToolDropDown(int): Returns whether the specified toolbar item has an associated drop down button.

GetToolDropDownMenu(int): Gets a menu used as this toolbar item drop-down.

GetToolDropDownOnEvent(int): Gets type of the event which shows a drop down menu associated with the toolbar item.

GetToolEnabled(int): Called to determine whether a tool is enabled (responds to user input).

GetToolFits(int): Gets whether the specified tool fits in the toolbar visible area.

GetToolIndex(int): Finds tool by its ID and returns tool index (position).

GetToolKind(int): Gets kind of the tool item.

GetToolLabel(int): Gets the specified toolbar item label text.

GetToolLongHelp(int): Returns the long help for the given tool.

GetToolMaxOfMinHeights(params int[]): Gets maximal value in minimal heights of the specified toolbar items.

GetToolMinHeight(int): Gets minimal height of the toolbar item.

GetToolMinHeights(params int[]): Gets minimal heights of the toolbar items.

GetToolMinSize(int): Gets minimal size of the toolbar item.

GetToolMinWidth(int): Gets minimal width of the toolbar item.

GetToolName(int): Gets name of the specified tool.

GetToolPopupLocation(int): Gets location of the popup window for the toolbar item.

GetToolProportion(int): Gets the specified toolbar item proportion.

GetToolRect(int): Returns the specified tool rectangle in the toolbar.

GetToolShortHelp(int): Returns the short help for the given tool.

GetToolSticky(int): Gets the specified toolbar item Sticky property value.

GetToolTag(int): Gets user data associated with the specified tool.

GetToolToggled(int): Returns whether a tool is on or off.

GrowToolMinSize(int, int, int): Sets new minimal size of the toolbar item if its greater than previous size.

GrowToolMinWidth(int, int): Sets new minimal width of the toolbar item if its greater than previous width.

LoadSvgImage(string, SizeD, Color?): Creates ImageSet and loads Svg data from the specified url.

LoadSvgImage(string, SizeI, Color?): Creates ImageSet and loads Svg data from the specified url.

LoadSvgImage(string, Control, Color?): Creates ImageSet and loads Svg data from the specified url.

OnBeginDrag(EventArgs): Called when the user begins toolbar dragging by the mouse.

OnOverflowClick(EventArgs): Called when the tool overflow button is clicked.

OnToolCommand(EventArgs): Called when the tool is clicked, after OnToolDropDown(EventArgs).

OnToolDropDown(EventArgs): Called when the tool is clicked.

OnToolMiddleClick(EventArgs): Called when the user begins toolbar dragging by the mouse.

OnToolRightClick(EventArgs): Called when the tool is clicked with right mouse button.

Realize(): This function should be called after you have added tools.

RemoveToolOnClick(int, EventHandler): Unregisters event handler which was called when tool is clicked.

SetMargins(int, int, int, int): Set the values to be used as margins for the toolbar.

SetToolBitmap(int, ImageSet?): Sets the specified toolbar item image.

SetToolDropDown(int, bool): Set whether the specified toolbar item has a drop down button.

SetToolDropDownMenu(int, ContextMenu): Sets a menu used as this toolbar item drop-down.

SetToolDropDownOnEvent(int, AuiToolbarItemDropDownOnEvent): Sets when a drop down menu associated with the toolbar item is shown.

SetToolLabel(int, string): Sets the specified toolbar item label text.

SetToolLongHelp(int, string): Sets the long help for the given tool.

SetToolMinSize(int, int, int): Sets new minimal size of the toolbar item.

SetToolMinWidth(int, int): Sets minimal width of the toolbar item.

SetToolName(int, string?): Sets name of the specified tool.

SetToolProportion(int, int): Sets the specified toolbar item proportion.

SetToolShortHelp(int, string): Sets the short help for the given tool.

SetToolSticky(int, bool): Sets the specified toolbar item Sticky property value.

SetToolTag(int, object?): Sets user data associated with the specified tool.

ShowDropDownMenu(int, ContextMenu): Shows context menu under the toolbar item.

ToggleTool(int, bool): Toggles a tool on or off.

Events

BeginDrag: Occurs when the user begins toolbar dragging by the mouse.

OverflowClick: Occurs when the tool overflow button is clicked.

ToolCommand: Occurs when the tool is clicked, after ToolDropDown.

ToolDropDown: Occurs when the tool is clicked.

ToolMiddleClick: Occurs when the tool is clicked with middle mouse button.

ToolRightClick: Occurs when the tool is clicked with right mouse button.