DataColumnProperties Class

TIBCO Spotfire 7.12 API Reference

Represents a collection of the properties in a column.

Inheritance Hierarchy

SystemObject
Spotfire.Dxp.DataDataColumnProperties

Namespace: Spotfire.Dxp.Data
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 30.0.11525.4184 (30.0.11525.4184)

Syntax

public sealed class DataColumnProperties : IDataPropertyContainer, 
	IDataPropertiesAccessor

The DataColumnProperties type exposes the following members.

Constructors

	Name	Description
	DataColumnProperties	Initializes a new instance of the DataColumnProperties class.

Methods

	Name	Description
	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.
	TryGetCustomSortOrder	Tries to get the custom sort order of the column, if any.

Properties

	Name	Description
	AllowedValues	Obsolete. Gets the list of all valid values that may appear in the column.
	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.
	PropertyNames	Gets an enumeration of the names of all the properties in the column.

Remarks

This collection can be retrieved from a IDataColumn, DataColumn or DataRowReaderColumn.

Version Information