DocumentViewBeginUse Method TIBCO Spotfire 7.6 API Reference
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.

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

C#
public static IDisposable BeginUse(
	DocumentView documentView
)

Parameters

documentView
Type: Spotfire.Dxp.Framework.DocumentModelDocumentView
The document view, or null.

Return Value

Type: IDisposable
A handle that should be disposed when the specifed view no longer should be the current view.
Version Information

Supported in: 7.6, 7.5
See Also

Reference