action (addClass)

Parent: action

Applies whentype = addClass

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
namestringNodata type=string; maxLen=255
Enter the name of the action. This helps to identify what the action does in Page Designer.
actionenumYesdata type=string; lov=PLUGINS
Valid values: addClass

Property Groups:

  • settings
  • genAI
  • affectedElements
  • execution
  • clientSideCondition
  • serverSideCondition
  • security
  • config
  • advanced
  • comments
settings
PropertyTypeRequiredDefault ValueDetails
classstringYesdata type=string; maxLen=4000
settings {
  class: value
}
genAI
PropertyTypeRequiredDefault ValueDetails
enabledbooleanYesfalsedata type=boolean
agentreferenceNodata type=reference; lov=COMPONENT; references=aiAgent
Applies whenenabled = true
servicereferenceNodata type=reference; lov=COMPONENT; references=genAIService
Applies whenenabled = true
systemPromptmultiline stringNodata type=multiline string; maxLen=32767
Applies whenenabled = true
welcomeMessagemultiline stringNodata type=multiline string; maxLen=32767
Applies whenenabled = true
itemsToSubmitarray of stringsNodata type=string; maxLen=4000; textCase=UPPER
Applies whenenabled = true
genAI {
  enabled: false
  agent: @component
  service: @component
  systemPrompt: ```
    value
  ```
  welcomeMessage: ```html
    value
  ```
  itemsToSubmit: [
    value
    value
  ]
}
affectedElements
PropertyTypeRequiredDefault ValueDetails
selectionTypeenumNodata type=string; lov=STATIC
Valid values: items button region columns domObject jquerySelector javaScriptExpression triggeringElement eventSource
regionreferenceYesdata type=reference; lov=COMPONENT; references=region
Applies whenselectionType = region
columnsarray of stringsYesdata type=string; maxLen=4000; textCase=UPPER
Applies whenselectionType = columns
buttonreferenceYesdata type=reference; lov=COMPONENT; references=button
Applies whenselectionType = button
itemsarray of stringsYesdata type=string; maxLen=4000; textCase=UPPER
Applies whenselectionType = items
domObjectstringYesdata type=string; maxLen=4000
Applies whenselectionType = domObject
jquerySelectorstringYesdata type=string; maxLen=4000
Applies whenselectionType = jquerySelector
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whenselectionType = javaScriptExpression
affectedElements {
  selectionType: items
  region: @component
  columns: [
    value
    value
  ]
  button: @component
  items: [
    value
    value
  ]
  domObject: value
  jquerySelector: value
  javaScriptExpression: ```javascript-browser
    value
  ```
}
execution
PropertyTypeRequiredDefault ValueDetails
sequencenumberYesdata type=number; maxLen=22
eventreferenceYesdata type=reference; lov=COMPONENT; references=dynamicAction
fireWhenEventResultIsenumYestruedata type=string; lov=STATIC
Valid values: true false
fireOnInitbooleanYestruedata type=boolean
stopExecutionOnErrorbooleanYestruedata type=boolean
waitForResultbooleanYestruedata type=boolean
execution {
  sequence: 42
  event: @component
  fireWhenEventResultIs: true
  fireOnInit: false
  stopExecutionOnError: false
  waitForResult: false
}
clientSideCondition
PropertyTypeRequiredDefault ValueDetails
typeenumNodata type=string; lov=STATIC
Valid values: item=value item!=value item>value item>=value item<value item<=value itemIsNull itemIsNotNull itemIsInList itemIsNotInList jsExpression
Applies whenregion does not support IG_REGION
Specify a client-side condition, to control whether the action fires.
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whenregion does not support IG_REGION and type in (item=value)region does not support IG_REGION and type in (item!=value)region does not support IG_REGION and type in (item>value)region does not support IG_REGION and type in (item>=value)region does not support IG_REGION and type in (item<value)region does not support IG_REGION and type in (item<=value)region does not support IG_REGION and type in (itemIsNull)region does not support IG_REGION and type in (itemIsNotNull)region does not support IG_REGION and type in (itemIsInList)region does not support IG_REGION and type in (itemIsNotInList)

Enter the page item used in this condition. You can type in the name or pick from the list of available items.

valuestringYesdata type=string; maxLen=4000
Applies whenregion does not support IG_REGION and type in (item=value)region does not support IG_REGION and type in (item!=value)region does not support IG_REGION and type in (item>value)region does not support IG_REGION and type in (item>=value)region does not support IG_REGION and type in (item<value)region does not support IG_REGION and type in (item<=value)
listarray of stringsYesdata type=string; maxLen=4000
Applies whenregion does not support IG_REGION and type in (itemIsInList)region does not support IG_REGION and type in (itemIsNotInList)
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whenregion does not support IG_REGION and type = jsExpression
typeenumNodata type=string; lov=STATIC
Valid values: itemColumn=value itemColumn!=value itemColumn>value itemColumn>=value itemColumn<value itemColumn<=value itemColumnIsNull itemColumnIsNotNull itemColumnIsInList itemColumnIsNotInList jsExpression
Applies whenregion supports IG_REGION
Specify a client-side condition, to control whether the action fires.
componentTypeenumYescolumndata type=string; lov=STATIC
Valid values: item column
Applies whentype in (itemColumn=value)type in (itemColumn!=value)type in (itemColumn>value)type in (itemColumn>=value)type in (itemColumn<value)type in (itemColumn<=value)type in (itemColumnIsNull)type in (itemColumnIsNotNull)type in (itemColumnIsInList)type in (itemColumnIsNotInList)region supports IG_REGION and type in (itemColumn=value)region supports IG_REGION and type in (itemColumn!=value)region supports IG_REGION and type in (itemColumn>value)region supports IG_REGION and type in (itemColumn>=value)region supports IG_REGION and type in (itemColumn<value)region supports IG_REGION and type in (itemColumn<=value)region supports IG_REGION and type in (itemColumnIsNull)region supports IG_REGION and type in (itemColumnIsNotNull)region supports IG_REGION and type in (itemColumnIsInList)region supports IG_REGION and type in (itemColumnIsNotInList)
itemstringYesdata type=string; maxLen=4000; textCase=UPPER
Applies whentype in (itemColumn=value) and componentType = itemtype in (itemColumn!=value) and componentType = itemtype in (itemColumn>value) and componentType = itemtype in (itemColumn>=value) and componentType = itemtype in (itemColumn<value) and componentType = itemtype in (itemColumn<=value) and componentType = itemtype in (itemColumnIsNull) and componentType = itemtype in (itemColumnIsNotNull) and componentType = itemtype in (itemColumnIsInList) and componentType = itemtype in (itemColumnIsNotInList) and componentType = itemregion supports IG_REGION and type in (itemColumn=value) and componentType = itemregion supports IG_REGION and type in (itemColumn!=value) and componentType = itemregion supports IG_REGION and type in (itemColumn>value) and componentType = itemregion supports IG_REGION and type in (itemColumn>=value) and componentType = itemregion supports IG_REGION and type in (itemColumn<value) and componentType = itemregion supports IG_REGION and type in (itemColumn<=value) and componentType = itemregion supports IG_REGION and type in (itemColumnIsNull) and componentType = itemregion supports IG_REGION and type in (itemColumnIsNotNull) and componentType = itemregion supports IG_REGION and type in (itemColumnIsInList) and componentType = itemregion supports IG_REGION and type in (itemColumnIsNotInList) and componentType = item
columnstringYesdata type=string; maxLen=4000
Applies whentype in (itemColumn=value) and componentType = columntype in (itemColumn!=value) and componentType = columntype in (itemColumn>value) and componentType = columntype in (itemColumn>=value) and componentType = columntype in (itemColumn<value) and componentType = columntype in (itemColumn<=value) and componentType = columntype in (itemColumnIsNull) and componentType = columntype in (itemColumnIsNotNull) and componentType = columntype in (itemColumnIsInList) and componentType = columntype in (itemColumnIsNotInList) and componentType = columnregion supports IG_REGION and type in (itemColumn=value) and componentType = columnregion supports IG_REGION and type in (itemColumn!=value) and componentType = columnregion supports IG_REGION and type in (itemColumn>value) and componentType = columnregion supports IG_REGION and type in (itemColumn>=value) and componentType = columnregion supports IG_REGION and type in (itemColumn<value) and componentType = columnregion supports IG_REGION and type in (itemColumn<=value) and componentType = columnregion supports IG_REGION and type in (itemColumnIsNull) and componentType = columnregion supports IG_REGION and type in (itemColumnIsNotNull) and componentType = columnregion supports IG_REGION and type in (itemColumnIsInList) and componentType = columnregion supports IG_REGION and type in (itemColumnIsNotInList) and componentType = column
valuestringYesdata type=string; maxLen=4000
Applies whentype in (itemColumn=value)type in (itemColumn!=value)type in (itemColumn>value)type in (itemColumn>=value)type in (itemColumn<value)type in (itemColumn<=value)region supports IG_REGION and type in (itemColumn=value)region supports IG_REGION and type in (itemColumn!=value)region supports IG_REGION and type in (itemColumn>value)region supports IG_REGION and type in (itemColumn>=value)region supports IG_REGION and type in (itemColumn<value)region supports IG_REGION and type in (itemColumn<=value)
listarray of stringsYesdata type=string; maxLen=4000
Applies whentype in (itemColumnIsInList)type in (itemColumnIsNotInList)region supports IG_REGION and type in (itemColumnIsInList)region supports IG_REGION and type in (itemColumnIsNotInList)
javaScriptExpressionmultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype = jsExpressionregion supports IG_REGION and type = jsExpression
clientSideCondition {
  type: "item=value"
  item: value
  value: value
  list: [
    value
    value
  ]
  javaScriptExpression: ```javascript-browser
    value
  ```
  componentType: item
  column: 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
Select a condition type to be met in order for this action to be active.
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
  ]
}
security
PropertyTypeRequiredDefault ValueDetails
authorizationSchemeenumNodata type=reference; lov=COMPONENT; references=authorization
Valid values: mustNotBePublicUser
security {
  authorizationScheme: mustNotBePublicUser
}
config
PropertyTypeRequiredDefault ValueDetails
buildOptionreferenceNodata type=reference; lov=COMPONENT; references=buildOption
config {
  buildOption: @component
}
advanced
PropertyTypeRequiredDefault ValueDetails
staticIdstringYesdata type=string; maxLen=255
initJavaScriptFunctionmultiline stringNodata type=multiline string; maxLen=4000
advanced {
  staticId: value
  initJavaScriptFunction: ```javascript-browser
    value
  ```
}
comments
PropertyTypeRequiredDefault ValueDetails
commentsmultiline stringNodata type=multiline string; maxLen=4000
comments {
  comments: ```
    value
  ```
}

APEXlang Example

action sample (
    name: value
    action: addClass
    settings {
        class: value
    }
    genAI {
        enabled: false
        agent: @component
        service: @component
        systemPrompt: ```
          value
        ```
        welcomeMessage: ```html
          value
        ```
        itemsToSubmit: [
          value
          value
        ]
    }
    affectedElements {
        selectionType: items
        region: @component
        columns: [
          value
          value
        ]
        button: @component
        items: [
          value
          value
        ]
        domObject: value
        jquerySelector: value
        javaScriptExpression: ```javascript-browser
          value
        ```
    }
    execution {
        sequence: 42
        event: @component
        fireWhenEventResultIs: true
        fireOnInit: false
        stopExecutionOnError: false
        waitForResult: false
    }
    clientSideCondition {
        type: "item=value"
        item: value
        value: value
        list: [
          value
          value
        ]
        javaScriptExpression: ```javascript-browser
          value
        ```
        componentType: item
        column: 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
    }
    advanced {
        staticId: value
        initJavaScriptFunction: ```javascript-browser
          value
        ```
    }
    comments {
        comments: ```
          value
        ```
    }
)