page
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
page | number | Yes | data type=number; maxLen=10 | |
name | string | Yes | data type=string; maxLen=255Enter the name of the current page. This name is used in numerous Oracle APEX pages and reports, along with the page number and title. | |
alias | string | No | data type=string; maxLen=80; textCase=UPPER | |
title | string | No | data type=string; maxLen=255Enter a title that will be displayed in the title bar of the browser window, and announced to screen reader users when they first open the page.
The Oracle APEX engine uses the title you specify here in place of the A good page title should provide a clear and concise description of the purpose of the page, can include the application name and sub-section of the application for additional context, and should always include the most important, and unique information first. For example, if you have a 'Products' page in an 'Administration' section of a 'Customer Portal' application, the page title could be defined as 'Products | Admin | Customer Portal'. | |
pageGroup | reference | No | data type=reference; lov=COMPONENT; references=pageGroupApplies when type in (standard)type in (boilerplate) |
appearance
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
pageMode | enum | Yes | normal | data type=string; lov=STATICValid values: normal modalDialog nonModalDialog |
pageTemplate | reference | Yes | data type=reference; lov=COMPONENT; references=pageTemplateApplies when pageMode = normal | |
dialogTemplate | reference | Yes | data type=reference; lov=COMPONENT; references=pageTemplateApplies when pageMode in (modalDialog)pageMode in (nonModalDialog) | |
templateOptions | array of strings | No | data type=string; lov=TEMPLATE_OPTIONS | |
cssClasses | array of strings | No | data type=string; maxLen=255Enter classes to add to this component. You may add multiple classes by separating them with spaces. | |
mediaType | string | No | data type=string; maxLen=255 |
appearance {
pageMode: normal
pageTemplate: @component
dialogTemplate: @component
templateOptions: [
value
value
]
cssClasses: [
value
value
]
mediaType: value
}dialog
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
width | string | No | data type=string; maxLen=20Applies when pageMode in (modalDialog)pageMode in (nonModalDialog) | |
height | string | No | data type=string; maxLen=20Applies when pageMode in (modalDialog)pageMode in (nonModalDialog) | |
maxWidth | string | No | data type=string; maxLen=20Applies when pageMode in (modalDialog)pageMode in (nonModalDialog) | |
attributes | array of strings | No | data type=string; maxLen=255Applies when pageMode in (modalDialog)pageMode in (nonModalDialog) | |
cssClasses | array of strings | No | data type=string; maxLen=255Applies when pageMode in (modalDialog)pageMode in (nonModalDialog) | |
chained | boolean | Yes | true | data type=booleanApplies when pageMode in (modalDialog)pageMode in (nonModalDialog) |
resizable | boolean | Yes | true | data type=booleanApplies when pageMode in (modalDialog)pageMode in (nonModalDialog) |
dialog {
width: value
height: value
maxWidth: value
attributes: [
value
value
]
cssClasses: [
value
value
]
chained: false
resizable: false
}navigationMenu
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
overrideUserInterfaceLevel | boolean | Yes | false | data type=booleanApplies when currentTheme supports HAS_LIST_NAVIGATION |
list | reference | No | data type=reference; lov=COMPONENT; references=listApplies when currentTheme supports HAS_LIST_NAVIGATION and overrideUserInterfaceLevel = true | |
listPosition | enum | Yes | data type=string; lov=STATICValid values: top sideApplies when currentTheme supports HAS_LIST_NAVIGATION and overrideUserInterfaceLevel = true and list is set | |
listTemplate | reference | Yes | data type=reference; lov=COMPONENT; references=listTemplateApplies when currentTheme supports HAS_LIST_NAVIGATION and overrideUserInterfaceLevel = true and list is set | |
templateOptions | array of strings | No | data type=string; lov=TEMPLATE_OPTIONSApplies when currentTheme supports HAS_LIST_NAVIGATION and overrideUserInterfaceLevel = true and list is set |
navigationMenu {
overrideUserInterfaceLevel: false
list: @component
listPosition: top
listTemplate: @component
templateOptions: [
value
value
]
}navigation
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
cursorFocus | enum | Yes | doNotFocusCursor | data type=string; lov=STATICValid values: firstItemOnPage doNotFocusCursor |
warnOnUnsavedChanges | boolean | Yes | true | data type=boolean |
navigation {
cursorFocus: firstItemOnPage
warnOnUnsavedChanges: false
}javaScript
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
fileUrls | array of strings | No | data type=string; maxLen=4000 | |
functionAndGlobalVariableDeclaration | multiline string | No | data type=multiline string; maxLen=32767 | |
executeWhenPageLoads | multiline string | No | data type=multiline string; maxLen=32767 | |
includeStandardJavaScriptAndCss | boolean | Yes | true | data type=boolean |
javaScript {
fileUrls: [
value
value
]
functionAndGlobalVariableDeclaration: ```javascript-browser
value
```
executeWhenPageLoads: ```javascript-browser
value
```
includeStandardJavaScriptAndCss: false
}css
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
fileUrls | array of strings | No | data type=string; maxLen=4000 | |
inline | multiline string | No | data type=multiline string; maxLen=32767 |
css {
fileUrls: [
value
value
]
inline: ```css
value
```
}htmlHeader
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
htmlHeader | multiline string | No | data type=multiline string; maxLen=32767 | |
pageHtmlBodyAttribute | multiline string | No | data type=multiline string; maxLen=4000 |
htmlHeader {
htmlHeader: ```html
value
```
pageHtmlBodyAttribute: ```
value
```
}headerAndFooter
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
headerText | multiline string | No | data type=multiline string; maxLen=4000 | |
bodyHeader | multiline string | No | data type=multiline string; maxLen=4000 | |
footerText | multiline string | No | data type=multiline string; maxLen=4000 |
headerAndFooter {
headerText: ```html
value
```
bodyHeader: ```html
value
```
footerText: ```html
value
```
}readOnly
| 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 never | |
sqlQuery | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type in (rowsReturned)type in (noRowsReturned) | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: sql plsql javaScript-mleApplies when type = expression |
sqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = expression and language = sql | |
plsqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = expression and language = plsql | |
javaScriptExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = expression and language = javaScript-mle | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: plsql javaScript-mleApplies when type = functionBody |
plsqlFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = functionBody and language = plsql | |
javaScriptFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = functionBody and language = javaScript-mle | |
value | string | Yes | data type=string; maxLen=4000Applies when type 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) | |
item | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when type 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) | |
preference | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when type in (userPreference=value)type in (userPreference!=value) | |
page | integer | Yes | data type=integer; maxLen=4000Applies when type in (currentPage=page)type in (currentPage!=page) | |
pages | array of integers | Yes | data type=integer; maxLen=4000Applies when type in (currentPageInList)type in (currentPageNotInList) | |
text | string | Yes | data type=string; maxLen=4000Applies when type in (textIsContainedInItem)type in (textIsContainedInValue)type in (textIsNotContainedInValue)type in (text=value)type in (text!=value) | |
value | string | Yes | data type=string; maxLen=4000Applies when type 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 (userPreference=value)type in (userPreference!=value) | |
list | array of strings | Yes | data type=string; maxLen=4000Applies when type in (itemIsInColonDelimitedList)type in (itemIsNotInColonDelimitedList) | |
item | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when type = textIsContainedInItem | |
value | string | Yes | data type=string; maxLen=4000Applies when type in (textIsContainedInValue)type in (textIsNotContainedInValue)type in (text=value)type in (text!=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
]
}security
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
authorizationScheme | enum | No | data type=reference; lov=COMPONENT; references=authorizationValid values: mustNotBePublicUserSelect an authorization scheme applied to the page. Authorization schemes are defined at the application-level and can be applied to many elements within the application. An authorization scheme is evaluated either once for each application session (at session creation), or once for each page view. If the selected authorization scheme evaluates to TRUE, then the page displays and is subject to other defined conditions. If it evaluates to FALSE, then the page does not display and an error message displays. | |
authentication | enum | Yes | required | data type=string; lov=STATICValid values: required public |
deepLinking | enum | No | data type=string; lov=STATICValid values: true false | |
pageAccessProtection | enum | Yes | argumentsMustHaveChecksum | data type=string; lov=STATICValid values: unrestricted argumentsMustHaveChecksum noArgumentsSupported noUrlAccess |
formAutoComplete | enum | Yes | false | data type=string; lov=STATICValid values: true false |
browserCache | enum | No | data type=string; lov=STATICValid values: true false |
security {
authorizationScheme: mustNotBePublicUser
authentication: required
deepLinking: true
pageAccessProtection: unrestricted
formAutoComplete: true
browserCache: true
}sessionManagement
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
rejoinSessions | enum | No | data type=string; lov=STATICValid values: false publicSessions allSessions |
sessionManagement {
rejoinSessions: false
}advanced
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
enableMetaTags | boolean | Yes | false | data type=booleanApplies when authentication = public |
enableDuplicatePageSubmissions | enum | Yes | true | data type=string; lov=STATICValid values: false true |
reloadOnSubmit | enum | Yes | onlyForSuccess | data type=string; lov=STATICValid values: always onlyForSuccess |
duplicateSubmissionUrl | string | No | data type=string; maxLen=4000Applies when enableDuplicatePageSubmissions = false |
advanced {
enableMetaTags: false
enableDuplicatePageSubmissions: false
reloadOnSubmit: always
duplicateSubmissionUrl: value
}serverCache
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
caching | enum | Yes | false | data type=string; lov=STATICValid values: false true cacheByUser cacheBySession |
cacheTimeout | enum | Yes | 6Hours | data type=string; lov=STATICValid values: 10Seconds 1Minute 10Minutes 30Minutes 1Hour 2Hours 3Hours 4Hours 6Hours 12Hours 1Day 2Days 3Days 4Days 1Week 2Weeks 4Weeks 10Weeks 1Year |
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 never | |
sqlQuery | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type in (rowsReturned)type in (noRowsReturned) | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: sql plsql javaScript-mleApplies when type = expression |
sqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = expression and language = sql | |
plsqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = expression and language = plsql | |
javaScriptExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = expression and language = javaScript-mle | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: plsql javaScript-mleApplies when type = functionBody |
plsqlFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = functionBody and language = plsql | |
javaScriptFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type = functionBody and language = javaScript-mle | |
value | string | Yes | data type=string; maxLen=4000Applies when type 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) | |
item | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when type 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) | |
preference | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when type in (userPreference=value)type in (userPreference!=value) | |
page | integer | Yes | data type=integer; maxLen=4000Applies when type in (currentPage=page)type in (currentPage!=page) | |
pages | array of integers | Yes | data type=integer; maxLen=4000Applies when type in (currentPageInList)type in (currentPageNotInList) | |
text | string | Yes | data type=string; maxLen=4000Applies when type in (textIsContainedInItem)type in (textIsContainedInValue)type in (textIsNotContainedInValue)type in (text=value)type in (text!=value) | |
value | string | Yes | data type=string; maxLen=4000Applies when type 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 (userPreference=value)type in (userPreference!=value) | |
list | array of strings | Yes | data type=string; maxLen=4000Applies when type in (itemIsInColonDelimitedList)type in (itemIsNotInColonDelimitedList) | |
item | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when type = textIsContainedInItem | |
value | string | Yes | data type=string; maxLen=4000Applies when type in (textIsContainedInValue)type in (textIsNotContainedInValue)type in (text=value)type in (text!=value) |
serverCache {
caching: false
cacheTimeout: "10Seconds"
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
]
}errorHandling
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
inLineErrorNotificationText | multiline string | No | data type=multiline string; maxLen=4000 | |
errorHandlingFunctionName | string | No | data type=string; maxLen=255 |
errorHandling {
inLineErrorNotificationText: ```
value
```
errorHandlingFunctionName: value
}help
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
helpText | multiline string | No | data type=multiline string; maxLen=32767 |
help {
helpText: ```html
value
```
}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
page sample (
page: 42
name: value
alias: value
title: value
pageGroup: @component
appearance {
pageMode: normal
pageTemplate: @component
dialogTemplate: @component
templateOptions: [
value
value
]
cssClasses: [
value
value
]
mediaType: value
}
dialog {
width: value
height: value
maxWidth: value
attributes: [
value
value
]
cssClasses: [
value
value
]
chained: false
resizable: false
}
navigationMenu {
overrideUserInterfaceLevel: false
list: @component
listPosition: top
listTemplate: @component
templateOptions: [
value
value
]
}
navigation {
cursorFocus: firstItemOnPage
warnOnUnsavedChanges: false
}
javaScript {
fileUrls: [
value
value
]
functionAndGlobalVariableDeclaration: ```javascript-browser
value
```
executeWhenPageLoads: ```javascript-browser
value
```
includeStandardJavaScriptAndCss: false
}
css {
fileUrls: [
value
value
]
inline: ```css
value
```
}
htmlHeader {
htmlHeader: ```html
value
```
pageHtmlBodyAttribute: ```
value
```
}
headerAndFooter {
headerText: ```html
value
```
bodyHeader: ```html
value
```
footerText: ```html
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
]
}
security {
authorizationScheme: mustNotBePublicUser
authentication: required
deepLinking: true
pageAccessProtection: unrestricted
formAutoComplete: true
browserCache: true
}
sessionManagement {
rejoinSessions: false
}
advanced {
enableMetaTags: false
enableDuplicatePageSubmissions: false
reloadOnSubmit: always
duplicateSubmissionUrl: value
}
serverCache {
caching: false
cacheTimeout: "10Seconds"
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
]
}
errorHandling {
inLineErrorNotificationText: ```
value
```
errorHandlingFunctionName: value
}
help {
helpText: ```html
value
```
}
config {
buildOption: @component
}
comments {
comments: ```
value
```
}
)