Spotfire.Dxp.Application Namespace

Represents the currently running Spotfire instance. This object can therefore be used to control the running instance, for example open files or replace data.

If an analysis file (DXP file) has been opened in the application, an object representing that document is available through Document.

Used as argument to the Exiting event.

Represents a captured bookmark state.

The property names for Bookmark.

A collection container for bookmarks.

The property names for BookmarkCollection.

Represents a collection of custom nodes.

Represents the panel where the details-on-demand table is displayed.

Contains property name constants for the public properties of DetailsOnDemandPanel.

A document opened in a running instance of Spotfire is referred to as an Analysis Document. The document not only contains a series of metadata information (see DocumentMetadata), but it also contains references to the data itself (see DataManager), and to various other components being part of the document, such as pages, filterings, bookmarks, etc.

As soon as data has been opened in Spotfire, an instance of this class can be accessed through the Document property of the AnalysisApplication. This is regardless of whether the data was opened through the user interface or programmatically. Hence, new instances of this class cannot be created through calls to the constructor.

When a document is opened in Spotfire using the user interface, the document will be automatically configured to be ready for use. This includes creation of a new page and adding a default visualization to that page. When opening a document through the API, however, it is empty. To achieve the same result as opening the document through the user interface, a call to the AutoConfigure method must be made.

Contains property name constants for the public properties of Document.

Used as argument to the DocumentChanged event.

Represents settings for compatibility with older versions.

Contains property name constants for the public properties of DocumentCompatibility.

Provides access to metadata for the currently opened Document.

Provides settings and information used while a document is opened.

Provides access to the document properties in the document.

Contains predefined name constants for the default document properties.

Contains property name constants for the public properties of DocumentProperties.

The DocumentSaveSettings class provides settings and information used when a document is saved.

Represents content that can be served by a web server via HTTP.

Represents a collection of images stored in the document.

Contains property name constants for the public properties of ImageCollection.

Describes what menu category a Tool belongs to.

A page contains visuals and panels.

Contains property name constants for the public properties of Page.

A collection of visual pages in an analysis document. Note that new instances of this class cannot be created. The one and only instance is accessed through the Pages property of the Document class.

The instance of this class can be used directly either to enumerate or to modify the visual pages in the document, that is, add new pages, remove pages, move pages, etc.

Contains property name constants for the public properties of PageCollection.

Base class for panels placed at the sides or at the bottom of the application.

Contains property name constants for the public properties of Panel.

A collection of Panels.

Contains property name constants for the public properties of PanelCollection.

Defines the type identifiers for built-in panels.

This is the base class for creating share tools. It provides the ability to perform asynchronous prompting.

Represents a share tool execution context. This is a marker class for share tools.

Represents a stylable element in the user interface.

The Panel for the Tag Panel.

This is the base class for tools, that is, functionality available through the tools menu and on various context menus. A tool can be launched by calling its Execute(TContext) method. The ContextType property determines the type of context object the tool expects in the Execute(TContext) method call. For example, a tool with a ContextType of Page would expect a page (typically the ActivePageReference) to be passed to it.

Tools can belong to different categories. The category might affect where the tool is rendered in the Spotfire user interface. However, the category and the context of a tool are not interconnected. That is, two different tools may share the same context but have different categories.

Tools are accessed via the Toolbox.

This is a generic base class for tools. This class cannot be extended directly, instead refer to CustomToolTContext,

Contains the tools available to the application.

This class represents either a visualization or a text area.

Contains property name constants for the public properties of Visual.

A collection of Visual objects.

Contains property name constants for the public properties of VisualCollection.

Specifies the components to use when capturing a bookmark.

Used to specify the current navigation mode.

Describes what category a Tool belongs to.