Document Properties

Spotfire 14.2 API Reference

The Document type exposes the following members.

Properties

  NameDescription
Public propertyActiveDataTableReference
Gets the active DataTable. That is, the active DataTable of the active Visual, if there is any. May return null.
Public propertyActiveFilteringSelectionReference
Gets the active filter. That is, the active filtering of the active page if there is any. May return null.
Public propertyActiveMarkingSelectionReference
Gets the active marking. That is, the active marking of the active Visual, if there is any. May return null.
Public propertyActivePageReference
Gets or sets the currently active Page.

Note: This property can return null, but cannot be set to null.

Public propertyActiveVisualReference
Gets the active Visual. That is, the active Visual of the active Page, if there is any. May return null.
Public propertyBookmarks
Gets the collection of Bookmarks. The collection can be used to create new bookmarks or to find and apply existing ones.
Public propertyCalculations
Gets the collection of executions of calculations.
Public propertyColoringTemplates
Gets the coloring templates.
Public propertyCompatibility
Gets settings for compatibility with older versions.
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyCustomNodes
Gets the collection of custom nodes associated with this document.
Public propertyData
Gets the Data Manager, which can be used to access the data contained in this document.
Public propertyFilteringSchemes
Gets the collection of filter schemes in the document. The FilteringSchemeCollection can be used to access and/or manipulate filters and filtering schemes.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyPages
Gets the pages of this document.
Public propertyProperties
Gets the document properties.
Public propertyScriptManager
Gets the script manger.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyUseLightTooltips
Gets or sets a value controlling if tooltips are rendered using dark text on a light background (as in pre 4.0 versions), or light text on dark background.
Top
See Also

Reference