IHtmlHelper.Display(String, String, String, Object) Method

Definition

Namespace:

Microsoft.AspNetCore.Mvc.Rendering

Assembly:

Microsoft.AspNetCore.Mvc.ViewFeatures.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Source:

IHtmlHelper.cs

Returns HTML markup for the expression, using a display template, specified HTML field name, and additional view data. The template is found using the templateName or the expression's ModelMetadata.

public:
 Microsoft::AspNetCore::Html::IHtmlContent ^ Display(System::String ^ expression, System::String ^ templateName, System::String ^ htmlFieldName, System::Object ^ additionalViewData);

public Microsoft.AspNetCore.Html.IHtmlContent Display (string expression, string templateName, string htmlFieldName, object additionalViewData);

abstract member Display : string * string * string * obj -> Microsoft.AspNetCore.Html.IHtmlContent

Public Function Display (expression As String, templateName As String, htmlFieldName As String, additionalViewData As Object) As IHtmlContent

Parameters

expression

String

Expression name, relative to the current model. May identify a single property or an Object that contains the properties to display.

templateName

String

The name of the template used to create the HTML markup.

htmlFieldName

String

A String used to disambiguate the names of HTML elements that are created for properties that have the same name.

additionalViewData

Object

An anonymous Object or IDictionary<TKey,TValue> that can contain additional view data that will be merged into the ViewDataDictionary<TModel> instance created for the template.

Returns

IHtmlContent

A new IHtmlContent containing the created HTML.

Remarks

For example the default Object display template includes markup for each property in the expression's value.

Example expressions include string.Empty which identifies the current model and "prop" which identifies the current model's "prop" property.

Custom templates are found under a DisplayTemplates folder. The folder name is case-sensitive on case-sensitive file systems.