GroupColumn Class

GroupColumn Class

DataPA OpenAnalytics API Reference

Object representing a grouping column.

Inheritance Hierarchy

SystemObject
DataPAEnterpriseDashboardGroupColumn

Namespace: DataPAEnterpriseDashboard
Assembly: DataPAEnterpriseDashboard (in DataPAEnterpriseDashboard.dll) Version: 1.0.90.0 (1.0.90.0)

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
public class GroupColumn : _GroupColumn, 
	ISerializable

<SerializableAttribute>
Public Class GroupColumn
	Implements _GroupColumn, ISerializable

[SerializableAttribute]
public ref class GroupColumn : _GroupColumn, 
	ISerializable

DataPAEnterpriseDashboard.GroupColumn = function();

Type.createClass(
	'DataPAEnterpriseDashboard.GroupColumn',
	null,
	DataPAEnterpriseDashboard.GroupColumn._GroupColumn,
	DataPASerialization.ISerializable);

The GroupColumn type exposes the following members.

Constructors

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

Top

Methods

	Name	Description
	GetObjectData

Top

Fields

	Name	Description
	ClassId
	EventsId
	InterfaceId

Top

Properties

	Name	Description
	ColumnName	Gets the name of this group 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.
	DateColumn	Gets a value that indicates if this GroupColumn represents a date value.
	DateGroupType	Gets and sets a value that indicates how date values should be grouped.
	DateTimeColumn	Gets a value that indicates if this GroupColumn represents a DateTime 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 or sets the format string for this group column.
	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.
	GroupColumns	Gets and sets a child GroupColumns object for this group column.
	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.
	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.
	IncludeTies	Gets and sets a value that indicates whether ties should be included when ShowGroupType is not SummaryData.SummaryDataShowGroupType.All.
	IsListOfValues	Gets and sets a value that indicates if this group column contains a list of values used in a treeview
	Label	Gets or sets the label for this group column.
	ListDelimiter	Gets and sets the delimiter used to generate unique values for the treeview from this 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 GroupColumn represents a numeric value.
	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.
	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)
	OtherGroupName	Gets and sets a display value used to display other values IncludeOthers is true.
	Parent	Gets and sets an object that represents the GroupColumns object that is the parent of this GroupColumn.
	PivotTableDimension	Gets and sets a value that indicates whether this column is plotted as a row or column in a pivot table.
	QuarterStartMonth	Gets and sets a value that indicates how quarters are evaluated when dates are grouped by quarter.
	ShowGroupType	Gets and sets a value a SummaryDataShowGroupType that determins which values in this group is shown.
	ShowGroupValue	Gets and sets a value that determins how many values are shown for this group when ShowGroupType is not SummaryData.SummaryDataShowGroupType.All.
	SortColumn	Gets and sets a value a SummaryColumn object that determins which summary column is used to sort this group.
	SortType	Gets and sets a value a SummaryDataSummarySortType that determins how this group is sorted.
	SpecifiedGroupSortValues	Gets and sets a collection of values that determins the group order when SortType is SummaryData.SummaryDataSummarySortType.Specified.
	SuppressThousandSeparator	Gets and sets a property that indicates if numeric values should suppress the thousand separator.

Top

Remarks

Reference

DataPAEnterpriseDashboard Namespace

Send comments on this topic to info@datapa.com