Page Class

TIBCO Spotfire 7.6 API Reference

A page contains visuals and panels.

Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Framework.DocumentModelNode
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.ApplicationPage

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

Syntax

Copy

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

The Page type exposes the following members.

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.
	CreateEventRelay(PropertyName, StatelessDependencyDeclarer)	Creates an event relay. An event relay is a property in the document model which propagates event. An event is raised for the event relay whenever when the trigger returned by the specified dependencyDeclarer fires. (Inherited from DocumentNode.)
	CreateEventRelay(PropertyName, StatelessDependencyDeclarer, EventRelayMode)	Creates an event relay. An event relay is a property in the document model which propagates event. An event is raised for the event relay whenever when the trigger returned by the specified dependencyDeclarer fires. (Inherited from DocumentNode.)
	CreatePropertyT(PropertyName, UndoableListT)	Creates an UndoableListT and assigns it to the specified field. The UndoableListT will have the specified propertyName. (Inherited from DocumentNode.)
	CreatePropertyT(PropertyName, UndoableSetT)	Creates an UndoableSetT and assigns it to the specified field. The UndoableSetT will have the specified propertyName. (Inherited from DocumentNode.)
	CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode)	Creates an UndoableCrossReferencePropertyT and assigns it to the specified field. The UndoableCrossReferencePropertyT will have the specified propertyName and initialValue. (Inherited from DocumentNode.)
	CreatePropertyT(PropertyName, UndoablePropertyT, T)	Creates an UndoablePropertyT and assigns it to the specified field. The UndoablePropertyT will have the specified propertyName and initialValue. (Inherited from DocumentNode.)
	CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue)	Creates an UndoableDictionaryTKey, TValue and assigns it to the specified field. The UndoableDictionaryTKey, TValue will have the specified propertyName. (Inherited from DocumentNode.)
	CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode)	Creates an UndoableKeyedCollectionTKey, TNode and assigns it to the specified field. The UndoableKeyedCollectionTKey, TNode will have the specified propertyName. (Inherited from DocumentNode.)
	CreateReadOnlyPropertyT	Creates a read-only property of type T and assigns it to the specified field. (Inherited from DocumentNode.)
	CreateRuntimeConstantT	Creates a runtime constant. A runtime constant is a property in the document model whose value is computed once when first accessed. The value is then disposed along with the DocumentNode. (Inherited from DocumentNode.)
	CreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT)	Obsolete. Creates a RuntimePropertyT. (Inherited from DocumentNode.)
	CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT)	Creates a RuntimePropertyT. (Inherited from DocumentNode.)
	DeclareInternalEventHandlers	Override this method to declare handlers of internal events. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT)	Deserializes an UndoableCrossReferencePropertyT with value of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT)	Deserializes an UndoableListT with value of type T stored in info with key given by propertyName. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT)	Deserializes an UndoablePropertyT with value of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT)	Deserializes an UndoableSetT with value of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue)	Deserializes an UndoableDictionaryTKey, TValue stored in info with key given by propertyName. (Inherited from DocumentNode.)
	DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode)	Deserializes an UndoableKeyedCollectionTKey, TNode stored in info with key given by propertyName. (Inherited from DocumentNode.)
	DeserializeReadOnlyPropertyT	Deserializes a read-only property of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	Duplicate	Obsolete. Returns a copy of this Page intended to be attached immediately.
	DuplicateSubtreeT	Returns a copy of the sub tree spanned from this node that has the same outwards non-owning references. The returned copy will be in state New and is intended to be attached to the document immediately. (Inherited from DocumentNode.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetPersistedTypeName	Can be used in the deserialization constructor to get the type name that the class corresponding to this class had when it was originally serialized. Will return null if the specified caller type has no correspondence in the serialized information (Inherited from DocumentNode.)
	GetPersistedVersion	Can be used in the deserialization constructor to get the persistence version that this class was marked with when it was originally serialized. Will return null if the specified caller type has no correspondence in the serialized information (Inherited from DocumentNode.)
	GetService	Override this method to provide services accessible from this node and its descendants. If you can not provide the requested service, you should call base.GetService which relays the request to the owner or to the AnalysisApplication if no owner is set. (Inherited from Node.)
	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.
	InternalTransaction	Starts an internal transaction on the document model by executing the specified executor delegate. (Inherited from DocumentNode.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnConfigure	Allows a node to configure itself to the surrounding document. (Inherited from DocumentNode.)
	OnConfigured	Allows a node to configure itself to the surrounding document. (Inherited from DocumentNode.)
	OnReconfigure	Allows a node to reconfigure itself to a new part of the surrounding document. (Inherited from DocumentNode.)
	OnReconfigured	Allows a node to reconfigure itself to a new part of the surrounding document. (Inherited from DocumentNode.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT)	Serializes an Undoable*Property with value of type T storing it in info with key property.Name. (Inherited from DocumentNode.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT)	Serializes an UndoableList with values of type T storing it in info with key list.Name. (Inherited from DocumentNode.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT)	Serializes an UndoableProperty with value of type T storing it in info with key property.Name. (Inherited from DocumentNode.)
	SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT)	Serializes an UndoableSet storing it in info with key given by the property name of the set. (Inherited from DocumentNode.)
	SerializePropertyTKey, TValue(SerializationInfo, StreamingContext, UndoableDictionaryTKey, TValue)	Serializes an UndoableDictionary storing it in info with key given by the property name of the dictionary. (Inherited from DocumentNode.)
	SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode)	Serializes an UndoableKeyedCollectionTKey, TNode storing it in info with key given by the property name of the keyedCollection. (Inherited from DocumentNode.)
	SerializeReadOnlyPropertyT	Serializes a read-only property of type T stored in info with key propertyName. (Inherited from DocumentNode.)
	ValidateAttached	Validates that the node is attached. (Inherited from DocumentNode.)

Top

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.
	Id	Gets the unique id for this instance.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Panels	Gets the Panel collection for the Page.
	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.)
	Visuals	Gets the collection of Visual objects on this Page.

Top

Explicit Interface Implementations

	Name	Description
	IServiceProviderGetService	Implements IServiceProvider. (Inherited from Node.)
	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.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (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: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference

Spotfire.Dxp.Application Namespace

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0See Also

Reference

Supported in: 7.6, 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also