pageItem (checkbox)

Parent: pageItem

Applies whentype = checkbox

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
namestringYesP#PAGE_ID#_NEWdata type=string; maxLen=255; textCase=UPPER
typeenumYesdata type=string; lov=PLUGINS
Valid values: checkbox

Property Groups:

  • settings
  • label
  • lov
  • cascadingLov
  • genAI
  • multipleValues
  • layout
  • appearance
  • validation
  • advanced
  • source
  • default
  • sessionState
  • quickPicks
  • serverSideCondition
  • readOnly
  • security
  • help
  • config
  • comments
settings
PropertyTypeRequiredDefault ValueDetails
useDefaultsbooleanYestruedata type=boolean
checkedValuestringYesdata type=string; maxLen=4000
uncheckedValuestringNodata type=string; maxLen=255
settings {
  useDefaults: false
  checkedValue: value
  uncheckedValue: value
}
label
PropertyTypeRequiredDefault ValueDetails
labelstringNodata type=string; maxLen=4000
Applies whentype supports VISIBLE
alignmentenumYesrightCenterdata type=string; lov=STATIC
Valid values: above below center centerBottom centerCenter centerTop left leftBottom leftCenter leftTop right rightBottom rightCenter rightTop
Applies whentype supports VISIBLE
tableCellAttributesarray of stringsNodata type=string; maxLen=255
Applies whentype supports VISIBLE
label {
  label: value
  alignment: above
  tableCellAttributes: [
    value
    value
  ]
}
lov
PropertyTypeRequiredDefault ValueDetails
typeenumNodata type=string; lov=STATIC
Valid values: sharedComponent sqlQuery staticValues functionBody
Applies whentype supports LOV
lovreferenceYesdata type=reference; lov=COMPONENT; references=lov
Applies whentype supports LOV and type = sharedComponent
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports LOV and type = sqlQuery

Enter the SQL query definition to populate this list of values. Generally list of value queries are of the form:

select [displayValue],
       [returnValue]
  from ...
 where ...
 order by ...

Each column selected must have a unique name or alias. Oracle recommends using an alias on any column that includes an SQL expression.

Note: When defining a Popup LOV item type, if you would like to display multiple columns in the popup, you must instead define your List of Values in Shared Components, with the required additional metadata. Inline list of values can only be used to display single columns for Popup LOVs.

staticValuesmultiline stringYesSTATIC:Display1;Return1,Display2;Return2data type=multiline string; maxLen=4000
Applies whentype supports LOV and type = staticValues
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whentype supports LOV and type = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=32767
Applies whentype supports LOV and type = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=32767
Applies whentype supports LOV and type = functionBody and language = javaScript-mle
displayExtraValuesbooleanYestruedata type=boolean
Applies whentype supports LOV and type is set
displayNullValuebooleanYestruedata type=boolean
Applies whentype supports LOV_DISPLAY_NULL and type supports LOV and type is set
nullDisplayValuestringNodata type=string; maxLen=255
Applies whentype supports LOV_DISPLAY_NULL and type supports LOV and type is set and displayNullValue = true
nullReturnValuestringNodata type=string; maxLen=255
Applies whentype supports LOV_DISPLAY_NULL and type supports LOV and type is set and displayNullValue = true
lov {
  type: sharedComponent
  lov: @component
  sqlQuery: ```sql
    value
  ```
  staticValues: ```
    value
  ```
  language: plsql
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
  displayExtraValues: false
  displayNullValue: false
  nullDisplayValue: value
  nullReturnValue: value
}
cascadingLov
PropertyTypeRequiredDefault ValueDetails
parentItemsarray of stringsNodata type=string; maxLen=255; textCase=UPPER
Applies whentype supports CASCADING_LOV and type supports LOV and type is set
itemsToSubmitarray of stringsNodata type=string; maxLen=4000; textCase=UPPER
Applies whentype supports CASCADING_LOV and type supports LOV and type is set and parentItems is set
parentRequiredbooleanYestruedata type=boolean
Applies whentype supports CASCADING_LOV and type supports LOV and type is set and parentItems is set
cascadingLov {
  parentItems: [
    value
    value
  ]
  itemsToSubmit: [
    value
    value
  ]
  parentRequired: false
}
genAI
PropertyTypeRequiredDefault ValueDetails
enabledbooleanYesfalsedata type=boolean
Applies whentype supports AI_ENABLED
agentreferenceNodata type=reference; lov=COMPONENT; references=aiAgent
Applies whentype supports AI_ENABLED_ALWAYS and type supports AI_ENABLED and enabled = truetype supports AI_ENABLED and enabled = true
servicereferenceNodata type=reference; lov=COMPONENT; references=genAIService
Applies whentype supports AI_ENABLED_ALWAYS and type supports AI_ENABLED and enabled = truetype supports AI_ENABLED and enabled = true
systemPromptmultiline stringNodata type=multiline string; maxLen=32767
Applies whentype supports AI_SYSTEM_PROMPT and type supports AI_ENABLED_ALWAYS and type supports AI_ENABLED and enabled = truetype supports AI_SYSTEM_PROMPT and type supports AI_ENABLED and enabled = true
welcomeMessagemultiline stringNodata type=multiline string; maxLen=32767
Applies whentype supports AI_UI and type supports AI_ENABLED_ALWAYS and type supports AI_ENABLED and enabled = truetype supports AI_UI and type supports AI_ENABLED and enabled = true
genAI {
  enabled: false
  agent: @component
  service: @component
  systemPrompt: ```
    value
  ```
  welcomeMessage: ```html
    value
  ```
}
multipleValues
PropertyTypeRequiredDefault ValueDetails
typeenumYesdelimitedListdata type=string; lov=STATIC
Valid values: delimitedList jsonArray
Applies whentype supports MULTI_VALUE_ALWAYS
typeenumNodata type=string; lov=STATIC
Valid values: delimitedList jsonArray
Applies whentype supports MULTI_VALUE_OPTIONALtype supports MULTI_VALUE_OPTIONAL and page_action_on_selection = NONE
separatorstringYes:data type=string; maxLen=5
Applies whentype supports MULTI_VALUE_ALWAYS and type = delimitedListtype supports MULTI_VALUE_OPTIONAL and type = delimitedListtype supports MULTI_VALUE_OPTIONAL and page_action_on_selection = NONE and type = delimitedList
multipleValues {
  type: delimitedList
  separator: value
}
layout
PropertyTypeRequiredDefault ValueDetails
sequencenumberYesdata type=number; maxLen=22
regionreferenceNodata type=reference; lov=COMPONENT; references=region
Select the region in which the item will be displayed.
slotstringYesdata type=string; lov=SLOTS
alignmentenumYesleftCenterdata type=string; lov=STATIC
Valid values: center centerBottom centerCenter centerTop left leftBottom leftCenter leftTop right rightBottom rightCenter rightTop
Applies whentype supports ELEMENT
startNewLayoutbooleanYesfalsedata type=boolean
Applies whentype supports VISIBLE
startNewRowbooleanYestruedata type=boolean
Applies whentype supports VISIBLE and startNewLayout = false
rowCssClassesarray of stringsNodata type=string; maxLen=255
Applies whentype supports VISIBLE
columnstringNodata type=string; lov=GRID_COLUMNS
Applies whentype supports VISIBLE
newColumnbooleanYestruedata type=boolean
Applies whentype supports VISIBLE and startNewLayout = false and startNewRow = false
columnSpanstringNodata type=string; lov=GRID_COLUMNS
Applies whentype supports VISIBLE
rowSpannumberNodata type=number; maxLen=22
Applies whentype supports VISIBLE
labelColumnSpanstringNodata type=string; lov=GRID_COLUMNS
Applies whentype supports VISIBLE
columnCssClassesarray of stringsNodata type=string; maxLen=255
Applies whentype supports VISIBLE
columnAttributesarray of stringsNodata type=string; maxLen=255
Applies whentype supports VISIBLE
layout {
  sequence: 42
  region: @component
  slot: value
  alignment: center
  startNewLayout: false
  startNewRow: false
  rowCssClasses: [
    value
    value
  ]
  column: value
  newColumn: false
  columnSpan: value
  rowSpan: 42
  labelColumnSpan: value
  columnCssClasses: [
    value
    value
  ]
  columnAttributes: [
    value
    value
  ]
}
appearance
PropertyTypeRequiredDefault ValueDetails
templatereferenceNodata type=reference; lov=COMPONENT; references=fieldTemplate
Applies whentype supports VISIBLE
templateOptionsarray of stringsNodata type=string; lov=TEMPLATE_OPTIONS
Applies whentype supports VISIBLE and template is set
cssClassesarray of stringsNodata type=string; maxLen=255
Applies whentype supports VISIBLE and template is set

Enter classes to add to this item. You may add multiple classes by separating them with spaces.

This property can be used to make style modifications to the item, beyond template options, or to provide a simpler way of selecting this item via JavaScript.

Note: To apply CSS classes to the HTML form element tag, please see the CSS Classes property under the Advanced group.

iconstringNodata type=string; maxLen=255
Applies whentype supports ICON

Enter the classes for the icon you want to add to the component. You may add multiple classes by separating them with spaces.

If your theme uses Font APEX then review the Universal Theme Sample Application to view available icons and modifiers.

Note: This icon will be displayed inside of the item, not as part of the label.

formatMaskstringNodata type=string; maxLen=255
Applies whentype supports FORMAT_MASK_ALL
formatMaskstringNodata type=string; maxLen=255
Applies whentype supports FORMAT_MASK_DATE
formatMaskstringNodata type=string; maxLen=255
Applies whentype supports FORMAT_MASK_NUMBER
widthnumberNodata type=number; maxLen=22
Applies whentype supports WIDTH
heightnumberNodata type=number; maxLen=22
Applies whentype supports HEIGHT
valuePlaceholderstringNodata type=string; maxLen=255
Applies whentype supports PLACEHOLDER
appearance {
  template: @component
  templateOptions: [
    value
    value
  ]
  cssClasses: [
    value
    value
  ]
  icon: value
  formatMask: value
  width: 42
  height: 42
  valuePlaceholder: value
}
validation
PropertyTypeRequiredDefault ValueDetails
valueRequiredbooleanYesfalsedata type=boolean
Applies whentype supports SESSION_STATE
maxLengthnumberNodata type=number; maxLen=22
Applies whentype supports WIDTH
validation {
  valueRequired: false
  maxLength: 42
}
advanced
PropertyTypeRequiredDefault ValueDetails
cssClassesarray of stringsNodata type=string; maxLen=255
Applies whentype supports ELEMENT

Enter classes to add to this component. You may add multiple classes by separating them with spaces.

Note: These CSS classes will be applied to the HTML form element tag.

customAttributesstringNodata type=string; maxLen=2000
Applies whentype supports ELEMENT
Enter additional attributes to be included in the form element HTML tag. The size and id HTML attributes are generated and therefore should not be supplied. For the class HTML attribute it is better to use the dedicated CSS Classes attribute instead.
optionHtmlAttributesarray of stringsNodata type=string; maxLen=255
Applies whentype supports ELEMENT_OPTION
preTextmultiline stringNodata type=multiline string; maxLen=4000
Applies whentype supports ELEMENT
postTextmultiline stringNodata type=multiline string; maxLen=4000
Applies whentype supports ELEMENT
warnOnUnsavedChangesenumNodata type=string; lov=STATIC
Valid values: ignore
initJavaScriptFunctionmultiline stringNodata type=multiline string; maxLen=4000
Applies whentype supports INIT_JAVASCRIPT_CODE
advanced {
  cssClasses: [
    value
    value
  ]
  customAttributes: value
  optionHtmlAttributes: [
    value
    value
  ]
  preText: ```html
    value
  ```
  postText: ```html
    value
  ```
  warnOnUnsavedChanges: ignore
  initJavaScriptFunction: ```javascript-browser
    value
  ```
}
source
PropertyTypeRequiredDefault ValueDetails
formRegionreferenceNodata type=reference; lov=COMPONENT; references=region
Applies whentype supports SOURCE
columnstringYesdata type=string; maxLen=128
Applies whentype supports SOURCE and formRegion is set
dataTypeenumYesdata type=string; maxLen=128; lov=STATIC
Valid values: varchar2 number date timestamp timestampWithTimeZone timestampWithLocalTimeZone intervalYearToMonth intervalDayToSecond clob blob boolean rowid bfile sdoGeometry
Applies whentype supports SOURCE and formRegion is set
queryOnlybooleanYesfalsedata type=boolean
Applies whentype supports SOURCE and formRegion is set
primaryKeybooleanYesfalsedata type=boolean
Applies whentype supports SOURCE and formRegion is set
typeenumYesnulldata type=string; lov=STATIC
Valid values: staticValue databaseColumn item sqlQuerySingleValue sqlQueryMultipleValues expression functionBody preference null
Applies whentype supports SOURCE
staticValuemultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = staticValue
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = sqlQuerySingleValue
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = sqlQueryMultipleValues
itemstringYesdata type=string; maxLen=255; textCase=UPPER
Applies whentype supports SOURCE and type = item
languageenumYesplsqldata type=string; lov=STATIC
Valid values: sql plsql javaScript-mle
Applies whentype supports SOURCE and type = expression
sqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = expression and language = sql
plsqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = expression and language = plsql
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = expression and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whentype supports SOURCE and type = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = functionBody and language = javaScript-mle
databaseColumnstringYesdata type=string; maxLen=128
Applies whentype supports SOURCE and type = databaseColumn
preferencestringYesdata type=string; maxLen=255
Applies whentype supports SOURCE and type = preference
usedenumYesonlyWhenSessionStateIsNulldata type=string; lov=STATIC
Valid values: always onlyWhenSessionStateIsNull
Applies whentype supports SOURCE
postCalculationComputationmultiline stringNodata type=multiline string; maxLen=4000
Applies whentype supports SOURCE
source {
  formRegion: @component
  column: value
  dataType: varchar2
  queryOnly: false
  primaryKey: false
  type: staticValue
  staticValue: ```
    value
  ```
  sqlQuery: ```sql
    value
  ```
  item: value
  language: sql
  sqlExpression: ```sql
    value
  ```
  plsqlExpression: ```plsql
    value
  ```
  javaScriptExpression: ```javascript-mle
    value
  ```
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
  databaseColumn: value
  preference: value
  used: always
  postCalculationComputation: ```plsql
    value
  ```
}
default
PropertyTypeRequiredDefault ValueDetails
typeenumNodata type=string; lov=STATIC
Valid values: static item sqlQuerySingleValue sqlQueryMultipleValues expression functionBody sequence
Applies whentype supports SOURCE
staticValuemultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = static
itemstringYesdata type=string; maxLen=32767; textCase=UPPER
Applies whentype supports SOURCE and type = item
sqlQuerySingleValuemultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = sqlQuerySingleValue
sqlQueryMultipleValuesmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = sqlQueryMultipleValues
languageenumYesplsqldata type=string; lov=STATIC
Valid values: sql plsql javaScript-mle
Applies whentype supports SOURCE and type = expression
sqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = expression and language = sql
plsqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = expression and language = plsql
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = expression and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whentype supports SOURCE and type = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports SOURCE and type = functionBody and language = javaScript-mle
sequencestringYesdata type=string; maxLen=128
Applies whentype supports SOURCE and type = sequence
default {
  type: static
  staticValue: ```
    value
  ```
  item: value
  sqlQuerySingleValue: ```sql
    value
  ```
  sqlQueryMultipleValues: ```sql
    value
  ```
  language: sql
  sqlExpression: ```sql
    value
  ```
  plsqlExpression: ```plsql
    value
  ```
  javaScriptExpression: ```javascript-mle
    value
  ```
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
  sequence: value
}
sessionState
PropertyTypeRequiredDefault ValueDetails
dataTypeenumYesvarchar2data type=string; maxLen=128; lov=STATIC
Valid values: varchar2 clob boolean number
storageenumYessessiondata type=string; lov=STATIC
Valid values: request session user
Applies whentype supports SOURCE
storageenumYesrequestdata type=string; lov=STATIC
Valid values: request session
Applies whentype supports SOURCE and formRegion is set
sessionState {
  dataType: varchar2
  storage: request
}
quickPicks
PropertyTypeRequiredDefault ValueDetails
typeenumNodata type=string; lov=STATIC
Valid values: static sharedLov sqlQuery
Applies whentype supports QUICKPICK
label1stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
value1stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
label2stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
value2stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
label3stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
value3stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
label4stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
value4stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
label5stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
value5stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
label6stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
value6stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
label7stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
value7stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
label8stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
value8stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
label9stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
value9stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
label10stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
value10stringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type = static
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports QUICKPICK and type = sqlQuery
maxDisplayedEntriesintegerNodata type=integer; maxLen=32767
Applies whentype supports QUICKPICK and type in (sharedLov)type supports QUICKPICK and type in (sqlQuery)
linkAttributesstringNodata type=string; maxLen=255
Applies whentype supports QUICKPICK and type is set
quickPicks {
  type: static
  label1: value
  value1: value
  label2: value
  value2: value
  label3: value
  value3: value
  label4: value
  value4: value
  label5: value
  value5: value
  label6: value
  value6: value
  label7: value
  value7: value
  label8: value
  value8: value
  label9: value
  value9: value
  label10: value
  value10: value
  sqlQuery: ```sql
    value
  ```
  maxDisplayedEntries: 42
  linkAttributes: value
}
serverSideCondition
PropertyTypeRequiredDefault ValueDetails
typeenumNodata type=string; lov=STATIC
Valid 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 never
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype in (rowsReturned)type in (noRowsReturned)
languageenumYesplsqldata type=string; lov=STATIC
Valid values: sql plsql javaScript-mle
Applies whentype = expression
sqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = expression and language = sql
plsqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = expression and language = plsql
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = expression and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whentype = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = functionBody and language = javaScript-mle
valuestringYesdata type=string; maxLen=4000
Applies whentype in (request=Value)type in (request!=Value)type in (requestIsContainedInValue)type in (requestIsNotContainedInValue)type in (currentLanguageIsContainedInValue)type in (currentLanguageIsNotContainedInValue)type in (currentLanguage!=value)type in (currentLanguage=value)type in (cgiEnvDadName=value)type in (cgiEnvDadName!=value)type in (cgiEnvServerName=value)type in (cgiEnvServerName!=value)type in (cgiEnvHttpHost=value)type in (cgiEnvHttpHost!=value)
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype in (item=value)type in (item!=value)type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2)type in (itemIsNull)type in (itemIsNotNull)type in (itemIsZero)type in (itemIsNotZero)type in (itemIsNullOrZero)type in (itemIsNotNullAndNotZero)type in (itemContainsNoSpaces)type in (itemIsNumeric)type in (itemIsNotNumeric)type in (itemIsAlphanumeric)type in (itemIsInColonDelimitedList)type in (itemIsNotInColonDelimitedList)
preferencestringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype in (userPreference=value)type in (userPreference!=value)
pageintegerYesdata type=integer; maxLen=4000
Applies whentype in (currentPage=page)type in (currentPage!=page)
pagesarray of integersYesdata type=integer; maxLen=4000
Applies whentype in (currentPageInList)type in (currentPageNotInList)
textstringYesdata type=string; maxLen=4000
Applies whentype in (textIsContainedInItem)type in (textIsContainedInValue)type in (textIsNotContainedInValue)type in (text=value)type in (text!=value)
valuestringYesdata type=string; maxLen=4000
Applies whentype in (item=value)type in (item!=value)type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2)
listarray of stringsYesdata type=string; maxLen=4000
Applies whentype in (itemIsInColonDelimitedList)type in (itemIsNotInColonDelimitedList)
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype = textIsContainedInItem
valuestringYesdata type=string; maxLen=4000
Applies whentype in (textIsContainedInValue)type in (textIsNotContainedInValue)type in (text=value)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
  ]
}
readOnly
PropertyTypeRequiredDefault ValueDetails
typeenumNodata type=string; lov=STATIC
Valid 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 never
Applies whentype supports READONLY

Select a condition type that must be met in order for this component to render as read-only. Not selecting a condition causes the item to render normally. A read-only item is rendered with the same settings as a Display Only item.

Note: Set the condition type to Never to always render the item as an enterable field. This setting overwrites any read-only condition setting on the region or page level.

sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports READONLY and type in (rowsReturned)type supports READONLY and type in (noRowsReturned)
languageenumYesplsqldata type=string; lov=STATIC
Valid values: sql plsql javaScript-mle
Applies whentype supports READONLY and type = expression
sqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports READONLY and type = expression and language = sql
plsqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports READONLY and type = expression and language = plsql
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports READONLY and type = expression and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whentype supports READONLY and type = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports READONLY and type = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype supports READONLY and type = functionBody and language = javaScript-mle
valuestringYesdata type=string; maxLen=4000
Applies whentype supports READONLY and type in (request=Value)type supports READONLY and type in (request!=Value)type supports READONLY and type in (requestIsContainedInValue)type supports READONLY and type in (requestIsNotContainedInValue)type supports READONLY and type in (currentLanguageIsContainedInValue)type supports READONLY and type in (currentLanguageIsNotContainedInValue)type supports READONLY and type in (currentLanguage!=value)type supports READONLY and type in (currentLanguage=value)type supports READONLY and type in (cgiEnvDadName=value)type supports READONLY and type in (cgiEnvDadName!=value)type supports READONLY and type in (cgiEnvServerName=value)type supports READONLY and type in (cgiEnvServerName!=value)type supports READONLY and type in (cgiEnvHttpHost=value)type supports READONLY and type in (cgiEnvHttpHost!=value)
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype supports READONLY and type in (item=value)type supports READONLY and type in (item!=value)type supports READONLY and type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)type supports READONLY and type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2)type supports READONLY and type in (itemIsNull)type supports READONLY and type in (itemIsNotNull)type supports READONLY and type in (itemIsZero)type supports READONLY and type in (itemIsNotZero)type supports READONLY and type in (itemIsNullOrZero)type supports READONLY and type in (itemIsNotNullAndNotZero)type supports READONLY and type in (itemContainsNoSpaces)type supports READONLY and type in (itemIsNumeric)type supports READONLY and type in (itemIsNotNumeric)type supports READONLY and type in (itemIsAlphanumeric)type supports READONLY and type in (itemIsInColonDelimitedList)type supports READONLY and type in (itemIsNotInColonDelimitedList)
preferencestringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype supports READONLY and type in (userPreference=value)type supports READONLY and type in (userPreference!=value)
pageintegerYesdata type=integer; maxLen=4000
Applies whentype supports READONLY and type in (currentPage=page)type supports READONLY and type in (currentPage!=page)
pagesarray of integersYesdata type=integer; maxLen=4000
Applies whentype supports READONLY and type in (currentPageInList)type supports READONLY and type in (currentPageNotInList)
textstringYesdata type=string; maxLen=4000
Applies whentype supports READONLY and type in (textIsContainedInItem)type supports READONLY and type in (textIsContainedInValue)type supports READONLY and type in (textIsNotContainedInValue)type supports READONLY and type in (text=value)type supports READONLY and type in (text!=value)
valuestringYesdata type=string; maxLen=4000
Applies whentype supports READONLY and type in (item=value)type supports READONLY and type in (item!=value)type supports READONLY and type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)type supports READONLY and type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2)type supports READONLY and type in (userPreference=value)type supports READONLY and type in (userPreference!=value)
listarray of stringsYesdata type=string; maxLen=4000
Applies whentype supports READONLY and type in (itemIsInColonDelimitedList)type supports READONLY and type in (itemIsNotInColonDelimitedList)
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype supports READONLY and type = textIsContainedInItem
valuestringYesdata type=string; maxLen=4000
Applies whentype supports READONLY and type in (textIsContainedInValue)type supports READONLY and type in (textIsNotContainedInValue)type supports READONLY and type in (text=value)type supports READONLY and type in (text!=value)
readOnlyHtmlAttributesstringNodata type=string; maxLen=4000
Applies whentype supports READONLY and type is set
readOnly {
  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
  ]
  readOnlyHtmlAttributes: value
}
security
PropertyTypeRequiredDefault ValueDetails
authorizationSchemeenumNodata type=reference; lov=COMPONENT; references=authorization
Valid values: mustNotBePublicUser
sessionStateProtectionenumYesunrestricteddata type=string; lov=STATIC
Valid values: unrestricted checksumRequiredAppLevel checksumRequiredUserLevel checksumRequiredSessionLevel restricted
encryptSessionStatebooleanYestruedata type=boolean
Applies whentype supports ENCRYPT
escapeSpecialCharsbooleanYestruedata type=boolean
Applies whentype supports ESCAPE_OUTPUT
restrictedCharsenumNodata type=string; lov=STATIC
Valid values: alphanumWithSpace webSafe noSpecialChar noSpecialCharNoNewline workspaceSchema workspaceUserSchema workspaceUserSchemaId
security {
  authorizationScheme: mustNotBePublicUser
  sessionStateProtection: unrestricted
  encryptSessionState: false
  escapeSpecialChars: false
  restrictedChars: alphanumWithSpace
}
help
PropertyTypeRequiredDefault ValueDetails
inlineHelpTextmultiline stringNodata type=multiline string; maxLen=4000
helpTextmultiline stringNodata type=multiline string; maxLen=4000
Enter help text for this item. The help text may be used to provide field level context sensitive help.
help {
  inlineHelpText: ```html
    value
  ```
  helpText: ```html
    value
  ```
}
config
PropertyTypeRequiredDefault ValueDetails
buildOptionreferenceNodata type=reference; lov=COMPONENT; references=buildOption
config {
  buildOption: @component
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
comments {
  comments: ```
    value
  ```
}

APEXlang Example

pageItem sample (
    name: value
    type: checkbox
    settings {
        useDefaults: false
        checkedValue: value
        uncheckedValue: value
    }
    label {
        label: value
        alignment: above
        tableCellAttributes: [
          value
          value
        ]
    }
    lov {
        type: sharedComponent
        lov: @component
        sqlQuery: ```sql
          value
        ```
        staticValues: ```
          value
        ```
        language: plsql
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        displayExtraValues: false
        displayNullValue: false
        nullDisplayValue: value
        nullReturnValue: value
    }
    cascadingLov {
        parentItems: [
          value
          value
        ]
        itemsToSubmit: [
          value
          value
        ]
        parentRequired: false
    }
    genAI {
        enabled: false
        agent: @component
        service: @component
        systemPrompt: ```
          value
        ```
        welcomeMessage: ```html
          value
        ```
    }
    multipleValues {
        type: delimitedList
        separator: value
    }
    layout {
        sequence: 42
        region: @component
        slot: value
        alignment: center
        startNewLayout: false
        startNewRow: false
        rowCssClasses: [
          value
          value
        ]
        column: value
        newColumn: false
        columnSpan: value
        rowSpan: 42
        labelColumnSpan: value
        columnCssClasses: [
          value
          value
        ]
        columnAttributes: [
          value
          value
        ]
    }
    appearance {
        template: @component
        templateOptions: [
          value
          value
        ]
        cssClasses: [
          value
          value
        ]
        icon: value
        formatMask: value
        width: 42
        height: 42
        valuePlaceholder: value
    }
    validation {
        valueRequired: false
        maxLength: 42
    }
    advanced {
        cssClasses: [
          value
          value
        ]
        customAttributes: value
        optionHtmlAttributes: [
          value
          value
        ]
        preText: ```html
          value
        ```
        postText: ```html
          value
        ```
        warnOnUnsavedChanges: ignore
        initJavaScriptFunction: ```javascript-browser
          value
        ```
    }
    source {
        formRegion: @component
        column: value
        dataType: varchar2
        queryOnly: false
        primaryKey: false
        type: staticValue
        staticValue: ```
          value
        ```
        sqlQuery: ```sql
          value
        ```
        item: value
        language: sql
        sqlExpression: ```sql
          value
        ```
        plsqlExpression: ```plsql
          value
        ```
        javaScriptExpression: ```javascript-mle
          value
        ```
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        databaseColumn: value
        preference: value
        used: always
        postCalculationComputation: ```plsql
          value
        ```
    }
    default {
        type: static
        staticValue: ```
          value
        ```
        item: value
        sqlQuerySingleValue: ```sql
          value
        ```
        sqlQueryMultipleValues: ```sql
          value
        ```
        language: sql
        sqlExpression: ```sql
          value
        ```
        plsqlExpression: ```plsql
          value
        ```
        javaScriptExpression: ```javascript-mle
          value
        ```
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        sequence: value
    }
    sessionState {
        dataType: varchar2
        storage: request
    }
    quickPicks {
        type: static
        label1: value
        value1: value
        label2: value
        value2: value
        label3: value
        value3: value
        label4: value
        value4: value
        label5: value
        value5: value
        label6: value
        value6: value
        label7: value
        value7: value
        label8: value
        value8: value
        label9: value
        value9: value
        label10: value
        value10: value
        sqlQuery: ```sql
          value
        ```
        maxDisplayedEntries: 42
        linkAttributes: 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
        ]
    }
    readOnly {
        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
        ]
        readOnlyHtmlAttributes: value
    }
    security {
        authorizationScheme: mustNotBePublicUser
        sessionStateProtection: unrestricted
        encryptSessionState: false
        escapeSpecialChars: false
        restrictedChars: alphanumWithSpace
    }
    help {
        inlineHelpText: ```html
          value
        ```
        helpText: ```html
          value
        ```
    }
    config {
        buildOption: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)