DataType Class

Spotfire 14.3 API Reference

This class contains information about a Spotfire data type and the properties of that data type. This is an enumeration class with one static instance for each of the supported data types.

Inheritance Hierarchy

SystemObject
Spotfire.Dxp.DataDataType

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(6, 0)]
[ImmutableAttribute]
public sealed class DataType : IObjectReference

The DataType type exposes the following members.

Properties

	Name	Description
	AutoIndexUniqueValueCount	Gets the unique value count threshold value for auto-indexing. An imported column with a unique value count less or equal to this threshold will always be indexed.
	AvailableDataTypes	Gets the available data types.
	DefaultComparer	Gets the default comparer for this DataType.
	DefaultValue	Gets the default value for the underlying type.
	Formatter	Gets a default, user localized, read-only formatter for this data type.
	InvariantFormatter	Gets a read-only formatter for this data type that does invariant formatting. This formatting is independent of localization and uses InvariantCulture.
	IsNumeric	Gets a value indicating whether the data type is numeric or not, that is, Integer, Currency, Real, LongInteger or SingleReal
	IsSimple	Gets a value indicating whether the data type is considered simple or not. E.g. String and int (etc) are simple, Binary is not.
	IsTime	Gets a value indicating whether the data type represents time or not, that is, Date, Time or DateTime.
	Name	Gets the type name.
	NullValue	Gets a null (empty) value for the underlying type.
	RepresentationType	Gets the representation type of the data type. This is the .NET type that values of this data type are stored as.

Top

Methods

	Name	Description
	CreateCultureSpecificFormatter(CultureInfo)	Obsolete. Creates a culture specific formatter for this data type. A formatter may configured by casting it to the corresponding formatter class. For numeric types (DataType.Integer, DataType.Long and DataType.Real) the formatter class is NumberFormatter. For date/time types (DataType.Date, DataType.Time and DataType.DateTime it is DateTimeFormatter. The formatter class for DataType.String is StringFormatter.
	CreateCultureSpecificFormatter(String)	Creates a culture specific formatter for this data type. A formatter may configured by casting it to the corresponding formatter class. For numeric types (DataType.Integer, DataType.Long and DataType.Real) the formatter class is NumberFormatter. For date/time types (DataType.Date, DataType.Time and DataType.DateTime it is DateTimeFormatter. The formatter class for DataType.String is StringFormatter.
	CreateFormatter	Obsolete. Creates a user localized formatter for this data type. A formatter may configured by casting it to the corresponding formatter class. For numeric types (DataType.Integer, DataType.Long and DataType.Real) the formatter class is NumberFormatter. For date/time types (DataType.Date, DataType.Time and DataType.DateTime it is DateTimeFormatter. The formatter class for DataType.String is StringFormatter.
	CreateFormatter(CultureInfo)	Obsolete. Creates a culture specific formatter for this data type. A formatter may configured by casting it to the corresponding formatter class. For numeric types (DataType.Integer, DataType.Long and DataType.Real) the formatter class is NumberFormatter. For date/time types (DataType.Date, DataType.Time and DataType.DateTime it is DateTimeFormatter. The formatter class for DataType.String is StringFormatter.
	CreateList	Obsolete. Create an array of the representation type.
	CreateLocalizedFormatter	Creates a user localized formatter for this data type. A formatter may configured by casting it to the corresponding formatter class. For numeric types (DataType.Integer, DataType.Long and DataType.Real) the formatter class is NumberFormatter. For date/time types (DataType.Date, DataType.Time and DataType.DateTime it is DateTimeFormatter. The formatter class for DataType.String is StringFormatter.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	FromExternalDataType	Converts a DataSourceDataType to a DataType.
	FromImportReaderColumn	Converts the type of a column, from an IDataReader, to the DataType used in the Data Manager.
	FromImportType	Converts the type from an import source to the DataType used in the Data Manager.
	FromName	Looks up a data type by name.
	GetDataType	Gets the DataType with the given name.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetRealObject	Returns the real object that should be deserialized, rather than the object that the serialized stream specifies.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Get the name of the data type. (Overrides ObjectToString.)
	TryConvertFromNumeric	Converts a value from a numeric (double) representation, to the value representation defined by dataType.
	TryConvertToNumeric	Converts a value to a numeric (double) representation.
	Validate	Validates a value with the representation type.

Top

Fields

	Name	Description
	Binary	Binary type.
	Boolean	Boolean type.
	Currency	Currency type.
	Date	Date type.
	DateTime	DateTime type (both date and a time stamp).
	Integer	Integer type.
	LongInteger	Long integer type.
	Real	Real (double) type.
	SingleReal	Short Real (float) type.
	String	String type.
	Time	Timestamp type (not including date).
	TimeSpan	Time span type.
	Undefined	Undefined type. This is not a real data type but can be used in some places when any type is acceptable.

Top

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

Reference

Spotfire.Dxp.Data Namespace