Skip to content

Interface: ISelectableSectionProxy

Hierarchy

Implemented by

Summary

Properties

Methods

Properties

dataSubscriptions

dataSubscriptions: string[]

Inherited from ISectionProxy.dataSubscriptions

Get or set the dataSubscriptions property for this section. The dataSubScriptions array contains entitySets names or services names


searchString

searchString: string

Inherited from ISectionProxy.searchString

Get the searchString property for this section.

Methods

getControl

getControl(name: string): IControlProxy

Inherited from ISectionProxy.getControl

Gets the associated control by name. This searches controls in this section if it is a FormCell section.

Parameters:

Name Type Description
name string The control name specified by the _Name definition property.

Returns: IControlProxy

The control assocated with the name parameter


getControls

getControls(): IControlProxy[]

Inherited from ISectionProxy.getControls

This method returns the controls in this section if it is FormCell section

Returns: IControlProxy[]

The controls for this container


getExtensions

getExtensions(): IView[]

Inherited from ISectionProxy.getExtensions

Returns the extensions the section is using.

Returns: IView[]


getName

getName(): string

Inherited from ISectionProxy.getName

Get the section name

Returns: string


getPageProxy

getPageProxy(): IPageProxy

Inherited from ISectionProxy.getPageProxy

Get the PageClientAPI associated with this section.

Returns: IPageProxy


getProperty

getProperty(): string

Inherited from ISectionProxy.getProperty

Get the property name being bound, one of the property names in a section definition

Returns: string


getSelectedItems

getSelectedItems(): [SelectedItem]

Get the current section selected items when selection mode is active. Otherwise an empty array will be returned.

Returns: [SelectedItem]


getSelectionChangedItem

getSelectionChangedItem(): ChangedItem

Get the last selected or deselected item.

Returns: ChangedItem


getSelectionMode

getSelectionMode(): string

Get selection mode for the current section. The return value is None or Multiple

Returns: string


getTargetSpecifier

getTargetSpecifier(): ITargetProxy

Inherited from IBindableSectionProxy.getTargetSpecifier

Gets the target specifier

Returns: ITargetProxy


getType

getType(): string

Inherited from ISectionProxy.getType

Get the section type

Returns: string


getVisible

getVisible(): boolean

Inherited from ISectionProxy.getVisible

Get the section visible property

Returns: boolean


isStaticSection

isStaticSection(): boolean

Inherited from ISectionProxy.isStaticSection

The bound object type, if true binding object is definition

Returns: boolean


redraw

redraw(): Promise‹any›

Inherited from ISectionProxy.redraw

Redraw the section

Returns: Promise‹any›


setIndicatorState

setIndicatorState(newState: string, pressedItem: PressedItem): any

Inherited from ISectionProxy.setIndicatorState

Sets the interacte object cell indicator's state in the section

Parameters:

Name Type Description
newState string the new state of the indicator (possible values: toDownload, inProgress, open)
pressedItem PressedItem the pressed object cell in the section

Returns: any


setSelectionMode

setSelectionMode(mode: string): any

Set the section selection mode

Parameters:

Name Type
mode string

Returns: any


setTargetSpecifier

setTargetSpecifier(target: ITargetProxy, redraw?: boolean): Promise‹any›

Inherited from IBindableSectionProxy.setTargetSpecifier

Sets the target specifier and redraws the formcell

throws {Error} if target is incomplete

Parameters:

Name Type Description
target ITargetProxy -
redraw? boolean whether to redraw formcell

Returns: Promise‹any›


setVisible

setVisible(value: boolean, redraw?: boolean): Promise‹any›

Inherited from ISectionProxy.setVisible

Sets the section's visible state with / without redraw

Parameters:

Name Type Description
value boolean visible state
redraw? boolean whether redraw after setting the visible state, the default value is true.

Returns: Promise‹any›