Document Methods

Spotfire 14.5 API Reference

The Document type exposes the following members.

Methods

  NameDescription
Public methodApplyUserPreferences
Applies the current user's preferences to a newly created document.
Public methodAutoConfigure
Configures a newly created document with reasonable default values such as an initial page with a visualization on it and a filter panel containing default filters for all columns and hierarchies.
Public methodExport Obsolete.
Exports the document to PDF using the settings and saves the result in the specified directory.
Public methodForEachNodeInSubTree<TNode>
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
(Inherited from DocumentNode.)
Public methodGetReports
Gets the prepared Reports saved in the document.
Public methodGetStyle
Gets the style properties for an element in the user interface.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetReport
Tries to get the Report specified by name.
Top
Extension Methods

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

  NameDescription
Explicit interface implementationPrivate methodINodeContext.GetAncestor<T> (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContext.GetService<T> (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContext.IsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.BeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.ExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.ExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.ExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.ExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.ExecuteTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactions.ExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
See Also

Reference