HtmlHelper Class

Represents support for rendering HTML controls in a view.

Inheritance Hierarchy

System.Object
  System.Web.Mvc.HtmlHelper
    System.Web.Mvc.HtmlHelper<TModel>

Namespace:  System.Web.Mvc
Assembly:  System.Web.Mvc (in System.Web.Mvc.dll)

Syntax

'Declaration
Public Class HtmlHelper
public class HtmlHelper
public ref class HtmlHelper

The HtmlHelper type exposes the following members.

Constructors

  Name Description
Public method HtmlHelper(ViewContext, IViewDataContainer) Initializes a new instance of the HtmlHelper class by using the specified view context and view data container.
Public method HtmlHelper(ViewContext, IViewDataContainer, RouteCollection) Initializes a new instance of the HtmlHelper class by using the specified view context, view data container, and route collection.

Top

Properties

  Name Description
Public propertyStatic member IdAttributeDotReplacement Gets or sets the character that replaces periods in the ID attribute of an element.
Public property RouteCollection Gets or sets the collection of routes for the application.
Public property ViewContext Gets or sets the context information about the view.
Public property ViewData Gets the current view data dictionary.
Public property ViewDataContainer Gets or sets the view data container.

Top

Methods

  Name Description
Public method AntiForgeryToken() Generates a hidden form field (anti-forgery token) that is validated when the form is submitted.
Public method AntiForgeryToken(String) Generates a hidden form field (anti-forgery token) that is validated when the form is submitted. The field value is generated using the specified salt value.
Public method AntiForgeryToken(String, String, String) Generates a hidden form field (anti-forgery token) that is validated when the form is submitted. The field value is generated using the specified salt value, domain, and path.
Public method AttributeEncode(Object) Converts the specified attribute object to an HTML-encoded string.
Public method AttributeEncode(String) Converts the specified attribute string to an HTML-encoded string.
Public method EnableClientValidation Enables input validation that is performed by using client script in the browser.
Public method Encode(Object) Converts the value of the specified object to an HTML-encoded string.
Public method Encode(String) Converts the specified string to an HTML-encoded string.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodStatic member GenerateIdFromName(String) Creates an HTML element ID using the specified element name.
Public methodStatic member GenerateIdFromName(String, String) Creates an HTML element ID using the specified element name and a string that replaces dots in the name.
Public methodStatic member GenerateLink(RequestContext, RouteCollection, String, String, String, String, RouteValueDictionary, IDictionary<String, Object>) Generates an HTML anchor element (a element) that links to the specified action method.
Public methodStatic member GenerateLink(RequestContext, RouteCollection, String, String, String, String, String, String, String, RouteValueDictionary, IDictionary<String, Object>) Generates an HTML anchor element (a element) that links to the specified action method, and enables the user to specify the communication protocol, name of the host, and a URL fragment.
Public methodStatic member GenerateRouteLink(RequestContext, RouteCollection, String, String, RouteValueDictionary, IDictionary<String, Object>) Generates an HTML anchor element (a element) that links to the specified URL route.
Public methodStatic member GenerateRouteLink(RequestContext, RouteCollection, String, String, String, String, String, RouteValueDictionary, IDictionary<String, Object>) Generates an HTML anchor element (a element) that links to the specified URL route, and enables the user to specify the communication protocol, name of the host, and a URL fragment.
Public methodStatic member GetFormMethodString Returns the HTTP method that handles form input (GET or POST) as a string.
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodStatic member GetInputTypeString Returns the HTML input control type as a string.
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method HttpMethodOverride(String) Returns a hidden input element that identifies the override method for the specified HTTP data-transfer method that was used by the client.
Public method HttpMethodOverride(HttpVerbs) Returns a hidden input element that identifies the override method for the specified verb that represents the HTTP data-transfer method used by the client.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

  Name Description
Public Extension Method Action(String) Overloaded. Invokes the specified child action method and returns the result as an HTML string. (Defined by ChildActionExtensions.)
Public Extension Method Action(String, Object) Overloaded. Invokes the specified child action method with the specified parameters and returns the result as an HTML string. (Defined by ChildActionExtensions.)
Public Extension Method Action(String, RouteValueDictionary) Overloaded. Invokes the specified child action method using the specified parameters and returns the result as an HTML string. (Defined by ChildActionExtensions.)
Public Extension Method Action(String, String) Overloaded. Invokes the specified child action method using the specified controller name and returns the result as an HTML string. (Defined by ChildActionExtensions.)
Public Extension Method Action(String, String, Object) Overloaded. Invokes the specified child action method using the specified parameters and controller name and returns the result as an HTML string. (Defined by ChildActionExtensions.)
Public Extension Method Action(String, String, RouteValueDictionary) Overloaded. Invokes the specified child action method using the specified parameters and controller name and returns the result as an HTML string. (Defined by ChildActionExtensions.)
Public Extension Method ActionLink(String, String) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method ActionLink(String, String, Object) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method ActionLink(String, String, RouteValueDictionary) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method ActionLink(String, String, String) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method ActionLink(String, String, Object, Object) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method ActionLink(String, String, RouteValueDictionary, IDictionary<String, Object>) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method ActionLink(String, String, String, Object, Object) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method ActionLink(String, String, String, RouteValueDictionary, IDictionary<String, Object>) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method ActionLink(String, String, String, String, String, String, Object, Object) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method ActionLink(String, String, String, String, String, String, RouteValueDictionary, IDictionary<String, Object>) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method BeginForm() Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by an action method. (Defined by FormExtensions.)
Public Extension Method BeginForm(Object) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by an action method. (Defined by FormExtensions.)
Public Extension Method BeginForm(RouteValueDictionary) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by an action method. (Defined by FormExtensions.)
Public Extension Method BeginForm(String, String) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by an action method. (Defined by FormExtensions.)
Public Extension Method BeginForm(String, String, Object) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by an action method. (Defined by FormExtensions.)
Public Extension Method BeginForm(String, String, RouteValueDictionary) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by an action method. (Defined by FormExtensions.)
Public Extension Method BeginForm(String, String, FormMethod) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by an action method. (Defined by FormExtensions.)
Public Extension Method BeginForm(String, String, Object, FormMethod) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by an action method. (Defined by FormExtensions.)
Public Extension Method BeginForm(String, String, RouteValueDictionary, FormMethod) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by an action method. (Defined by FormExtensions.)
Public Extension Method BeginForm(String, String, FormMethod, Object) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by an action method. (Defined by FormExtensions.)
Public Extension Method BeginForm(String, String, FormMethod, IDictionary<String, Object>) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by an action method. (Defined by FormExtensions.)
Public Extension Method BeginForm(String, String, Object, FormMethod, Object) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by an action method. (Defined by FormExtensions.)
Public Extension Method BeginForm(String, String, RouteValueDictionary, FormMethod, IDictionary<String, Object>) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by an action method. (Defined by FormExtensions.)
Public Extension Method BeginRouteForm(Object) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by the route target. (Defined by FormExtensions.)
Public Extension Method BeginRouteForm(RouteValueDictionary) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by the route target. (Defined by FormExtensions.)
Public Extension Method BeginRouteForm(String) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by the route target. (Defined by FormExtensions.)
Public Extension Method BeginRouteForm(String, Object) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by the route target. (Defined by FormExtensions.)
Public Extension Method BeginRouteForm(String, RouteValueDictionary) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by the route target. (Defined by FormExtensions.)
Public Extension Method BeginRouteForm(String, FormMethod) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by the route target. (Defined by FormExtensions.)
Public Extension Method BeginRouteForm(String, Object, FormMethod) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by the route target. (Defined by FormExtensions.)
Public Extension Method BeginRouteForm(String, RouteValueDictionary, FormMethod) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by the route target. (Defined by FormExtensions.)
Public Extension Method BeginRouteForm(String, FormMethod, Object) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by the route target. (Defined by FormExtensions.)
Public Extension Method BeginRouteForm(String, FormMethod, IDictionary<String, Object>) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by the route target. (Defined by FormExtensions.)
Public Extension Method BeginRouteForm(String, Object, FormMethod, Object) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by the route target. (Defined by FormExtensions.)
Public Extension Method BeginRouteForm(String, RouteValueDictionary, FormMethod, IDictionary<String, Object>) Overloaded. Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by the route target. (Defined by FormExtensions.)
Public Extension Method CheckBox(String) Overloaded. Returns a check box input element by using the specified HTML helper and the name of the form field. (Defined by InputExtensions.)
Public Extension Method CheckBox(String, Boolean) Overloaded. Returns a check box input element by using the specified HTML helper, the name of the form field, and a value to indicate whether the check box is selected. (Defined by InputExtensions.)
Public Extension Method CheckBox(String, Object) Overloaded. Returns a check box input element by using the specified HTML helper, the name of the form field, and the HTML attributes. (Defined by InputExtensions.)
Public Extension Method CheckBox(String, IDictionary<String, Object>) Overloaded. Returns a check box input element by using the specified HTML helper, the name of the form field, and the HTML attributes. (Defined by InputExtensions.)
Public Extension Method CheckBox(String, Boolean, Object) Overloaded. Returns a check box input element by using the specified HTML helper, the name of the form field, a value that indicates whether the check box is selected, and the HTML attributes. (Defined by InputExtensions.)
Public Extension Method CheckBox(String, Boolean, IDictionary<String, Object>) Overloaded. Returns a check box input element by using the specified HTML helper, the name of the form field, a value to indicate whether the check box is selected, and the HTML attributes. (Defined by InputExtensions.)
Public Extension Method Display(String) Overloaded. Returns HTML markup for each property in the object that is represented by a string expression. (Defined by DisplayExtensions.)
Public Extension Method Display(String, Object) Overloaded. Returns HTML markup for each property in the object that is represented by a string expression, using additional view data. (Defined by DisplayExtensions.)
Public Extension Method Display(String, String) Overloaded. Returns HTML markup for each property in the object that is represented by the expression, using the specified template. (Defined by DisplayExtensions.)
Public Extension Method Display(String, String, Object) Overloaded. Returns HTML markup for each property in the object that is represented by the expression, using the specified template and additional view data. (Defined by DisplayExtensions.)
Public Extension Method Display(String, String, String) Overloaded. Returns HTML markup for each property in the object that is represented by the expression, using the specified template and an HTML field ID. (Defined by DisplayExtensions.)
Public Extension Method Display(String, String, String, Object) Overloaded. Returns HTML markup for each property in the object that is represented by the expression, using the specified template, HTML field ID, and additional view data. (Defined by DisplayExtensions.)
Public Extension Method DisplayForModel() Overloaded. Returns HTML markup for each property in the model. (Defined by DisplayExtensions.)
Public Extension Method DisplayForModel(Object) Overloaded. Returns HTML markup for each property in the model, using additional view data. (Defined by DisplayExtensions.)
Public Extension Method DisplayForModel(String) Overloaded. Returns HTML markup for each property in the model using the specified template. (Defined by DisplayExtensions.)
Public Extension Method DisplayForModel(String, Object) Overloaded. Returns HTML markup for each property in the model, using the specified template and additional view data. (Defined by DisplayExtensions.)
Public Extension Method DisplayForModel(String, String) Overloaded. Returns HTML markup for each property in the model using the specified template and HTML field ID. (Defined by DisplayExtensions.)
Public Extension Method DisplayForModel(String, String, Object) Overloaded. Returns HTML markup for each property in the model, using the specified template, an HTML field ID, and additional view data. (Defined by DisplayExtensions.)
Public Extension Method DisplayText Returns HTML markup for each property in the object that is represented by the specified expression. (Defined by DisplayTextExtensions.)
Public Extension Method DropDownList(String) Overloaded. Returns a single-selection select element using the specified HTML helper and the name of the form field. (Defined by SelectExtensions.)
Public Extension Method DropDownList(String, String) Overloaded. Returns a single-selection select element using the specified HTML helper, the name of the form field, and an option label. (Defined by SelectExtensions.)
Public Extension Method DropDownList(String, IEnumerable<SelectListItem>) Overloaded. Returns a single-selection select element using the specified HTML helper, the name of the form field, and the specified list items. (Defined by SelectExtensions.)
Public Extension Method DropDownList(String, IEnumerable<SelectListItem>, Object) Overloaded. Returns a single-selection select element using the specified HTML helper, the name of the form field, the specified list items, and the specified HTML attributes. (Defined by SelectExtensions.)
Public Extension Method DropDownList(String, IEnumerable<SelectListItem>, IDictionary<String, Object>) Overloaded. Returns a single-selection select element using the specified HTML helper, the name of the form field, the specified list items, and the specified HTML attributes. (Defined by SelectExtensions.)
Public Extension Method DropDownList(String, IEnumerable<SelectListItem>, String) Overloaded. Returns a single-selection select element using the specified HTML helper, the name of the form field, the specified list items, and an option label. (Defined by SelectExtensions.)
Public Extension Method DropDownList(String, IEnumerable<SelectListItem>, String, Object) Overloaded. Returns a single-selection select element using the specified HTML helper, the name of the form field, the specified list items, an option label, and the specified HTML attributes. (Defined by SelectExtensions.)
Public Extension Method DropDownList(String, IEnumerable<SelectListItem>, String, IDictionary<String, Object>) Overloaded. Returns a single-selection select element using the specified HTML helper, the name of the form field, the specified list items, an option label, and the specified HTML attributes. (Defined by SelectExtensions.)
Public Extension Method Editor(String) Overloaded. Returns an HTML input element for each property in the object that is represented by the expression. (Defined by EditorExtensions.)
Public Extension Method Editor(String, Object) Overloaded. Returns an HTML input element for each property in the object that is represented by the expression, using additional view data. (Defined by EditorExtensions.)
Public Extension Method Editor(String, String) Overloaded. Returns an HTML input element for each property in the object that is represented by the expression, using the specified template. (Defined by EditorExtensions.)
Public Extension Method Editor(String, String, Object) Overloaded. Returns an HTML input element for each property in the object that is represented by the expression, using the specified template and additional view data. (Defined by EditorExtensions.)
Public Extension Method Editor(String, String, String) Overloaded. Returns an HTML input element for each property in the object that is represented by the expression, using the specified template and HTML field name. (Defined by EditorExtensions.)
Public Extension Method Editor(String, String, String, Object) Overloaded. Returns an HTML input element for each property in the object that is represented by the expression, using the specified template, HTML field name, and additional view data. (Defined by EditorExtensions.)
Public Extension Method EditorForModel() Overloaded. Returns an HTML input element for each property in the model. (Defined by EditorExtensions.)
Public Extension Method EditorForModel(Object) Overloaded. Returns an HTML input element for each property in the model, using additional view data. (Defined by EditorExtensions.)
Public Extension Method EditorForModel(String) Overloaded. Returns an HTML input element for each property in the model, using the specified template. (Defined by EditorExtensions.)
Public Extension Method EditorForModel(String, Object) Overloaded. Returns an HTML input element for each property in the model, using the specified template and additional view data. (Defined by EditorExtensions.)
Public Extension Method EditorForModel(String, String) Overloaded. Returns an HTML input element for each property in the model, using the specified template name and HTML field name. (Defined by EditorExtensions.)
Public Extension Method EditorForModel(String, String, Object) Overloaded. Returns an HTML input element for each property in the model, using the template name, HTML field name, and additional view data. (Defined by EditorExtensions.)
Public Extension Method EndForm Renders the closing </form> tag to the response. (Defined by FormExtensions.)
Public Extension Method Hidden(String) Overloaded. Returns a hidden input element by using the specified HTML helper and the name of the form field. (Defined by InputExtensions.)
Public Extension Method Hidden(String, Object) Overloaded. Returns a hidden input element by using the specified HTML helper, the name of the form field, and the value. (Defined by InputExtensions.)
Public Extension Method Hidden(String, Object, Object) Overloaded. Returns a hidden input element by using the specified HTML helper, the name of the form field, the value, and the HTML attributes. (Defined by InputExtensions.)
Public Extension Method Hidden(String, Object, IDictionary<String, Object>) Overloaded. Returns a hidden input element by using the specified HTML helper, the name of the form field, the value, and the HTML attributes. (Defined by InputExtensions.)
Public Extension Method Label Returns an HTML label element and the property name of the property that is represented by the specified expression. (Defined by LabelExtensions.)
Public Extension Method LabelForModel Returns an HTML label element and the property name of the property that is represented by the model. (Defined by LabelExtensions.)
Public Extension Method ListBox(String) Overloaded. Returns a multi-select select element using the specified HTML helper and the name of the form field. (Defined by SelectExtensions.)
Public Extension Method ListBox(String, IEnumerable<SelectListItem>) Overloaded. Returns a multi-select select element using the specified HTML helper, the name of the form field, and the specified list items. (Defined by SelectExtensions.)
Public Extension Method ListBox(String, IEnumerable<SelectListItem>, Object) Overloaded. Returns a multi-select select element using the specified HTML helper, the name of the form field, and the specified list items. (Defined by SelectExtensions.)
Public Extension Method ListBox(String, IEnumerable<SelectListItem>, IDictionary<String, Object>) Overloaded. Returns a multi-select select element using the specified HTML helper, the name of the form field, the specified list items, and the specified HMTL attributes. (Defined by SelectExtensions.)
Public Extension Method Partial(String) Overloaded. Renders the specified partial view as an HTML-encoded string. (Defined by PartialExtensions.)
Public Extension Method Partial(String, ViewDataDictionary) Overloaded. Renders the specified partial view as an HTML-encoded string. (Defined by PartialExtensions.)
Public Extension Method Partial(String, Object) Overloaded. Renders the specified partial view as an HTML-encoded string. (Defined by PartialExtensions.)
Public Extension Method Partial(String, Object, ViewDataDictionary) Overloaded. Renders the specified partial view as an HTML-encoded string. (Defined by PartialExtensions.)
Public Extension Method Password(String) Overloaded. Returns a password input element by using the specified HTML helper and the name of the form field. (Defined by InputExtensions.)
Public Extension Method Password(String, Object) Overloaded. Returns a password input element by using the specified HTML helper, the name of the form field, and the value. (Defined by InputExtensions.)
Public Extension Method Password(String, Object, Object) Overloaded. Returns a password input element by using the specified HTML helper, the name of the form field, the value, and the HTML attributes. (Defined by InputExtensions.)
Public Extension Method Password(String, Object, IDictionary<String, Object>) Overloaded. Returns a password input element by using the specified HTML helper, the name of the form field, the value, and the HTML attributes. (Defined by InputExtensions.)
Public Extension Method RadioButton(String, Object) Overloaded. Returns a radio button input element that is used to present mutually exclusive options. (Defined by InputExtensions.)
Public Extension Method RadioButton(String, Object, Object) Overloaded. Returns a radio button input element that is used to present mutually exclusive options. (Defined by InputExtensions.)
Public Extension Method RadioButton(String, Object, IDictionary<String, Object>) Overloaded. Returns a radio button input element that is used to present mutually exclusive options. (Defined by InputExtensions.)
Public Extension Method RadioButton(String, Object, Boolean) Overloaded. Returns a radio button input element that is used to present mutually exclusive options. (Defined by InputExtensions.)
Public Extension Method RadioButton(String, Object, Boolean, Object) Overloaded. Returns a radio button input element that is used to present mutually exclusive options. (Defined by InputExtensions.)
Public Extension Method RadioButton(String, Object, Boolean, IDictionary<String, Object>) Overloaded. Returns a radio button input element that is used to present mutually exclusive options. (Defined by InputExtensions.)
Public Extension Method RenderAction(String) Overloaded. Invokes the specified child action method and renders the result inline in the parent view. (Defined by ChildActionExtensions.)
Public Extension Method RenderAction(String, Object) Overloaded. Invokes the specified child action method using the specified parameters and renders the result inline in the parent view. (Defined by ChildActionExtensions.)
Public Extension Method RenderAction(String, RouteValueDictionary) Overloaded. Invokes the specified child action method using the specified parameters and renders the result inline in the parent view. (Defined by ChildActionExtensions.)
Public Extension Method RenderAction(String, String) Overloaded. Invokes the specified child action method using the specified controller name and renders the result inline in the parent view. (Defined by ChildActionExtensions.)
Public Extension Method RenderAction(String, String, Object) Overloaded. Invokes the specified child action method using the specified parameters and controller name and renders the result inline in the parent view. (Defined by ChildActionExtensions.)
Public Extension Method RenderAction(String, String, RouteValueDictionary) Overloaded. Invokes the specified child action method using the specified parameters and controller name and renders the result inline in the parent view. (Defined by ChildActionExtensions.)
Public Extension Method RenderPartial(String) Overloaded. Renders the specified partial view by using the specified HMTL helper. (Defined by RenderPartialExtensions.)
Public Extension Method RenderPartial(String, ViewDataDictionary) Overloaded. Renders the specified partial view, replacing its ViewData property with the specified ViewDataDictionary object. (Defined by RenderPartialExtensions.)
Public Extension Method RenderPartial(String, Object) Overloaded. Renders the specified partial view, passing it a copy of the current ViewDataDictionary object, but with the Model property set to the specified model. (Defined by RenderPartialExtensions.)
Public Extension Method RenderPartial(String, Object, ViewDataDictionary) Overloaded. Renders the specified partial view, replacing the partial view's ViewData property with the specified ViewDataDictionary object and setting the Model property of the view data to the specified model. (Defined by RenderPartialExtensions.)
Public Extension Method RouteLink(String, Object) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method RouteLink(String, RouteValueDictionary) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method RouteLink(String, String) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method RouteLink(String, String, Object) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method RouteLink(String, String, RouteValueDictionary) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method RouteLink(String, Object, Object) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method RouteLink(String, RouteValueDictionary, IDictionary<String, Object>) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method RouteLink(String, String, Object, Object) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method RouteLink(String, String, RouteValueDictionary, IDictionary<String, Object>) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method RouteLink(String, String, String, String, String, Object, Object) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method RouteLink(String, String, String, String, String, RouteValueDictionary, IDictionary<String, Object>) Overloaded. Returns an anchor element (a element) that contains the virtual path of the specified action. (Defined by LinkExtensions.)
Public Extension Method TextArea(String) Overloaded. Returns the specified textarea element by using the specified HTML helper and the name of the form field. (Defined by TextAreaExtensions.)
Public Extension Method TextArea(String, Object) Overloaded. Returns the specified textarea element by using the specified HTML helper and HTML attributes. (Defined by TextAreaExtensions.)
Public Extension Method TextArea(String, IDictionary<String, Object>) Overloaded. Returns the specified textarea element by using the specified HTML helper, the name of the form field, and the specified HTML attributes. (Defined by TextAreaExtensions.)
Public Extension Method TextArea(String, String) Overloaded. Returns the specified textarea element by using the specified HTML helper, the name of the form field, and the text content. (Defined by TextAreaExtensions.)
Public Extension Method TextArea(String, String, Object) Overloaded. Returns the specified textarea element by using the specified HTML helper, the name of the form field, the text content, and the specified HTML attributes. (Defined by TextAreaExtensions.)
Public Extension Method TextArea(String, String, IDictionary<String, Object>) Overloaded. Returns the specified textarea element by using the specified HTML helper, the name of the form field, the text content, and the specified HTML attributes. (Defined by TextAreaExtensions.)
Public Extension Method TextArea(String, String, Int32, Int32, Object) Overloaded. Returns the specified textarea element by using the specified HTML helper, the name of the form field, the text content, the number of rows and columns, and the specified HTML attributes. (Defined by TextAreaExtensions.)
Public Extension Method TextArea(String, String, Int32, Int32, IDictionary<String, Object>) Overloaded. Returns the specified textarea element by using the specified HTML helper, the name of the form field, the text content, the number of rows and columns, and the specified HTML attributes. (Defined by TextAreaExtensions.)
Public Extension Method TextBox(String) Overloaded. Returns a text input element by using the specified HTML helper and the name of the form field. (Defined by InputExtensions.)
Public Extension Method TextBox(String, Object) Overloaded. Returns a text input element by using the specified HTML helper, the name of the form field, and the value. (Defined by InputExtensions.)
Public Extension Method TextBox(String, Object, Object) Overloaded. Returns a text input element by using the specified HTML helper, the name of the form field, the value, and the HTML attributes. (Defined by InputExtensions.)
Public Extension Method TextBox(String, Object, IDictionary<String, Object>) Overloaded. Returns a text input element by using the specified HTML helper, the name of the form field, the value, and the HTML attributes. (Defined by InputExtensions.)
Public Extension Method Validate Retrieves the validation metadata for the specified model and applies each rule to the data field. (Defined by ValidationExtensions.)
Public Extension Method ValidationMessage(String) Overloaded. Displays a validation message if an error exists for the specified field in the ModelStateDictionary object. (Defined by ValidationExtensions.)
Public Extension Method ValidationMessage(String, Object) Overloaded. Displays a validation message if an error exists for the specified field in the ModelStateDictionary object. (Defined by ValidationExtensions.)
Public Extension Method ValidationMessage(String, String) Overloaded. Displays a validation message if an error exists for the specified field in the ModelStateDictionary object. (Defined by ValidationExtensions.)
Public Extension Method ValidationMessage(String, IDictionary<String, Object>) Overloaded. Displays a validation message if an error exists for the specified field in the ModelStateDictionary object. (Defined by ValidationExtensions.)
Public Extension Method ValidationMessage(String, String, Object) Overloaded. Displays a validation message if an error exists for the specified field in the ModelStateDictionary object. (Defined by ValidationExtensions.)
Public Extension Method ValidationMessage(String, String, IDictionary<String, Object>) Overloaded. Displays a validation message if an error exists for the specified field in the ModelStateDictionary object. (Defined by ValidationExtensions.)
Public Extension Method ValidationSummary() Overloaded. Returns an unordered list (ul element) of validation messages that are in the ModelStateDictionary object. (Defined by ValidationExtensions.)
Public Extension Method ValidationSummary(Boolean) Overloaded. Returns an unordered list (ul element) of validation messages that are in the ModelStateDictionary object and optionally displays only model-level errors. (Defined by ValidationExtensions.)
Public Extension Method ValidationSummary(String) Overloaded. Returns an unordered list (ul element) of validation messages that are in the ModelStateDictionary object. (Defined by ValidationExtensions.)
Public Extension Method ValidationSummary(Boolean, String) Overloaded. Returns an unordered list (ul element) of validation messages that are in the ModelStateDictionary object and optionally displays only model-level errors. (Defined by ValidationExtensions.)
Public Extension Method ValidationSummary(String, Object) Overloaded. Returns an unordered list (ul element) of validation messages in the ModelStateDictionary object. (Defined by ValidationExtensions.)
Public Extension Method ValidationSummary(String, IDictionary<String, Object>) Overloaded. Returns an unordered list (ul element) of validation messages that are in the ModelStateDictionary object. (Defined by ValidationExtensions.)
Public Extension Method ValidationSummary(Boolean, String, Object) Overloaded. Returns an unordered list (ul element) of validation messages that are in the ModelStateDictionary object and optionally displays only model-level errors. (Defined by ValidationExtensions.)
Public Extension Method ValidationSummary(Boolean, String, IDictionary<String, Object>) Overloaded. Returns an unordered list (ul element) of validation messages that are in the ModelStateDictionary object and optionally displays only model-level errors. (Defined by ValidationExtensions.)

Top

Fields

  Name Description
Public fieldStatic member ValidationInputCssClassName The name of the CSS class that is used to style an input field when a validation error occurs.
Public fieldStatic member ValidationInputValidCssClassName The name of the CSS class that is used to style an input field when the input is valid.
Public fieldStatic member ValidationMessageCssClassName The name of the CSS class that is used to style the error message when a validation error occurs.
Public fieldStatic member ValidationMessageValidCssClassName The name of the CSS class that is used to style the validation message when the input is valid.
Public fieldStatic member ValidationSummaryCssClassName The name of the CSS class that is used to style validation summary error messages.
Public fieldStatic member ValidationSummaryValidCssClassName The name of the CSS class that is used to style the validation summary when the input is valid.

Top

Remarks

The HtmlHelper class provides methods that help you create HTML controls programmatically. All HtmlHelper methods generate HTML and return the result as a string.

Note

The HtmlHelper class is designed to generate UI. It should not be used in controllers or models.

Extension methods for the HtmlHelper class are in the System.Web.Mvc.Html namespace. These extensions add helper methods for creating forms, rendering HTML controls, rendering partial views, performing input validation, and more.

Helper methods and extensions are called using the Html property of the view, which is an instance of the HtmlHelper class. For example, to generate a check box in a form, you call the CheckBox method in a view using the following syntax:

<%= Html.CheckBox("OptionName") %>

Examples

The following example shows how to use the HtmlHelper class and shows how to use the methods of the InputExtensions class. The view displays a text box, a password box, some radio buttons, and some check boxes.

<h2><%= Html.Encode(ViewData("Message")) %></h2>
<br /><br />
<% Using Html.BeginForm("Input", "Home")%>
    Enter your name: <%= Html.TextBox("name") %>
    <br /><br />
    Enter a password: <%= Html.Password("pass") %> (Not actually used.)
    <br /><br />
    Select your favorite color:<br />
    <%= Html.RadioButton("favColor", "Blue", true) %> Blue <br />
    <%= Html.RadioButton("favColor", "Purple", false)%> Purple <br />
    <%= Html.RadioButton("favColor", "Red", false)%> Red <br />
    <%= Html.RadioButton("favColor", "Orange", false)%> Orange <br />
    <%= Html.RadioButton("favColor", "Yellow", false)%> Yellow <br />
    <%= Html.RadioButton("favColor", "Brown", false)%> Brown <br />
    <%= Html.RadioButton("favColor", "Green", false)%> Green 
    <br /><br />
    <%= Html.CheckBox("technical") %> I like to read technical books.<br />
    <%= Html.CheckBox("novels") %> I like to read novels.<br />
    <%= Html.CheckBox("comic") %> I like to read comic books.<br /> 
    <br /><br />
    <input type="submit" value="Submit" />
<% End Using%>
<h2><%= Html.Encode(ViewData["Message"]) %></h2>
<br /><br />
<% using(Html.BeginForm("Input", "Home")) %>
<% { %>
    Enter your name: <%= Html.TextBox("name") %>
    <br /><br />
    Enter a password: <%= Html.Password("pass") %> (Not actually used.)
    <br /><br />
    Select your favorite color:<br />
    <%= Html.RadioButton("favColor", "Blue", true) %> Blue <br />
    <%= Html.RadioButton("favColor", "Purple", false)%> Purple <br />
    <%= Html.RadioButton("favColor", "Red", false)%> Red <br />
    <%= Html.RadioButton("favColor", "Orange", false)%> Orange <br />
    <%= Html.RadioButton("favColor", "Yellow", false)%> Yellow <br />
    <%= Html.RadioButton("favColor", "Brown", false)%> Brown <br />
    <%= Html.RadioButton("favColor", "Green", false)%> Green 
    <br /><br />
    <%= Html.CheckBox("technical") %> I like to read technical books.<br />
    <%= Html.CheckBox("novels") %> I like to read novels.<br />
    <%= Html.CheckBox("comic") %> I like to read comic books.<br /> 
    <br /><br />
    <input type="submit" value="Submit" />
<% } %>

The following example shows a form. When the user submits the form, the Input action method processes the form data and renders a view.

Function Input(ByVal name As String, ByVal pass As String, _
               ByVal favColor As String, ByVal technical As Boolean, _
               ByVal novels As Boolean, _
               ByVal comic As Boolean) As ActionResult

    ViewData("name") = name
    ViewData("favColor") = favColor

    Dim bookMsg As String = ""
    If (technical) Then bookMsg = "You read technical books.<br />"
    If (novels) Then bookMsg = bookMsg + "You read novels.<br />"
    If (comic) Then bookMsg = bookMsg + "You read comic books."
    ViewData("books") = bookMsg

    Return View()
End Function
public ActionResult Input(string name, string pass, 
    string favColor, Boolean technical, Boolean novels, 
    Boolean comic)
{
    ViewData["name"] = name;
    ViewData["favColor"] = favColor;

    string bookMsg = "";
    if (technical) bookMsg = "You read tehnical books.<br />";
    if (novels) bookMsg += "You read novels.<br />";
    if (comic) bookMsg += "You read comic books.";
    ViewData["books"] = bookMsg;

    return View();
}

In the following example, the view displays the data that was submitted.

<h2>HTML Input Extensions</h2>

<p>Hello, <b><%=Html.Encode(ViewData("name"))%></b></p>

<p>Your favorite color: <b><%=Html.Encode(ViewData("favColor"))%></b></p>

<p><%=ViewData("books")%></p>
<h2>HTML Input Extensions</h2>

<p>Hello, <b><%= Html.Encode(ViewData["name"])%></b></p>

<p>Your favorite color: <b><%= Html.Encode(ViewData["favColor"]) %></b></p>

<p><%= ViewData["books"] %></p>

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.Web.Mvc Namespace

Other Resources

Rendering a Form in ASP.NET MVC Using HTML Helpers