ColoringCollection Members TIBCO Spotfire 6.0 API Reference
The ColoringCollection type exposes the following members.
Methods

  NameDescription
Public methodAddCopy
Adds a copy of the given color rule collection with a new display name.
Public methodAddMapping
Adds a mapping between the specified Coloring instance and the specified CategoryKey value. This means that the specified category will be colored by the specified coloring.
Public methodAddNew 
Adds a new Coloring instance to this ColoringCollection.
Public methodAddNew(String)
Adds a new Coloring instance to this ColoringCollection.
Public methodClear
Clears all Coloring instances and mappings in this ColoringCollection.
Public methodContains
Determines whether the given coloring exists in this collection.
Protected methodCreateEventRelay
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.)
Protected methodCreateProperty T (PropertyName, UndoableList T  ) (Inherited from DocumentNode.)
Protected methodCreateProperty T (PropertyName, UndoableSet T  ) (Inherited from DocumentNode.)
Protected methodCreateProperty TNode (PropertyName, UndoableCrossReferenceProperty TNode  , TNode) (Inherited from DocumentNode.)
Protected methodCreateProperty T (PropertyName, UndoableProperty T  , T) (Inherited from DocumentNode.)
Protected methodCreateProperty TKey, TValue (PropertyName, UndoableDictionary TKey, TValue  ) (Inherited from DocumentNode.)
Protected methodCreateProperty TKey, TNode (PropertyName, PropertyName, UndoableKeyedCollection TKey, TNode  ) (Inherited from DocumentNode.)
Protected methodCreateReadOnlyProperty T 
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.)
Protected methodCreateRuntimeConstant T 
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.)
Protected methodCreateRuntimeProperty T (PropertyName, RuntimeProperty T  , DependencyDeclarer, PropertyComputer T )Obsolete. (Inherited from DocumentNode.)
Protected methodCreateRuntimeProperty T (PropertyName, RuntimeProperty T  , StatelessDependencyDeclarer, StatelessPropertyComputer T ) (Inherited from DocumentNode.)
Protected methodDeclareInternalEventHandlers
Override this method to declare handlers of internal events.
(Inherited from DocumentNode.)
Protected methodDeserializeProperty T (SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferenceProperty T  ) (Inherited from DocumentNode.)
Protected methodDeserializeProperty T (SerializationInfo, StreamingContext, PropertyName, UndoableList T  ) (Inherited from DocumentNode.)
Protected methodDeserializeProperty T (SerializationInfo, StreamingContext, PropertyName, UndoableProperty T  ) (Inherited from DocumentNode.)
Protected methodDeserializeProperty T (SerializationInfo, StreamingContext, PropertyName, UndoableSet T  ) (Inherited from DocumentNode.)
Protected methodDeserializeProperty TKey, TValue (SerializationInfo, StreamingContext, PropertyName, UndoableDictionary TKey, TValue  ) (Inherited from DocumentNode.)
Protected methodDeserializeProperty TKey, TNode (SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollection TKey, TNode  ) (Inherited from DocumentNode.)
Protected methodDeserializeReadOnlyProperty T 
Deserializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected methodDuplicateSubtree T 
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.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetCategories
Gets all CategoryKey values that are currently mapped to any Coloring managed by this ColoringCollection.
Public methodGetCategoriesForColoring
Gets the CategoryKey values that are mapped to the specified Coloring, otherwise an empty list.
Public methodGetColoringForCategory
Gets the Coloring instance that is mapped to the specified CategoryKey value, otherwise the default coloring for the category's data type. If no type can be established for the given category, or if no default has been set, null is returned.
Protected methodGetPersistedTypeName
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.)
Protected methodGetPersistedVersion
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.)
Protected methodGetService
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.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInternalTransaction
Starts an internal transaction on the document model by executing the specified executor delegate.
(Inherited from DocumentNode.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnConfigure
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnConfigured
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigure
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Protected methodOnReconfigured
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Public methodRemove
Removes the specified Coloring instance and any mappings to it.
Public methodRemoveAt
Removes the item at the given index.
Public methodRemoveMapping
Removes the mapping between the specified Coloring instance and the specified CategoryKey value.
Protected methodSerializeProperty T (SerializationInfo, StreamingContext, UndoableCrossReferenceProperty T )
Serializes an Undoable*Property with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializeProperty T (SerializationInfo, StreamingContext, UndoableList T )
Serializes an UndoableList with values of type T storing it in info with key list.Name.
(Inherited from DocumentNode.)
Protected methodSerializeProperty T (SerializationInfo, StreamingContext, UndoableProperty T )
Serializes an UndoableProperty with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializeProperty T (SerializationInfo, StreamingContext, UndoableSet T )
Serializes an UndoableSet storing it in info with key given by the property name of the set.
(Inherited from DocumentNode.)
Protected methodSerializeProperty TKey, TValue (SerializationInfo, StreamingContext, UndoableDictionary TKey, TValue )
Serializes an UndoableDictionary storing it in info with key given by the property name of the dictionary.
(Inherited from DocumentNode.)
Protected methodSerializeProperty TKey, TNode (SerializationInfo, StreamingContext, UndoableKeyedCollection TKey, TNode ) (Inherited from DocumentNode.)
Protected methodSerializeReadOnlyProperty T 
Serializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected methodValidateAttached
Validates that the node is attached.
(Inherited from DocumentNode.)
Back to Top
Properties

  NameDescription
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyCount
Gets the number of items in the collection.
Public propertyDefaultBooleanReference
Gets or sets the default coloring for Boolean datatypes, the fallback if no mapping exists for an inquiry. When set, the given coloring must be owned by this ColoringCollection.
Public propertyDefaultDateReference
Gets or sets the default coloring for date datatypes, the fallback if no mapping exists for an inquiry. When set, the given coloring must be owned by this ColoringCollection.
Public propertyDefaultDateTimeReference
Gets or sets the default coloring for date time datatypes, the fallback if no mapping exists for an inquiry. When set, the given coloring must be owned by this ColoringCollection.
Public propertyDefaultNumericReference
Gets or sets the default coloring for numeric datatypes, the fallback if no mapping exists for an inquiry. When set, the given coloring must be owned by this ColoringCollection.
Public propertyDefaultStringReference
Gets or sets the default coloring for string datatypes, the fallback if no mapping exists for an inquiry. When set, the given coloring must be owned by this ColoringCollection.
Public propertyDefaultTimeReference
Gets or sets the default coloring for time datatypes, the fallback if no mapping exists for an inquiry. When set, the given coloring must be owned by this ColoringCollection.
Public propertyDefaultTimeSpanReference
Gets or sets the default coloring for TimeSpan datatypes, the fallback if no mapping exists for an inquiry. When set, the given coloring must be owned by this ColoringCollection.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyItem
Gets the Coloring at the given index.
Public propertyLegendItem
Gets the legend item used to display information about this ColoringCollection.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Back to Top
Explicit Interface Implementations

  NameDescription
Explicit interface implemetationPrivate methodIServiceProvider GetService
Implements IServiceProvider.
(Inherited from Node.)
Explicit interface implemetationPrivate methodINodeContext GetAncestor T  (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodINodeContext GetService T  (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodINodeContext IsDescendantOf (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodITransactions BeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodITransactions ExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodITransactions ExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implemetationPrivate methodITransactions ExecuteTransaction (Inherited from DocumentNode.)
Back to Top
See Also