CustomVisualView Class

Spotfire 14.2 API Reference
Base class for the view of a CustomVisual.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Application.ExtensionCustomVisualView
    Spotfire.Dxp.Application.ExtensionCustomVisualViewT

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#
public abstract class CustomVisualView : IDisposable

The CustomVisualView type exposes the following members.

Properties

  NameDescription
Public propertyIsEditing
Gets a value indicating whether the current Spotfire UI is in editing mode. When the Spotfire UI is in editing mode, controls used to enable authoring capabilities, such as axis selectors, are hidden. Use this property to turn off authoring UI in the custom view.
Public propertyIsStatic
Gets a value indicating whether this instance is a static view. A static view is used for printing, export and preview generation. Use this property to turn off animations and other features not desired in this case.
Top
Methods

  NameDescription
Protected methodAddEventHandler
Adds an event handler which is called when any of the triggers fire.
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources.
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.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInvalidate
Invalidates the view which causes it to be redrawn.
Protected methodInvokeClientEventHandler
Invokes the client event handler specified by name. A call to this method will result in a call to a function previously registered in the HTML/Javascript part of the UI with Spotfire.addEventHandler("myHandlerName", function);
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnUpdateRequiredCore
Override this method and call InvokeClientEventHandler() to make the HTML/Javascript part of the UI re-render itself.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
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