Page Class

Spotfire 14.3 API Reference

A page contains visuals and panels.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.ApplicationPage

Namespace: Spotfire.Dxp.Application
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)

Syntax

Copy

[SerializableAttribute]
[ToolContextAttribute]
[PersistenceVersionAttribute(43, 0)]
public sealed class Page : DocumentNode, IServiceProvider

The Page type exposes the following members.

Properties

	Name	Description
	ActiveDataTableReference	Gets the active DataTable. That is, the active DataTable of the active Visual, if there is any. May return null.
	ActiveFilteringSelectionReference	Gets the active filter. That is, the active filtering of the active page if there is any. May return null.
	ActiveMarkingSelectionReference	Gets the active marking. That is, the active marking of the active Visual, if there is any. May return null.
	ActiveVisualReference	Gets or sets the active Visual. That is, the active Visual of the active Page, if there is any. May return null.
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	CustomNodes	Gets the collection of custom nodes associated with this page.
	DetailsOnDemandPanel	Gets the details on demand panel for this Page.
	FilterPanel	Gets the filter panel for this Page.
	HasMinimumHeight	Gets or sets a value indicating whether a minimum height has been set for the page.
	HasMinimumWidth	Gets or sets a value indicating whether a minimum width has been set for the page.
	Id	Gets the unique id for this instance.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	MinimumHeight	Gets or sets the minimum height of the page. This is used if HasMinimumHeight is set to true.
	MinimumWidth	Gets or sets the minimum width of the page. This is used if HasMinimumWidth is set to true.
	Panels	Gets the Panel collection for the Page.
	ShowActiveVisualMaximized	Gets or sets a value indicating whether to show the active visual maximized.
	Title	Gets or sets the page title. If set to a title that is not unique, the provided title will be modified in such a way that it becomes unique.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	Visible	Gets or sets a value indicating whether this Page is visible.
	Visuals	Gets the collection of Visual objects on this Page.

Top

Methods

	Name	Description
	ApplyLayout(LayoutDefinition)	Applies the supplied LayoutDefinition to the Visuals in this Page.
	ApplyLayout(TileMode)	Applies the supplied TileMode to the Page.
	AutoConfigure	Configures this page in a default way.
	AutoConfigure(Page)	Configures this page using settings from the specified source page.
	Duplicate	Obsolete. Returns a copy of this Page intended to be attached immediately.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetVisualBounds(Visual)	Gets the bounds of a visual in the user interface.
	GetVisualBounds(Visual, Rectangle)	Gets the bounds of a visual given a rectangle defining a visualization area.
	GetVisualizationAreaSize	Gets the size of the visualization area in the user interface.
	RenderAsync	Renders the page asynchronously to a PNG image with the specified settings.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	GetServiceTService	Convenience generic extension method that calls GetService(Type) and casts the result. (Defined by Extensions.)

Top

Explicit Interface Implementations

	Name	Description
	INodeContextGetAncestorT	Implements GetAncestorT. (Inherited from DocumentNode.)
	INodeContextGetServiceT	Implements GetServiceT. (Inherited from DocumentNode.)
	INodeContextIsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactionsBeginAggregatedTransaction	Implements BeginAggregatedTransaction. (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Remarks

The visuals are displayed in the visualization area at the center of the page. The panels are docked to the sides around the visualization area.

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

Reference

Spotfire.Dxp.Application Namespace