VisualControlStateTVisual, TValue Class

 Spotfire 14.3 API Reference

Note: This API is now obsolete.

Keeps the state and visual model for a custom visual web control. The state is used to preserve data related to layout and rendering of a web control, which is important for web controls since they are disposed after they have been rendered. Typically, this can be used to implement more efficient tooltips. The state is cleared when the model must be re-rendered, that is, when the TVisual's GetRenderTrigger fires.
Inheritance Hierarchy
SystemObject
  Spotfire.Dxp.Application.ExtensionCustomControlState
    Spotfire.Dxp.Application.ExtensionCustomControlStateTVisual
      Spotfire.Dxp.Application.ExtensionVisualControlStateTVisual, TValue

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#
Copy
[ObsoleteAttribute("Use Spotfire.Dxp.Application.Extension.CustomVisualView instead.")]
public sealed class VisualControlState<TVisual, TValue> : CustomControlState<TVisual>
where TVisual : VisualContent
where TValue : class

Type Parameters

TVisual
TValue

The VisualControlStateTVisual, TValue type exposes the following members.

Constructors
  NameDescription
Public methodVisualControlStateTVisual, TValue
Constructor for class VisualControlStateTVisual, TValue.
Top
Properties
  NameDescription
Public propertyEventManager
Gets an ExternalEventManager that can be used to subscribe to events from the document.
(Inherited from CustomControlStateTNode.)
Public propertyNode
Gets the DocumentNode.
(Inherited from CustomControlStateTNode.)
Top
Methods
  NameDescription
Public methodDispose
Implements the IDisposable pattern.
(Inherited from CustomControlStateTNode.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodSetValue
Sets the state value.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetValue
Tries to get the state value.
Top
Version Information

Obsolete (compiler warning) in 14.3
Obsolete (compiler warning) in 14.2
Obsolete (compiler warning) in 14.1
Obsolete (compiler warning) in 14.0
Obsolete (compiler warning) in 12.5
Obsolete (compiler warning) in 12.4
Obsolete (compiler warning) in 12.3
Obsolete (compiler warning) in 12.2
Obsolete (compiler warning) in 12.1
Obsolete (compiler warning) in 12.0
Obsolete (compiler warning) in 11.8
See Also

Reference

Spotfire.Dxp.Application.Extension Namespace