Intersoft WebDesktop Documentation
WebToolBar
Send Feedback
Intersoft WebDesktop > Client-side References > WebToolBar

Glossary Item Box

 WebToolBar Properties

ClassName Description
Gets the object class name.

ValueType
String

Default Value
WebToolBar
Caption Description
Specifies the bar caption.

ValueType
String

Default Value
null
Commands Description
Gets the collection of tool commands in this webtoolbar.

ValueType
ISArray object

Default Value
array
Display Description
Gets a value that indicates whether a WebToolBar control is displayed as UI on the page.

ValueType
Boolean

Default Value
True
MergeToolBar Description
Gets a value that indicates whether a WebToolBar control is a merge webtoolbar.

ValueType
Boolean

Default Value
False
CommandClientSideEvents Description
Specifies the client side (JavaScript) tool command events.

ValueType
CommandClientEvents object

Default Value
null
SizeMode Description
Gets the tool command sizing mode.

ValueType
String

Default Value
Automatic
AllowMove Description
Gets or sets a value that indicates whether a WebToolBar control is moveable.

ValueType
String

Default Value
Default
AllowCustomize Description
Gets a value that indicates whether a WebToolBar control is customizeable.

ValueType
String

Default Value
Default
AllowDockBottom Description
Gets or sets a value that indicates whether a WebToolBar control can be dock to bottom area of PlaceHolderManager.

ValueType
String

Default Value
Default
AllowDockLeft Description
Gets or sets a value that indicates whether a WebToolBar control can be dock to left area of PlaceHolderManager.

ValueType
String

Default Value
Default
AllowDockRight Description
Gets or sets a value that indicates whether a WebToolBar control can be dock to right area of PlaceHolderManager.

ValueType
String

Default Value
Default
AllowDockTop Description
Gets or sets a value that indicates whether a WebToolBar control can be dock to top area of PlaceHolderManager.

ValueType
String

Default Value
Default
AllowExpandCollapse Description
Gets or sets a value that indicates whether a WebToolBar control is expandable and collapseable.

ValueType
String

Default Value
Default
AllowFloat Description
Gets or sets a value that indicates whether a WebToolBar control is floatable.

ValueType
String

Default Value
Default
DockingArea Description
Gets the WebToolBar docking area.

ValueType
String

Default Value
NotSet
DockingOffset Description
Gets the WebToolBar docking offset.

ValueType
Number

Default Value
0
DockingRow Description
Gets the WebToolBar docking row.

ValueType
Number

Default Value
0
FillDockingRow Description
Gets a value that indicates whether a WebToolBar control dimension fills the row region of PlaceHolderManager docking row.

ValueType
String

Default Value
Yes
ToggleGroups Description
Gets the collection of toggle group commands in this webtoolbar.

ValueType
ISArray object

Default Value
array
HandleStyle Description
Gets or sets the style properties of handle bar section in the bar control.

ValueType
BarSectionStyle object

Default Value
object
BodyStyle Description
Gets or sets the style properties of body bar section in the bar control.

ValueType
BarSectionStyle object

Default Value
object
OptionStyle Description
Gets or sets the style properties of option bar section in the bar control.

ValueType
BarSectionStyle object

Default Value
object
CommandStyle Description
Gets or sets the style properties of command in the bar control.

ValueType
DynamicStyle object

Default Value
object
SeparatorStyle Description
Gets or sets the style properties of separator command in the bar control.

ValueType
String

Default Value
Empty string
ShowDelay Description
Gets or sets the amount of submenu show delay in miliseconds.

ValueType
Number

Default Value
500
MenuStyleSettings Description
Gets or sets the style properties of menu styles in the bar control.

ValueType
WebMenuStyles object

Default Value
object
CommandSize Description
Specifies the ToolCommand size.

ValueType
String

Default Value
50px
ToolTip Description
Specifies the WebToolBar tooltip.

ValueType
String

Default Value
Empty string
TextAlign Description
Specifies the ToolCommand text align type.

ValueType
String

Default Value
Default
DisplayMode Description
Specifies the ToolCommand display mode.

ValueType
String

Default Value
Default

 WebToolBar Methods

UnregisterAccessKeys Description
Unregisters access keys from command items.

Parameters

Remarks

Return Value
void

Samples



RegisterAccessKeys Description
Registers access keys for command items.

Parameters

Remarks

Return Value
void

Samples



GetOrientation Description
Gets WebToolBar orientation

Parameters

Remarks

Return Value
String. Horizontal or Vertical

Samples



SetCaption Description
Sets WebToolBar caption

Parameters
caption ( String )
WebToolBar caption paramater
null

Remarks

Return Value
void

Samples



SetDisplayToolTip Description
Sets WebToolBar DisplayToolTip

Parameters
val ( String )
no default

Remarks

Return Value
void

Samples



SetAllowMove Description
Sets WebToolBar AllowMove

Parameters
val ( String )
no default

Remarks

Return Value
void

Samples



SetToolTip Description
Sets WebToolBar ToolTip

Parameters
tooltips ( String )
no default

Remarks

Return Value
void

Samples



SetDisplay Description
Sets WebToolBar Display

Parameters
val ( Boolean )
no default

Remarks

Return Value
void

Samples



SetIsFloat Description
Sets WebToolBar floating dock behavior.

Parameters
val ( String )
No default (required)

Remarks

Return Value

Samples



ShowCommand Description
Show WebToolBar command

Parameters
cmd ( ToolCommand object )
no default
updateContainerDimension ( Boolean )
Update container (WebToolBar) dimension when Command is showed.
False

Remarks

Return Value
void

Samples



HideCommand Description
Hide WebToolBar command

Parameters
cmd ( ToolCommand object )
no default
updateContainerDimension ( Boolean )
Update container (WebToolBar) dimension when Command is hided.
False

Remarks

Return Value
void

Samples



AddCommand Description
Add Command to existing ToolCommandCollection

Parameters
cmd ( ToolCommand object )
no default
idx ( Number )
Last collection index

Remarks

Return Value
void

Samples



RemoveCommand Description
Remove Command from ToolCommandCollection

Parameters
cmd ( ToolCommand object )
no default

Remarks

Return Value
void

Samples



EnableCommand Description
Enabling group of Commands

Parameters
c ( ToolCommand or Array of ToolCommands )
no default

Remarks

Return Value
void

Samples



DisableCommand Description
Disabling group of Commands

Parameters
c ( ToolCommand or Array of ToolCommands )
no default

Remarks

Return Value
void

Samples



UpdateUI Description
Apply immediately all UI changes.

Parameters
updateContainerDimension ( Boolean )
Update container (WebToolBar) dimension.
False

Remarks

Return Value
void

Samples



ResetUsageData Description
Reset ToolCommands setting to original setting.

Parameters

Remarks

Return Value
void

Samples



© 2012 Intersoft Solutions Corp. All Rights Reserved.