CustomValueRendererFactoryTRenderer, TSettings Class

 Spotfire 14.2 API Reference
Base class for factories that create a CustomValueRenderer.
Inheritance Hierarchy
SystemObject
  Spotfire.Dxp.Application.ExtensionValueRendererFactory
    Spotfire.Dxp.Application.ExtensionValueRendererFactoryTRenderer, TSettings
      Spotfire.Dxp.Application.ExtensionCustomValueRendererFactoryTRenderer, TSettings

Namespace:  Spotfire.Dxp.Application.Extension
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax
C#
Copy
public abstract class CustomValueRendererFactory<TRenderer, TSettings> : ValueRendererFactory<TRenderer, TSettings>
where TRenderer : CustomValueRenderer
where TSettings : CustomValueRendererSettings

Type Parameters

TRenderer
The type of the renderer class.
TSettings
The type of the renderer settings class.

The CustomValueRendererFactoryTRenderer, TSettings type exposes the following members.

Constructors
  NameDescription
Protected methodCustomValueRendererFactoryTRenderer, TSettings(CustomTypeIdentifier)
Initializes a new instance of the CustomValueRendererFactoryTRenderer, TSettings class.
Protected methodCustomValueRendererFactoryTRenderer, TSettings(CustomTypeIdentifier, LicensedFunction)
Initializes a new instance of the CustomValueRendererFactoryTRenderer, TSettings class.
Top
Properties
  NameDescription
Protected propertySupportsCreateRendererCore
Override this method to tell that CreateRendererCore should be called instead of deprecated CreateRendererCore(TSettings).
(Inherited from ValueRendererFactory.)
Public propertyTypeId
Gets the TypeIdentifier for the factory.
(Inherited from ValueRendererFactory.)
Top
Methods
  NameDescription
Protected methodCreateRendererCore
Override this method to create a renderer. Called if SupportsCreateRendererCore returns true.
(Inherited from ValueRendererFactoryTRenderer, TSettings.)
Protected methodCreateRendererCore(TSettings) Obsolete.
Returns a renderer, initialized using specific renderer settings.
(Inherited from ValueRendererFactoryTRenderer, TSettings.)
Protected methodCreateRendererSettingsCore
Returns default renderer settings.
(Inherited from ValueRendererFactoryTRenderer, TSettings.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
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 methodGetCachingBehaviorCore
Override this method to specify a caching behavior. This method is only called if the factory supports create renderer without parameters.
(Inherited from ValueRendererFactory.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetModelKeyCore
Override this method to specify a model key for caching. The default implementation throws.
(Inherited from ValueRendererFactoryTRenderer, TSettings.)
Protected methodGetRendererMatchCore
Override this method to indicate whether the created value renderer can support the specified content type and data type.
(Inherited from ValueRendererFactory.)
Protected methodGetThreadingModelCore
Override this method to specify a threading model. Default is one dedicated thread.
(Inherited from ValueRendererFactory.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
Value renderer factories are made available to the application by overriding the RegisterValueRenderers(AddInValueRendererRegistrar) method.
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference

Spotfire.Dxp.Application.Extension Namespace