The ToolBarButton component is a toolbar button.
The component is implemented by the ToolBarButton class.
The example below shows a toolbar that houses buttons of different types: radio buttons, checkboxes, and a dropdown menu button.
The ToolBar.addItem method is used to add buttons on the toolbar. The IsToggle and GroupName properties determine if a button belongs to a group of checkboxes or radiobuttons. Button drop-down menu is defined in the Menu property.
A button may contain an icon. The following methods can be used to set an icon for the button:
In the ToolBar.ImageList property specify the set of icons and using the RowIndex and ColumnIndex properties set the coordinates of the required icon.
Use the ImageUrl property to specify path for the desired icon.
The Content property sets the button text.
Main event of a button is the toggle event.
Example of the ToolBarButton Component Layout
Example of Creating the Radio Buttons Group
Example of Creating Checkboxes
Example of Creating the Button with the Drop-down Menu
Constructor name | Brief description | |
ToolBarButton | The ToolBarButton constructor creates an instance of the ToolBarButton component. |
Property name | Brief description | |
ColumnIndex | The ColumnIndex property determines index of the column that will contain the icon. | |
GroupName | The GroupName property sets a name for a group of radio buttons. | |
ImageUrl | The ImageUrl property sets the path to button image. | |
IsChecked | The IsChecked property sets button state. | |
IsToggle | The IsToggle property determines whether the button is a checkbox. | |
Menu | The Menu property sets a child menu for a component. | |
Parent | The Parent property sets a parent element of component that is an instance of the ToolBar class. | |
RowIndex | The RowIndex property sets an index of the row that contains the icon. |
Method name | Brief description | |
getColumnIndex | The getColumnIndex method returns value of the ColumnIndex property. | |
getRowIndex | The getRowIndex method returns value of the RowIndex property. | |
refreshCorners | The refreshCorners method smoothes all edges of toolbar button. | |
setIsHovered | The setIsHovered method determines whether the mouse cursor is over the button. | |
setRoundedCorners | The setRoundedCorners method sets the edges smooth versions for the button. |
Event name | Brief description | |
StateChanged | The StateChanged event occurs when the button state is changed. |
Property name | Brief description | |
ColumnIndex | The ColumnIndex property determines index of a column with an icon selected from the image file implemented by the ImageList class. | |
EnableEdit | The EnableEdit property determines whether button contents can be edited. | |
ImageList | The ImageList property determines a file with images, from which a button icon is to be selected. | |
ImagePosition | The ImagePosition property determines the position of a button image. | |
ImageUrl | The ImageUrl determines the path to a button image. | |
IsPressed | The IsPressed property determines whether a button is pressed. | |
IsRetinaAvailable | The IsRetinaAvailable property determines whether it is possible to work on a device with the retina display. | |
IsToogleButton | The IsToogleButton property determines whether a button can be toggled (pressed or released). | |
Menu | The Menu property determines the component's child menu. | |
MenuArrowPosition | The MenuArrowPosition property sets an arrow position of the child menu component. | |
MenuDropPosition | The MenuDropPosition property sets a drop position of the child menu component. | |
RowIndex | The RowIndex property determines index of a row with an icon selected from the image file implemented by the ImageList class. | |
UseWrapping | The UseWrapping property wraps a text on two lines. |
NOTE. By default the UseWrapping property is set to True.
Method name | Brief description | |
hasImage | The hasImage method returns whether a button contains an image. | |
setIsHovered | The setIsHovered method determines whether the cursor is hovered over a button. |
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. |
NOTE. The Height property is irrelevant.
Method name | Brief description | |
The addClass method adds a CSS class to the component. | ||
addEventHandler | The addEventHandler method adds an event handler to a DOM node. | |
The addStateClass method adds a CSS class to the component and removes the previous CSS class. | ||
The addToNode method adds a component to the specified node. | ||
bindEvents | The bindEvents method subscribes an element to all available events. | |
The getAnchorFlags method returns JSON object that contains settings of the current component's position. | ||
The getClass method returns the current CSS classes of the component. | ||
The getCssStyle method returns style for the specified node. | ||
The getDomNode method returns main DOM node of the component. | ||
The getFocused method determines whether the component is focused. | ||
getIsBinded | The getIsBinded method returns whether an element is subscribed to all DOM node events. | |
The hide method hides a control. | ||
The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown. | ||
refreshStyle | The refreshStyle method refreshes element CSS styles. | |
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. | |
The removeStateClasses method removes CSS classes of the component. | ||
The setDraggable method determines whether a component can be dragged on the HTML page. | ||
The setFocus method sets the component focus. | ||
The setIsHovered method sets up component displaying only on mouseover. | ||
The setSize method establishes the sizes of the component. | ||
The show method displays a control. | ||
unBindEvents | The unBindEvents method unsubscribes an element from all standard events. | |
The updatePosition method updates size and position when absolute positioning based on the current parameters is used. | ||
The updateSize method updates the component size on changing the size of the container that contains the component. |
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. |
Property name | Brief description | |
The Id property determines a repository object identifier. |
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: