ColoringTemplateCollection Class

Spotfire 14.2 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: 64.0.19329.3263 (64.0.19329.3263)
Syntax

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

The ColoringTemplateCollection type exposes the following members.

Properties

  NameDescription
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyCount
Gets the number of items in the collection.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyItemInt32
Gets the Coloring at the given index.
Public propertyItemString
Gets the Coloring with the given name.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Top
Methods

  NameDescription
Public methodAddCopy(Coloring)
Adds a copy of the given Coloring.
Public methodAddCopy(Coloring, String)
Adds a copy of the given Coloring with a new display name.
Public methodAddFromLibrary
Adds the specified color scheme from the library to this ColoringTemplateCollection.
Public methodAddFromStream
Adds a Coloring to this collection by reading from the given stream. The content of the stream must be a dxpcolor file.
Public methodAddNew
Creates a new Coloring and adds it to this collection.
Public methodClear
Clears the collection.
Public methodContains
Determines whether a Coloring with the given name exists in this collection.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodRemoveAt
Removes the item at the given index.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetValue
Tries to get the Coloring with the specified name, returning true upon success.
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodIEnumerableColoringGetEnumerator
Returns an enumerator that iterates through the collection.
Explicit interface implementationPrivate methodIEnumerableGetEnumerator
Returns an enumerator that iterates through the collection.
Explicit interface implementationPrivate methodINodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference