Skip to content

Interface: ISectionProxy

Hierarchy

  • ISectionProxy

Implemented by

Summary

Properties

Methods

Properties

searchString

searchString: string

Returns the user provided search string for this section

Methods

getControl

getControl(name: string): IControlProxy

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[]

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

Returns: IControlProxy[]

The controls for this container


getExtensions

getExtensions(): IView[]

Returns the extensions the section is using.

Returns: IView[]


getName

getName(): string

The section name

Returns: string


getPageProxy

getPageProxy(): IPageProxy

Get the PageClientAPI associated with this section.

Returns: IPageProxy


getProperty

getProperty(): string

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

Returns: string


getType

getType(): string

The section type

Returns: string


isStaticSection

isStaticSection(): boolean

The bound object type, if true binding object is definition

Returns: boolean


setIndicatorState

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

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