Abstract base class for all Document Nodes.
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
Spotfire.Dxp.Framework.DocumentModelDocumentNode
More...
Namespace: Spotfire.Dxp.Framework.DocumentModel
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(3, 0)] public abstract class DocumentNode : Node, IDocumentNode, INode, IDocumentNodeOwner, IServiceProvider, IDocumentNodeChild, ITransactions, INodeContext
The DocumentNode type exposes the following members.
Constructors
Name | Description | |
---|---|---|
DocumentNode |
Initializes a new instance of the DocumentNode class.
| |
DocumentNode(SerializationInfo, StreamingContext) | Implements ISerializable. |
Methods
Name | Description | |
---|---|---|
CreateEventRelay(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.
| |
CreateEventRelay(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.
| |
CreatePropertyT(PropertyName, UndoableListT) |
Creates an UndoableListT and assigns it to the specified field.
The UndoableListT will have the specified propertyName.
| |
CreatePropertyT(PropertyName, UndoableSetT) |
Creates an UndoableSetT and assigns it to the specified field.
The UndoableSetT will have the specified propertyName.
| |
CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) |
Creates an UndoableCrossReferencePropertyT and assigns it to the specified field.
The UndoableCrossReferencePropertyT will have the specified propertyName and initialValue.
| |
CreatePropertyT(PropertyName, UndoablePropertyT, T) |
Creates an UndoablePropertyT and assigns it to the specified field.
The UndoablePropertyT will have the specified propertyName and initialValue.
| |
CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) |
Creates an UndoableDictionaryTKey, TValue and assigns it to the specified field.
The UndoableDictionaryTKey, TValue will have the specified propertyName.
| |
CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) |
Creates an UndoableKeyedCollectionTKey, TNode and assigns it to the specified field.
The UndoableKeyedCollectionTKey, TNode will have the specified propertyName.
| |
CreateReadOnlyPropertyT |
Creates a read-only property of type T and assigns it to the specified field.
| |
CreateRuntimeConstantT |
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.
| |
CreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) | Obsolete.
Creates a RuntimePropertyT.
| |
CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) |
Creates a RuntimePropertyT.
| |
DeclareInternalEventHandlers | Override this method to declare handlers of internal events.
| |
DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) |
Deserializes an UndoableCrossReferencePropertyT with value of type T
stored in info with key propertyName.
| |
DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) | ||
DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) | ||
DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) | ||
DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) | ||
DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) | ||
DeserializeReadOnlyPropertyT |
Deserializes a read-only property of type T
stored in info with key propertyName.
| |
DuplicateSubtreeT | 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. | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetPersistedTypeName | 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
| |
GetPersistedVersion | 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
| |
GetService | Override this method to provide services accessible
from this node and its descendants.
If you can not provide the requested service, you should call
base.GetService which relays the request to the owner
or to the AnalysisApplication if no owner is set.
(Inherited from Node.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
InternalTransaction |
Starts an internal transaction on the document model by
executing the specified executor delegate.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnConfigure |
Allows a node to configure itself to the surrounding document.
| |
OnConfigured |
Allows a node to configure itself to the surrounding document.
| |
OnReconfigure |
Allows a node to reconfigure itself to a new part of the surrounding document.
| |
OnReconfigured |
Allows a node to reconfigure itself to a new part of the surrounding document.
| |
SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT) | Serializes an Undoable*Property with value of type T
storing it in info with key property.Name.
| |
SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT) | Serializes an UndoableList with values of type T
storing it in info with key list.Name.
| |
SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT) | Serializes an UndoableProperty with value of type T
storing it in info with key property.Name.
| |
SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT) | Serializes an UndoableSet storing it in info
with key given by the property name of the set.
| |
SerializePropertyTKey, TValue(SerializationInfo, StreamingContext, UndoableDictionaryTKey, TValue) | Serializes an UndoableDictionary storing it in info
with key given by the property name of the dictionary.
| |
SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) |
Serializes an UndoableKeyedCollectionTKey, TNode storing it in info
with key given by the property name of the keyedCollection.
| |
SerializeReadOnlyPropertyT |
Serializes a read-only property of type T
stored in info with key propertyName.
| |
ValidateAttached | Validates that the node is attached.
|
Extension Methods
Name | Description | |
---|---|---|
GetServiceTService |
Convenience generic extension method that calls GetService(Type) and casts the result.
(Defined by Extensions.) |
Properties
Name | Description | |
---|---|---|
Context |
Gets the context of this node.
| |
IsAttached |
Gets a value indicating whether this node is attached.
| |
Transactions |
Gets a collection of methods for executing transactions on the document.
|
Explicit Interface Implementations
Name | Description | |
---|---|---|
IServiceProviderGetService |
Implements IServiceProvider.
(Inherited from Node.) | |
INodeContextGetAncestorT |
Implements GetAncestorT.
| |
INodeContextGetServiceT |
Implements GetServiceT.
| |
INodeContextIsDescendantOf |
Implements IsDescendantOf(DocumentNode).
| |
ITransactionsBeginAggregatedTransaction |
Implements BeginAggregatedTransaction.
| |
ITransactionsExecuteInvisibleTransaction |
Implements ExecuteInvisibleTransaction(Executor).
| |
ITransactionsExecuteStickyTransaction |
Implements ExecuteStickyTransaction(Guid, Executor).
| |
ITransactionsExecuteTransaction |
Implements ExecuteTransaction(Executor).
|
Remarks
- The class must be marked with the SerializableAttribute attribute.
- If objects of the class are intended to be persisted when the TIBCO Spotfire document is saved, the class must be marked with the PersistenceVersionAttribute attribute.
- The class must not implement any of the IDisposable or 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 DocumentNode.
- One of the Undoable building blocks of the document model (UndoablePropertyT, UndoableListT, UndoableDictionaryTKey, TValue, etc.).
- An instance of the RuntimePropertyT type.
- An instance of the RuntimeConstantT 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 DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) or DeserializeReadOnlyPropertyT(SerializationInfo, StreamingContext, PropertyName, T) are called to deserialize persisted state and initialize the fields of this class.
- The class must override GetObjectData(SerializationInfo, StreamingContext) in which SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT) or SerializeReadOnlyPropertyT(SerializationInfo, StreamingContext, PropertyName, T) are called to serialize the state held by the fields of this class.
Version Information
See Also
Reference
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
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.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.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.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.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