| SummaryColumn Class |
|
Object representing a grouping column.
Inheritance Hierarchy
Namespace: DataPAEnterpriseDashboard
Assembly: DataPAEnterpriseDashboard (in DataPAEnterpriseDashboard.dll) Version: 1.0.90.0 (1.0.90.0)
Syntax[SerializableAttribute] public class SummaryColumn : _SummaryColumn, ISerializable, NumericFormatProvider
The SummaryColumn type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SummaryColumn |
Creates and returns a new SummaryColumn object.
|
| SummaryColumn(DataColumn) |
Creates and returns a new SummaryColumn object.
|
| SummaryColumn(DataColumn, String) |
Creates and returns a new SummaryColumn object.
|
| SummaryColumn(SummaryColumns, DataColumn, String) |
Creates and returns a new SummaryColumn object.
|
Methods| Name | Description | |
|---|---|---|
| CopyNumericFormat |
Copies the numeric format values from one object to this
|
| GetObjectData |
Fields| Name | Description | |
|---|---|---|
  | ClassId | |
| EventsId | |
| InterfaceId |
Properties| Name | Description | |
|---|---|---|
 | ColumnName |
Gets and sets the name of this summary column.
|
| DataGridFont |
Gets and sets the bespoke font that will be used to render this column in a datagrid if DataGridUseBespokeFont is true.
|
| DataGridFormatColumn |
Gets and sets a column from the query data source that will be used to provide the format value for this column.
|
| DataGridFormatType |
Gets and sets a value that indicates how to derive the format string for this column when displayed in a data grid.
|
| DataGridTextColor |
Gets and sets the colour of the text used for this column in a data grid if DataGridUseBespokeFont is true.
|
| DataGridUseBespokeFont |
Gets and sets a value that indicates if this column should use a bespoke font when rendered in a data grid.
|
| DisplayType |
Gets and sets a value representing the type of object that will be used to display this summary column.
|
| DistinctColumn |
Gets and sets the name of the distinct column that will be used to calculate a distinct sum value
|
| Editable |
Gets and sets a property that indicates if this column is editable in a datagrid.
|
| 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.
|
| Format |
Gets and sets a display format string for this summary column.
|
| formatNumericValues |
Gets and sets a value that indicates if numeric values for this column should be formatted.
|
| GUID |
Gets a GUID that uniquely identifies this object.
|
| Hidden |
Gets and sets a value that indicates if this column should be hidden in a datagrid.
|
| HyperLink |
Gets and sets a hyperlink value that will be applied to this column.
|
| ID |
Gets a value that indicates the Unique ID of this object.
|
| Label |
Gets and sets a label for this summary column.
|
| numberDecimals |
Gets and sets a value that indicates the number of decimal places that should be used for this column in a data grid.
|
| NumericColumn |
Gets a value that indicates if this SummaryColumn is derived from a numeric value.
|
| NumericFormatSelectionName |
Gets the label used to identify this numeric format provider in the interface
|
| NumericGuiFormat |
Gets a GUI format string for this Column
|
| numericPrefix |
Gets and sets the numeric prefix (text before the data value) that will be used in a data grid.
|
| NumericSourceColumn |
Gets a value that indicates if this SummaryColumn is derived from a numeric value.
|
| numericSuffix |
Gets and sets the numeric suffix (text after the data value) that will be used in a data grid.
|
| ObjectSizes |
Gets a dictionary of serialized objects contained in this object, along with their sizes (in bytes)
|
| Parent |
Gets the SummaryColumns object that is the parent of this SummaryColumn.
|
| PivotTotalSource |
Gets and sets a value representing how averages in a pivot table are calculated
|
| scalingUnits |
Gets and sets a string value that represents the scaling units used to represent values.
|
| scalingValues |
Gets and sets a string value that represents the scaling values used to represent values.
|
| ShowAsPercentageOfTotal |
Gets a value that indicates if this column should be displayed as a percentage of the total.
|
| SummariseBeforeCalculation |
Gets and sets a value that indicates when the calculation on a calculated column should be executed.
|
| SummaryType |
Gets and sets a value that indicates the summary operation this column will use.
|
| SuppressThousandSeparator |
Gets and sets a property that indicates if numeric values should suppress the thousand separator.
|
| TotalSummaryType |
Gets and sets a value that indicates the summary operation this column will use for totals in a pivot table.
|
| UniqueColumnName |
Gets a unique column name based on the column and it's summary type
|
| UseSecondaryYAxis |
Gets and sets a value that indicates if this summary column will be associated with the secondary Y axis.
|
RemarksSee Also