DocumentNode Class

DocumentNode Class

TIBCO Spotfire 6.0 API Reference

Abstract base class for all Document Nodes.

Inheritance Hierarchy

System Object
  Spotfire.Dxp.Framework.DocumentModel Node
    Spotfire.Dxp.Framework.DocumentModel DocumentNode
      Spotfire.Dxp.Application Bookmark
      Spotfire.Dxp.Application.Calculations CalculationDependency
      Spotfire.Dxp.Application.Calculations CalculationDependencyCollection
      Spotfire.Dxp.Application.Calculations CalculationResults
      Spotfire.Dxp.Application.Calculations CalculationSettings
      Spotfire.Dxp.Application.Calculations ColumnsCalculationResult
      Spotfire.Dxp.Application CustomNodes
      Spotfire.Dxp.Application Document
      Spotfire.Dxp.Application DocumentProperties
      Spotfire.Dxp.Application.Extension CustomNode
      Spotfire.Dxp.Application.Filters Filter
      Spotfire.Dxp.Application.Filters FilterBase
      Spotfire.Dxp.Application.Filters FilterGroupItem
      Spotfire.Dxp.Application ImageCollection
      Spotfire.Dxp.Application.Layout VisualizationAreaSize
      Spotfire.Dxp.Application Page
      Spotfire.Dxp.Application Panel
      Spotfire.Dxp.Application PanelCollection
      Spotfire.Dxp.Application.Scripting ScriptManager
      Spotfire.Dxp.Application Visual
      Spotfire.Dxp.Application VisualCollection
      Spotfire.Dxp.Application.Visuals Axis
      Spotfire.Dxp.Application.Visuals Axis CategoricalAxis
      Spotfire.Dxp.Application.Visuals Axis ContinuousAxis
      Spotfire.Dxp.Application.Visuals AxisBinding
      Spotfire.Dxp.Application.Visuals BoxPlotComparisonCircles
      Spotfire.Dxp.Application.Visuals BoxPlotReferencePoint
      Spotfire.Dxp.Application.Visuals BoxPlotStatisticsTable
      Spotfire.Dxp.Application.Visuals Camera
      Spotfire.Dxp.Application.Visuals CategoricalColorEntry
      Spotfire.Dxp.Application.Visuals ColorScheme
      Spotfire.Dxp.Application.Visuals CombinationChartBarProperties
      Spotfire.Dxp.Application.Visuals CombinationChartLineProperties
      Spotfire.Dxp.Application.Visuals.ConditionalColoring ColorBreakpoint
      Spotfire.Dxp.Application.Visuals.ConditionalColoring ColorBreakpointCollection
      Spotfire.Dxp.Application.Visuals.ConditionalColoring Coloring
      Spotfire.Dxp.Application.Visuals.ConditionalColoring ColoringCollection
      Spotfire.Dxp.Application.Visuals.ConditionalColoring ColoringTemplateCollection
      Spotfire.Dxp.Application.Visuals.ConditionalColoring ColorRule
      Spotfire.Dxp.Application.Visuals ContinuousColorEntry
      Spotfire.Dxp.Application.Visuals CrossTableSubtotal
      Spotfire.Dxp.Application.Visuals CrossTableSubtotalCollection
      Spotfire.Dxp.Application.Visuals Dendrogram
      Spotfire.Dxp.Application.Visuals DetailItem
      Spotfire.Dxp.Application.Visuals DetailItemCollection
      Spotfire.Dxp.Application.Visuals Details
      Spotfire.Dxp.Application.Visuals ErrorBars
      Spotfire.Dxp.Application.Visuals ExpressionColumn
      Spotfire.Dxp.Application.Visuals FilterRule
      Spotfire.Dxp.Application.Visuals FilterRuleCollection
      Spotfire.Dxp.Application.Visuals.FittingModels FittingModel
      Spotfire.Dxp.Application.Visuals.FittingModels ReferenceCurve
      Spotfire.Dxp.Application.Visuals.FittingModels ReferenceDetailItem
      Spotfire.Dxp.Application.Visuals.FittingModels ReferencePoint
      Spotfire.Dxp.Application.Visuals Formatting
      Spotfire.Dxp.Application.Visuals Legend
      Spotfire.Dxp.Application.Visuals Legend LegendItemCollection
      Spotfire.Dxp.Application.Visuals LegendItem
      Spotfire.Dxp.Application.Visuals LineConnection
      Spotfire.Dxp.Application.Visuals MapChartLayer
      Spotfire.Dxp.Application.Visuals.Miniatures BulletGraphColorRange
      Spotfire.Dxp.Application.Visuals.Miniatures BulletGraphColorRangeCollection
      Spotfire.Dxp.Application.Visuals.Miniatures CalculatedValueRule
      Spotfire.Dxp.Application.Visuals.Miniatures CalculatedValueRuleCollection
      Spotfire.Dxp.Application.Visuals.Miniatures GraphicalTableColumn
      Spotfire.Dxp.Application.Visuals.Miniatures GraphicalTableColumnCollection
      Spotfire.Dxp.Application.Visuals.Miniatures GraphicalTableColumnSortInfo
      Spotfire.Dxp.Application.Visuals.Miniatures GraphicalTableColumnSortInfoCollection
      Spotfire.Dxp.Application.Visuals.Miniatures IconRule
      Spotfire.Dxp.Application.Visuals.Miniatures IconRuleCollection
      Spotfire.Dxp.Application.Visuals ParallelCoordinatePlotColumnScale
      Spotfire.Dxp.Application.Visuals PieChartVisualAttributes
      Spotfire.Dxp.Application.Visuals PieMarker
      Spotfire.Dxp.Application.Visuals ReferenceLine
      Spotfire.Dxp.Application.Visuals ReferenceLines
      Spotfire.Dxp.Application.Visuals RuleCondition
      Spotfire.Dxp.Application.Visuals ScaleBase
      Spotfire.Dxp.Application.Visuals ScaleLabels
      Spotfire.Dxp.Application.Visuals ScaleLabelsLevelSettings
      Spotfire.Dxp.Application.Visuals ShapeScheme
      Spotfire.Dxp.Application.Visuals ShapeSchemeEntry
      Spotfire.Dxp.Application.Visuals SummaryTableAggregationColumn
      Spotfire.Dxp.Application.Visuals SummaryTableSortColumn
      Spotfire.Dxp.Application.Visuals SummaryTableVisibleColumn
      Spotfire.Dxp.Application.Visuals SummaryTableVisibleColumnCollection
      Spotfire.Dxp.Application.Visuals TableColumnCollection
      Spotfire.Dxp.Application.Visuals TablePlotColumn
      Spotfire.Dxp.Application.Visuals TablePlotColumnCollection T
      Spotfire.Dxp.Application.Visuals TableSortInfoCollection
      Spotfire.Dxp.Application.Visuals Trellis
      Spotfire.Dxp.Application.Visuals.ValueRenderers ValueRendererSettings
      Spotfire.Dxp.Application.Visuals VisualContent
      Spotfire.Dxp.Application.Visuals VisualizationData
      Spotfire.Dxp.Application.Visuals VisualizationFilteringCollection
      Spotfire.Dxp.Application.Visuals VisualizationRelations
      Spotfire.Dxp.Application.Visuals VisualizationSubset
      Spotfire.Dxp.Application.Visuals VisualizationSubsetCollection
      Spotfire.Dxp.Data Calculation
      Spotfire.Dxp.Data ColumnRelationCollection
      Spotfire.Dxp.Data DataColumn
      Spotfire.Dxp.Data DataColumnCollection
      Spotfire.Dxp.Data DataFilteringSelectionCollection
      Spotfire.Dxp.Data.DataFunctions DataFunction
      Spotfire.Dxp.Data.DataFunctions DataFunctionCollection
      Spotfire.Dxp.Data.DataFunctions DataFunctionInput
      Spotfire.Dxp.Data.DataFunctions DataFunctionInputCollection
      Spotfire.Dxp.Data.DataFunctions DataFunctionOutput
      Spotfire.Dxp.Data.DataFunctions DataFunctionOutputCollection
      Spotfire.Dxp.Data DataManager
      Spotfire.Dxp.Data DataMarkingSelectionCollection
      Spotfire.Dxp.Data DataProperty
      Spotfire.Dxp.Data DataPropertyRegistry
      Spotfire.Dxp.Data DataRelation
      Spotfire.Dxp.Data DataRelationCollection
      Spotfire.Dxp.Data DataSelection
      Spotfire.Dxp.Data DataTable
      Spotfire.Dxp.Data DataTableCollection
      Spotfire.Dxp.Data HighlightSelection
      Spotfire.Dxp.Data PersistentDataView
      Spotfire.Dxp.Data.VirtualColumns VirtualColumn
      Spotfire.Dxp.Data.VirtualColumns VirtualColumnAvailableInputCollection
      Spotfire.Dxp.Data.VirtualColumns VirtualColumnCollection
      Spotfire.Dxp.Data.VirtualColumns VirtualColumnInputCollection
      Spotfire.Dxp.Data.VirtualColumns VirtualColumnProducer
      Spotfire.Dxp.Data.VirtualColumns VirtualColumnProducerCollection
      Spotfire.Dxp.Framework.ApplicationModel DocumentOperation
      Spotfire.Dxp.Framework.DocumentModel DocumentNodeDictionary TKey, TValue
      Spotfire.Dxp.Framework.DocumentModel DocumentNodeKeyedCollectionBase TKey, TNode
      Spotfire.Dxp.Framework.DocumentModel DocumentNodeListBase T
      Spotfire.Dxp.Framework.DocumentModel DocumentNodeSet T

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

Syntax

Copy to Clipboard Print

[SerializableAttribute]
[PersistenceVersionAttribute(3, 0)]
public abstract class DocumentNode : Node, 
	IDocumentNode, INode, IDocumentNodeOwner, IServiceProvider, IDocumentNodeChild, 
	ITransactions, INodeContext

[SerializableAttribute]
[PersistenceVersionAttribute(3, 0)]
public abstract class DocumentNode : Node, 
	IDocumentNode, INode, IDocumentNodeOwner, IServiceProvider, IDocumentNodeChild, 
	ITransactions, INodeContext

Remarks

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

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 (UndoableProperty T , UndoableList T , UndoableDictionary TKey, TValue , etc.).
- An instance of the RuntimeProperty T type.
- An instance of the RuntimeConstant T 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 DeserializeProperty T (SerializationInfo, StreamingContext, PropertyName, UndoableProperty T ) or DeserializeReadOnlyProperty T (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 SerializeProperty T (SerializationInfo, StreamingContext, UndoableProperty T ) or SerializeReadOnlyProperty T (SerializationInfo, StreamingContext, PropertyName, T) are called to serialize the state held by the fields of this class.

See Also

DocumentNode Members

Spotfire.Dxp.Framework.DocumentModel Namespace

Built: 12/02/2013.

Online ©2013 TIBCO. All Rights Reserved. (http://www.tibco.com)

Send Feedback on this topic.