VisualControlStateTVisual, TValue Class TIBCO Spotfire 7.6 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: 25.11.10401.3615 (25.11.10401.3615)
Syntax

C#
[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
Methods

  NameDescription
Public methodDispose
Implements the IDisposable pattern.
(Inherited from CustomControlStateTNode.)
Protected methodDispose(Boolean)
Implements the IDisposable pattern.
(Inherited from CustomControlStateTNode.)
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.)
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 methodSetValue
Sets the state value.
Public methodTryGetValue
Tries to get the state value.
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
Version Information

Supported in: 7.0, 6.5, 6.0, 5.5, 5.0
Obsolete (compiler warning) in 7.6
Obsolete (compiler warning) in 7.5
See Also

Reference