Skip to content

Interface: IPageProxy

ClientAPI used if the current context is a page.

Hierarchy

Implemented by

Summary

Properties

Class Properties

Inherited Properties

Methods

Class Methods

Inherited Methods

Properties

Methods

executeCustomEvent

executeCustomEvent(eventType: string, eventData: any): any

Executes rule specified as page level custom event.

Parameters:

Name Type Description
eventType string can be used to describe the current event.
eventData any Data that is passed to the associated rule.

Returns: any


getActionBinding

getActionBinding(): any

Set the binding that is being used by the current action

Returns: any


getExecutedContextMenuItem

getExecutedContextMenuItem(): ContextItem

return the most recently swipe item on this page.

Returns: ContextItem


getGlobalSideDrawerControlProxy

getGlobalSideDrawerControlProxy(): ISideDrawerControlProxy

Get the global side drawer control proxy

Returns: ISideDrawerControlProxy


getMissingRequiredControls

getMissingRequiredControls(): Object[]

After running a CheckRequiredFields action, this method is to return a list of any controls whose value were found to be missing when required.

Returns: Object[]


getPageProxy

getPageProxy(): IPageProxy

Returns: IPageProxy

the Page self


getPressedItem

getPressedItem(): PressedItem

return the control, toolbar item or action bar item that was most recently pressed on this page.

Returns: PressedItem


getToolbar

getToolbar(): IToolbarProxy

Returns: IToolbarProxy

return the ToolbarProxy instance of the associated toolbar of that page


redraw

redraw(): any

Redraw the page

Returns: any


setActionBarItemVisible

setActionBarItemVisible(item: any, visibleFlag: boolean): any

Set specified actionBar item on page to visible/hidden

Parameters:

Name Type Description
item any either an number or a string the number is the position of the item.(zero based, first item on actionBar is 0 and second is 1 etc.) the string is the _Name parameter of the action item
visibleFlag boolean if true set item to visible else hidden.

Returns: any


setActionBinding

setActionBinding(binding: Object): any

Set the binding to be used by the current action. For example, a navigation would set this to pass on the binding for the next page which is navigated to.

Parameters:

Name Type
binding Object

Returns: any


setCaption

setCaption(caption: string): any

Parameters:

Name Type Description
caption string new caption value

Returns: any


setStyle

setStyle(styleClass: string, subControl: string): any

Apply styles to a control

Parameters:

Name Type Description
styleClass string The name of the style class to be applied
subControl string The name of the control to apply the style to. It could be either 'ActionBar' or 'ToolBar'. If this is '', the style is applied to the entire page.

Returns: any

this for chaining

See Styles/ docs for details.


setToolbarItemCaption

setToolbarItemCaption(toolbarItemName: string, newCaption: string): Promise‹any›

Asynchronously apply a new caption to a toolbar item on page

Parameters:

Name Type Description
toolbarItemName string the name of the item to modify caption
newCaption string the new caption

Returns: Promise‹any›