ColoringTemplateCollection Class

Spotfire 15.0 API Reference

Collection class used to store templates used for coloring in visualizations. In a document, the template collection can be accessed at ColoringTemplates.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.Visuals.ConditionalColoringColoringTemplateCollection

Namespace: Spotfire.Dxp.Application.Visuals.ConditionalColoring
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 71.0.22122.5390 (71.0.22122.5390)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(6, 0)]
public sealed class ColoringTemplateCollection : DocumentNode, 
	IEnumerable<Coloring>, IEnumerable

The ColoringTemplateCollection type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Count	Gets the number of items in the collection.
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	ItemInt32	Gets the Coloring at the given index.
	ItemString	Gets the Coloring with the given name.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	AddCopy(Coloring)	Adds a copy of the given Coloring.
	AddCopy(Coloring, String)	Adds a copy of the given Coloring with a new display name.
	AddFromLibrary	Adds the specified color scheme from the library to this ColoringTemplateCollection.
	AddFromStream	Adds a Coloring to this collection by reading from the given stream. The content of the stream must be a dxpcolor file.
	AddNew	Creates a new Coloring and adds it to this collection.
	Clear	Clears the collection.
	Contains	Determines whether a Coloring with the given name exists in this collection.
	ForEachNodeInSubTreeTNode	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.)
	RemoveAt	Removes the item at the given index.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetValue	Tries to get the Coloring with the specified name, returning true upon success.

Top

Explicit Interface Implementations

	Name	Description
	IEnumerableColoringGetEnumerator	Returns an enumerator that iterates through the collection.
	IEnumerableGetEnumerator	Returns an enumerator that iterates through the collection.
	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

Version Information

Reference

Spotfire.Dxp.Application.Visuals.ConditionalColoring Namespace