An abstract base class for flyweight data value containers. More precisely, a DataValue instance contains
a value of a particular DataType, and thus every DataValue has a corresponding DataType. (This is not
necessarily true for the methods marked Obsolete in this class.) Instances of the generic subclass are
normally used, often explicitly, and this non-generic base class is provided only for convenience in
contexts where the generic type is not known, or variable. Note that this class is intended as a flyweight,
that is, as a reusable container. This means that it is not optimized for memory and is unsuitable for
representing arrays or matrices of data values, where a separate DataValue instance is used for each cell.
Consider using a more compact representation of the values for such purposes. The DataValue class is not
serializable and should not be used for persistent storage.
Inheritance Hierarchy
Spotfire.Dxp.DataDataValue
Spotfire.Dxp.DataDataValueT
Namespace: Spotfire.Dxp.Data
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
public abstract class DataValue
The DataValue type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | AssignFrom |
Sets this DataValue instance equal to another DataValue instance.
|
| Clone | Creates a copy of this instance. |
 | Create(DataType) |
Creates a DataValue instance of a given data type.
|
| Create(DataType, DataErrorValue) | Obsolete.
Creates a DataValue instance of a given data type and with a provided error value.
|
| Create(DataType, Object) |
Creates a DataValue instance of a given data type and with a provided initial value.
|
| CreateT |
Creates a DataValue instance of a given runtime type.
|
| CreateT(T) |
Creates a DataValue instance of a given runtime type and with a provided initial value.
|
| CreateT(T, Boolean) |
Creates a DataValue instance of a given runtime type and with a provided initial value.
This method is redundant but useful in practice.
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetNullValue |
Makes this DataValue instance represent a null value. That is, an invalid value with a null
data error. After the method call, HasValidValue will return false, IsNullValue will return true,
and HasDataError will return false. The ValidValue property will be null or default(T).
|
Properties
| Name | Description | |
|---|---|---|
 | DataError | Obsolete.
Gets or sets the data error contained in this DataValue instance.
The getter returns null if HasDataError is false.
After invoking the setter HasDataError will be true, HasValidValue and IsNullValue will be false,
and ValidValue will return a default value.
|
| DataType |
Gets the data type corresponding to the runtime values that can be stored in this value container.
The data type is fixed, since a data value cannot be used for values of varying types.
|
| ErrorValue | Obsolete.
Gets or sets the data error associated with this DataValue.
|
| HasDataError | Obsolete.
Gets a value indicating whether this DataValue (i) is invalid and (ii) has an associated
data error.
If HasDataError is true, then HasValidValue and IsNullValue are both false.
|
| HasValidValue |
Gets a value indicating whether this DataValue contains a valid value.
If HasValidValue is false, then either IsNullValue is true or HasDataError is true, but not both.
If HasValidValue is true, the IsNullValue and HasDataError are both false.
|
| Index | Obsolete.
Gets the row index associated with this DataValue, if applicable.
|
| IsError | Obsolete.
Gets a value indicating whether the DataValue represents an error.
|
| IsNullValue |
Gets a value indicating whether this DataValue instance represents a null value,
or, more precisely, an invalid value with a null data error.
|
| IsValid | Obsolete.
Gets or sets a value indicating whether the contained data value is valid.
|
| ValidValue |
Gets or sets the runtime value contained in this DataValue instance, as a boxed value.
The getter returns null for reference types and default(T) for value types, if the HasValidValue is false.
After setting a valid value HasValidValue will be true, HasDataError and IsNullValue will be false,
and DataError will return null.
|
| Value | Obsolete.
Gets the value contained in this DataValue instance.
|
Version Information
See Also