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

  NameDescription
Protected methodAddDependency(CalculationDependencyIdentifier, DataColumn)
Creates a dependency on a DataColumn identified by identifier. If a dependency with that identifier already exists it will replace the old dependency with the new one.
Protected methodAddDependency(CalculationDependencyIdentifier, DataSelection)
Creates a dependency on a dataselection identified by identifier. If a dependency with that identifier already exists it will replace the old dependency with the new one.
Protected methodAddDependency(CalculationDependencyIdentifier, IEnumerable DataColumn )
Creates a dependency on a number of DataColumn objects identified by identifier. If a dependency with that identifier already exists it will replace the old dependency with the new one.
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.
(Overrides DocumentNode DeclareInternalEventHandlers(InternalEventManager).)
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.)
Protected methodGetAdditionalIsValidTriggers
If a subclass has additional dependencies besides those added to the baseclass this method can be overridden to indicate when the input to the calculation has changed/disappeared so the calculation can no longer produce a sensible result. This will trigger the Calculation.HasValidValue property and cause invalid columns to be output the next time the calculation is run.
Protected methodGetAdditionalNeedsRefreshTriggers
If a subclass has additional dependencies besides those added to the baseclass this method can be overridden to indicate when the input to the calculation has changed to warrant an invalidation or recalculation depending on UpdateBehavior. This will trigger the Calculation.NeedsRefresh property.
Protected methodGetColumnDependencies
Get the column dependencies identified by a given CalculationDependencyIdentifier
Protected methodGetDataSelectionDependency
Get the DataSelection dependency identified by a given CalculationDependencyIdentifier
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 methodGetSelectedRowsObsolete.
Gets the selected rows for a datatable and a CalculationDependencyIdentifier that has been registered together with a DataSelection.
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 methodGetUpdateBehaviorTriggerCore
Override this method to provide a trigger which fire when the value of the UpdateBehavior changes.
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.
(Overrides DocumentNode OnConfigure .)
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.)
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.)
Public methodValidateSettings
Validates the suggested columns, filtering selections and marking selections with respect to the current Settings and Results. In particular this means checking for circular references. This method is meant to be called from a dialog before allowing the user to set up dependencies that would cause errors. If the implementer forgets to do this the framework will run the same check before trying to calculate but without any chance for the user to modify their choices.
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