An abstract class for implementing custom virtual column producers.
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.Data.VirtualColumnsVirtualColumnProducer
Spotfire.Dxp.Application.ExtensionCustomVirtualColumnProducer
Namespace: Spotfire.Dxp.Application.Extension
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(4, 0)] public abstract class CustomVirtualColumnProducer : VirtualColumnProducer
The CustomVirtualColumnProducer type exposes the following members.
Constructors
Name | Description | |
---|---|---|
CustomVirtualColumnProducer |
Initializes a new instance.
| |
CustomVirtualColumnProducer(SerializationInfo, StreamingContext) |
Methods
Name | Description | |
---|---|---|
ConfigureColumnsCore |
Implement to create the columns. This method will be called each time the inputs of the producer changes
or the GetConfigureColumnsTriggerCore fires. The purpose is to add the metadata about each output column
that should be created and which inputs it has to the configurator. If this is the first call to the method those
columns will be created.
If there are already existing output columns those will be matched against those provided in the configurator,
primarily on external id, and those no longer present will be removed, new ones added and those still remaining updated
with the new information provided.
(Inherited from VirtualColumnProducer.) | |
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.) | |
CreateInputs |
Creates an VirtualColumnInputCollection associated with the given inputIdentifier.
(Inherited from VirtualColumnProducer.) | |
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 DocumentNode.) | |
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.) | |
GetCacheKeyCore |
Implement to return an object that serves as a cache key for the producer. The returned
object should implement Equals so that it returns a different value for each model state
that influences if the resultvalue returned for a given VirtualValueRequest is different.
The object should also implement GetHashCode to match that. This method will be called when
GetCacheKeyTriggerCore fires.
(Inherited from VirtualColumnProducer.) | |
GetCacheKeyTriggerCore |
Override this method to provide a trigger that
fires when the settings in the producer changes so that a
result value returned for a given VirtualValueRequest
changes.
(Inherited from VirtualColumnProducer.) | |
GetConfigureColumnsTriggerCore |
Implement this method to provide a trigger that
fires when the output columns needs to be created or changed. This trigger should not include the inputs changing
as that is added automatically by the framework.
(Inherited from VirtualColumnProducer.) | |
GetCredentialsModelCore |
If the producer has credentials that needs to be filled in by the user, then
this method should be implemented to return a credentialsmodel that has been
registered with an appropriate UI-component in the ViewRegistry. The default
implementation returns null which means no credentials are necessary.
(Inherited from VirtualColumnProducer.) | |
GetInputs |
Gets the inputs for the given identifier.
(Inherited from VirtualColumnProducer.) | |
GetNeedsPromptingCore |
Implement this to indicate if the producer needs prompting
in order to set up its parameters, not including credentials.
(Inherited from VirtualColumnProducer.) | |
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.) | |
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.) | |
GetThreadingModelCore | Override this method to specify the worker
threading model of the producer's virtual value worker.
(Inherited from VirtualColumnProducer.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
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 DocumentNode.) | |
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.) | |
Prompt |
Prompts the registered ui to fill in any settings if allowed and GetNeedsPromptingCore determines that
prompting is necessary.
(Inherited from VirtualColumnProducer.) | |
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.) | |
SetInputs |
Sets the inputs for the given identifier. Setting the inputs causes configurecolumnscore to happen. Any previous
inputs for this identifier are replaced.
(Inherited from VirtualColumnProducer.) | |
ValidateAttached | Validates that the node is attached.
(Inherited from DocumentNode.) |
Properties
Name | Description | |
---|---|---|
AvailableInputs |
Gets the signatures for any input columns that are possible to choose from as inputs.
In a typical scenario they would be exposed either to the end user in the UI or through the api
for an apiuser to select among. Once some are selected they can be used in SetInputs(VirtualColumnInputIdentifier, IEnumerableDataColumnSignature)
to set the inputs for a particular VirtualColumnInputIdentifier. Each output column is
associated with an identifier and thus the set inputs in ConfigureColumnsCore(VirtualColumnsConfigurator).
(Inherited from VirtualColumnProducer.) | |
Columns |
Gets the produced columns.
(Inherited from VirtualColumnProducer.) | |
Context |
Gets the context of this node.
(Inherited from DocumentNode.) | |
IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) | |
Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) | |
TypeId | Gets the type identifier for the producer.
(Inherited from VirtualColumnProducer.) |
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