Factory base class for creating custom visuals. A custom visual inherits
from CustomVisual.
Extend this class to provide AutoConfigure logic to your visual.
Inheritance Hierarchy
Spotfire.Dxp.Application.ExtensionVisualFactory
Spotfire.Dxp.Application.ExtensionVisualFactoryT
Spotfire.Dxp.Application.ExtensionCustomVisualFactoryT
Namespace: Spotfire.Dxp.Application.Extension
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
public class CustomVisualFactory<T> : VisualFactory<T> where T : CustomVisual
Type Parameters
- T
The CustomVisualFactoryT type exposes the following members.
Constructors
Name | Description | |
---|---|---|
CustomVisualFactoryT(CustomTypeIdentifier, VisualCategory, Image) | Obsolete.
Initializes a new instance of the CustomVisualFactoryT class.
| |
CustomVisualFactoryT(CustomTypeIdentifier, VisualCategory, ExtensionIcon, LicensedFunction) |
Initializes a new instance of the CustomVisualFactoryT class.
| |
CustomVisualFactoryT(CustomTypeIdentifier, VisualCategory, Image, LicensedFunction) | Obsolete.
Initializes a new instance of the CustomVisualFactoryT class.
|
Methods
Name | Description | |
---|---|---|
AutoConfigureCore | Override this method to configure data-dependent properties.
(Inherited from VisualFactoryT.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetDisplayNameCore |
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.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetTooltipDescriptionCore |
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.
(Overrides VisualFactoryGetTooltipDescriptionCore.)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.". | |
GetTooltipTitleCore |
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.
(Overrides VisualFactoryGetTooltipTitleCore.)Override this method and return a non empty string to override the default behavior. E.g "Add a donut chart". | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
InitializeCore | Override this method to initialize the visual.
(Inherited from VisualFactoryT.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
Remarks
Version Information
Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also