DataPA Enterprise Dashboard Controls API Reference
The CalculatedColumn type exposes the following members.
Constructors
Name | Description | |
---|---|---|
CalculatedColumn()()()() |
Creates and returns a new CalculatedColumn object
|
|
CalculatedColumn(CalculatedColumns, String, String, String) |
Creates and returns a new CalculatedColumn object
|
Methods
Name | Description | |
---|---|---|
Apply |
Applies the current expression to the column in the dataset
|
|
GetObjectData | ||
RefreshFilterParameterValues |
Updates the expression to reflect any changes in filter dependant values
|
|
SetObjectData |
Fields
Name | Description | |
---|---|---|
ClassId | ||
EventsId | ||
InterfaceId |
Properties
Name | Description | |
---|---|---|
ChildColumns |
Gets a list of calculated columns that have a dependancy on this calculated column
|
|
Clone |
Gets cloned copy of this object.
|
|
ColumnName |
Gets and sets the name of the calculated column.
|
|
DependantColumns |
Gets an array of column names that this calculated column is dependant on.
|
|
DependantColumnsSummaryTypes |
Gets a collection that defines the summary type to be used on any dependant columns if this column is calculated post summary.
|
|
DependantDashboardObjects |
Gets an array of dashboard objects that are dependant on this calculated column.
|
|
Expression |
Gets and sets the expression used to calculate the calculated column.
|
|
Guid |
Gets a Guid that uniquely identifies this CalculatedColumn.
|
|
ID |
Gets a String that uniquely identifies this CalculatedColumn.
|
|
IsDateTime |
Gets and sets a value that indicates whether this calculated column is a date time (as opposed to date) column.
|
|
IsPopulating |
Gets a property that indicates if the values for this calculated column are currently being populated in the related datatable.
|
|
Modified |
Gets a property that indicates if the calculated column has been modified since it was last applied to the dataset.
|
|
Parent |
Gets and sets a CalculatedColumns object that represents the parent of this object.
|
|
ParentDataset |
Gets and sets the name of the dataset this calculated column will be added to.
|
|
SourceExpression |
Gets and sets the source expression (before any filter parameters have been replaced with their values)
|
|
SuppressDashboardEvent |
Gets and sets a property that determines if the event raised when populated should be supressed
|
|
SyntaxMessage |
Gets a string that gives feedback on the syntax of the expression.
|
|
Type |
Gets and sets the type of the calculated column.
|
|
UpdatingFilterObjectIDs |
Gets a list of the IDs of any filter object that updates this calculated column
|
|
UpdatingFilterObjects |
Gets a list of control panel objects that update this calculated column
|
|
ValidExpression |
Gets a value that indicates whether the syntax of the expression is correct.
|
Events
Name | Description | |
---|---|---|
ValuesPopulated |
Event that fires to indicate the values for this calculated column have been populated in the datatable.
|