ConfiguredVisualFactoryT Class

 Spotfire 14.2 API Reference
Factory base class for creating configured visuals. A configured visual gives a new unique CustomTypeIdentifier to an existing visual. Override this class to provide new AutoConfigure logic for the visual.
Inheritance Hierarchy
SystemObject
  Spotfire.Dxp.Application.ExtensionVisualFactory
    Spotfire.Dxp.Application.ExtensionVisualFactoryT
      Spotfire.Dxp.Application.ExtensionConfiguredVisualFactoryT

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 class ConfiguredVisualFactory<T> : VisualFactory<T>
where T : VisualContent

Type Parameters

T

The ConfiguredVisualFactoryT type exposes the following members.

Constructors
  NameDescription
Public methodConfiguredVisualFactoryT(TypeIdentifier, TypeIdentifier, VisualCategory, ExtensionIcon, LicensedFunction)
Initializes a new instance of the ConfiguredVisualFactoryT class.
Public methodConfiguredVisualFactoryT(TypeIdentifier, TypeIdentifier, VisualCategory, Image, LicensedFunction) Obsolete.
Initializes a new instance of the ConfiguredVisualFactoryT class.
Top
Methods
  NameDescription
Protected methodAutoConfigureCore
Override this method to configure data-dependent properties.
(Inherited from VisualFactoryT.)
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 methodGetDisplayNameCore
Gets a string to be displayed in the user interface at the access points for creating visuals via this factory. By default, the application will use the DisplayName property of the CustomTypeIdentifier associated with this class. Override this method and return a non empty string to show something else.
(Overrides VisualFactoryGetDisplayNameCore.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetTooltipDescriptionCore
Gets a descriptive string to display in the the tooltip for this factory. The tooltip is made up of a description, that can be customized with this method, and a title that can be supplied via GetTooltipTitleCore.

Override this method and return a non empty string to provide a description. E.g "A donut chart is a pie chart with a hole in it.".

(Overrides VisualFactoryGetTooltipDescriptionCore.)
Protected methodGetTooltipTitleCore
Gets a string to display in the title of the tooltip for this factory. The tooltip is made up of a title, that can be customized via this method, and a description that can be supplied via GetTooltipDescriptionCore.

Override this method and return a non empty string to override the default behavior. E.g "Add a donut chart".

(Overrides VisualFactoryGetTooltipTitleCore.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInitializeCore
Override this method to initialize the visual.
(Inherited from VisualFactoryT.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Top
Remarks
Objects of this type are used by the application to create new Visuals. Visual factories are registered with the application by overriding the RegisterVisuals(AddInVisualRegistrar) 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