ListViewColumn

Contains metadata about a single list view column.

The ListViewColumn object is returned by the describeSoqlListViews() and executeListView() calls. ListViewColumn has these properties.

NameTypeDescription
ascendingLabelstringThe localized type-specific label for sorting the column in ascending order. For example: “A-Z” for a text field, or “Low to High” for a numeric field. Set to null if the column isn’t sortable.
descendingLabelstringThe localized type-specific label for sorting the column in ascending order. For example: “Z-A” for a text field, or “High to Low” for a numeric field. Set to null if the column isn’t sortable.
fieldNameOrPathstringThe field name or SOQL field path for the column.
hiddenbooleanIf true, specifies that the column isn’t displayed, and is present only to support the display of other columns or other client-side logic.
labelstringThe localized display label for the column.
searchablebooleanWhether the column is searchable.
selectListItemstringThe SOQL SELECT item for the column. The item can differ from the field name or path, due to display formatting (for example, toLabel for picklists).
sortDirectionorderByDirectionAn enumerated value, one of the following if the column is sortable:
  • ascending
  • descending
Set to null if the column isn’t sortable.
sortIndexintThe zero-based index that indicates the column’s position within a multilevel sort, or null if the records aren’t sorted by the column.
sortablebooleanWhether the column is sortable, in which case it can be referenced in the ExecuteListView orderBy parameter.
typeFieldTypeThe column data type.