HtmlHelper Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Default implementation of IHtmlHelper.
public ref class HtmlHelper : Microsoft::AspNetCore::Mvc::Rendering::IHtmlHelper, Microsoft::AspNetCore::Mvc::ViewFeatures::IViewContextAware
public class HtmlHelper : Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper, Microsoft.AspNetCore.Mvc.ViewFeatures.IViewContextAware
type HtmlHelper = class
interface IHtmlHelper
interface IViewContextAware
Public Class HtmlHelper
Implements IHtmlHelper, IViewContextAware
- Inheritance
-
HtmlHelper
- Derived
- Implements
Constructors
HtmlHelper(IHtmlGenerator, ICompositeViewEngine, IModelMetadataProvider, IViewBufferScope, HtmlEncoder, UrlEncoder) |
Initializes a new instance of the HtmlHelper class. |
HtmlHelper(IHtmlGenerator, ICompositeViewEngine, IModelMetadataProvider, IViewBufferScope, HtmlEncoder, UrlEncoder) |
Initializes a new instance of the HtmlHelper class. |
Fields
ValidationInputCssClassName |
CSS class name for input validation. |
ValidationInputValidCssClassName |
CSS class name for valid input validation. |
ValidationMessageCssClassName |
CSS class name for field validation error. |
ValidationMessageValidCssClassName |
CSS class name for valid field validation. |
ValidationSummaryCssClassName |
CSS class name for validation summary errors. |
ValidationSummaryValidCssClassName |
CSS class name for valid validation summary. |
Properties
Html5DateRenderingMode |
Set this property to CurrentCulture to have templated helpers such as Editor(String, String, String, Object) and EditorFor<TResult>(Expression<Func<TModel,TResult>>, String, String, Object) render date and time values using the current culture. By default, these helpers render dates and times as RFC 3339 compliant strings. |
IdAttributeDotReplacement |
Gets the String that replaces periods in the ID attribute of an element. |
MetadataProvider |
Gets the metadata provider. Intended for use in IHtmlHelper extension methods. |
TempData |
Gets the current ITempDataDictionary instance. |
UrlEncoder |
Gets the UrlEncoder to be used for encoding a URL. |
ViewBag |
Gets the view bag. |
ViewContext |
Gets the context information about the view. |
ViewData |
Gets the current view data. |
Methods
ActionLink(String, String, String, String, String, String, Object, Object) |
Returns an anchor (<a>) element that contains a URL path to the specified action. |
AnonymousObjectToHtmlAttributes(Object) |
Creates a dictionary of HTML attributes from the input object, translating underscores to dashes in each public instance property. |
AntiForgeryToken() |
Returns a <hidden> element (antiforgery token) that will be validated when the containing <form> is submitted. |
BeginForm(String, String, Object, FormMethod, Nullable<Boolean>, Object) |
Renders a <form> start tag to the response. When the user submits the form, the action with name
|
BeginRouteForm(String, Object, FormMethod, Nullable<Boolean>, Object) |
Renders a <form> start tag to the response. The route with name |
CheckBox(String, Nullable<Boolean>, Object) |
Returns an <input> element of type "checkbox" with value "true" and an <input> element of type
"hidden" with value "false" for the specified |
Contextualize(ViewContext) |
Sets the ViewContext. |
CreateForm() |
Override this method to return an MvcForm subclass. That subclass may change EndForm() behavior. |
Display(String, String, String, Object) |
Returns HTML markup for the |
DisplayName(String) |
Returns the display name for the specified |
DisplayText(String) |
Returns the simple display text for the specified |
DropDownList(String, IEnumerable<SelectListItem>, String, Object) |
Returns a single-selection HTML <select> element for the |
Editor(String, String, String, Object) |
Returns HTML markup for the |
Encode(Object) |
Converts the |
Encode(String) | |
EndForm() |
Renders the </form> end tag to the response. |
FormatValue(Object, String) |
Formats the value. |
GenerateCheckBox(ModelExplorer, String, Nullable<Boolean>, Object) |
Generate a check box. |
GenerateDisplay(ModelExplorer, String, String, Object) |
Generate a display. |
GenerateDisplayName(ModelExplorer, String) |
Generate display name. |
GenerateDisplayText(ModelExplorer) |
Generate display text. |
GenerateDropDown(ModelExplorer, String, IEnumerable<SelectListItem>, String, Object) |
Generate a drop down. |
GenerateEditor(ModelExplorer, String, String, Object) |
Generate editor. |
GenerateForm(String, String, Object, FormMethod, Nullable<Boolean>, Object) |
Renders a <form> start tag to the response. When the user submits the form, the action with name
|
GenerateHidden(ModelExplorer, String, Object, Boolean, Object) |
Generate a hidden. |
GenerateId(String) |
Generate an id. |
GenerateIdFromName(String) |
Returns an HTML element Id for the specified expression |
GenerateLabel(ModelExplorer, String, String, Object) |
Generate a label. |
GenerateListBox(ModelExplorer, String, IEnumerable<SelectListItem>, Object) |
Generate a list box. |
GenerateName(String) |
Geneate a name. |
GeneratePassword(ModelExplorer, String, Object, Object) |
Generate a password. |
GenerateRadioButton(ModelExplorer, String, Object, Nullable<Boolean>, Object) |
Generate a radio button. |
GenerateRouteForm(String, Object, FormMethod, Nullable<Boolean>, Object) |
Renders a <form> start tag to the response. The route with name |
GenerateTextArea(ModelExplorer, String, Int32, Int32, Object) |
Generate a text area. |
GenerateTextBox(ModelExplorer, String, Object, String, Object) |
Generates a text box. |
GenerateValidationMessage(ModelExplorer, String, String, String, Object) |
Generate a validation message. |
GenerateValidationSummary(Boolean, String, Object, String) |
Generate a validation summary. |
GenerateValue(String, Object, String, Boolean) |
Generate a value. |
GetEnumSelectList(ModelMetadata) |
Returns a select list for the given |
GetEnumSelectList(Type) |
Returns a select list for the given |
GetEnumSelectList<TEnum>() |
Returns a select list for the given |
GetFormMethodString(FormMethod) |
Returns the HTTP method that handles form input (GET or POST) as a string. |
Hidden(String, Object, Object) |
Returns an <input> element of type "hidden" for the specified |
Id(String) |
Returns the HTML element Id for the specified |
Label(String, String, Object) |
Returns a <label> element for the specified |
ListBox(String, IEnumerable<SelectListItem>, Object) |
Returns a multi-selection <select> element for the |
Name(String) |
Returns the full HTML element name for the specified |
ObjectToDictionary(Object) |
Creates a dictionary from an object, by adding each public instance property as a key with its associated value to the dictionary. It will expose public properties from derived types as well. This is typically used with objects of an anonymous type. If the |
PartialAsync(String, Object, ViewDataDictionary) |
Returns HTML markup for the specified partial view. |
Password(String, Object, Object) |
Returns an <input> element of type "password" for the specified |
RadioButton(String, Object, Nullable<Boolean>, Object) |
Returns an <input> element of type "radio" for the specified |
Raw(Object) |
Wraps HTML markup from the string representation of an Object in an HtmlString, without HTML-encoding the string representation. |
Raw(String) |
Wraps HTML markup in an HtmlString, without HTML-encoding the specified
|
RenderPartialAsync(String, Object, ViewDataDictionary) |
Renders HTML markup for the specified partial view. |
RenderPartialCoreAsync(String, Object, ViewDataDictionary, TextWriter) |
Render a partial view. |
RouteLink(String, String, String, String, String, Object, Object) |
Returns an anchor (<a>) element that contains a URL path to the specified route. |
TextArea(String, String, Int32, Int32, Object) |
Returns a <textarea> element for the specified |
TextBox(String, Object, String, Object) |
Returns an <input> element of type "text" for the specified |
ValidationMessage(String, String, Object, String) |
Returns the validation message if an error exists in the ModelStateDictionary object
for the specified |
ValidationSummary(Boolean, String, Object, String) |
Returns an unordered list (<ul> element) of validation messages that are in the ModelStateDictionary object. |
Value(String, String) |
Returns the formatted value for the specified |
Extension Methods
RenderComponentAsync(IHtmlHelper, Type, RenderMode, Object) |
Renders the specified |
RenderComponentAsync<TComponent>(IHtmlHelper, RenderMode, Object) |
Renders the |
RenderComponentAsync<TComponent>(IHtmlHelper, RenderMode) |
Renders the |
Display(IHtmlHelper, String, Object) |
Returns HTML markup for the |
Display(IHtmlHelper, String, String, Object) |
Returns HTML markup for the |
Display(IHtmlHelper, String, String, String) |
Returns HTML markup for the |
Display(IHtmlHelper, String, String) |
Returns HTML markup for the |
Display(IHtmlHelper, String) |
Returns HTML markup for the |
DisplayForModel(IHtmlHelper, Object) |
Returns HTML markup for the current model, using a display template and specified additional view data. The template is found using the model's ModelMetadata. |
DisplayForModel(IHtmlHelper, String, Object) |
Returns HTML markup for the current model, using a display template and specified additional view data. The
template is found using the |
DisplayForModel(IHtmlHelper, String, String, Object) |
Returns HTML markup for the current model, using a display template, specified HTML field name, and
additional view data. The template is found using the |
DisplayForModel(IHtmlHelper, String, String) |
Returns HTML markup for the current model, using a display template and specified HTML field name. The
template is found using the |
DisplayForModel(IHtmlHelper, String) |
Returns HTML markup for the current model, using a display template. The template is found using the
|
DisplayForModel(IHtmlHelper) |
Returns HTML markup for the current model, using a display template. The template is found using the model's ModelMetadata. |
DisplayNameForModel(IHtmlHelper) |
Returns the display name for the current model. |
Editor(IHtmlHelper, String, Object) |
Returns HTML markup for the |
Editor(IHtmlHelper, String, String, Object) |
Returns HTML markup for the |
Editor(IHtmlHelper, String, String, String) |
Returns HTML markup for the |
Editor(IHtmlHelper, String, String) |
Returns HTML markup for the |
Editor(IHtmlHelper, String) |
Returns HTML markup for the |
EditorForModel(IHtmlHelper, Object) |
Returns HTML markup for the current model, using an editor template and specified additional view data. The template is found using the model's ModelMetadata. |
EditorForModel(IHtmlHelper, String, Object) |
Returns HTML markup for the current model, using an editor template and specified additional view data. The
template is found using the |
EditorForModel(IHtmlHelper, String, String, Object) |
Returns HTML markup for the current model, using an editor template, specified HTML field name, and
additional view data. The template is found using the |
EditorForModel(IHtmlHelper, String, String) |
Returns HTML markup for the current model, using an editor template and specified HTML field name. The
template is found using the |
EditorForModel(IHtmlHelper, String) |
Returns HTML markup for the current model, using an editor template. The template is found using the
|
EditorForModel(IHtmlHelper) |
Returns HTML markup for the current model, using an editor template. The template is found using the model's ModelMetadata. |
BeginForm(IHtmlHelper, FormMethod, Nullable<Boolean>, Object) |
Renders a <form> start tag to the response. When the user submits the form, the current action will process the request. |
BeginForm(IHtmlHelper, FormMethod, Object) |
Renders a <form> start tag to the response. When the user submits the form, the current action will process the request. |
BeginForm(IHtmlHelper, FormMethod) |
Renders a <form> start tag to the response. When the user submits the form, the current action will process the request. |
BeginForm(IHtmlHelper, Nullable<Boolean>) |
Renders a <form> start tag to the response. The <form>'s |
BeginForm(IHtmlHelper, Object) |
Renders a <form> start tag to the response. When the user submits the form, the current action will process the request. |
BeginForm(IHtmlHelper, String, String, FormMethod, Object) |
Renders a <form> start tag to the response. When the user submits the form, the action with name
|
BeginForm(IHtmlHelper, String, String, FormMethod) |
Renders a <form> start tag to the response. When the user submits the form, the action with name
|
BeginForm(IHtmlHelper, String, String, Object, FormMethod) |
Renders a <form> start tag to the response. When the user submits the form, the action with name
|
BeginForm(IHtmlHelper, String, String, Object) |
Renders a <form> start tag to the response. When the user submits the form, the action with name
|
BeginForm(IHtmlHelper, String, String) |
Renders a <form> start tag to the response. When the user submits the form, the action with name
|
BeginForm(IHtmlHelper) |
Renders a <form> start tag to the response. The <form>'s |
BeginRouteForm(IHtmlHelper, Object, Nullable<Boolean>) |
Renders a <form> start tag to the response. The first route that can provide a URL with the
specified |
BeginRouteForm(IHtmlHelper, Object) |
Renders a <form> start tag to the response. The first route that can provide a URL with the
specified |
BeginRouteForm(IHtmlHelper, String, FormMethod, Object) |
Renders a <form> start tag to the response. The route with name |
BeginRouteForm(IHtmlHelper, String, FormMethod) |
Renders a <form> start tag to the response. The route with name |
BeginRouteForm(IHtmlHelper, String, Nullable<Boolean>) |
Renders a <form> start tag to the response. The route with name |
BeginRouteForm(IHtmlHelper, String, Object, FormMethod) |
Renders a <form> start tag to the response. The route with name |
BeginRouteForm(IHtmlHelper, String, Object) |
Renders a <form> start tag to the response. The route with name |
BeginRouteForm(IHtmlHelper, String) |
Renders a <form> start tag to the response. The route with name |
CheckBox(IHtmlHelper, String, Boolean) |
Returns an <input> element of type "checkbox" with value "true" and an <input> element of type
"hidden" with value "false" for the specified |
CheckBox(IHtmlHelper, String, Object) |
Returns an <input> element of type "checkbox" with value "true" and an <input> element of type
"hidden" with value "false" for the specified |
CheckBox(IHtmlHelper, String) |
Returns an <input> element of type "checkbox" with value "true" and an <input> element of type
"hidden" with value "false" for the specified |
Hidden(IHtmlHelper, String, Object) |
Returns an <input> element of type "hidden" for the specified |
Hidden(IHtmlHelper, String) |
Returns an <input> element of type "hidden" for the specified |
Password(IHtmlHelper, String, Object) |
Returns an <input> element of type "password" for the specified |
Password(IHtmlHelper, String) |
Returns an <input> element of type "password" for the specified |
RadioButton(IHtmlHelper, String, Object, Boolean) |
Returns an <input> element of type "radio" for the specified |
RadioButton(IHtmlHelper, String, Object, Object) |
Returns an <input> element of type "radio" for the specified |
RadioButton(IHtmlHelper, String, Object) |
Returns an <input> element of type "radio" for the specified |
TextArea(IHtmlHelper, String, Object) |
Returns a <textarea> element for the specified |
TextArea(IHtmlHelper, String, String, Object) |
Returns a <textarea> element for the specified |
TextArea(IHtmlHelper, String, String) |
Returns a <textarea> element for the specified |
TextArea(IHtmlHelper, String) |
Returns a <textarea> element for the specified |
TextBox(IHtmlHelper, String, Object, Object) |
Returns an <input> element of type "text" for the specified |
TextBox(IHtmlHelper, String, Object, String) |
Returns an <input> element of type "text" for the specified |
TextBox(IHtmlHelper, String, Object) |
Returns an <input> element of type "text" for the specified |
TextBox(IHtmlHelper, String) |
Returns an <input> element of type "text" for the specified |
Label(IHtmlHelper, String, String) |
Returns a <label> element for the specified |
Label(IHtmlHelper, String) |
Returns a <label> element for the specified |
LabelForModel(IHtmlHelper, Object) |
Returns a <label> element for the current model. |
LabelForModel(IHtmlHelper, String, Object) |
Returns a <label> element for the current model. |
LabelForModel(IHtmlHelper, String) |
Returns a <label> element for the current model. |
LabelForModel(IHtmlHelper) |
Returns a <label> element for the current model. |
ActionLink(IHtmlHelper, String, String, Object, Object) |
Returns an anchor (<a>) element that contains a URL path to the specified action. |
ActionLink(IHtmlHelper, String, String, Object) |
Returns an anchor (<a>) element that contains a URL path to the specified action. |
ActionLink(IHtmlHelper, String, String, String, Object, Object) |
Returns an anchor (<a>) element that contains a URL path to the specified action. |
ActionLink(IHtmlHelper, String, String, String, Object) |
Returns an anchor (<a>) element that contains a URL path to the specified action. |
ActionLink(IHtmlHelper, String, String, String) |
Returns an anchor (<a>) element that contains a URL path to the specified action. |
ActionLink(IHtmlHelper, String, String) |
Returns an anchor (<a>) element that contains a URL path to the specified action. |
RouteLink(IHtmlHelper, String, Object, Object) |
Returns an anchor (<a>) element that contains a URL path to the specified route. |
RouteLink(IHtmlHelper, String, Object) |
Returns an anchor (<a>) element that contains a URL path to the specified route. |
RouteLink(IHtmlHelper, String, String, Object, Object) |
Returns an anchor (<a>) element that contains a URL path to the specified route. |
RouteLink(IHtmlHelper, String, String, Object) |
Returns an anchor (<a>) element that contains a URL path to the specified route. |
RouteLink(IHtmlHelper, String, String) |
Returns an anchor (<a>) element that contains a URL path to the specified route. |
IdForModel(IHtmlHelper) |
Returns the HTML element Id for the current model. |
NameForModel(IHtmlHelper) |
Returns the full HTML element name for the current model. Uses HtmlFieldPrefix (if non-empty) to reflect relationship between current Model and the top-level view's model. |
Partial(IHtmlHelper, String, ViewDataDictionary) |
Returns HTML markup for the specified partial view. |
Partial(IHtmlHelper, String, Object, ViewDataDictionary) |
Returns HTML markup for the specified partial view. |
Partial(IHtmlHelper, String, Object) |
Returns HTML markup for the specified partial view. |
Partial(IHtmlHelper, String) |
Returns HTML markup for the specified partial view. |
PartialAsync(IHtmlHelper, String, ViewDataDictionary) |
Returns HTML markup for the specified partial view. |
PartialAsync(IHtmlHelper, String, Object) |
Returns HTML markup for the specified partial view. |
PartialAsync(IHtmlHelper, String) |
Returns HTML markup for the specified partial view. |
RenderPartial(IHtmlHelper, String, ViewDataDictionary) |
Renders HTML markup for the specified partial view. |
RenderPartial(IHtmlHelper, String, Object, ViewDataDictionary) |
Renders HTML markup for the specified partial view. |
RenderPartial(IHtmlHelper, String, Object) |
Renders HTML markup for the specified partial view. |
RenderPartial(IHtmlHelper, String) |
Renders HTML markup for the specified partial view. |
RenderPartialAsync(IHtmlHelper, String, ViewDataDictionary) |
Renders HTML markup for the specified partial view. |
RenderPartialAsync(IHtmlHelper, String, Object) |
Renders HTML markup for the specified partial view. |
RenderPartialAsync(IHtmlHelper, String) |
Renders HTML markup for the specified partial view. |
DropDownList(IHtmlHelper, String, IEnumerable<SelectListItem>, Object) |
Returns a single-selection HTML <select> element for the |
DropDownList(IHtmlHelper, String, IEnumerable<SelectListItem>, String) |
Returns a single-selection HTML <select> element for the |
DropDownList(IHtmlHelper, String, IEnumerable<SelectListItem>) |
Returns a single-selection HTML <select> element for the |
DropDownList(IHtmlHelper, String, String) |
Returns a single-selection HTML <select> element for the |
DropDownList(IHtmlHelper, String) |
Returns a single-selection HTML <select> element for the |
ListBox(IHtmlHelper, String, IEnumerable<SelectListItem>) |
Returns a multi-selection <select> element for the |
ListBox(IHtmlHelper, String) |
Returns a multi-selection <select> element for the |
ValidationMessage(IHtmlHelper, String, Object) |
Returns the validation message if an error exists in the ModelStateDictionary
object for the specified |
ValidationMessage(IHtmlHelper, String, String, Object) |
Returns the validation message if an error exists in the ModelStateDictionary
object for the specified |
ValidationMessage(IHtmlHelper, String, String, String) |
Returns the validation message if an error exists in the ModelStateDictionary
object for the specified |
ValidationMessage(IHtmlHelper, String, String) |
Returns the validation message if an error exists in the ModelStateDictionary
object for the specified |
ValidationMessage(IHtmlHelper, String) |
Returns the validation message if an error exists in the ModelStateDictionary
object for the specified |
ValidationSummary(IHtmlHelper, Boolean, String, Object) |
Returns an unordered list (<ul> element) of validation messages that are in the ModelStateDictionary object. |
ValidationSummary(IHtmlHelper, Boolean, String, String) |
Returns an unordered list (<ul> element) of validation messages that are in the ModelStateDictionary object. |
ValidationSummary(IHtmlHelper, Boolean, String) |
Returns an unordered list (<ul> element) of validation messages that are in the ModelStateDictionary object. |
ValidationSummary(IHtmlHelper, Boolean) |
Returns an unordered list (<ul> element) of validation messages that are in the ModelStateDictionary object. |
ValidationSummary(IHtmlHelper, String, Object, String) |
Returns an unordered list (<ul> element) of validation messages that are in the ModelStateDictionary object. |
ValidationSummary(IHtmlHelper, String, Object) |
Returns an unordered list (<ul> element) of validation messages that are in the ModelStateDictionary object. |
ValidationSummary(IHtmlHelper, String, String) |
Returns an unordered list (<ul> element) of validation messages that are in the ModelStateDictionary object. |
ValidationSummary(IHtmlHelper, String) |
Returns an unordered list (<ul> element) of validation messages that are in the ModelStateDictionary object. |
ValidationSummary(IHtmlHelper) |
Returns an unordered list (<ul> element) of validation messages that are in the ModelStateDictionary object. |
Value(IHtmlHelper, String) |
Returns the formatted value for the specified |
ValueForModel(IHtmlHelper, String) |
Returns the formatted value for the current model. Specifically, returns the
first non- |
ValueForModel(IHtmlHelper) |
Returns the formatted value for the current model. Specifically, returns the
first non- |