Click or drag to resize
FormLabel Class
Form label control for a specific form field.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      System.Web.UI.WebControlsLabel
        CMS.Base.Web.UILocalizedLabel
          CMS.FormEngine.Web.UIFormLabel
            CMS.FormEngine.Web.UIFormErrorLabel

Namespace: CMS.FormEngine.Web.UI
Assembly: CMS.FormEngine.Web.UI (in CMS.FormEngine.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class FormLabel : LocalizedLabel

The FormLabel type exposes the following members.

Constructors
  NameDescription
Public methodFormLabel
Constructor.
Top
Properties
  NameDescription
Public propertyAssociatedControlClientID
Associated control client ID.
(Inherited from LocalizedLabel.)
Public propertyCssClass
Label's CSS class.
(Overrides WebControlCssClass.)
Public propertyDisplay
Indicates if the label should be displayed (not visible but rendered to page). Default value is 'true'.
(Inherited from LocalizedLabel.)
Public propertyDisplayColon
Display colon at the end of the text.
(Overrides LocalizedLabelDisplayColon.)
Public propertyField
Field name for which the label applies. This property is only supported in templated form.
Public propertyRequiredMarkCssClass
Gets or sets CSS class for the required mark (*)
(Inherited from LocalizedLabel.)
Public propertyResourceString
Name of a resource string used for text.
(Inherited from LocalizedLabel.)
Public propertyShowRequiredMark
Indicates if required mark (* by default) should be displayed at the end of the text. False by default.
(Overrides LocalizedLabelShowRequiredMark.)
Public propertySource
Localized string source property - may be 'database' or 'file'.
(Inherited from LocalizedLabel.)
Protected propertyTagKey
Tag key.
(Inherited from LocalizedLabel.)
Public propertyText
Display text.
(Inherited from LocalizedLabel.)
Public propertyToolTipResourceString
Name of a resource string used for tooltip.
(Inherited from LocalizedLabel.)
Protected propertyUseFFI
Indicates if control should load properties from FormFieldInfo. True by default.
Top
Methods
  NameDescription
Public methodAddCharacters
Adds the characters to the string.
(Inherited from LocalizedLabel.)
Protected methodCreateChildControls
Override for CreateChildControls method.
(Overrides ControlCreateChildControls.)
Public methodGetText
Gets the final text of the control.
(Inherited from LocalizedLabel.)
Protected methodOnPreRender
Refreshes label's text on pre-render.
(Inherited from LocalizedLabel.)
Public methodRefreshText
Refreshes the control text.
(Inherited from LocalizedLabel.)
Protected methodRender
Render override.
(Inherited from LocalizedLabel.)
Top
Extension Methods
  NameDescription
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodCallHandled
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 MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Top
See Also