Class HelpButtonControl

HelpButtonControl is a user control that provides all the server code to display field level help button.

Inheritance

System.Object

HelpButtonControl

Namespace: DotNetNuke.UI.UserControls

Assembly: DotNetNuke.dll

Syntax

public abstract class HelpButtonControl : UserControl

Remarks

To implement help, the control uses the ClientAPI interface. In particular the javascript function __dnn_Help_OnClick().

Fields

cmdHelp

HelpButtonControl is a user control that provides all the server code to display field level help button.

Declaration

protected LinkButton cmdHelp

Field Value

Type	Description
LinkButton

Remarks

To implement help, the control uses the ClientAPI interface. In particular the javascript function __dnn_Help_OnClick().

imgHelp

HelpButtonControl is a user control that provides all the server code to display field level help button.

Declaration

protected Image imgHelp

Field Value

Type	Description
Image

Remarks

To implement help, the control uses the ClientAPI interface. In particular the javascript function __dnn_Help_OnClick().

lblHelp

HelpButtonControl is a user control that provides all the server code to display field level help button.

Declaration

protected Label lblHelp

Field Value

Type	Description
Label

Remarks

To implement help, the control uses the ClientAPI interface. In particular the javascript function __dnn_Help_OnClick().

pnlHelp

HelpButtonControl is a user control that provides all the server code to display field level help button.

Declaration

protected Panel pnlHelp

Field Value

Type	Description
Panel

Remarks

To implement help, the control uses the ClientAPI interface. In particular the javascript function __dnn_Help_OnClick().

Properties

ControlName

Gets or sets controlName is the Id of the control that is associated with the label.

Declaration

public string ControlName { get; set; }

Property Value

Type	Description
System.String	A string representing the id of the associated control.

Remarks

To implement help, the control uses the ClientAPI interface. In particular the javascript function __dnn_Help_OnClick().

HelpKey

Gets or sets helpKey is the Resource Key for the Help Text.

Declaration

public string HelpKey { get; set; }

Property Value

Type	Description
System.String	A string representing the Resource Key for the Help Text.

Remarks

To implement help, the control uses the ClientAPI interface. In particular the javascript function __dnn_Help_OnClick().

HelpText

Gets or sets helpText is value of the Help Text if no ResourceKey is provided.

Declaration

public string HelpText { get; set; }

Property Value

Type	Description
System.String	A string representing the Text.

Remarks

To implement help, the control uses the ClientAPI interface. In particular the javascript function __dnn_Help_OnClick().

ResourceKey

Gets or sets resourceKey is the Resource Key for the Help Text.

Declaration

public string ResourceKey { get; set; }

Property Value

Type	Description
System.String	A string representing the Resource Key for the Label Text.

Remarks

To implement help, the control uses the ClientAPI interface. In particular the javascript function __dnn_Help_OnClick().

Methods

cmdHelp_Click(Object, EventArgs)

HelpButtonControl is a user control that provides all the server code to display field level help button.

Declaration

protected void cmdHelp_Click(object sender, EventArgs e)

Parameters

Type	Name	Description
System.Object	sender
EventArgs	e

Remarks

To implement help, the control uses the ClientAPI interface. In particular the javascript function __dnn_Help_OnClick().

OnLoad(EventArgs)

Page_Load runs when the control is loaded.

Declaration

protected override void OnLoad(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

Remarks

To implement help, the control uses the ClientAPI interface. In particular the javascript function __dnn_Help_OnClick().

Extension Methods

JsonExtensionsWeb.ToJson(Object)