menu

Parent: button

Applies whentype = menu

Children: triggerActiontype = menuEntry and type = triggerAction

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
typeenumYesmenuEntrydata type=string; lov=STATIC
Valid values: menuEntry subMenu separator
labelstringYesdata type=string; maxLen=255
Applies whentype in (menuEntry)type in (subMenu)
Enter the text to be displayed in the menu.
parentMenureferenceNodata type=reference; lov=COMPONENT; references=menu

Property Groups:

  • layout
  • behavior
  • appearance
  • serverSideCondition
  • advanced
  • security
  • config
  • comments
layout
PropertyTypeRequiredDefault ValueDetails
sequencenumberYesdata type=number; maxLen=22
Enter 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
PropertyTypeRequiredDefault ValueDetails
typeenumYesredirectThisAppdata type=string; lov=STATIC
Valid values: redirectThisApp redirectOtherApp redirectUrl triggerAction
Applies whentype = menuEntry
targetcomplexYesdata type=complex; maxLen=32767
Applies whentype = menuEntry and type = redirectThisApp
targetcomplexYesdata type=complex; maxLen=32767
Applies whentype = menuEntry and type = redirectOtherApp
targetUrlstringYesdata type=string; maxLen=4000
Applies whentype = menuEntry and type = redirectUrl
linkAttributesstringNodata type=string; maxLen=4000
Applies whentype = 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
PropertyTypeRequiredDefault ValueDetails
iconstringNodata type=string; maxLen=255
Applies whentype in (menuEntry)type in (subMenu)
appearance {
  icon: 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
Applies whentype in (menuEntry)type in (subMenu)
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype 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)
languageenumYesplsqldata type=string; lov=STATIC
Valid values: sql plsql javaScript-mle
Applies whentype in (menuEntry) and type = expressiontype in (subMenu) and type = expression
sqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype in (menuEntry) and type = expression and language = sqltype in (subMenu) and type = expression and language = sql
plsqlExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype in (menuEntry) and type = expression and language = plsqltype in (subMenu) and type = expression and language = plsql
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype in (menuEntry) and type = expression and language = javaScript-mletype in (subMenu) and type = expression and language = javaScript-mle
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whentype in (menuEntry) and type = functionBodytype in (subMenu) and type = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype in (menuEntry) and type = functionBody and language = plsqltype in (subMenu) and type = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype in (menuEntry) and type = functionBody and language = javaScript-mletype in (subMenu) and type = functionBody and language = javaScript-mle
valuestringYesdata type=string; maxLen=4000
Applies whentype 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)
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype 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)
preferencestringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype 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)
pageintegerYesdata type=integer; maxLen=4000
Applies whentype 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)
pagesarray of integersYesdata type=integer; maxLen=4000
Applies whentype 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)
textstringYesdata type=string; maxLen=4000
Applies whentype 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)
valuestringYesdata type=string; maxLen=4000
Applies whentype 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)
listarray of stringsYesdata type=string; maxLen=4000
Applies whentype 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)
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype in (menuEntry) and type = textIsContainedInItemtype in (subMenu) and type = textIsContainedInItem
valuestringYesdata type=string; maxLen=4000
Applies whentype 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
PropertyTypeRequiredDefault ValueDetails
staticIdstringYesdata type=string; maxLen=255
advanced {
  staticId: value
}
security
PropertyTypeRequiredDefault ValueDetails
authorizationSchemeenumNodata type=reference; lov=COMPONENT; references=authorization
Valid values: mustNotBePublicUser
Applies whentype in (menuEntry)type in (subMenu)
security {
  authorizationScheme: mustNotBePublicUser
}
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

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
        ```
    }
)