Action
    Preparing search index...

    Abstract base class for all Document Nodes.

    Each class that inherits from Spotfire.Dxp.Framework.DocumentModel.DocumentNode must follow the design pattern for document nodes. This includes: The class must be marked with the System.SerializableAttribute attribute.If objects of the class are intended to be persisted when the Spotfire document is saved, the class must be marked with the Spotfire.Dxp.Framework.Persistence.PersistenceVersionAttribute attribute.The class must not implement any of the System.IDisposable or System.Runtime.Serialization.IDeserializationCallback interfaces.The class must not declare any events.All fields declared in the class must be marked readonly.The type of each field declared in the class must be one of the following: A primitive type (string, bool, float, etc.). An immutable type. A type that derives from Spotfire.Dxp.Framework.DocumentModel.DocumentNode. One of the Undoable building blocks of the document model (Spotfire.Dxp.Framework.DocumentModel.UndoableProperty, Spotfire.Dxp.Framework.DocumentModel.UndoableList, Spotfire.Dxp.Framework.DocumentModel.UndoableDictionary, etc.). An instance of the Spotfire.Dxp.Framework.DocumentModel.RuntimeProperty type. An instance of the Spotfire.Dxp.Framework.DocumentModel.RuntimeConstant type. The class must declare a nested class called PropertyNames that derives from the PropertyNames class declared by the inherited document node class. The PropertyNames class declared in this class shall shadow the inherited PropertyNames class, which is accomplished using the new keyword.The class must declare a protected (or private if this class is sealed) deserialization constructor in which or are called to deserialize persisted state and initialize the fields of this class.The class must override Spotfire.Dxp.Framework.DocumentModel.DocumentNode.GetObjectData|GetObjectData(info, context) in which or are called to serialize the state held by the fields of this class.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    • Casts this object to the specified type. Throws error on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1

    • Determines whether the specified object is equal to the current object.

      Parameters

      • obj: any

        The object to compare with the current object.

      Returns boolean

      true if the specified object is equal to the current object; otherwise, false.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • Casts this object to the specified type. Returns null on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns null | T1

    • Determines whether the specified object instances are considered equal.

      Parameters

      • objA: any

        The first object to compare.

      • objB: any

        The second object to compare.

      Returns boolean

      true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

    Default capability

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get Transactions(): ITransactions

      Gets a collection of methods for executing transactions on the document.

      Returns ITransactions

      2.0

    • Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.

      Type Parameters

      • TNode

      Parameters

      Returns void

      2.1