DocumentNode Class

Spotfire 14.2 API Reference
Abstract base class for all Document Nodes.
Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      More...

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

C#
[SerializableAttribute]
[PersistenceVersionAttribute(3, 0)]
public abstract class DocumentNode : Node, 
	IServiceProvider, ITransactions, INodeContext

The DocumentNode type exposes the following members.

Constructors

  NameDescription
Protected methodDocumentNode
Initializes a new instance of the DocumentNode class.
Protected methodDocumentNode(SerializationInfo, StreamingContext)
Implements ISerializable.
Top
Properties

  NameDescription
Public propertyContext
Gets the context of this node.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
Top
Methods

  NameDescription
Protected methodCreateEventRelay(PropertyName, StatelessDependencyDeclarer)
Creates an event relay. An event relay is a property in the document model which propagates event. An event is raised for the event relay whenever when the trigger returned by the specified dependencyDeclarer fires.
Protected methodCreateEventRelay(PropertyName, StatelessDependencyDeclarer, EventRelayMode)
Creates an event relay. An event relay is a property in the document model which propagates event. An event is raised for the event relay whenever when the trigger returned by the specified dependencyDeclarer fires.
Protected methodCreatePropertyT(PropertyName, UndoableListT)
Protected methodCreatePropertyT(PropertyName, UndoableSetT)
Protected methodCreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode)
Protected methodCreatePropertyT(PropertyName, UndoablePropertyT, T)
Protected methodCreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue)
Protected methodCreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode)
Protected methodCreateReadOnlyPropertyT
Creates a read-only property of type T and assigns it to the specified field.
Protected methodCreateRuntimeConstantT
Creates a runtime constant. A runtime constant is a property in the document model whose value is computed once when first accessed. The value is then disposed along with the DocumentNode.
Protected methodCreateRuntimePropertyT
Protected methodDeclareInternalEventHandlers
Override this method to declare handlers of internal events.
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT)
Protected methodDeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue)
Protected methodDeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode)
Protected methodDeserializeReadOnlyPropertyT
Deserializes a read-only property of type T stored in info with key propertyName.
Protected methodDuplicateSubtreeT
Returns a copy of the sub tree spanned from this node that has the same outwards non-owning references. The returned copy will be in state New and is intended to be attached to the document immediately.
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
Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides Node.GetObjectData(SerializationInfo, StreamingContext).)
Protected methodGetPersistedTypeName
Can be used in the deserialization constructor to get the type name that the class corresponding to this class had when it was originally serialized. Will return null if the specified caller type has no correspondence in the serialized information
Protected methodGetPersistedVersion
Can be used in the deserialization constructor to get the persistence version that this class was marked with when it was originally serialized. Will return null if the specified caller type has no correspondence in the serialized information
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInternalTransaction
Starts an internal transaction on the document model by executing the specified executor delegate.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnConfigure
Allows a node to configure itself to the surrounding document.
Protected methodOnConfigured
Allows a node to configure itself to the surrounding document.
Protected methodOnReconfigure
Allows a node to reconfigure itself to a new part of the surrounding document.
Protected methodOnReconfigured
Allows a node to reconfigure itself to a new part of the surrounding document.
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT)
Serializes an Undoable*Property with value of type T storing it in info with key property.Name.
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableListT)
Serializes an UndoableList with values of type T storing it in info with key list.Name.
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT)
Serializes an UndoableProperty with value of type T storing it in info with key property.Name.
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT)
Serializes an UndoableSet storing it in info with key given by the property name of the set.
Protected methodSerializePropertyTKey, TValue(SerializationInfo, StreamingContext, UndoableDictionaryTKey, TValue)
Serializes an UndoableDictionary storing it in info with key given by the property name of the dictionary.
Protected methodSerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode)
Protected methodSerializeReadOnlyPropertyT
Serializes a read-only property of type T stored in info with key propertyName.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodValidateAttached
Validates that the node is attached.
Top
Extension Methods

  NameDescription
Public Extension MethodGetServiceTService
Convenience generic extension method that calls GetService(Type) and casts the result.
(Defined by Extensions.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodINodeContextGetAncestorT
Explicit interface implementationPrivate methodINodeContextGetServiceT
Explicit interface implementationPrivate methodINodeContextIsDescendantOf
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
Explicit interface implementationPrivate methodITransactionsExecuteTransaction
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
Top
Remarks

Each class that inherits from DocumentNode must follow the design pattern for document nodes. This includes:
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.ApplicationBookmark
      Spotfire.Dxp.Application.CalculationsCalculationDependency
      Spotfire.Dxp.Application.CalculationsCalculationDependencyCollection
      Spotfire.Dxp.Application.CalculationsCalculationResults
      Spotfire.Dxp.Application.CalculationsCalculationSettings
      Spotfire.Dxp.Application.CalculationsColumnsCalculationResult
      Spotfire.Dxp.ApplicationCustomNodes
      Spotfire.Dxp.ApplicationDocument
      Spotfire.Dxp.ApplicationDocumentCompatibility
      Spotfire.Dxp.ApplicationDocumentProperties
      Spotfire.Dxp.Application.ExtensionCustomNode
      Spotfire.Dxp.Application.FiltersFilter
      Spotfire.Dxp.Application.FiltersFilterBase
      Spotfire.Dxp.Application.FiltersFilterGroupItem
      Spotfire.Dxp.ApplicationImageCollection
      Spotfire.Dxp.Application.LayoutVisualizationAreaSize
      Spotfire.Dxp.ApplicationPage
      Spotfire.Dxp.ApplicationPanel
      Spotfire.Dxp.ApplicationPanelCollection
      Spotfire.Dxp.Application.ScriptingScriptManager
      Spotfire.Dxp.ApplicationVisual
      Spotfire.Dxp.ApplicationVisualCollection
      Spotfire.Dxp.Application.VisualsAxis
      Spotfire.Dxp.Application.VisualsAxisCategoricalAxis
      Spotfire.Dxp.Application.VisualsAxisContinuousAxis
      Spotfire.Dxp.Application.VisualsAxisBinding
      Spotfire.Dxp.Application.VisualsBoxPlotComparisonCircles
      Spotfire.Dxp.Application.VisualsBoxPlotReferencePoint
      Spotfire.Dxp.Application.VisualsBoxPlotStatisticsTable
      Spotfire.Dxp.Application.VisualsCamera
      Spotfire.Dxp.Application.VisualsCategoricalColorEntry
      Spotfire.Dxp.Application.VisualsColorScheme
      Spotfire.Dxp.Application.VisualsCombinationChartBarProperties
      Spotfire.Dxp.Application.VisualsCombinationChartLineProperties
      Spotfire.Dxp.Application.Visuals.ConditionalColoringColorBreakpoint
      Spotfire.Dxp.Application.Visuals.ConditionalColoringColorBreakpointCollection
      Spotfire.Dxp.Application.Visuals.ConditionalColoringColoring
      Spotfire.Dxp.Application.Visuals.ConditionalColoringColoringCollection
      Spotfire.Dxp.Application.Visuals.ConditionalColoringColoringTemplateCollection
      Spotfire.Dxp.Application.Visuals.ConditionalColoringColorRule
      Spotfire.Dxp.Application.VisualsContinuousColorEntry
      Spotfire.Dxp.Application.VisualsCrossTableSubtotal
      Spotfire.Dxp.Application.VisualsCrossTableSubtotalCollection
      Spotfire.Dxp.Application.VisualsCrossTableTotals
      Spotfire.Dxp.Application.VisualsDendrogram
      Spotfire.Dxp.Application.VisualsDetailItem
      Spotfire.Dxp.Application.VisualsDetailItemCollection
      Spotfire.Dxp.Application.VisualsDetails
      Spotfire.Dxp.Application.VisualsErrorBars
      Spotfire.Dxp.Application.VisualsExpressionColumn
      Spotfire.Dxp.Application.VisualsFilterRule
      Spotfire.Dxp.Application.VisualsFilterRuleCollection
      Spotfire.Dxp.Application.Visuals.FittingModelsFittingModel
      Spotfire.Dxp.Application.Visuals.FittingModelsReferenceCurve
      Spotfire.Dxp.Application.Visuals.FittingModelsReferenceDetailItem
      Spotfire.Dxp.Application.Visuals.FittingModelsReferencePoint
      Spotfire.Dxp.Application.VisualsFormatting
      Spotfire.Dxp.Application.VisualsHorizontalLegend
      Spotfire.Dxp.Application.VisualsKpiCollection
      Spotfire.Dxp.Application.VisualsKpiContent
      Spotfire.Dxp.Application.VisualsLegend
      Spotfire.Dxp.Application.VisualsLegendLegendItemCollection
      Spotfire.Dxp.Application.VisualsLegendItem
      Spotfire.Dxp.Application.VisualsLineConnection
      Spotfire.Dxp.Application.VisualsMapChartLayer
      Spotfire.Dxp.Application.Visuals.MapsGeocodingTableReference
      Spotfire.Dxp.Application.Visuals.MapsGeocodingTableReferenceCollection
      Spotfire.Dxp.Application.Visuals.MapsLineFeatureVisualAttributes
      Spotfire.Dxp.Application.Visuals.MapsMapChartLayer
      Spotfire.Dxp.Application.Visuals.MapsMapChartLayerCollection
      Spotfire.Dxp.Application.Visuals.MapsPointFeatureVisualAttributes
      Spotfire.Dxp.Application.Visuals.MapsPolygonFeatureVisualAttributes
      Spotfire.Dxp.Application.Visuals.MapsWmsSublayer
      Spotfire.Dxp.Application.Visuals.MapsWmsSublayerCollection
      Spotfire.Dxp.Application.Visuals.MiniaturesBulletGraphColorRange
      Spotfire.Dxp.Application.Visuals.MiniaturesBulletGraphColorRangeCollection
      Spotfire.Dxp.Application.Visuals.MiniaturesCalculatedValueRule
      Spotfire.Dxp.Application.Visuals.MiniaturesCalculatedValueRuleCollection
      Spotfire.Dxp.Application.Visuals.MiniaturesGraphicalTableColumn
      Spotfire.Dxp.Application.Visuals.MiniaturesGraphicalTableColumnCollection
      Spotfire.Dxp.Application.Visuals.MiniaturesGraphicalTableColumnSortInfo
      Spotfire.Dxp.Application.Visuals.MiniaturesGraphicalTableColumnSortInfoCollection
      Spotfire.Dxp.Application.Visuals.MiniaturesIconRule
      Spotfire.Dxp.Application.Visuals.MiniaturesIconRuleCollection
      Spotfire.Dxp.Application.VisualsParallelCoordinatePlotColumnScale
      Spotfire.Dxp.Application.VisualsPieChartVisualAttributes
      Spotfire.Dxp.Application.VisualsPieMarker
      Spotfire.Dxp.Application.VisualsReferenceLine
      Spotfire.Dxp.Application.VisualsReferenceLines
      Spotfire.Dxp.Application.VisualsRuleCondition
      Spotfire.Dxp.Application.VisualsScaleBase
      Spotfire.Dxp.Application.VisualsScaleLabels
      Spotfire.Dxp.Application.VisualsScaleLabelsLevelSettings
      Spotfire.Dxp.Application.VisualsShapeScheme
      Spotfire.Dxp.Application.VisualsShapeSchemeEntry
      Spotfire.Dxp.Application.VisualsSummaryTableAggregationColumn
      Spotfire.Dxp.Application.VisualsSummaryTableSortColumn
      Spotfire.Dxp.Application.VisualsSummaryTableVisibleColumn
      Spotfire.Dxp.Application.VisualsSummaryTableVisibleColumnCollection
      Spotfire.Dxp.Application.VisualsTableColumnCollection
      Spotfire.Dxp.Application.VisualsTablePlotColumn
      Spotfire.Dxp.Application.VisualsTablePlotColumnCollectionT
      Spotfire.Dxp.Application.VisualsTableSortInfoCollection
      Spotfire.Dxp.Application.VisualsTrellis
      Spotfire.Dxp.Application.Visuals.ValueRenderersValueRendererSettings
      Spotfire.Dxp.Application.VisualsVisualContent
      Spotfire.Dxp.Application.VisualsVisualizationData
      Spotfire.Dxp.Application.VisualsVisualizationFilteringCollection
      Spotfire.Dxp.Application.VisualsVisualizationRelations
      Spotfire.Dxp.Application.VisualsVisualizationSubset
      Spotfire.Dxp.Application.VisualsVisualizationSubsetCollection
      Spotfire.Dxp.DataCalculation
      Spotfire.Dxp.DataColumnRelationCollection
      Spotfire.Dxp.DataDataColumn
      Spotfire.Dxp.DataDataColumnCollection
      Spotfire.Dxp.DataDataFilteringSelectionCollection
      Spotfire.Dxp.Data.DataFunctionsDataFunction
      Spotfire.Dxp.Data.DataFunctionsDataFunctionCollection
      Spotfire.Dxp.Data.DataFunctionsDataFunctionExpressionFunctionCollection
      Spotfire.Dxp.Data.DataFunctionsDataFunctionInput
      Spotfire.Dxp.Data.DataFunctionsDataFunctionInputCollection
      Spotfire.Dxp.Data.DataFunctionsDataFunctionOutput
      Spotfire.Dxp.Data.DataFunctionsDataFunctionOutputCollection
      Spotfire.Dxp.DataDataManager
      Spotfire.Dxp.DataDataMarkingSelectionCollection
      Spotfire.Dxp.DataDataProperty
      Spotfire.Dxp.DataDataPropertyRegistry
      Spotfire.Dxp.DataDataRelation
      Spotfire.Dxp.DataDataRelationCollection
      Spotfire.Dxp.DataDataSelection
      Spotfire.Dxp.DataDataTable
      Spotfire.Dxp.DataDataTableCollection
      Spotfire.Dxp.DataDisplayValueSettings
      Spotfire.Dxp.DataHighlightSelection
      Spotfire.Dxp.DataPersistentDataView
      Spotfire.Dxp.Data.VirtualColumnsVirtualColumn
      Spotfire.Dxp.Data.VirtualColumnsVirtualColumnAvailableInputCollection
      Spotfire.Dxp.Data.VirtualColumnsVirtualColumnCollection
      Spotfire.Dxp.Data.VirtualColumnsVirtualColumnInputCollection
      Spotfire.Dxp.Data.VirtualColumnsVirtualColumnProducer
      Spotfire.Dxp.Data.VirtualColumnsVirtualColumnProducerCollection
      Spotfire.Dxp.Framework.ApplicationModelDocumentOperation
      Spotfire.Dxp.Framework.DocumentModelDocumentNodeDictionaryTKey, TValue
      Spotfire.Dxp.Framework.DocumentModelDocumentNodeKeyedCollectionBaseTKey, TNode
      Spotfire.Dxp.Framework.DocumentModelDocumentNodeListBaseT
      Spotfire.Dxp.Framework.DocumentModelDocumentNodeSetT