Defines the input to a DataRelationshipsCalculation
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.Application.CalculationsCalculationSettings
Spotfire.Dxp.Application.Calculations.DataRelationshipsDataRelationshipsCalculationSettings
Namespace: Spotfire.Dxp.Application.Calculations.DataRelationships
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(3, 0)] public sealed class DataRelationshipsCalculationSettings : CalculationSettings
The DataRelationshipsCalculationSettings type exposes the following members.
Methods
Name | Description | |
---|---|---|
AddDependency(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.
(Inherited from CalculationSettings.) | |
AddDependency(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.
(Inherited from CalculationSettings.) | |
AddDependency(CalculationDependencyIdentifier, IEnumerableDataColumn) |
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.
(Inherited from CalculationSettings.) | |
ApplyPreferences |
Initializes the settings with the preferences of the current user.
Preferences consists of the two column sets, the comparison method and table name to operate on.
| |
CreateEventRelay(PropertyName, StatelessDependencyDeclarer) |
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.) | |
CreateEventRelay(PropertyName, StatelessDependencyDeclarer, EventRelayMode) |
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.) | |
CreatePropertyT(PropertyName, UndoableListT) |
Creates an UndoableListT and assigns it to the specified field.
The UndoableListT will have the specified propertyName.
(Inherited from DocumentNode.) | |
CreatePropertyT(PropertyName, UndoableSetT) |
Creates an UndoableSetT and assigns it to the specified field.
The UndoableSetT will have the specified propertyName.
(Inherited from DocumentNode.) | |
CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) |
Creates an UndoableCrossReferencePropertyT and assigns it to the specified field.
The UndoableCrossReferencePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) | |
CreatePropertyT(PropertyName, UndoablePropertyT, T) |
Creates an UndoablePropertyT and assigns it to the specified field.
The UndoablePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) | |
CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) |
Creates an UndoableDictionaryTKey, TValue and assigns it to the specified field.
The UndoableDictionaryTKey, TValue will have the specified propertyName.
(Inherited from DocumentNode.) | |
CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) |
Creates an UndoableKeyedCollectionTKey, TNode and assigns it to the specified field.
The UndoableKeyedCollectionTKey, TNode will have the specified propertyName.
(Inherited from DocumentNode.) | |
CreateReadOnlyPropertyT |
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.) | |
CreateRuntimeConstantT |
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.) | |
CreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) | Obsolete.
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) | |
CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) |
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) | |
DeclareInternalEventHandlers | Override this method to declare handlers of internal events.
(Inherited from CalculationSettings.) | |
DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) |
Deserializes an UndoableCrossReferencePropertyT with value of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) | |
DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) | (Inherited from DocumentNode.) | |
DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) | (Inherited from DocumentNode.) | |
DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) | (Inherited from DocumentNode.) | |
DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) | (Inherited from DocumentNode.) | |
DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) | (Inherited from DocumentNode.) | |
DeserializeReadOnlyPropertyT |
Deserializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) | |
DuplicateSubtreeT | 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.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetAdditionalIsValidTriggers |
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.
(Inherited from CalculationSettings.) | |
GetAdditionalNeedsRefreshTriggers |
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.
(Inherited from CalculationSettings.) | |
GetColumnDependencies |
Get the column dependencies identified by a given CalculationDependencyIdentifier (Inherited from CalculationSettings.) | |
GetDataSelectionDependency |
Get the DataSelection dependency identified by a given CalculationDependencyIdentifier (Inherited from CalculationSettings.) | |
GetPersistedTypeName | 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.) | |
GetPersistedVersion | 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.) | |
GetSelectedRows | Obsolete.
Gets the selected rows for a datatable and a CalculationDependencyIdentifier that has been registered together with
a DataSelection.
(Inherited from CalculationSettings.) | |
GetService | 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.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetUpdateBehaviorTriggerCore |
Override this method to provide a trigger which fire when the value of the UpdateBehavior changes.
(Inherited from CalculationSettings.) | |
InternalTransaction |
Starts an internal transaction on the document model by
executing the specified executor delegate.
(Inherited from DocumentNode.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnConfigure |
Allows a node to configure itself to the surrounding document.
(Inherited from CalculationSettings.) | |
OnConfigured |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) | |
OnReconfigure |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) | |
OnReconfigured |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) | |
SavePreferences |
Saves the user preferences to match the current settings.
Preferences consists of the two column sets, the comparison method and table name to operate on.
| |
SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT) | Serializes an Undoable*Property with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) | |
SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT) | Serializes an UndoableList with values of type T
storing it in info with key list.Name.
(Inherited from DocumentNode.) | |
SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT) | Serializes an UndoableProperty with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) | |
SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT) | Serializes an UndoableSet storing it in info
with key given by the property name of the set.
(Inherited from DocumentNode.) | |
SerializePropertyTKey, TValue(SerializationInfo, StreamingContext, UndoableDictionaryTKey, TValue) | Serializes an UndoableDictionary storing it in info
with key given by the property name of the dictionary.
(Inherited from DocumentNode.) | |
SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) |
Serializes an UndoableKeyedCollectionTKey, TNode storing it in info
with key given by the property name of the keyedCollection.
(Inherited from DocumentNode.) | |
SerializeReadOnlyPropertyT |
Serializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) | |
ValidateAttached | Validates that the node is attached.
(Inherited from DocumentNode.) | |
ValidateSettings |
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.
(Inherited from CalculationSettings.) |
Properties
Name | Description | |
---|---|---|
ComparisonMethod | Gets or sets the ComparisonMethod of the data relationships
calculation.
| |
Context |
Gets the context of this node.
(Inherited from DocumentNode.) | |
DataFilteringSelectionReference |
Specifies which DataFilteringSelection the DataRelationshipsCalculation operates on.
| |
IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) | |
IsNew |
Gets whether or not a settings object is new, that is, is associated
with a calculation instance that has not been executed yet.
(Inherited from CalculationSettings.) | |
Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) | |
UpdateBehavior |
Gets the update behavior of the calculation.
(Inherited from CalculationSettings.) | |
XColumns | Represents one of the column sets to compare.
| |
YColumns | Represents one of the column sets to compare.
|
Explicit Interface Implementations
Name | Description | |
---|---|---|
IServiceProviderGetService |
Implements IServiceProvider.
(Inherited from Node.) | |
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.) | |
ITransactionsExecuteStickyTransaction |
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.) | |
ITransactionsExecuteTransaction |
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.) |
Version Information
See Also