This is a handle to a column expression. This class
is created by the factory methods Create(String), and can be used
to retrieve information about the components of the column
expression.
Inheritance Hierarchy
Spotfire.Dxp.Data.ExpressionsAbstractExpression
Spotfire.Dxp.Data.ExpressionsColumnExpression
Namespace: Spotfire.Dxp.Data.Expressions
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
[SerializableAttribute] [NotPersistedAttribute] public sealed class ColumnExpression : AbstractExpression
The ColumnExpression type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Alias | Get the alias (name) of the calculated column if there is an AS
part of the column expression.
|
| ColumnNames | Get the names of all column names referenced in the expression.
|
| ErrorDisplayMessage | Get the localized error message if the expression is
invalid, null otherwise.
|
| ErrorExpression | Get the expression that could not be parsed if it exists,
if the expression is valid then this property is null.
|
| ErrorMessage | Get the error message if the expression is invalid, null
otherwise.
|
| Expression | Gets the expression as a string.
This would exclude any alias (name) statement.
|
| HierarchyNames | Get all hierarchy names referenced in the expression.
|
| IsValid | True if the expression is valid, false otherwise.
|
| MethodNames | Get the names of all the methods which are referenced
in the expression.
|
Methods
| Name | Description | |
|---|---|---|
 | Clone | Clone the expression.
|
| ContainsAggregationMethod | Checks if column expression contains an aggregation method.
|
 | Create | Parse a column expression and return a ColumnExpression.
|
| CreateFromPlotExpression |
Parse a custom expression that can be used on plots and return a list of ColumnExpressions.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetExpressionReturnType | Get the result type for the given expression using the columns
in the specified table.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| QualifyNames |
Make sure that all column/hierarchy references in the query are fully qualified.
|
| RenameColumn | Rename all column references from oldName to
newName.
|
| RenameHierarchy | Rename all hierarchy references from oldName to
newName.
|
| ToString | Get a string representation of the column expression.
(Overrides ObjectToString.) |
| Validate | Validates if the column expression is valid in the given
DataTable context.
|
Version Information
Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also