column
Applies when
type supports COLUMNS| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
columnName | string | Yes | data type=string; maxLen=128 | |
show | boolean | Yes | true | data type=boolean |
source
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
dataType | string | Yes | data type=string; maxLen=255 |
source {
dataType: value
}heading
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
heading | string | No | data type=string; maxLen=4000Applies when type supports COLUMN_HEADING and show = true | |
alignment | enum | Yes | start | data type=string; lov=STATICValid values: start center endApplies when type supports HEADING_ALIGNMENT and show = true |
heading {
heading: value
alignment: start
}layout
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
sequence | number | Yes | data type=number; maxLen=22 | |
columnAlignment | enum | Yes | start | data type=string; lov=STATICValid values: start center endApplies when type supports VALUE_ALIGNMENT and show = true |
layout {
sequence: 42
columnAlignment: start
}appearance
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
formatMask | string | No | data type=string; maxLen=255Applies when dataType in (DATE)dataType in (TIMESTAMP)dataType in (TIMESTAMP_TZ)dataType in (TIMESTAMP_LTZ) | |
formatMask | string | No | data type=string; maxLen=255Applies when dataType = NUMBER | |
cssClasses | array of strings | No | data type=string; maxLen=255Applies when type supports VALUE_CSS and show = true |
appearance {
formatMask: value
cssClasses: [
value
value
]
}advanced
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
customAttributes | string | No | data type=string; maxLen=2000Applies when type supports VALUE_ATTRIBUTE and show = true |
advanced {
customAttributes: value
}serverSideCondition
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
type | enum | No | data type=string; lov=STATICValid values: always rowsReturned noRowsReturned expression functionBody request=Value request!=Value requestIsContainedInValue requestIsNotContainedInValue item=value item!=value itemIsNull itemIsNotNull itemIsZero itemIsNotZero itemIsNullOrZero itemIsNotNullAndNotZero itemContainsNoSpaces itemIsNumeric itemIsNotNumeric itemIsAlphanumeric itemIsInColonDelimitedList itemIsNotInColonDelimitedList textIsContainedInItem text=value text!=value textIsContainedInValue textIsNotContainedInValue userPreference=value userPreference!=value currentPage=page currentPage!=page currentPageInList currentPageNotInList currentPage=pageSubmitted currentPage!=pageSubmitted currentPageIsInPrinterFriendlyMode currentPageIsNotInPrinterFriendlyMode pageRegionIsReadOnly pageRegionIsNotReadOnly userIsAuthenticated userIsPublicUser inlineValidationErrorsDisplayed inlineValidationErrorsNotDisplayed sqlReportsOkToShowForwardButton sqlReportsOkToShowBackButton currentLanguage=value currentLanguage!=value currentLanguageIsContainedInValue currentLanguageIsNotContainedInValue clientBrowserIsMozilla clientBrowserIsIE7higher clientBrowserIsXhtmlCssCapable clientBrowserIsOther cgiEnvDadName=value cgiEnvDadName!=value cgiEnvServerName=value cgiEnvServerName!=value cgiEnvHttpHost=value cgiEnvHttpHost!=value neverApplies when show = true | |
sqlQuery | multiline string | Yes | data type=multiline string; maxLen=4000Applies when show = true and type in (rowsReturned)show = true and type in (noRowsReturned) | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: sql plsql javaScript-mleApplies when show = true and type = expression |
sqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when show = true and type = expression and language = sql | |
plsqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when show = true and type = expression and language = plsql | |
javaScriptExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when show = true and type = expression and language = javaScript-mle | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: plsql javaScript-mleApplies when show = true and type = functionBody |
plsqlFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when show = true and type = functionBody and language = plsql | |
javaScriptFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when show = true and type = functionBody and language = javaScript-mle | |
value | string | Yes | data type=string; maxLen=4000Applies when show = true and type in (request=Value)show = true and type in (request!=Value)show = true and type in (requestIsContainedInValue)show = true and type in (requestIsNotContainedInValue)show = true and type in (currentLanguageIsContainedInValue)show = true and type in (currentLanguageIsNotContainedInValue)show = true and type in (currentLanguage!=value)show = true and type in (currentLanguage=value)show = true and type in (cgiEnvDadName=value)show = true and type in (cgiEnvDadName!=value)show = true and type in (cgiEnvServerName=value)show = true and type in (cgiEnvServerName!=value)show = true and type in (cgiEnvHttpHost=value)show = true and type in (cgiEnvHttpHost!=value) | |
item | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when show = true and type in (item=value)show = true and type in (item!=value)show = true and type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)show = true and type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2)show = true and type in (itemIsNull)show = true and type in (itemIsNotNull)show = true and type in (itemIsZero)show = true and type in (itemIsNotZero)show = true and type in (itemIsNullOrZero)show = true and type in (itemIsNotNullAndNotZero)show = true and type in (itemContainsNoSpaces)show = true and type in (itemIsNumeric)show = true and type in (itemIsNotNumeric)show = true and type in (itemIsAlphanumeric)show = true and type in (itemIsInColonDelimitedList)show = true and type in (itemIsNotInColonDelimitedList) | |
preference | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when show = true and type in (userPreference=value)show = true and type in (userPreference!=value) | |
page | integer | Yes | data type=integer; maxLen=4000Applies when show = true and type in (currentPage=page)show = true and type in (currentPage!=page) | |
pages | array of integers | Yes | data type=integer; maxLen=4000Applies when show = true and type in (currentPageInList)show = true and type in (currentPageNotInList) | |
text | string | Yes | data type=string; maxLen=4000Applies when show = true and type in (textIsContainedInItem)show = true and type in (textIsContainedInValue)show = true and type in (textIsNotContainedInValue)show = true and type in (text=value)show = true and type in (text!=value) | |
value | string | Yes | data type=string; maxLen=4000Applies when show = true and type in (item=value)show = true and type in (item!=value)show = true and type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)show = true and type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2) | |
list | array of strings | Yes | data type=string; maxLen=4000Applies when show = true and type in (itemIsInColonDelimitedList)show = true and type in (itemIsNotInColonDelimitedList) | |
item | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when show = true and type = textIsContainedInItem | |
value | string | Yes | data type=string; maxLen=4000Applies when show = true and type in (textIsContainedInValue)show = true and type in (textIsNotContainedInValue)show = true and type in (text=value)show = true and type in (text!=value) |
serverSideCondition {
type: always
sqlQuery: ```sql
value
```
language: sql
sqlExpression: ```sql
value
```
plsqlExpression: ```plsql
value
```
javaScriptExpression: ```javascript-mle
value
```
plsqlFunctionBody: ```plsql
value
```
javaScriptFunctionBody: ```javascript-mle
value
```
value: value
item: value
preference: value
page: 42
pages: [
42
42
]
text: value
list: [
value
value
]
}security
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
authorizationScheme | enum | No | data type=reference; lov=COMPONENT; references=authorizationValid values: mustNotBePublicUserApplies when show = true | |
escapeSpecialChars | boolean | Yes | true | data type=booleanApplies when type supports VALUE_ESCAPE_OUTPUT |
security {
authorizationScheme: mustNotBePublicUser
escapeSpecialChars: false
}config
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
buildOption | reference | No | data type=reference; lov=COMPONENT; references=buildOption |
config {
buildOption: @component
}comments
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
comments | multiline string | No | data type=multiline string; maxLen=4000 |
comments {
comments: ```
value
```
}APEXlang Example
column sample (
columnName: value
show: false
source {
dataType: value
}
heading {
heading: value
alignment: start
}
layout {
sequence: 42
columnAlignment: start
}
appearance {
formatMask: value
cssClasses: [
value
value
]
}
advanced {
customAttributes: value
}
serverSideCondition {
type: always
sqlQuery: ```sql
value
```
language: sql
sqlExpression: ```sql
value
```
plsqlExpression: ```plsql
value
```
javaScriptExpression: ```javascript-mle
value
```
plsqlFunctionBody: ```plsql
value
```
javaScriptFunctionBody: ```javascript-mle
value
```
value: value
item: value
preference: value
page: 42
pages: [
42
42
]
text: value
list: [
value
value
]
}
security {
authorizationScheme: mustNotBePublicUser
escapeSpecialChars: false
}
config {
buildOption: @component
}
comments {
comments: ```
value
```
}
)