DocumentView Class

Spotfire 14.3 API Reference
This class is used to control which view of the document that is used when getting and settings properties of the document model. A document has multiple views if the user has opened multiple browser tabs for the document in the web client, or if a javascript mashup uses multiple views.

Each view of the document can have different values for active page, active visualization, active data table, active marking, and active filtering selection. The value of these properties depends on the currently active view of the document. This class provides the API for getting and setting the current view of the document. We will refer to these properties as view properties.

The current document view is stored in a thread static variable and is thus associated with the current thread.

Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Framework.DocumentModelDocumentView

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

C#
public sealed class DocumentView

The DocumentView type exposes the following members.

Properties

  NameDescription
Public propertyStatic memberCurrent
Gets the view of the document that is currently associated with the current thread. The current view of the document determines the value of the properties for active page, active visualization, active data table, active marking, and active filtering selection.
Top
Methods

  NameDescription
Public methodStatic memberBeginUse
Sets the specifed document view as the current view of the document for the current thread.

The current view of the document determines the value of the properties for active page, active visualization, active data table, active marking, and active filtering selection.

This method returns a handle that must be disposed. The current document view will be restored when the handle is disposed.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodStatic memberForEach
Executes the specified action for each view of the document.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
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.)
Top
Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference