Represents a collection of the properties in a column.
Inheritance Hierarchy
Spotfire.Dxp.DataDataColumnProperties
Namespace: Spotfire.Dxp.Data
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
public sealed class DataColumnProperties
The DataColumnProperties type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | DataColumnProperties |
Initializes a new instance of the DataColumnProperties class. |
Properties
| Name | Description | |
|---|---|---|
 | CalculatedExpression | Gets the derived expression of the column.
The calculated expression is the expression text after preprocessing the original expression (Expression).
|
| ColumnType | Gets or sets the column type of the column. |
| Comparer | Gets or sets the value comparer of the column. |
| ContentType |
Gets or sets a more specific type of the data contained in a column of a certain DataType.
|
| DataType | Gets or sets the data type of the column. |
| Description | Gets or sets a textual description of the column. |
| Expression | Gets the defining expression of the column. |
| ExternalId | Gets or sets the external identifier of the column. |
| ExternalName | Gets or sets the external name of the column. |
| Formatter | Gets or sets the value formatter of the column. |
| IsValid | Gets a value indicating whether the column has valid values:
true if the column has valid values; otherwise, false. |
| Item |
Gets or sets the value of a named property.
|
| Name | Gets or sets the name of the column. |
| PreferredAggregationMethod |
Gets or sets the preferred aggregation method. If set to the name of an aggregation method, for instance "sum" or "avg",
this method is used by plot heuristics when creating aggregated expressions from this column.
|
| PropertyNames | Gets an enumeration of the names of all the properties in the column. |
Methods
| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetProperty | Gets the value of a named property. |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HasPropertyValue | Checks if the column has a value for a named property. |
| Propagate(ImportContext) | Create a new collection of column properties where all the
properties that are defined in the DataPropertyRegistry
with the DataPropertyAttributesIsPropagated are forwarded.
|
| Propagate(ImportContext, Boolean, IDataFormatter, DataType) | Create a new collection of column properties where all the
properties that are defined in the DataPropertyRegistry
with the DataPropertyAttributesIsPropagated are forwarded.
|
| PropertyExists | Checks if a property with a given name exists.
|
| SetCustomSortOrder |
Sets a custom sort order. The values in values must be of the same type
as the values in the column. Column values not present in values will
be sorted last.
|
| SetProperty | Sets the value of a named property.
The property has to be defined in the DataPropertyRegistry and the value has to be of the
same type as defined in the registry.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TryGetCustomSortOrder |
Tries to get the custom sort order of the column, if any.
|
Remarks
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