MSComCtlToolbar¶
Microsoft Windows Toolbar Control
Extends ActiveXObject
Extends SeSSimulatedObject
Behavior Pattern: MSComCtlToolbarBehavior
Property Summary¶
| Property | Description | Getter | Setter |
|---|---|---|---|
| ItemCaption | The caption of the button on the toolbar | GetItemCaption | |
| ItemCount | The number of the items in the toolbar | GetItemCount | |
| ItemStyle | The style of the button on the toolbar | GetItemStyle | |
| ItemValue | Returns 'true' if element with nameCaptionIndex has value | GetItemValue |
Action Summary¶
| Action | Description |
|---|---|
| DoClickItem | ClickItem |
| DoSetCheck | SetCheck |
Property Detail¶
ItemCaption¶
The caption of the button on the toolbar
Getter Parameters:
| Name | Type | Description |
|---|---|---|
| nameCaptionIndex | number | string | Index, name or caption of the item. |
Type: string
Accessors: GetItemCaption
value = SeS('SomeMSComCtlToolbar').GetItemCaption(/**number|string*/ nameCaptionIndex)
ItemCount¶
The number of the items in the toolbar
Type: number
Accessors: GetItemCount
value = SeS('SomeMSComCtlToolbar').GetItemCount()
ItemStyle¶
The style of the button on the toolbar
Getter Parameters:
| Name | Type | Description |
|---|---|---|
| nameCaptionIndex | number | string | Index, name or caption of the item. |
Type: number
Accessors: GetItemStyle
value = SeS('SomeMSComCtlToolbar').GetItemStyle(/**number|string*/ nameCaptionIndex)
ItemValue¶
Returns 'true' if element with nameCaptionIndex has value
Getter Parameters:
| Name | Type | Description |
|---|---|---|
| nameCaptionIndex | number | string | Index, name or caption of the item. |
Type: boolean
Accessors: GetItemValue
value = SeS('SomeMSComCtlToolbar').GetItemValue(/**number|string*/ nameCaptionIndex)
Action Detail¶
DoClickItem¶
ClickItem
SeS('SomeMSComCtlToolbar').DoClickItem(nameCaptionIndex, clickType, xOffset, yOffset)
Parameters:
| Name | Type | Description |
|---|---|---|
| nameCaptionIndex | string | number | index, name or caption of the item to be selected. |
| clickType | string | Type of click, can be one of "L" - left click, "LD" - double left click, "R" - right click, "RD" - double right click, "M" - middle click, "MD" - double middle click, "N" - don't click Possible values: "L", "LD", "R", "RD", "M", "MD", "N" Optional, Default: "L". |
| xOffset | number | X offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width. Optional. |
| yOffset | number | Y offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the height. Optional. |
Returns:
boolean: 'true' if success, 'false' otherwise.
DoSetCheck¶
SetCheck
SeS('SomeMSComCtlToolbar').DoSetCheck(bcheck, nameCaptionIndex)
Parameters:
| Name | Type | Description |
|---|---|---|
| bcheck | boolean | Check state to set |
| nameCaptionIndex | string | number | index, name or caption of the item to be selected. |
Returns:
boolean: 'true' if success, 'false' otherwise.