button - APEXlang Reference

`button`

Parent: page

Children: menutype = menu, triggerActiontype = standard and action = triggerAction

Direct Properties:

Property	Type	Required	Default Value	Details
`buttonName`	`string`	Yes		data type=`string`; maxLen=255 Enter the name used to reference the button being clicked. When this page is submitted, the value of REQUEST is set to this button name.
`label`	`string`	Yes		data type=`string`; maxLen=255

Property Groups:

layout

Property	Type	Required	Default Value	Details
`sequence`	`number`	Yes		data type=`number`; maxLen=22
`region`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`region` Select the region in which the button will be displayed.
`slot`	`string`	Yes		data type=`string`; lov=`SLOTS`
`startNewLayout`	`boolean`	Yes	`false`	data type=`boolean`
`startNewRow`	`boolean`	Yes	`true`	data type=`boolean` Applies when`startNewLayout = false`
`rowCssClasses`	`array of strings`	No		data type=`string`; maxLen=255
`column`	`string`	No		data type=`string`; lov=`GRID_COLUMNS`
`newColumn`	`boolean`	Yes	`true`	data type=`boolean` Applies when`startNewLayout = false and startNewRow = false`
`columnSpan`	`string`	No		data type=`string`; lov=`GRID_COLUMNS`
`rowSpan`	`number`	No		data type=`number`; maxLen=22
`columnCssClasses`	`array of strings`	No		data type=`string`; maxLen=255
`columnAttributes`	`array of strings`	No		data type=`string`; maxLen=255
`horizontalAlignment`	`enum`	Yes	`right`	data type=`string`; lov=`STATIC` Valid values: `left` `right` Applies when`slot in (TOP)slot in (TOP_AND_BOTTOM)slot in (ABOVE_BOX)slot in (BELOW_BOX)slot in (BOTTOM)`
`alignment`	`enum`	Yes	`leftCenter`	data type=`string`; lov=`STATIC` Valid values: `center` `centerBottom` `centerCenter` `centerTop` `left` `leftBottom` `leftCenter` `leftTop` `right` `rightBottom` `rightCenter` `rightTop` Applies when`slot = BODY`

layout {
  sequence: 42
  region: @component
  slot: value
  startNewLayout: false
  startNewRow: false
  rowCssClasses: [
    value
    value
  ]
  column: value
  newColumn: false
  columnSpan: value
  rowSpan: 42
  columnCssClasses: [
    value
    value
  ]
  columnAttributes: [
    value
    value
  ]
  horizontalAlignment: left
  alignment: center
}

appearance

Property	Type	Required	Default Value	Details
`buttonTemplate`	`reference`	Yes		data type=`reference`; lov=`COMPONENT`; references=`buttonTemplate`
`hot`	`boolean`	Yes	`false`	data type=`boolean`
`showAsDisabled`	`boolean`	Yes	`false`	data type=`boolean` Applies when`buttonTemplate supports IS_DISABLED` Specify whether to render the button or menu entries as disabled instead of hiding them if the defined server-side condition evaluates to FALSE.
`templateOptions`	`array of strings`	No		data type=`string`; lov=`TEMPLATE_OPTIONS`
`cssClasses`	`array of strings`	No		data type=`string`; maxLen=255 Enter classes to add to this component. You may add multiple classes by separating them with spaces.
`icon`	`string`	No		data type=`string`; maxLen=255

appearance {
  buttonTemplate: @component
  hot: false
  showAsDisabled: false
  templateOptions: [
    value
    value
  ]
  cssClasses: [
    value
    value
  ]
  icon: value
}

behavior

Property	Type	Required	Default Value	Details
`type`	`enum`	Yes	`standard`	data type=`string`; lov=`STATIC` Valid values: `standard` `menu`
`action`	`enum`	Yes	`submitPage`	data type=`string`; lov=`STATIC` Valid values: `submitPage` `triggerAction` `redirectThisApp` `redirectOtherApp` `redirectUrl` `definedByDynamicAction` `resetPage` `nextPage` `previousPage` Applies when`type = standard`
`target`	`complex`	Yes		data type=`complex`; maxLen=32767 Applies when`type = standard and action = redirectThisApp` Click the Target to invoke a modal dialog. You can enter the target to be called when this button is clicked. Only enter a target for buttons that should not invoke page processing when clicked (for example, a Cancel button).
`target`	`complex`	Yes		data type=`complex`; maxLen=32767 Applies when`type = standard and action = redirectOtherApp` Click the Target to invoke a modal dialog. You can enter the target to be called when this button is clicked. Only enter a target for buttons that should not invoke page processing when clicked (for example, a Cancel button).
`targetUrl`	`string`	Yes		data type=`string`; maxLen=4000 Applies when`type = standard and action = redirectUrl` Enter the URL to call when this button is clicked. Only enter a target for buttons that should not invoke page processing when clicked, for example a Cancel button.
`executeValidations`	`boolean`	Yes	`true`	data type=`boolean` Applies when`type = standard and action in (submitPage)type = standard and action in (redirectUrl)type = standard and action in (definedByDynamicAction)type = standard and action in (triggerAction)`
`showProcessing`	`boolean`	Yes	`false`	data type=`boolean` Applies when`type = standard and action = submitPage`
`warnOnUnsavedChanges`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `doNotCheck` Applies when`type = standard`
`databaseAction`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `insert` `update` `delete` Applies when`type = standard`
`requiresConfirmation`	`boolean`	Yes	`false`	data type=`boolean` Applies when`type = standard`

behavior {
  type: standard
  action: submitPage
  target: {
    page: value
    items: [
      value
      value
    ]
    clearCache: value
    action: value
    request: value
    anchor: value
    session: "&SESSION."
    debug: "&DEBUG."
    printerFriendly: N
    otherArgs: value
  }
  targetUrl: value
  executeValidations: false
  showProcessing: false
  warnOnUnsavedChanges: doNotCheck
  databaseAction: insert
  requiresConfirmation: false
}

confirmation

Property	Type	Required	Default Value	Details
`message`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = standard and requiresConfirmation = true`
`style`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `information` `warning` `danger` `success` Applies when`type = standard and requiresConfirmation = true`

confirmation {
  message: ```html
    value
  ```
  style: information
}

advanced

Property	Type	Required	Details
`htmlDomId`	`string`	No	data type=`string`; maxLen=255 Enter the DOM ID for the button. If defined, the DOM ID is used as the ID for the button. The DOM ID can be useful when developing custom JavaScript behavior for the button. If the DOM ID is not defined, the button generates an internal ID. Note: The template must include the `#DOM_ID#` substitution string, in order for the button to utilize the DOM ID entered.
`staticId`	`string`	Yes	data type=`string`; maxLen=255
`customAttributes`	`string`	No	data type=`string`; maxLen=2000 Enter HTML text to include for this button: For buttons of type HTML Button, this text is added to the HTML element definition. For buttons based on templates, your template must include the `#BUTTON_ATTRIBUTES#` substitution string. You can use this attribute to control tab stops
`preText`	`multiline string`	No	data type=`multiline string`; maxLen=4000
`postText`	`multiline string`	No	data type=`multiline string`; maxLen=4000
`requestSourceType`	`enum`	No	data type=`string`; lov=`STATIC` Valid values: `staticValue` `databaseColumn` `item` `sqlQuerySingleValue` `sqlQueryMultipleValues` `plsqlExpression` `plsqlFunctionBody` `preference` `null`
`requestSource`	`multiline string`	No	data type=`multiline string`; maxLen=4000 Applies when`requestSourceType is set`

advanced {
  htmlDomId: value
  staticId: value
  customAttributes: value
  preText: ```html
    value
  ```
  postText: ```html
    value
  ```
  requestSourceType: staticValue
  requestSource: ```
    value
  ```
}

serverSideCondition

Property	Type	Required	Default Value	Details
`type`	`enum`	No		data 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`
`sqlQuery`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type in (rowsReturned)type in (noRowsReturned)`
`language`	`enum`	Yes	`plsql`	data type=`string`; lov=`STATIC` Valid values: `sql` `plsql` `javaScript-mle` Applies when`type = expression`
`sqlExpression`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = expression and language = sql`
`plsqlExpression`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = expression and language = plsql`
`javaScriptExpression`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = expression and language = javaScript-mle`
`language`	`enum`	Yes	`plsql`	data type=`string`; lov=`STATIC` Valid values: `plsql` `javaScript-mle` Applies when`type = functionBody`
`plsqlFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = functionBody and language = plsql`
`javaScriptFunctionBody`	`multiline string`	Yes		data type=`multiline string`; maxLen=4000 Applies when`type = functionBody and language = javaScript-mle`
`value`	`string`	Yes		data type=`string`; maxLen=4000 Applies 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=`UPPER` Applies 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=`UPPER` Applies when`type in (userPreference=value)type in (userPreference!=value)`
`page`	`integer`	Yes		data type=`integer`; maxLen=4000 Applies when`type in (currentPage=page)type in (currentPage!=page)`
`pages`	`array of integers`	Yes		data type=`integer`; maxLen=4000 Applies when`type in (currentPageInList)type in (currentPageNotInList)`
`text`	`string`	Yes		data type=`string`; maxLen=4000 Applies 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=4000 Applies 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)`
`list`	`array of strings`	Yes		data type=`string`; maxLen=4000 Applies when`type in (itemIsInColonDelimitedList)type in (itemIsNotInColonDelimitedList)`
`item`	`string`	Yes		data type=`string`; maxLen=4000; textCase=`UPPER` Applies when`type = textIsContainedInItem`
`value`	`string`	Yes		data type=`string`; maxLen=4000 Applies when`type 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
  ]
}

security

Property	Type	Required	Default Value	Details
`authorizationScheme`	`enum`	No		data type=`reference`; lov=`COMPONENT`; references=`authorization` Valid values: `mustNotBePublicUser`

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

button sample (
    buttonName: value
    label: value
    layout {
        sequence: 42
        region: @component
        slot: value
        startNewLayout: false
        startNewRow: false
        rowCssClasses: [
          value
          value
        ]
        column: value
        newColumn: false
        columnSpan: value
        rowSpan: 42
        columnCssClasses: [
          value
          value
        ]
        columnAttributes: [
          value
          value
        ]
        horizontalAlignment: left
        alignment: center
    }
    appearance {
        buttonTemplate: @component
        hot: false
        showAsDisabled: false
        templateOptions: [
          value
          value
        ]
        cssClasses: [
          value
          value
        ]
        icon: value
    }
    behavior {
        type: standard
        action: submitPage
        target: {
          page: value
          items: [
            value
            value
          ]
          clearCache: value
          action: value
          request: value
          anchor: value
          session: "&SESSION."
          debug: "&DEBUG."
          printerFriendly: N
          otherArgs: value
        }
        targetUrl: value
        executeValidations: false
        showProcessing: false
        warnOnUnsavedChanges: doNotCheck
        databaseAction: insert
        requiresConfirmation: false
    }
    confirmation {
        message: ```html
          value
        ```
        style: information
    }
    advanced {
        htmlDomId: value
        staticId: value
        customAttributes: value
        preText: ```html
          value
        ```
        postText: ```html
          value
        ```
        requestSourceType: staticValue
        requestSource: ```
          value
        ```
    }
    serverSideCondition {
        type: always
        sqlQuery: ```sql
          value
        ```
        language: sql
        sqlExpression: ```sql
          value
        ```
        plsqlExpression: ```plsql
          value
        ```
        javaScriptExpression: ```javascript-mle
          value
        ```
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        value: value
        item: value
        preference: value
        page: 42
        pages: [
          42
          42
        ]
        text: value
        list: [
          value
          value
        ]
    }
    security {
        authorizationScheme: mustNotBePublicUser
    }
    config {
        buildOption: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)