DataPA Enterprise Dashboard Controls API Reference

The CalculatedColumn type exposes the following members.

Constructors

  Name Description
Public method CalculatedColumn()()()()
Creates and returns a new CalculatedColumn object
Public method CalculatedColumn(CalculatedColumns, String, String, String)
Creates and returns a new CalculatedColumn object

Methods

  Name Description
Public method Apply
Applies the current expression to the column in the dataset
Public method GetObjectData
Public method RefreshFilterParameterValues
Updates the expression to reflect any changes in filter dependant values
Protected method SetObjectData

Fields

  Name Description
Public field Static member ClassId
Public field Static member EventsId
Public field Static member InterfaceId

Properties

  Name Description
Public property ChildColumns
Gets a list of calculated columns that have a dependancy on this calculated column
Public property Clone
Gets cloned copy of this object.
Public property ColumnName
Gets and sets the name of the calculated column.
Public property DependantColumns
Gets an array of column names that this calculated column is dependant on.
Public property DependantColumnsSummaryTypes
Gets a collection that defines the summary type to be used on any dependant columns if this column is calculated post summary.
Public property DependantDashboardObjects
Gets an array of dashboard objects that are dependant on this calculated column.
Public property Expression
Gets and sets the expression used to calculate the calculated column.
Public property Guid
Gets a Guid that uniquely identifies this CalculatedColumn.
Public property ID
Gets a String that uniquely identifies this CalculatedColumn.
Public property IsDateTime
Gets and sets a value that indicates whether this calculated column is a date time (as opposed to date) column.
Public property IsPopulating
Gets a property that indicates if the values for this calculated column are currently being populated in the related datatable.
Public property Modified
Gets a property that indicates if the calculated column has been modified since it was last applied to the dataset.
Public property Parent
Gets and sets a CalculatedColumns object that represents the parent of this object.
Public property ParentDataset
Gets and sets the name of the dataset this calculated column will be added to.
Public property SourceExpression
Gets and sets the source expression (before any filter parameters have been replaced with their values)
Public property SuppressDashboardEvent
Gets and sets a property that determines if the event raised when populated should be supressed
Public property SyntaxMessage
Gets a string that gives feedback on the syntax of the expression.
Public property Type
Gets and sets the type of the calculated column.
Public property UpdatingFilterObjectIDs
Gets a list of the IDs of any filter object that updates this calculated column
Public property UpdatingFilterObjects
Gets a list of control panel objects that update this calculated column
Public property ValidExpression
Gets a value that indicates whether the syntax of the expression is correct.

Events

  Name Description
Public event ValuesPopulated
Event that fires to indicate the values for this calculated column have been populated in the datatable.

See Also