CustomVirtualColumnProducer Methods TIBCO Spotfire 7.6 API Reference

The CustomVirtualColumnProducer type exposes the following members.

Methods

  Name Description
Protected method 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.)
Protected method 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.)
Protected method 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.)
Protected method CreateInputs
Creates an VirtualColumnInputCollection associated with the given inputIdentifier.
(Inherited from VirtualColumnProducer.)
Protected method CreatePropertyT(PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected method CreatePropertyT(PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected method CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) (Inherited from DocumentNode.)
Protected method CreatePropertyT(PropertyName, UndoablePropertyT, T) (Inherited from DocumentNode.)
Protected method CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected method CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected method CreateReadOnlyPropertyT
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.)
Protected method 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.)
Protected method CreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) Obsolete. (Inherited from DocumentNode.)
Protected method CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) (Inherited from DocumentNode.)
Protected method DeclareInternalEventHandlers
Override this method to declare handlers of internal events.
(Inherited from DocumentNode.)
Protected method DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) (Inherited from DocumentNode.)
Protected method DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) (Inherited from DocumentNode.)
Protected method DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) (Inherited from DocumentNode.)
Protected method DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) (Inherited from DocumentNode.)
Protected method DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) (Inherited from DocumentNode.)
Protected method DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected method DeserializeReadOnlyPropertyT
Deserializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected method 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.)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected method 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.)
Protected method 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.)
Protected method 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.)
Protected method 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.)
Protected method GetInputs
Gets the inputs for the given identifier.
(Inherited from VirtualColumnProducer.)
Protected method GetNeedsPromptingCore
Implement this to indicate if the producer needs prompting in order to set up its parameters, not including credentials.
(Inherited from VirtualColumnProducer.)
Protected method 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.)
Protected method 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.)
Protected method 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.)
Protected method GetThreadingModelCore
Override this method to specify the worker threading model of the producer's virtual value worker.
(Inherited from VirtualColumnProducer.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method InternalTransaction
Starts an internal transaction on the document model by executing the specified executor delegate.
(Inherited from DocumentNode.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected method OnConfigure
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected method OnConfigured
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.)
Protected method OnReconfigure
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Protected method OnReconfigured
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.)
Public method Prompt
Prompts the registered ui to fill in any settings if allowed and GetNeedsPromptingCore determines that prompting is necessary.
(Inherited from VirtualColumnProducer.)
Protected method SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT)
Serializes an Undoable*Property with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected method SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT)
Serializes an UndoableList with values of type T storing it in info with key list.Name.
(Inherited from DocumentNode.)
Protected method SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT)
Serializes an UndoableProperty with value of type T storing it in info with key property.Name.
(Inherited from DocumentNode.)
Protected method SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT)
Serializes an UndoableSet storing it in info with key given by the property name of the set.
(Inherited from DocumentNode.)
Protected method 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.)
Protected method SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) (Inherited from DocumentNode.)
Protected method SerializeReadOnlyPropertyT
Serializes a read-only property of type T stored in info with key propertyName.
(Inherited from DocumentNode.)
Protected method 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.)
Protected method ValidateAttached
Validates that the node is attached.
(Inherited from DocumentNode.)
Top
Explicit Interface Implementations

  Name Description
Explicit interface implementation Private method IServiceProviderGetService
Implements IServiceProvider.
(Inherited from Node.)
Explicit interface implementation Private method INodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementation Private method INodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementation Private method INodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementation Private method ITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementation Private method ITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementation Private method ITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementation Private method ITransactionsExecuteTransaction (Inherited from DocumentNode.)
Top
See Also

Reference