DataProperty Class

Spotfire 14.3 API Reference

Definition of a data property.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.DataDataProperty

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(11, 10)]
public sealed class DataProperty : DocumentNode

The DataProperty type exposes the following members.

Properties

	Name	Description
	Attributes	Gets the attributes of the data property.
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	DefaultAttributes	Gets the default attributes for a custom data property: IsPersistent, IsVisible, IsEditable.
	Description	Gets a description of the property.
	HasDefaultValue	Gets a value indicating whether this property has a default value.
	HasInheritedType	Gets a value indicating whether the property has a value type that is derived from the container. For example, a column property that is a list of column values.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	IsCalculated	Gets a value indicating whether the property value is calculated or derived from the context.
	IsListValued	Gets a value indicating whether the property takes multiple values (the value is an array).
	IsPropagated	Gets a value indicating whether the property shall be copied to objects derived from the container. For example, a column property that is propagated to a derived data view.
	IsStandard	Gets a value indicating whether this is a standard data property.
	IsUserEditable	Gets a value indicating whether the property value can be edited by the user.
	IsUserVisible	Gets a value indicating whether the property can be displayed in the Data Properties UI.
	Name	Gets or sets the name of the data property.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	Value	Gets or sets the default value of the data property.

Top

Methods

	Name	Description
	CreateCustomPrototype(String, DataType, DataPropertyAttributes)	Creates a prototype for a custom data property.
	CreateCustomPrototype(String, Object, DataType, DataPropertyAttributes)	Creates a prototype for a custom data property.
	CreateCustomPrototype(String, String, Object, DataType, DataPropertyAttributes)	Creates a prototype for a custom data property.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	INodeContextGetAncestorT	Implements GetAncestorT. (Inherited from DocumentNode.)
	INodeContextGetServiceT	Implements GetServiceT. (Inherited from DocumentNode.)
	INodeContextIsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactionsBeginAggregatedTransaction	Implements BeginAggregatedTransaction. (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

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