UndoableCrossReferencePropertyT Class

Spotfire 14.3 API Reference
Manages a property that does not own its value. Assignments to the property will be recorded as undoable commands.
Inheritance Hierarchy

SystemObject
  Node
    UndoableNodeBase
      UndoableNode
        UndoablePropertyNode
          Spotfire.Dxp.Framework.DocumentModelUndoableCrossReferencePropertyT

Namespace:  Spotfire.Dxp.Framework.DocumentModel
Assembly:  Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax

C#
[SerializableAttribute]
public class UndoableCrossReferenceProperty<T> : UndoablePropertyNode
where T : DocumentNode

Type Parameters

T
The type of the DocumentNode pointed to by this UndoableCrossReferenceProperty.

The UndoableCrossReferencePropertyT type exposes the following members.

Properties

  NameDescription
Public propertyValue
Gets or sets the value of the managed node. Assignment of objects with the same value as the current value, will be ignored.
Top
Methods

  NameDescription
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetObjectData
Implements ISerializable.
(Overrides UndoablePropertyNode.GetObjectData(SerializationInfo, StreamingContext).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

The value of an UndoableCrossReferenceProperty must be a class deriving from DocumentNode or null. An UndoableCrossReferenceProperty does not own its value, it only points to a DocumentNode that is owned somewhere else in the document. Thus the value of an UndoableCrossReferenceProperty is not part sub tree in which the UndoableCrossReferenceProperty lives.

When the DocumentNode pointed to by an UndoableCrossReferenceProperty is detached, the value of the UndoableCrossReferenceProperty is set to null by the document model framework. This action is undoable and generates an event.

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

Reference