CustomVirtualColumnProducer Methods

Spotfire 14.2 API Reference

The CustomVirtualColumnProducer type exposes the following members.

Methods

  NameDescription
Protected methodConfigureColumnsCore
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.)
Protected methodCreateEventRelay(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.)
Protected methodCreateEventRelay(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.)
Protected methodCreateInputs
Creates an VirtualColumnInputCollection associated with the given inputIdentifier.
(Inherited from VirtualColumnProducer.)
Protected methodCreatePropertyT(PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected methodCreatePropertyT(PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected methodCreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) (Inherited from DocumentNode.)
Protected methodCreatePropertyT(PropertyName, UndoablePropertyT, T) (Inherited from DocumentNode.)
Protected methodCreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected methodCreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodCreateReadOnlyPropertyT
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.)
Protected methodCreateRuntimeConstantT
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 methodCreateRuntimePropertyT (Inherited from DocumentNode.)
Protected methodDeclareInternalEventHandlers
Override this method to declare handlers of internal events.
(Inherited from VirtualColumnProducer.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected methodDeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected methodDeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodDeserializeReadOnlyPropertyT
Deserializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected methodDuplicateSubtreeT
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 methodGetCacheKeyCore
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.)
Protected methodGetCacheKeyTriggerCore
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.)
Protected methodGetConfigureColumnsTriggerCore
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.)
Protected methodGetCredentialsModelCore
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.)
Protected methodGetInputs
Gets the inputs for the given identifier.
(Inherited from VirtualColumnProducer.)
Protected methodGetNeedsPromptingCore
Implement this to indicate if the producer needs prompting in order to set up its parameters, not including credentials.
(Inherited from VirtualColumnProducer.)
Protected methodGetObjectData
Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides VirtualColumnProducerGetObjectData(SerializationInfo, StreamingContext).)
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 methodGetThreadingModelCore
Override this method to specify the worker threading model of the producer's virtual value worker.
(Inherited from VirtualColumnProducer.)
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
This method is called when this node is attached (added to) to the document for the first time. This method is not called at undo or redo. The purpose of the method is to allow a node to configure itself depending on the surrounding document. It may especially configure itself with respect to the DataManager. The node may modify its undoable state. These modifications will not be recorded on the undo stack. The node has an owner and can lookup services. The owner of the node has been configured when this method is called but the children of the node have not been configured yet. Make sure to call base.OnConfigure() at the start of the overriding method.
(Inherited from VirtualColumnProducer.)
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 methodPrompt
Prompts the registered ui to fill in any settings if allowed and GetNeedsPromptingCore determines that prompting is necessary.
(Inherited from VirtualColumnProducer.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT)
Serializes an Undoable*Property with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableListT)
Serializes an UndoableList with values of type T storing it in info with key list.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT)
Serializes an UndoableProperty with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected methodSerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT)
Serializes an UndoableSet storing it in info with key given by the property name of the set.
(Inherited from DocumentNode.)
Protected methodSerializePropertyTKey, 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.)
Protected methodSerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected methodSerializeReadOnlyPropertyT
Serializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected methodSetInputs
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.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodValidateAttached
Validates that the node is attached.
(Inherited from DocumentNode.)
Top
Explicit Interface Implementations

  NameDescription
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
See Also

Reference