NavButtonPad

UI element class: LSRetail.NAV.POSControls.ButtonPad

Extends ManagedObject

Extends SeSSimulatedObject

Behavior Pattern: POSControlsButtonPadBehavior

Property Summary

Property Description Getter Setter
ButtonCaption Caption of a button with specified index GetButtonCaption
ColumnCount Number of columns on a page GetColumnCount
FullInfo JSON-formatted info for all buttons GetFullInfo
FullText TAB-separated table with button captions GetFullText
PageCount Number of pages GetPageCount
RowCount Number of rows on a page GetRowCount
ToggleState ToggleState of the button GetToggleState

Action Summary

Action Description
DoClick Click button by caption or no (1-based index)

Property Detail

ButtonCaption

Caption of a button with specified index

Getter Parameters:

Name Type Description
textOrId string | number button 'no' (1-based index)

Type: string

Accessors: GetButtonCaption

ColumnCount

Number of columns on a page

Type: number

Accessors: GetColumnCount

FullInfo

JSON-formatted info for all buttons

Type: string

Accessors: GetFullInfo

FullText

TAB-separated table with button captions

Type: string

Accessors: GetFullText

PageCount

Number of pages

Type: number

Accessors: GetPageCount

RowCount

Number of rows on a page

Type: number

Accessors: GetRowCount

ToggleState

ToggleState of the button

Getter Parameters:

Name Type Description
textOrId string | number caption or 'no' (1-based index)

Type: boolean

Accessors: GetToggleState

Action Detail

DoClick(textOrId, timeout)

Click button by caption or no (1-based index)

Parameters:

Name Type Description
textOrId string | number caption or 'no' (1-based index)
timeout number number of milliseconds to wait for a button to appear
Optional, Default: 5000.

Returns:

boolean: 'true' if success, 'false' otherwise.