ToolBar

Description

The ToolBar component is a toolbar. The toolbar houses buttons (instances of the ToolBarButton class) and separators (instances of the ToolBarSeparator class).

Comments

The component is implemented by the ToolBar class.

Example

The component looks as follows:

The toolbar includes a group of radio buttons, a group of checkboxes and a combo-box. A line separator divides the checkbox group and the menu button.

Example of Creating the ToolBar Component

Constructor

  Constructor name Brief description
ToolBar The ToolBar constructor creates an instance of the ToolBar component.

Properties

  Property name Brief description
AutoFit The IsSplitGroups property determines whether there is a split between group elements on the toolbar.
ImageList The ImageList property returns an instance of the ImageList non-visual component.
IsSplitGroups The IsSplitGroups property determines whether elements are split within the group on the toolbar.
Items The Items property contains an array of toolbar elements.
Orientation The Orientation property determines orientation of the ToolBar component.
ShowOverflowButton The ShowOverflowButton property determines whether there is a menu button with hidden elements.

Methods

  Method name Brief description
addItem The addItem method adds a new child element to the toolbar.
beginUpdate The beginUpdate method disables rerendering of toolbar until the endUpdate method is called.
endUpdate The endUpdate method enables toolbar rerendering and refreshes it.
getImageList The getImageList method returns value of the ImageList property.
getItem The getItem method returns a child element of the toolbar by the specified index.
getItemById The getItemById method returns a child element of the toolbar by the specified identifier.
getItemsByGroupName The getItemsByGroupName method returns the list of panel controls by the specified group name.
insertItem The insertItem method inserts a new toolbar element to the specified position.
refreshGroup The refreshGroup method refreshes a group by name.
refreshGroups The refreshGroups method refreshes all toolbar groups.
refreshItemsVisibility The refreshItemsVisibility method refreshes visibility of toolbar elements.
removeItem The removeItem method removes the child element of the toolbar.
removeItemById The removeItemById method removes a child element by the specified identifier.
removeItemByIndex The removeItemByIndex method removes a toolbar child by the specified index.
removeItems The removeItems method removes all child elements of the toolbar.

Properties inherited from the Control class

  Property name Brief description
Anchors The Anchors property determines position of the component placed within container.
Animation The Animation property determines component animation parameters.
Bottom The Bottom property determines a bottom margin if a component is placed inside LayoutPanel.
Content The Content property determines component contents.
ContextMenu The ContextMenu property determines a component's context menu.
Data The Data property is used to store any custom data.
Enabled The Enabled property determines whether a component can be used.
Height The Height property determines component height.
IsRTL The IsRTL property determines whether component elements are aligned to the right.
IsVisible The IsVisible property determines whether a component is displayed.
Left The Left property determines a left margin if a component is placed inside GridPanel.
Opacity The Opacity property determines component transparency.
Parent The Parent property determines a parent component of a control.
ParentNode The ParentNode property determines a parent DOM node.
ResourceKey The ResourceKey property determines a component resource key.
Right The Right property determines a right margin if a component is placed inside LayoutPanel.
Rotate The Rotate property determines a component rotation angle.
ShowToolTip The ShowToolTip property determines whether a tooltip of the component can be displayed.
Style The Style property determines a component style.
TabIndex The TabIndex property determines the order of the control element passing inside the container.
Tag The Tag property determines a JSON object associated with the component.
ToolTip The ToolTip property determines text of component tooltip.
Top The Top property determines a top margin if a component is placed inside GridPanel.
Value The Value property determines a component value.
Width The Width property determines component width.

Methods inherited from the Control class

  Method name Brief description

addClass

The addClass method adds a CSS class to the component.
addEventHandler The addEventHandler method adds an event handler to a DOM node.

addStateClass

The addStateClass method adds a CSS class to the component and removes the previous CSS class.

addToNode

The addToNode method adds a component to the specified node.
bindEvents The bindEvents method subscribes an element to all available events.

getAnchorFlags

The getAnchorFlags method returns JSON object that contains settings of the current component's position.

getClass

The getClass method returns the current CSS classes of the component.

getCssStyle

The getCssStyle method returns style for the specified node.

getDomNode

The getDomNode method returns main DOM node of the component.

getFocused

The getFocused method determines whether the component is focused.
getIsBinded The getIsBinded method returns whether an element is subscribed to all DOM node events.

hide

The hide method hides a control.

hideToolTip

The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown.
refreshStyle The refreshStyle method refreshes element CSS styles.

removeClass

The removeClass method removes CSS class from the component.
removeEventHandler The removeEventHandler method removes event handler from DOM node.
removeFromDOM The removeFromDOM method removes node from the DOM structure.

removeStateClasses

The removeStateClasses method removes CSS classes of the component.

setDraggable

The setDraggable method determines whether a component can be dragged on the HTML page.

setFocus

The setFocus method sets the component focus.

setIsHovered

The setIsHovered method sets up component displaying only on mouseover.

setSize

The setSize method establishes the sizes of the component.

show

The show method displays a control.
unBindEvents The unBindEvents method unsubscribes an element from all standard events.

updatePosition

The updatePosition method updates size and position when absolute positioning based on the current parameters is used.

updateSize

The updateSize method updates the component size on changing the size of the container that contains the component.

Events inherited from the Control class

  Event name Brief description
Drag The Drag event occurs on clicking and holding the mouse button.
DragEnd The DragEnd event occurs when dragging the component finishes.
DragStart The DragStart event occurs when dragging the component starts.
OnContextMenu The OnContextMenu event occurs on calling context menu of the component.
SizeChanged The SizeChanged event occurs after the component is resized.
SizeChanging The SizeChanging event occurs during component resize.

Properties inherited from the class Object

  Property name Brief description

Id

The Id property determines a repository object identifier.

Methods inherited from the class Object

  Method name Brief description
clone The clone method creates an object copy.
dispose The dispose method deletes the component.
getHashCode The getHashCode method returns hash code of repository object.
getId The getId method returns repository object identifier.
getSettings The getSettings method returns repository object settings.
getTypeName The getTypeName method returns the name of the object type without the namespace, to which it belongs.
isEqual The isEqual method determines whether the specified object is equal to the current repository object.
isLive The isLive method determines validity of repository object.
removeAllEvents The removeAllEvents method removes all object event handlers by the specified context.
setId The setId method determines a repository object identifier.
setSettings The setSettings method determines repository object settings.
defineProps The defineProps method creates get and set methods from name array for the specified class.
keys The keys method returns array of methods and properties names for the specified object.

See also:

DHTML Components