column

Parent: region

Applies whentype = classicReport

Direct Properties:

PropertyTypeRequiredDefault ValueDetails
columnNamestringYesdata type=string; maxLen=128
reportColumnQueryIdstringNodata type=string; maxLen=4
derivedColumnstringNodata type=string; maxLen=4
typeenumYesplainTextdata type=string; lov=STATIC
Valid values: plainText plainTextBasedOnLov richText link displayImage downloadBlob percentGraph hidden displayAsTextSavesState datePickerClassic datePicker textField textArea selectList radioGroup hiddenField popupLov popupKeyLov simpleCheckbox rowSelector

Property Groups:

  • heading
  • lov
  • layout
  • accessibility
  • appearance
  • settings
  • blobAttributes
  • link
  • element
  • columnFormatting
  • sorting
  • exportPrinting
  • advanced
  • serverSideCondition
  • security
  • config
  • comments
heading
PropertyTypeRequiredDefault ValueDetails
headingstringNodata type=string; maxLen=4000
alignmentenumYesstartdata type=string; lov=STATIC
Valid values: start center end
heading {
  heading: value
  alignment: start
}
lov
PropertyTypeRequiredDefault ValueDetails
typeenumYesdata type=string; lov=STATIC
Valid values: sharedComponent sqlQuery staticValues functionBody
Applies whentype in (plainTextBasedOnLov)type in (selectList)type in (radioGroup)type in (popupLov)type in (popupKeyLov)
lovreferenceYesdata type=reference; lov=COMPONENT; references=lov
Applies whentype in (plainTextBasedOnLov) and type = sharedComponenttype in (selectList) and type = sharedComponenttype in (radioGroup) and type = sharedComponenttype in (popupLov) and type = sharedComponenttype in (popupKeyLov) and type = sharedComponent
sqlQuerymultiline stringYesdata type=multiline string; maxLen=4000
Applies whentype in (plainTextBasedOnLov) and type = sqlQuerytype in (selectList) and type = sqlQuerytype in (radioGroup) and type = sqlQuerytype in (popupLov) and type = sqlQuerytype in (popupKeyLov) and type = sqlQuery
staticValuesmultiline stringYesSTATIC:Display1;Return1,Display2;Return2data type=multiline string; maxLen=4000
Applies whentype in (plainTextBasedOnLov) and type = staticValuestype in (selectList) and type = staticValuestype in (radioGroup) and type = staticValuestype in (popupLov) and type = staticValuestype in (popupKeyLov) and type = staticValues
languageenumYesplsqldata type=string; lov=STATIC
Valid values: plsql javaScript-mle
Applies whentype in (plainTextBasedOnLov) and type = functionBodytype in (selectList) and type = functionBodytype in (radioGroup) and type = functionBodytype in (popupLov) and type = functionBodytype in (popupKeyLov) and type = functionBody
plsqlFunctionBodymultiline stringYesdata type=multiline string; maxLen=32767
Applies whentype in (plainTextBasedOnLov) and type = functionBody and language = plsqltype in (selectList) and type = functionBody and language = plsqltype in (radioGroup) and type = functionBody and language = plsqltype in (popupLov) and type = functionBody and language = plsqltype in (popupKeyLov) and type = functionBody and language = plsql
javaScriptFunctionBodymultiline stringYesdata type=multiline string; maxLen=32767
Applies whentype in (plainTextBasedOnLov) and type = functionBody and language = javaScript-mletype in (selectList) and type = functionBody and language = javaScript-mletype in (radioGroup) and type = functionBody and language = javaScript-mletype in (popupLov) and type = functionBody and language = javaScript-mletype in (popupKeyLov) and type = functionBody and language = javaScript-mle
checkboxValuesstringYesdata type=string; maxLen=32767
Applies whentype = simpleCheckbox
displayExtraValuesbooleanYestruedata type=boolean
Applies whentype in (selectList)type in (radioGroup)
displayNullValuebooleanYestruedata type=boolean
Applies whentype in (selectList)type in (radioGroup)type in (popupLov)type in (popupKeyLov)
nullDisplayValuestringNodata type=string; maxLen=255
Applies whentype in (selectList) and displayNullValue = truetype in (radioGroup) and displayNullValue = truetype in (popupLov) and displayNullValue = truetype in (popupKeyLov) and displayNullValue = true
nullReturnValuestringNodata type=string; maxLen=255
Applies whentype in (selectList) and displayNullValue = truetype in (radioGroup) and displayNullValue = truetype in (popupLov) and displayNullValue = truetype in (popupKeyLov) and displayNullValue = true
lov {
  type: sharedComponent
  lov: @component
  sqlQuery: ```sql
    value
  ```
  staticValues: ```
    value
  ```
  language: plsql
  plsqlFunctionBody: ```plsql
    value
  ```
  javaScriptFunctionBody: ```javascript-mle
    value
  ```
  checkboxValues: value
  displayExtraValues: false
  displayNullValue: false
  nullDisplayValue: value
  nullReturnValue: value
}
layout
PropertyTypeRequiredDefault ValueDetails
sequencenumberYesdata type=number; maxLen=22
columnAlignmentenumYesstartdata type=string; lov=STATIC
Valid values: start center end
layout {
  sequence: 42
  columnAlignment: start
}
accessibility
PropertyTypeRequiredDefault ValueDetails
valueIdentifiesRowbooleanYesfalsedata type=boolean
imageDescriptionstringNodata type=string; maxLen=255
Applies whentype = displayImage
accessibility {
  valueIdentifiesRow: false
  imageDescription: value
}
appearance
PropertyTypeRequiredDefault ValueDetails
formatMaskstringNodata type=string; maxLen=255
Applies whentype in (plainText)type in (link)type in (displayAsTextSavesState)type in (textField)type in (datePicker)

Enter the format mask to apply to this column. You can type in the format mask or pick from the predefined list, based on a sample representation of how that format mask is displayed.

It is important that number format masks are only applied to columns that contain numbers and date format masks are only applied to columns that contain dates. Otherwise, a runtime error is raised when any record contains a value that can not be converted using the specified format mask.

formatMaskenumYesdata type=string; lov=STATIC
Valid values: useAppDateFormat useAppFormatMask useItemFormatMask ddMmYyyy ddMmYyyyHhMi ddMmYyyyHh24Mi ddMonRr ddMonRrHhMi ddMonRrHh24Mi ddMonYyyy ddMonYyyyHhMi ddMonYyyyHh24Mi mmDdYyyy mmDdYyyyHhMi mmDdYyyyHh24Mi rrMonDd rrMonDdHhMi rrMonDdHh24Mi yyyyDdMm yyyyDdMmHhMi yyyyDdMmHh24Mi yyyyMmDd yyyyMmDdHhMi yyyyMmDdHh24Mi
Applies whentype = datePickerClassic
backgroundColorstringNodata type=string; maxLen=255
Applies whentype = percentGraph
foregroundColorstringNodata type=string; maxLen=255
Applies whentype = percentGraph
barWidthintegerNodata type=integer; maxLen=32767
Applies whentype = percentGraph
widthnumberNodata type=number; maxLen=22
Applies whentype in (textField)type in (textArea)type in (datePickerClassic)type in (datePicker)type in (popupLov)type in (popupKeyLov)
heightnumberNodata type=number; maxLen=22
Applies whentype = textArea
viewFileAsenumYesattachmentdata type=string; lov=STATIC
Valid values: attachment inline
Applies whentype = downloadBlob
templatereferenceNodata type=reference; lov=COMPONENT; references=fieldTemplate
Applies whentype in (displayAsTextSavesState)type in (textField)type in (textArea)type in (datePickerClassic)type in (datePicker)type in (hiddenField)type in (selectList)type in (radioGroup)type in (popupLov)type in (popupKeyLov)type in (simpleCheckbox)
Choose the field template to be used when rendering the tabular form field. When no template is selected, the field is rendered using the default accessibility compliant label.
downloadTextstringNodata type=string; maxLen=255
Applies whentype = downloadBlob
appearance {
  formatMask: useAppDateFormat
  backgroundColor: value
  foregroundColor: value
  barWidth: 42
  width: 42
  height: 42
  viewFileAs: attachment
  template: @component
  downloadText: value
}
settings
PropertyTypeRequiredDefault ValueDetails
formatenumYesmarkdowndata type=string; lov=STATIC
Valid values: html markdown
Applies whentype = richText
settings {
  format: html
}
blobAttributes
PropertyTypeRequiredDefault ValueDetails
tableOwnerstringNodata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
tableNamestringYesdata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
blobColumnstringYesdata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
primaryKeyColumn1stringYesdata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
primaryKeyColumn2stringNodata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
mimeTypeColumnstringNodata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
filenameColumnstringNodata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
lastUpdatedColumnstringNodata type=string; maxLen=32767
Applies whentype in (displayImage)type in (downloadBlob)
charSetColumnstringNodata type=string; maxLen=32767
Applies whentype = downloadBlob
blobAttributes {
  tableOwner: value
  tableName: value
  blobColumn: value
  primaryKeyColumn1: value
  primaryKeyColumn2: value
  mimeTypeColumn: value
  filenameColumn: value
  lastUpdatedColumn: value
  charSetColumn: value
}
link
PropertyTypeRequiredDefault ValueDetails
targetcomplexNodata type=complex; maxLen=32767
Applies whentype in (link)type in (percentGraph)
linkTextstringYesdata type=string; maxLen=4000
Applies whentype in (link) and target is settype in (percentGraph) and target is set
linkAttributesstringNodata type=string; maxLen=4000
Applies whentype in (link) and target is settype in (percentGraph) and target is set
link {
  target: {
    type: in_app
    url: value
    app: value
    page: value
    items: [
      value
      value
    ]
    clearCache: value
    action: value
    request: value
    anchor: value
    session: "&SESSION."
    debug: "&DEBUG."
    printerFriendly: N
    otherArgs: value
  }
  linkText: value
  linkAttributes: value
}
element
PropertyTypeRequiredDefault ValueDetails
numberOfColumnsintegerNodata type=integer; maxLen=32767
Applies whentype = radioGroup
element {
  numberOfColumns: 42
}
columnFormatting
PropertyTypeRequiredDefault ValueDetails
htmlExpressionmultiline stringNodata type=multiline string; maxLen=4000
Applies whentype = plainText
cssClassesarray of stringsNodata type=string; maxLen=255
Applies whentype in (plainText)type in (link)type in (percentGraph)
cssStylearray of stringsNodata type=string; maxLen=255
Applies whentype in (plainText)type in (link)type in (percentGraph)
highlightWordsstringNodata type=string; maxLen=255
Applies whentype = plainText
columnFormatting {
  htmlExpression: ```html
    value
  ```
  cssClasses: [
    value
    value
  ]
  cssStyle: [
    value
    value
  ]
  highlightWords: value
}
sorting
PropertyTypeRequiredDefault ValueDetails
defaultSequenceenumNodata type=string; lov=STATIC
Valid values: 1 2 3 4 5 6 7 8
directionenumNodata type=string; lov=STATIC
Valid values: desc
Applies whendefaultSequence is set
sortablebooleanYesfalsedata type=boolean
sorting {
  defaultSequence: "1"
  direction: desc
  sortable: false
}
exportPrinting
PropertyTypeRequiredDefault ValueDetails
includeInExportPrintbooleanYestruedata type=boolean
printWidthstringNodata type=string; maxLen=4000
Applies whenincludeInExportPrint = true
exportPrinting {
  includeInExportPrint: false
  printWidth: value
}
advanced
PropertyTypeRequiredDefault ValueDetails
cssClassesarray of stringsNodata type=string; maxLen=255
Applies whentype in (textField)type in (textArea)type in (datePickerClassic)type in (datePicker)type in (hiddenField)type in (selectList)type in (radioGroup)type in (popupLov)type in (popupKeyLov)type in (simpleCheckbox)
customAttributesstringNodata type=string; maxLen=2000
Applies whentype in (textField)type in (textArea)type in (datePickerClassic)type in (datePicker)type in (hiddenField)type in (selectList)type in (radioGroup)type in (popupLov)type in (popupKeyLov)type in (simpleCheckbox)
cellWidthintegerNodata type=integer; maxLen=32767
computeSumbooleanYesfalsedata type=boolean
advanced {
  cssClasses: [
    value
    value
  ]
  customAttributes: value
  cellWidth: 42
  computeSum: false
}
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
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
escapeSpecialCharsbooleanYestruedata type=boolean
Applies whentype in (plainText)type in (link)type in (hidden)type in (plainTextBasedOnLov)
security {
  authorizationScheme: mustNotBePublicUser
  escapeSpecialChars: false
}
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

column sample (
    columnName: value
    reportColumnQueryId: value
    derivedColumn: value
    type: plainText
    heading {
        heading: value
        alignment: start
    }
    lov {
        type: sharedComponent
        lov: @component
        sqlQuery: ```sql
          value
        ```
        staticValues: ```
          value
        ```
        language: plsql
        plsqlFunctionBody: ```plsql
          value
        ```
        javaScriptFunctionBody: ```javascript-mle
          value
        ```
        checkboxValues: value
        displayExtraValues: false
        displayNullValue: false
        nullDisplayValue: value
        nullReturnValue: value
    }
    layout {
        sequence: 42
        columnAlignment: start
    }
    accessibility {
        valueIdentifiesRow: false
        imageDescription: value
    }
    appearance {
        formatMask: useAppDateFormat
        backgroundColor: value
        foregroundColor: value
        barWidth: 42
        width: 42
        height: 42
        viewFileAs: attachment
        template: @component
        downloadText: value
    }
    settings {
        format: html
    }
    blobAttributes {
        tableOwner: value
        tableName: value
        blobColumn: value
        primaryKeyColumn1: value
        primaryKeyColumn2: value
        mimeTypeColumn: value
        filenameColumn: value
        lastUpdatedColumn: value
        charSetColumn: value
    }
    link {
        target: {
          type: in_app
          url: value
          app: value
          page: value
          items: [
            value
            value
          ]
          clearCache: value
          action: value
          request: value
          anchor: value
          session: "&SESSION."
          debug: "&DEBUG."
          printerFriendly: N
          otherArgs: value
        }
        linkText: value
        linkAttributes: value
    }
    element {
        numberOfColumns: 42
    }
    columnFormatting {
        htmlExpression: ```html
          value
        ```
        cssClasses: [
          value
          value
        ]
        cssStyle: [
          value
          value
        ]
        highlightWords: value
    }
    sorting {
        defaultSequence: "1"
        direction: desc
        sortable: false
    }
    exportPrinting {
        includeInExportPrint: false
        printWidth: value
    }
    advanced {
        cssClasses: [
          value
          value
        ]
        customAttributes: value
        cellWidth: 42
        computeSum: false
    }
    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
        escapeSpecialChars: false
    }
    config {
        buildOption: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)