Class PropertyLabelControl

The PropertyLabelControl control provides a standard UI component for displaying a label for a property. It contains a Label and Help Text and can be Data Bound.

Inheritance

System.Object

PropertyLabelControl

Namespace: DotNetNuke.UI.WebControls

Assembly: DotNetNuke.dll

Syntax

public class PropertyLabelControl : WebControl

Constructors

PropertyLabelControl()

Initializes a new instance of the PropertyLabelControl class.

Declaration

public PropertyLabelControl()

Fields

cmdHelp

The PropertyLabelControl control provides a standard UI component for displaying a label for a property. It contains a Label and Help Text and can be Data Bound.

Declaration

protected LinkButton cmdHelp

Field Value

Type	Description
LinkButton

label

The PropertyLabelControl control provides a standard UI component for displaying a label for a property. It contains a Label and Help Text and can be Data Bound.

Declaration

protected HtmlGenericControl label

Field Value

Type	Description
HtmlGenericControl

lblHelp

The PropertyLabelControl control provides a standard UI component for displaying a label for a property. It contains a Label and Help Text and can be Data Bound.

Declaration

protected Label lblHelp

Field Value

Type	Description
Label

lblLabel

The PropertyLabelControl control provides a standard UI component for displaying a label for a property. It contains a Label and Help Text and can be Data Bound.

Declaration

protected Label lblLabel

Field Value

Type	Description
Label

pnlHelp

The PropertyLabelControl control provides a standard UI component for displaying a label for a property. It contains a Label and Help Text and can be Data Bound.

Declaration

protected Panel pnlHelp

Field Value

Type	Description
Panel

pnlTooltip

The PropertyLabelControl control provides a standard UI component for displaying a label for a property. It contains a Label and Help Text and can be Data Bound.

Declaration

protected Panel pnlTooltip

Field Value

Type	Description
Panel

Properties

AssociatedControlId

The PropertyLabelControl control provides a standard UI component for displaying a label for a property. It contains a Label and Help Text and can be Data Bound.

Declaration

public string AssociatedControlId { get; set; }

Property Value

Type	Description
System.String

Caption

Gets or sets the Caption Text if no ResourceKey is provided.

Declaration

public string Caption { get; set; }

Property Value

Type	Description
System.String	A string representing the Caption.

DataField

Gets or sets the value of the Field that is bound to the Label.

Declaration

public string DataField { get; set; }

Property Value

Type	Description
System.String	A string representing the Name of the Field.

DataSource

Gets or sets the DataSource that is bound to this control.

Declaration

public object DataSource { get; set; }

Property Value

Type	Description
System.Object	The DataSource object.

EditControl

Gets or sets the related Edit Control.

Declaration

public Control EditControl { get; set; }

Property Value

Type	Description
Control	A Control.

HelpStyle

Gets and sets the value of the Label Style.

Declaration

public Style HelpStyle { get; }

Property Value

Type	Description
Style	A string representing the Name of the Field.

HelpText

Gets or sets text is value of the Label Text if no ResourceKey is provided.

Declaration

public string HelpText { get; set; }

Property Value

Type	Description
System.String	A string representing the Text.

LabelStyle

Gets and sets the value of the Label Style.

Declaration

public Style LabelStyle { get; }

Property Value

Type	Description
Style	A string representing the Name of the Field.

Required

The PropertyLabelControl control provides a standard UI component for displaying a label for a property. It contains a Label and Help Text and can be Data Bound.

Declaration

public bool Required { get; set; }

Property Value

Type	Description
System.Boolean

ResourceKey

Gets or sets resourceKey is the root localization key for this control.

Declaration

public string ResourceKey { get; set; }

Property Value

Type	Description
System.String	A string representing the Resource Key.

Remarks

This control will "standardise" the resource key names, so for instance if the resource key is "Control", Control.Text is the label text key, Control.Help is the label help text, Control.ErrorMessage is the Validation Error Message for the control.

ShowHelp

The PropertyLabelControl control provides a standard UI component for displaying a label for a property. It contains a Label and Help Text and can be Data Bound.

Declaration

public bool ShowHelp { get; set; }

Property Value

Type	Description
System.Boolean

TagKey

The PropertyLabelControl control provides a standard UI component for displaying a label for a property. It contains a Label and Help Text and can be Data Bound.

Declaration

protected override HtmlTextWriterTag TagKey { get; }

Property Value

Type	Description
HtmlTextWriterTag

Methods

CreateChildControls()

CreateChildControls creates the control collection.

Declaration

protected override void CreateChildControls()

OnDataBinding(EventArgs)

OnDataBinding runs when the Control is being Data Bound (It is triggered by a call to Control.DataBind().

Declaration

protected override void OnDataBinding(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

OnLoad(EventArgs)

The PropertyLabelControl control provides a standard UI component for displaying a label for a property. It contains a Label and Help Text and can be Data Bound.

Declaration

protected override void OnLoad(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

OnPreRender(EventArgs)

OnLoad runs just before the Control is rendered, and makes sure that any properties are set properly before the control is rendered.

Declaration

protected override void OnPreRender(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

Extension Methods

JsonExtensionsWeb.ToJson(Object)