menu
Parent: button
Applies when
type = menuChildren: triggerActiontype = menuEntry and type = triggerAction
Direct Properties:
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
type | enum | Yes | menuEntry | data type=string; lov=STATICValid values: menuEntry subMenu separator |
label | string | Yes | data type=string; maxLen=255Applies when type in (menuEntry)type in (subMenu)Enter the text to be displayed in the menu. | |
parentMenu | reference | No | data type=reference; lov=COMPONENT; references=menu |
Property Groups:
- layout
- behavior
- appearance
- serverSideCondition
- advanced
- security
- config
- comments
layout
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
sequence | number | Yes | data type=number; maxLen=22Enter the display sequence for this menu entry. This is used to evaluate the display condition and render in the order defined. |
layout {
sequence: 42
}behavior
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
type | enum | Yes | redirectThisApp | data type=string; lov=STATICValid values: redirectThisApp redirectOtherApp redirectUrl triggerActionApplies when type = menuEntry |
target | complex | Yes | data type=complex; maxLen=32767Applies when type = menuEntry and type = redirectThisApp | |
target | complex | Yes | data type=complex; maxLen=32767Applies when type = menuEntry and type = redirectOtherApp | |
targetUrl | string | Yes | data type=string; maxLen=4000Applies when type = menuEntry and type = redirectUrl | |
linkAttributes | string | No | data type=string; maxLen=4000Applies when type = menuEntry and type in (redirectThisApp)type = menuEntry and type in (redirectOtherApp)type = menuEntry and type in (redirectUrl) |
behavior {
type: redirectThisApp
target: {
page: value
items: [
value
value
]
clearCache: value
action: value
request: value
anchor: value
session: "&SESSION."
debug: "&DEBUG."
printerFriendly: N
otherArgs: value
}
targetUrl: value
linkAttributes: value
}appearance
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
icon | string | No | data type=string; maxLen=255Applies when type in (menuEntry)type in (subMenu) |
appearance {
icon: 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 type in (menuEntry)type in (subMenu) | |
sqlQuery | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type in (menuEntry) and type in (rowsReturned)type in (menuEntry) and type in (noRowsReturned)type in (subMenu) and type in (rowsReturned)type in (subMenu) and type in (noRowsReturned) | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: sql plsql javaScript-mleApplies when type in (menuEntry) and type = expressiontype in (subMenu) and type = expression |
sqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type in (menuEntry) and type = expression and language = sqltype in (subMenu) and type = expression and language = sql | |
plsqlExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type in (menuEntry) and type = expression and language = plsqltype in (subMenu) and type = expression and language = plsql | |
javaScriptExpression | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type in (menuEntry) and type = expression and language = javaScript-mletype in (subMenu) and type = expression and language = javaScript-mle | |
language | enum | Yes | plsql | data type=string; lov=STATICValid values: plsql javaScript-mleApplies when type in (menuEntry) and type = functionBodytype in (subMenu) and type = functionBody |
plsqlFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type in (menuEntry) and type = functionBody and language = plsqltype in (subMenu) and type = functionBody and language = plsql | |
javaScriptFunctionBody | multiline string | Yes | data type=multiline string; maxLen=4000Applies when type in (menuEntry) and type = functionBody and language = javaScript-mletype in (subMenu) and type = functionBody and language = javaScript-mle | |
value | string | Yes | data type=string; maxLen=4000Applies when type in (menuEntry) and type in (request=Value)type in (menuEntry) and type in (request!=Value)type in (menuEntry) and type in (requestIsContainedInValue)type in (menuEntry) and type in (requestIsNotContainedInValue)type in (menuEntry) and type in (currentLanguageIsContainedInValue)type in (menuEntry) and type in (currentLanguageIsNotContainedInValue)type in (menuEntry) and type in (currentLanguage!=value)type in (menuEntry) and type in (currentLanguage=value)type in (menuEntry) and type in (cgiEnvDadName=value)type in (menuEntry) and type in (cgiEnvDadName!=value)type in (menuEntry) and type in (cgiEnvServerName=value)type in (menuEntry) and type in (cgiEnvServerName!=value)type in (menuEntry) and type in (cgiEnvHttpHost=value)type in (menuEntry) and type in (cgiEnvHttpHost!=value)type in (subMenu) and type in (request=Value)type in (subMenu) and type in (request!=Value)type in (subMenu) and type in (requestIsContainedInValue)type in (subMenu) and type in (requestIsNotContainedInValue)type in (subMenu) and type in (currentLanguageIsContainedInValue)type in (subMenu) and type in (currentLanguageIsNotContainedInValue)type in (subMenu) and type in (currentLanguage!=value)type in (subMenu) and type in (currentLanguage=value)type in (subMenu) and type in (cgiEnvDadName=value)type in (subMenu) and type in (cgiEnvDadName!=value)type in (subMenu) and type in (cgiEnvServerName=value)type in (subMenu) and type in (cgiEnvServerName!=value)type in (subMenu) and type in (cgiEnvHttpHost=value)type in (subMenu) and type in (cgiEnvHttpHost!=value) | |
item | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when type in (menuEntry) and type in (item=value)type in (menuEntry) and type in (item!=value)type in (menuEntry) and type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)type in (menuEntry) and type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2)type in (menuEntry) and type in (itemIsNull)type in (menuEntry) and type in (itemIsNotNull)type in (menuEntry) and type in (itemIsZero)type in (menuEntry) and type in (itemIsNotZero)type in (menuEntry) and type in (itemIsNullOrZero)type in (menuEntry) and type in (itemIsNotNullAndNotZero)type in (menuEntry) and type in (itemContainsNoSpaces)type in (menuEntry) and type in (itemIsNumeric)type in (menuEntry) and type in (itemIsNotNumeric)type in (menuEntry) and type in (itemIsAlphanumeric)type in (menuEntry) and type in (itemIsInColonDelimitedList)type in (menuEntry) and type in (itemIsNotInColonDelimitedList)type in (subMenu) and type in (item=value)type in (subMenu) and type in (item!=value)type in (subMenu) and type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)type in (subMenu) and type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2)type in (subMenu) and type in (itemIsNull)type in (subMenu) and type in (itemIsNotNull)type in (subMenu) and type in (itemIsZero)type in (subMenu) and type in (itemIsNotZero)type in (subMenu) and type in (itemIsNullOrZero)type in (subMenu) and type in (itemIsNotNullAndNotZero)type in (subMenu) and type in (itemContainsNoSpaces)type in (subMenu) and type in (itemIsNumeric)type in (subMenu) and type in (itemIsNotNumeric)type in (subMenu) and type in (itemIsAlphanumeric)type in (subMenu) and type in (itemIsInColonDelimitedList)type in (subMenu) and type in (itemIsNotInColonDelimitedList) | |
preference | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when type in (menuEntry) and type in (userPreference=value)type in (menuEntry) and type in (userPreference!=value)type in (subMenu) and type in (userPreference=value)type in (subMenu) and type in (userPreference!=value) | |
page | integer | Yes | data type=integer; maxLen=4000Applies when type in (menuEntry) and type in (currentPage=page)type in (menuEntry) and type in (currentPage!=page)type in (subMenu) and type in (currentPage=page)type in (subMenu) and type in (currentPage!=page) | |
pages | array of integers | Yes | data type=integer; maxLen=4000Applies when type in (menuEntry) and type in (currentPageInList)type in (menuEntry) and type in (currentPageNotInList)type in (subMenu) and type in (currentPageInList)type in (subMenu) and type in (currentPageNotInList) | |
text | string | Yes | data type=string; maxLen=4000Applies when type in (menuEntry) and type in (textIsContainedInItem)type in (menuEntry) and type in (textIsContainedInValue)type in (menuEntry) and type in (textIsNotContainedInValue)type in (menuEntry) and type in (text=value)type in (menuEntry) and type in (text!=value)type in (subMenu) and type in (textIsContainedInItem)type in (subMenu) and type in (textIsContainedInValue)type in (subMenu) and type in (textIsNotContainedInValue)type in (subMenu) and type in (text=value)type in (subMenu) and type in (text!=value) | |
value | string | Yes | data type=string; maxLen=4000Applies when type in (menuEntry) and type in (item=value)type in (menuEntry) and type in (item!=value)type in (menuEntry) and type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)type in (menuEntry) and type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2)type in (subMenu) and type in (item=value)type in (subMenu) and type in (item!=value)type in (subMenu) and type in (VALUE_OF_ITEM_IN_COND_1_EQ_COND_2)type in (subMenu) and type in (VALUE_OF_ITEM_IN_COND_1_NOT_EQ_COND_2) | |
list | array of strings | Yes | data type=string; maxLen=4000Applies when type in (menuEntry) and type in (itemIsInColonDelimitedList)type in (menuEntry) and type in (itemIsNotInColonDelimitedList)type in (subMenu) and type in (itemIsInColonDelimitedList)type in (subMenu) and type in (itemIsNotInColonDelimitedList) | |
item | string | Yes | data type=string; maxLen=4000; textCase=UPPERApplies when type in (menuEntry) and type = textIsContainedInItemtype in (subMenu) and type = textIsContainedInItem | |
value | string | Yes | data type=string; maxLen=4000Applies when type in (menuEntry) and type in (textIsContainedInValue)type in (menuEntry) and type in (textIsNotContainedInValue)type in (menuEntry) and type in (text=value)type in (menuEntry) and type in (text!=value)type in (subMenu) and type in (textIsContainedInValue)type in (subMenu) and type in (textIsNotContainedInValue)type in (subMenu) and type in (text=value)type in (subMenu) 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
]
}advanced
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
staticId | string | Yes | data type=string; maxLen=255 |
advanced {
staticId: value
}security
| Property | Type | Required | Default Value | Details |
|---|---|---|---|---|
authorizationScheme | enum | No | data type=reference; lov=COMPONENT; references=authorizationValid values: mustNotBePublicUserApplies when type in (menuEntry)type in (subMenu) |
security {
authorizationScheme: mustNotBePublicUser
}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
menu sample (
type: menuEntry
label: value
parentMenu: @component
layout {
sequence: 42
}
behavior {
type: redirectThisApp
target: {
page: value
items: [
value
value
]
clearCache: value
action: value
request: value
anchor: value
session: "&SESSION."
debug: "&DEBUG."
printerFriendly: N
otherArgs: value
}
targetUrl: value
linkAttributes: value
}
appearance {
icon: 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
]
}
advanced {
staticId: value
}
security {
authorizationScheme: mustNotBePublicUser
}
config {
buildOption: @component
}
comments {
comments: ```
value
```
}
)