FormLabel Class

Form label control for a specific form field.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.Label
        CMS.Base.Web.UI.LocalizedLabel
          CMS.FormEngine.Web.UI.FormLabel
            CMS.FormEngine.Web.UI.FormErrorLabel

Namespace: CMS.FormEngine.Web.UI
Assembly: CMS.FormEngine.Web.UI (in CMS.FormEngine.Web.UI.dll) Version: 12.0.0

Syntax

public class FormLabel : LocalizedLabel

The FormLabel type exposes the following members.

Constructors

	Name	Description
Public method	FormLabel	Constructor.

Properties

	Name	Description
Public property	AssociatedControlClientID	Associated control client ID. (Inherited from LocalizedLabel.)
Public property	CssClass	Label's CSS class. (Overrides WebControl.CssClass.)
Public property	Display	Indicates if the label should be displayed (not visible but rendered to page). Default value is 'true'. (Inherited from LocalizedLabel.)
Public property	DisplayColon	Display colon at the end of the text. (Overrides LocalizedLabel.DisplayColon.)
Public property	Field	Field name for which the label applies. This property is only supported in templated form.
Public property	RequiredMarkCssClass	Gets or sets CSS class for the required mark (*) (Inherited from LocalizedLabel.)
Public property	ResourceString	Name of a resource string used for text. (Inherited from LocalizedLabel.)
Public property	ShowRequiredMark	Indicates if required mark (* by default) should be displayed at the end of the text. False by default. (Overrides LocalizedLabel.ShowRequiredMark.)
Public property	Source	Localized string source property - may be 'database' or 'file'. (Inherited from LocalizedLabel.)
Protected property	TagKey	Tag key. (Inherited from LocalizedLabel.)
Public property	Text	Display text. (Inherited from LocalizedLabel.)
Public property	ToolTipResourceString	Name of a resource string used for tooltip. (Inherited from LocalizedLabel.)
Protected property	UseFFI	Indicates if control should load properties from FormFieldInfo. True by default.

Methods

	Name	Description
Public method	AddCharacters	Adds the characters to the string. (Inherited from LocalizedLabel.)
Protected method	CreateChildControls	Override for CreateChildControls method. (Overrides Control.CreateChildControls().)
Public method	GetText	Gets the final text of the control. (Inherited from LocalizedLabel.)
Protected method	OnPreRender	Refreshes label's text on pre-render. (Inherited from LocalizedLabel.)
Public method	RefreshText	Refreshes the control text. (Inherited from LocalizedLabel.)
Protected method	Render	Render override. (Inherited from LocalizedLabel.)

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)