Class HelpControl

This class presents a Help Link on a page. Specify a linkname in the HelpTopic property. Usually this is the name of a page.

Note: Can only be dropped on a wwWebForm derived Page class as it depends on methods in this class to figure out base URLs.

Note: The image does not display in design mode.

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      Westwind.Web.Controls.HelpControl
public class HelpControl : WebControl

Class Members

MemberDescription

Constructor

HelpBaseUrl

The base Help Url that is used as a base for Help Topics.

GetHelpHyperLink

public static string GetHelpHyperLink(string HelpTopic,     string LabelText,     string AltText,     string imageLink,     string cssClass)

public string GetHelpHyperLink(string HelpTopic)

public string GetHelpHyperLink()

AltText

The alternate text for the image displayed when the mouse hovers over the image.

HelpControlType

Determines whether this control handles a help link and/or F1 key operation

HelpImage

The image used for the help icon. Defaults to ~/images/help.gif

HelpTopic

The Help Topic to display. This should be just the help detail - usually the filename only (ie. _SomePage.htm) in your help base path.

Text

The text of the label. Leave blank to show only the image

Requirements

Namespace: Westwind.Web.Controls
Assembly: westwind.web.webforms.dll

© West Wind Technologies, 1996-2016 • Updated: 12/12/15
Comment or report problem with topic