DxpHelpProvider Class

TIBCO Spotfire 7.6 API Reference

This custom help provider contains functionality for mapping a loose help namespace (chm file) to a module in which the help file (resource) exists.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsHelpProvider
        Spotfire.Dxp.FormsDxpHelpProvider

Namespace: Spotfire.Dxp.Forms
Assembly: Spotfire.Dxp.Forms (in Spotfire.Dxp.Forms.dll) Version: 25.11.10401.3615 (25.11.10401.3615)

Syntax

Copy

public sealed class DxpHelpProvider : HelpProvider

The DxpHelpProvider type exposes the following members.

Constructors

	Name	Description
	DxpHelpProvider

Top

Methods

	Name	Description
	CanExtend	Specifies whether this object can provide its extender properties to the specified object. (Inherited from HelpProvider.)
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	Finalize	Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
	GetHelpKeyword	Returns the Help keyword for the specified control. (Inherited from HelpProvider.)
	GetHelpNavigator	Returns the current HelpNavigator setting for the specified control. (Inherited from HelpProvider.)
	GetHelpString	Returns the contents of the pop-up Help window for the specified control. (Inherited from HelpProvider.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetShowHelp	Returns a value indicating whether the specified control's Help should be displayed. (Inherited from HelpProvider.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialize	Initializes the help provider.
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	ResetShowHelp	Removes the Help associated with the specified control. (Inherited from HelpProvider.)
	SetHelpKeyword	Specifies the keyword used to retrieve Help when the user invokes Help for the specified control. (Inherited from HelpProvider.)
	SetHelpNavigator	Specifies the Help command to use when retrieving Help from the Help file for the specified control. (Inherited from HelpProvider.)
	SetHelpString	Specifies the Help string associated with the specified control. (Inherited from HelpProvider.)
	SetInvariantHelpNamespace	Calling this method overides the default help namespace with an invariant version. The intended use for this method is to provide English help for non-translated dialogs, such as for minor releases and service packs where the translation cost has been judged as too expensive.
	SetShowHelp	Specifies whether Help is displayed for the specified control. (Inherited from HelpProvider.)
	ShowHelp	Shows the help associated with the specified Control.
	ToString	Returns a string that represents the current HelpProvider. (Inherited from HelpProvider.)

Top

Properties

	Name	Description
	CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component.)
	Container	Gets the IContainer that contains the Component. (Inherited from Component.)
	DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
	Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component.)
	HelpNamespace	Gets or sets a value specifying the name of the Help file associated with this HelpProvider object. (Overrides HelpProviderHelpNamespace.)
	Site	Gets or sets the ISite of the Component. (Inherited from Component.)
	Tag	Gets or sets the object that contains supplemental data about the HelpProvider. (Inherited from HelpProvider.)

Top

Events

	Name	Description
	Disposed	Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

Top

Remarks

All help providers in TIBCO Spotfire must be instances of this class to guarantee that help and help localization will be fully functional.

Version Information

Supported in: 5.5
See Also

Reference

Spotfire.Dxp.Forms Namespace

Supported in: 5.5See Also

Reference

Supported in: 5.5
See Also