VisualCollection Class

Spotfire 14.5 API Reference

A collection of Visual objects.

Inheritance Hierarchy

System.Object
  Node
    Spotfire.Dxp.Framework.DocumentModel.DocumentNode
      Spotfire.Dxp.Application.VisualCollection

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(2, 0)]
public sealed class VisualCollection : DocumentNode, 
	IEnumerable<Visual>, IEnumerable

The VisualCollection type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Count	Gets the number of Visuals in this collection.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	AddDuplicate	Creates a duplicate of the specified Visual and adds it to the collection.
	AddNew(ModIdentifier)	Adds a new visual with a ModVisualization content as specified by the modIdentifier.
	AddNew(TypeIdentifier)	Creates a new Visual with a visual of the type identified by visualTypeId and adds it to the collection.
	AddNew<T>()	Adds a new visual of the specified type.
	Contains	Determines whether the visual is in the collection.
	ForEachNodeInSubTree<TNode>	Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node. (Inherited from DocumentNode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Remove	Removes the specified Visual.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetVisual	Tries to get a visual specified by its id.

Top

Explicit Interface Implementations

	Name	Description
	IEnumerable<Visual>.GetEnumerator	Returns an enumerator that iterates through the collection.
	IEnumerable.GetEnumerator	Returns an enumerator that iterates through a collection.
	INodeContext.GetAncestor<T>	Implements GetAncestor<T>(). (Inherited from DocumentNode.)
	INodeContext.GetService<T>	Implements GetService<T>(). (Inherited from DocumentNode.)
	INodeContext.IsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactions.BeginAggregatedTransaction	Implements BeginAggregatedTransaction(). (Inherited from DocumentNode.)
	ITransactions.ExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactions.ExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactions.ExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactions.ExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Version Information

Supported in: 14.5, 14.4, 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