DataPA Enterprise Dashboard Controls API Reference

The GroupColumn type exposes the following members.

Constructors

  Name Description
Public method GroupColumn()()()()
Creates and returns a new GroupColumn object.
Public method GroupColumn(GroupColumns, DataColumn, String, String)
Creates and returns a new GroupColumn object.

Methods

  Name Description
Public method GetObjectData
Protected method SetObjectData

Properties

  Name Description
Public property ColumnName
Gets the name of this group column.
Public property DataGridFont
Gets and sets the bespoke font that will be used to render this column in a datagrid if DataGridUseBespokeFont is true.
Public property DataGridFormatColumn
Gets and sets a column from the query data source that will be used to provide the format value for this column.
Public property DataGridFormatType
Gets and sets a value that indicates how to derive the format string for this column when displayed in a data grid.
Public property DataGridTextColor
Gets and sets the colour of the text used for this column in a data grid if DataGridUseBespokeFont is true.
Public property DataGridUseBespokeFont
Gets and sets a value that indicates if this column should use a bespoke font when rendered in a data grid.
Public property DateColumn
Gets a value that indicates if this GroupColumn represents a date value.
Public property DateGroupType
Gets and sets a value that indicates how date values should be grouped.
Public property DateTimeColumn
Gets a value that indicates if this GroupColumn represents a DateTime value.
Public property Editable
Gets and sets a property that indicates if this column is editable in a datagrid.
Public property forceTrailingZeros
Gets and sets a value that indicates whether all labels should have the number of decimal digits specified by numberDecimals, even if it requires trailing zeros.
Public property Format
Gets or sets the format string for this group column.
Public property GroupBasedOnColumn
Gets a value SummaryColumn object that indicates which summary column is used to evaluate which group columns to include when ShowGroupType is not SummaryData.SummaryDataShowGroupType.All.
Public property GroupColumns
Gets and sets a child GroupColumns object for this group column.
Public property GUID
Gets a GUID that uniquely identifies this object.
Public property Hidden
Gets and sets a value that indicates if this column should be hidden in a datagrid.
Public property HyperLink
Gets and sets a hyperlink value that will be applied to this column.
Public property ID
Gets a value that indicates the Unique ID of this object.
Public property IncludeOthers
Gets and sets a value that indicates if other group values should be included in the group labeled with OtherGroupName when ShowGroupType is not SummaryData.SummaryDataShowGroupType.All.
Public property IncludeTies
Gets and sets a value that indicates whether ties should be included when ShowGroupType is not SummaryData.SummaryDataShowGroupType.All.
Public property Label
Gets or sets the label for this group column.
Public property numberDecimals
Gets and sets a value that indicates the number of decimal places that should be used for this column in a data grid.
Public property NumericColumn
Gets a value that indicates if this GroupColumn represents a numeric value.
Public property NumericGuiFormat
Gets a GUI format string for this Column
Public property numericPrefix
Gets and sets the numeric prefix (text before the data value) that will be used in a data grid.
Public property numericSuffix
Gets and sets the numeric suffix (text after the data value) that will be used in a data grid.
Public property OtherGroupName
Gets and sets a display value used to display other values IncludeOthers is true.
Public property Parent
Gets and sets an object that represents the GroupColumns object that is the parent of this GroupColumn.
Public property PivotTableDimension
Gets and sets a value that indicates whether this column is plotted as a row or column in a pivot table.
Public property QuarterStartMonth
Gets and sets a value that indicates how quarters are evaluated when dates are grouped by quarter.
Public property ShowGroupType
Gets and sets a value a SummaryDataShowGroupType that determins which values in this group is shown.
Public property ShowGroupValue
Gets and sets a value that determins how many values are shown for this group when ShowGroupType is not SummaryData.SummaryDataShowGroupType.All.
Public property SortColumn
Gets and sets a value a SummaryColumn object that determins which summary column is used to sort this group.
Public property SortType
Gets and sets a value a SummaryDataSummarySortType that determins how this group is sorted.
Public property SpecifiedGroupSortValues
Gets and sets a collection of values that determins the group order when SortType is SummaryData.SummaryDataSummarySortType.Specified.
Public property SuppressThousandSeparator
Gets and sets a property that indicates if numeric values should suppress the thousand separator.

See Also