Skip to content

Interface: ISectionedTableProxy

A designer-facing interface that provides access to a sectioned table

It is passed to rules to provide access to a section for application specific customizations.

Hierarchy

Implemented by

Summary

Properties

Class Properties

Inherited Properties

Methods

Class Methods

Inherited Methods

Properties

filters

filters: FilterCriteria[]

Get or set the current filters for this Sectioned Table. Modifying this property will cause the filters to be applied on the Sectioned Table.


searchString

searchString: string

Get or set the user provided search string for this section table. Modifying this property will cause the search field's value to change and the search functionality will be executed. It does not do anything if the search is not enabled for any of the UI controls in the SectionedTable.


sections

sections: ISectionProxy[]

Methods

dataQueryBuilder

dataQueryBuilder(query: string): DataQueryBuilder

Factory method to construct an instance of DataQueryBuilder

Parameters:

Name Type
query string

Returns: DataQueryBuilder


getControl

getControl(name: string): IControlProxy

Gets the associated control by name. This searches controls in FormCell sections.

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 all FormCell sections for this section table

Returns: IControlProxy[]

The controls for this container


getFilterActionResult

getFilterActionResult(): string

This method returns filter query string of the FilterCriteria for the section table

Returns: string

Resolved OData $filter query string of the FilterCriteria for the section table


getSection

getSection(name: string): ISectionProxy

Gets the associated section by name. This searches section in SectionedTable.

Parameters:

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

Returns: ISectionProxy

The section assocated with the name parameter


getSections

getSections(): ISectionProxy[]

Get all of the sections that the table contains.

Returns: ISectionProxy[]


getSorterActionResult

getSorterActionResult(): string

This method returns sorter query string of the FilterCriteria for the section table

Returns: string

Resolved OData $orderby query string of the FilterCriteria for the section table