ToolBarButton

Description

The ToolBarButton component is a toolbar button.

Comments

The component is implemented by the ToolBarButton class.

Example

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

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

Properties

	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.

Methods

	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.

Events

	Event name	Brief description
	StateChanged	The StateChanged event occurs when the button state is changed.

Properties inherited from the Button class

	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.

Methods inherited from the Button class

	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.

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 sets animation parameters for component.
	Bottom	The Bottom property sets bottom offset on placing the component within the LayoutPanel.
	Content	The Content property sets the component contents.
	ContextMenu	The ContextMenu property sets the context menu for the component.
	Data	The Data property is used to store any custom data.
	DataContext	The DataContext property contains an object with data.
	Enabled	The Enabled property sets whether the component is enabled.
	Height	The Height property determines the component height.
	IsResizable	The IsResizable property determines whether the component can be resized.
	IsRTL	The lsRTL property sets right to left text direction.
	IsVisible	The IsVisible property determines whether the component is displayed.
	Left	The Left property sets left offset on placing the component within the GridPanel.
	Offset	The Offset property determines coordinates of root DOM node of a control.
	Opacity	The Opacity property determines component transparency.
	Parent	The Parent property determines a parent component of a control.
	ParentNode	The ParentNode property sets parent DOM node.
	ResourceKey	The ResourceKey property sets the resource key for the component.
	Right	The Right property sets right offset on placing the component within the LayoutPanel.
	Rotate	The Rotate property sets component rotation angle.
	ShowToolTip	The ShowToolTip property determines whether the tooltip of the component can be displayed.
	Style	The Style property sets component style.
	TabIndex	The TabIndex property sets the order of the control element passing inside the container.
	Tag	The Tag property sets JSON object associated with the component.
	ToolTip	The ToolTip property determines text of component tooltip.
	Top	The Top property sets top offset on placing the component within the GridPanel.
	Value	The Value property sets the value to the component.
	Width	The Width property sets the component width.

NOTE. The Height property is irrelevant.

Methods inherited from the Control class

	Method name	Brief description
	addClass	The addClass method adds a CSS class to the component.
	addEvent	The addEvent method adds an event handler to a DOM node.
	addEventHandler	The addEventHandler method adds an event handler to a DOM node.
	addEvents	The addEvents method adds an array of event handlers to a DOM node.
	addStateClass	The addStateClass method adds a CSS class to the component and removes the previous CSS class.
	addStyleBySelector	The addStyleBySelector method creates a block that contains a style with the specified CSS selector.
	addToNode	The addToNode method adds a component to the specified node.
	bindEvents	The bindEvents method subscribes an element to all available events.
	clearStylesCache	The clearStylesCache method clears cache of component styles.
	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.
	getFunctionByName	The getFunctionByName method returns function by name.
	getIsBinded	The getIsBinded method returns whether an element is subscribed to all DOM node events.
	hasClass	The hasClass method determines whether the specified CSS class is set for root DOM node of the control.
	hide	The hide method hides a control.
	hideToolTip	The hideToolTip method clears tooltip timeout and hides the tooltip if it is displayed.
	isResingNow	The isResingNow method determines whether the component is being resized.
	refreshBindingProperty	The refreshBindingProperty method refreshes the bound property by name.
	refreshItemsStyle	The refreshItemsStyle method refreshes CSS styles of child elements.
	refreshStyle	The refreshStyle method refreshes element CSS styles.
	removeClass	The removeClass method removes CSS class from the component.
	removeEvent	The removeEvent method removes event handler from DOM node.
	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 it is possible to drag component on the HTML page.
	setFocus	The setFocus method sets the component focus.
	setIsHovered	The setIsHovered method displays the component as on hover.
	setIsPressed	The setIsPressed method displays the component as if clicked upon.
	setOpacityIE8	The setOpacityIE8 method sets component transparency value in Internet Explorer 8.
	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 left 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
	Data	The Data property associates a random object with this component.
	Id	The Id property sets component identifier.
	Settings	The Settings property sets the component parameters.

Methods inherited from the class Object

	Method name	Brief description
	clone	The clone method creates a copy of object. It is not implemented in PP.Ui.Control.
	dispose	The dispose method deletes the component.
	getTypeName	The getTypeName method returns the name of the object type without the namespace, to which it belongs.

See also:

DHTML Components