Class: SectionedTableProxy¶
SectionedTableProxy is a developer-facing class that provides access to a sectioned table and its sections for application specific customizations.
Hierarchy¶
-
SectionedTableProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Accessors¶
Class Accessors¶
Inherited Accessors¶
Methods¶
Class Methods¶
- dataQueryBuilder
- getControl
- getControls
- getFilterActionResult
- getSection
- getSections
- getSorterActionResult
- isContainer
Inherited Methods¶
- _clientAPIProps
- _getExecuteSource
- applyValidation
- base64StringToBinary
- binaryToBase64String
- callFunction
- clearValidation
- clearValidationOnValueChange
- convertFilterCriteriaArrayToJSONString
- convertJSONStringToFilterCriteriaArray
- count
- create
- createFilterCriteria
- createFilterSelection
- createLinkSpecifierProxy
- createSorterSelection
- deleteODataCacheImages
- dismissActivityIndicator
- downloadInProgressForPage
- downloadInProgressForReadLink
- evaluateTargetPath
- evaluateTargetPathForAPI
- executeAction
- formatBase64String
- formatCurrency
- formatDate
- formatDatetime
- formatNumber
- formatPercentage
- formatScientific
- formatTime
- getActionResult
- getAppClientData
- getAppearanceMode
- getAppEventData
- getAppName
- getAvailableThemes
- getBindingObject
- getCaption
- getCircularImage
- getClientData
- getDefinitionValue
- getEventData
- getGlobalDefinition
- getGlobalSideDrawerControlProxy
- getIconTextImage
- getLanguage
- getLogger
- getMobileServiceAppId
- getMobileServiceEndpointUrl
- getName
- getODataCacheImagePath
- getODataProvider
- getPageDefinition
- getPageProxy
- getParent
- getPasscodeSource
- getPendingDownload
- getReadLink
- getRegion
- getRegions
- getSAPPassportHeaderValue
- getSupportedLanguages
- getTheme
- getType
- getUseInAppCamera
- getValue
- getVersionInfo
- initializeLogger
- isAppInMultiUserMode
- isContainer
- isCurrentPage
- isDemoMode
- isDeviceCompliant
- isMediaLocal
- localizeText
- read
- redraw
- sendMobileServiceRequest
- sendRequest
- setApplicationIconBadgeNumber
- setDebugSettings
- setEditable
- setLanguage
- setMdkWindows
- setRegion
- setStyle
- setTheme
- setUseInAppCamera
- setValidationProperty
- setValue
- setVisible
- showActivityIndicator
- updateProgressBanner
Constructors¶
Constructor¶
+ new SectionedTableProxy(context: IContext): SectionedTableProxy
Overrides ControlProxy.constructor
Parameters:
| Name | Type |
|---|---|
| context | IContext |
Returns: SectionedTableProxy
Accessors¶
filters¶
Get Signature¶
▸ getter
Get the current filters for this Sectioned Table
Returns¶
Set Signature¶
▸ setter
Set and apply the filters for this Sectioned Table
Parameters¶
filterCriteria¶
Returns¶
void
Get or set the current filters for this Sectioned Table. Modifying this property will cause the filters to be applied on the Sectioned Table.
Implementation of ISectionedTableProxy.filters
searchString¶
Get Signature¶
▸ getter
Get the user provided search string for this section table
Returns¶
string
Set Signature¶
▸ setter
Set the user provided search string for this section table. Not supported on Web
Parameters¶
searchText¶
string
Returns¶
void
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.
Implementation of ISectionedTableProxy.searchString
sections¶
Get Signature¶
▸ getter
Get the list of sections in the SectionedTable
Returns¶
Implementation of ISectionedTableProxy.sections
Methods¶
dataQueryBuilder¶
▸ dataQueryBuilder(query?: string = undefined): DataQueryBuilder
Factory method to construct an instance of DataQueryBuilder
Implementation of ISectionedTableProxy.dataQueryBuilder
Parameters:
| Name | Type | Description |
|---|---|---|
| query? | string = undefined | the query string |
Returns: DataQueryBuilder
getControl¶
▸ getControl(name: string): IControlProxy
Find a FormCell control based on the name. It returns FormCell controls in SectionedTable.
Implementation of ISectionedTableProxy.getControl
Parameters:
| Name | Type | Description |
|---|---|---|
| name | string | the name of the control to match |
Returns: IControlProxy
FormCellControlProxy instance or undefined if not found
getControls¶
▸ getControls(): IControlProxy[]
Get the list of FormCell controls if there is any FormCell Section in SectionedTable
Implementation of ISectionedTableProxy.getControls
Returns: IControlProxy[]
getFilterActionResult¶
▸ getFilterActionResult(): string
This method returns filter query string of the FilterCriteria for the section table
Implementation of ISectionedTableProxy.getFilterActionResult
Returns: string
Resolved OData $filter query string of the FilterCriteria for the section table
getSection¶
▸ getSection(name: string): ISectionProxy
Get the section based on the name
Implementation of ISectionedTableProxy.getSection
Parameters:
| Name | Type | Description |
|---|---|---|
| name | string | the name of the section to match |
Returns: ISectionProxy
getSections¶
▸ getSections(): ISectionProxy[]
Get the list of sections in the SectionedTable
Implementation of ISectionedTableProxy.getSections
Returns: ISectionProxy[]
getSorterActionResult¶
▸ getSorterActionResult(): string
This method returns sorter query string of the FilterCriteria for the section table
Implementation of ISectionedTableProxy.getSorterActionResult
Returns: string
Resolved OData $orderby query string of the FilterCriteria for the section table
isContainer¶
▸ isContainer(): boolean
Determine if the SectionedTable is a container.
Implementation of ISectionedTableProxy.isContainer Overrides ControlProxy.isContainer
Returns: boolean
true/false. It always returns true for SectionedTable.