FormExtensions.Label Method

Returns an HTML label element for given formComponent.

Namespace: Kentico.Forms.Web.Mvc
Assembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 12.0.0

Syntax

public static MvcHtmlString Label(
	this ExtensionPoint<HtmlHelper> htmlHelper,
	FormComponent formComponent,
	IDictionary<string, Object> htmlAttributes = null,
	bool renderColon = true
)

Parameters

htmlHelper

Type: Kentico.Web.Mvc.ExtensionPoint<HtmlHelper>
HtmlHelper extension point.

formComponent

Type: Kentico.Forms.Web.Mvc.FormComponent
The form component to render the label for.

htmlAttributes (Optional)

Type: System.Collections.Generic.IDictionary<String, Object>
An object containing additional HTML attributes for the label.

renderColon (Optional)

Type: System.Boolean
Indicates whether a colon is to be rendered after the label text. If a label text is missing then colon is not rendered.

Return Value

Type: MvcHtmlString
An HTML label element for form component.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ExtensionPoint<HtmlHelper>. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	Thrown when htmlHelper or formComponent is null.
ArgumentException	Thrown when Name of the form component passed is null or an empty string.