Format Column API

Provides run-time access to the Format Column function and Format Column State

Format Column API Methods

MethodDescription
addFormatColumn(formatColumn)Adds a Format Column to Format Column
applyFormatColumnDisplayFormats()Applies display format for all Format Columns in AdapTable State
deleteAllFormatColumn()Deletes all Format Columns in Adaptable State
deleteFormatColumn(formatColumn)Deletes an existing Format Column
editFormatColumn(formatColumn)Edits the Format Column
getAllFormatColumn()Retrieves all Format Columns in Adaptable State
getAllFormatColumnWithCellAlignment()Retrieves all Format Columns in Adaptable State with CellAlignment property set
getAllFormatColumnWithDisplayFormat()Retrieves all Format Columns in Adaptable State with DisplayFormat property set
getAllFormatColumnWithStyle()Retrieves all Format Columns in Adaptable State with the Style property set
getFormatColumnForColumn(column)Gets Format Column, if any, for given Column
getFormatColumnForColumnId(columnId)Gets Format Column, if any, for given ColumnId
getFormatColumnState()Retrieves Format Column section from Adaptable State
getFormatColumnWithDisplayFormatForColumn(column)Will get the most appropriate one i.e. first named Column, then DataType, then All
getFormatColumnWithStyleClassNameForColumn(column)Gets Format Column if any for given Column which includes Style element with ClassName
getFormatColumnWithStyleForColumn(column)Gets Format Column if any for given Column which includes Style element
hasStyleFormatColumns()Returns true if Format State includes Format Columns with a Style property
showFormatColumnPopup()Opens the Format Column popup screen

See API documentation for full details of all available functions with lists of parameters

More Information