TitleBarExtension Class

Spotfire 14.3 API Reference
Component that enables extending the title bar of custom visuals and visualizations.
Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      Spotfire.Dxp.Forms.ComponentsTitleBarExtension

Namespace:  Spotfire.Dxp.Forms.Components
Assembly:  Spotfire.Dxp.Forms (in Spotfire.Dxp.Forms.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax

C#
[DefaultEventAttribute("PopulateFeaturesMenu")]
public sealed class TitleBarExtension : Component

The TitleBarExtension type exposes the following members.

Constructors

  NameDescription
Public methodTitleBarExtension
Initializes a new TitleBarExtension instance.
Public methodTitleBarExtension(IContainer)
Initializes a new TitleBarExtension instance, and adds it to the specified IContainer.
Top
Methods

  NameDescription
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodDispose
Releases all resources used by the Component.
(Inherited from Component.)
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 methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitialize
Initalizes this component.
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodPerformPopulateTitleBar
Raises the PopulateTitleBar event. Used for explicitly re-populating the title bar.
Public methodToString
Returns a String containing the name of the Component, if any. This method should not be overridden.
(Inherited from Component.)
Top
Events

  NameDescription
Public eventEditProperties
Occurs when Properties is requested for the hosting CustomVisual.
Public eventHelpRequested
Occurs when Help is requested for the hosting CustomVisual.
Public eventPopulateFeaturesMenu
Occurs when the visualization features menu is requested for the hosting CustomVisual.
Public eventPopulateTitleBar
Occurs when the visualization title bar is updated. Note: This may happen at any time; always use the current state of the hosting CustomVisual.
Top
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

Reference