huahaofeng
/
aspnetcore
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Move value source information from `<remarks>` to `<summary>` 

- #1999
- may have reordered the precedence comments as I double-checked the implementations
 - `CheckBox()` and `RadioButton()` were examples of such updates

nits:
- use SSL in documentation links
- simplify mentions of format strings
- remove a few phrases that didn't say much and duplicated `<remarks>`
This commit is contained in:
Doug Bunting 2016-10-10 21:01:44 -07:00
parent 0eea3c2651
commit ada42ea913
16 changed files with 560 additions and 900 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/Microsoft.AspNetCore.Mvc.Abstractions/ModelBinding/ModelMetadata.cs
View File

@ -112,8 +112,8 @@ namespace Microsoft.AspNetCore.Mvc.ModelBinding
public abstract string Description { get; }
/// <summary>
/// Gets the composite format <see cref="string"/> (see
/// http://msdn.microsoft.com/en-us/library/txafckwd.aspx) used to display the model.
/// Gets the format string (see https://msdn.microsoft.com/en-us/library/txafckwd.aspx) used to display the
/// model.
/// </summary>
public abstract string DisplayFormatString { get; }
@ -123,8 +123,7 @@ namespace Microsoft.AspNetCore.Mvc.ModelBinding
public abstract string DisplayName { get; }
/// <summary>
/// Gets the composite format <see cref="string"/> (see
/// http://msdn.microsoft.com/en-us/library/txafckwd.aspx) used to edit the model.
/// Gets the format string (see https://msdn.microsoft.com/en-us/library/txafckwd.aspx) used to edit the model.
/// </summary>
public abstract string EditFormatString { get; }

2
src/Microsoft.AspNetCore.Mvc.Core/ApiExplorer/IApiRequestMetadataProvider.cs
View File

@ -7,7 +7,7 @@ using Microsoft.AspNetCore.Mvc.Formatters;
namespace Microsoft.AspNetCore.Mvc.ApiExplorer
{
/// <summary>
/// Provides a a set of possible content types than can be consumed by the action.
/// Provides a set of possible content types than can be consumed by the action.
/// </summary>
public interface IApiRequestMetadataProvider : IFilterMetadata
{

21
src/Microsoft.AspNetCore.Mvc.Razor/RazorPage.cs
View File

@ -12,7 +12,6 @@ using System.Threading.Tasks;
using Microsoft.AspNetCore.Antiforgery;
using Microsoft.AspNetCore.Html;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc.Internal;
using Microsoft.AspNetCore.Mvc.Razor.Internal;
using Microsoft.AspNetCore.Mvc.Rendering;
using Microsoft.AspNetCore.Mvc.Routing;
@ -764,8 +763,7 @@ namespace Microsoft.AspNetCore.Mvc.Razor
/// In layout pages, renders the content of the section named <paramref name="name"/>.
/// </summary>
/// <param name="name">The name of the section to render.</param>
/// <returns>Returns <see cref="HtmlString.Empty"/> to allow the <see cref="Write(object)"/> call to
/// succeed.</returns>
/// <returns>An empty <see cref="IHtmlContent"/>.</returns>
/// <remarks>The method writes to the <see cref="Output"/> and the value returned is a token
/// value that allows the Write (produced due to @RenderSection(..)) to succeed. However the
/// value does not represent the rendered content.</remarks>
@ -784,8 +782,7 @@ namespace Microsoft.AspNetCore.Mvc.Razor
/// </summary>
/// <param name="name">The section to render.</param>
/// <param name="required">Indicates if this section must be rendered.</param>
/// <returns>Returns <see cref="HtmlString.Empty"/> to allow the <see cref="Write(object)"/> call to
/// succeed.</returns>
/// <returns>An empty <see cref="IHtmlContent"/>.</returns>
/// <remarks>The method writes to the <see cref="Output"/> and the value returned is a token
/// value that allows the Write (produced due to @RenderSection(..)) to succeed. However the
/// value does not represent the rendered content.</remarks>
@ -806,8 +803,9 @@ namespace Microsoft.AspNetCore.Mvc.Razor
/// In layout pages, asynchronously renders the content of the section named <paramref name="name"/>.
/// </summary>
/// <param name="name">The section to render.</param>
/// <returns>A <see cref="Task{HtmlString}"/> that on completion returns <see cref="HtmlString.Empty"/> that
/// allows the <see cref="Write(object)"/> call to succeed.</returns>
/// <returns>
/// A <see cref="Task{HtmlString}"/> that on completion returns an empty <see cref="IHtmlContent"/>.
/// </returns>
/// <remarks>The method writes to the <see cref="Output"/> and the value returned is a token
/// value that allows the Write (produced due to @RenderSection(..)) to succeed. However the
/// value does not represent the rendered content.</remarks>
@ -827,8 +825,9 @@ namespace Microsoft.AspNetCore.Mvc.Razor
/// <param name="name">The section to render.</param>
/// <param name="required">Indicates the <paramref name="name"/> section must be registered
/// (using <c>@section</c>) in the page.</param>
/// <returns>A <see cref="Task{HtmlString}"/> that on completion returns <see cref="HtmlString.Empty"/> that
/// allows the <see cref="Write(object)"/> call to succeed.</returns>
/// <returns>
/// A <see cref="Task{HtmlString}"/> that on completion returns an empty <see cref="IHtmlContent"/>.
/// </returns>
/// <remarks>The method writes to the <see cref="Output"/> and the value returned is a token
/// value that allows the Write (produced due to @RenderSection(..)) to succeed. However the
/// value does not represent the rendered content.</remarks>
@ -912,7 +911,7 @@ namespace Microsoft.AspNetCore.Mvc.Razor
/// on the response stream, writing out any buffered content to the <see cref="HttpResponse.Body"/>.
/// </summary>
/// <returns>A <see cref="Task{HtmlString}"/> that represents the asynchronous flush operation and on
/// completion returns <see cref="HtmlString.Empty"/>.</returns>
/// completion returns an empty <see cref="IHtmlContent"/>.</returns>
/// <remarks>The value returned is a token value that allows FlushAsync to work directly in an HTML
/// section. However the value does not represent the rendered content.
/// This method also writes out headers, so any modifications to headers must be done before
@ -1015,7 +1014,7 @@ namespace Microsoft.AspNetCore.Mvc.Razor
/// <summary>
/// Sets antiforgery cookie and X-Frame-Options header on the response.
/// </summary>
/// <returns><see cref="HtmlString.Empty"/>.</returns>
/// <returns>An empty <see cref="IHtmlContent"/>.</returns>
/// <remarks> Call this method to send antiforgery cookie token and X-Frame-Options header to client
/// before <see cref="FlushAsync"/> flushes the headers. </remarks>
public virtual HtmlString SetAntiforgeryCookieAndHeader()

8
src/Microsoft.AspNetCore.Mvc.Razor/RazorViewEngineOptions.cs
View File

@ -42,8 +42,8 @@ namespace Microsoft.AspNetCore.Mvc.Razor
/// <remarks>
/// <para>
/// The locations of the views returned from controllers that do not belong to an area.
/// Locations are composite format strings (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx),
/// which may contain the following format items:
/// Locations are format strings (see https://msdn.microsoft.com/en-us/library/txafckwd.aspx) which may contain
/// the following format items:
/// </para>
/// <list type="bullet">
/// <item>
@ -68,8 +68,8 @@ namespace Microsoft.AspNetCore.Mvc.Razor
/// <remarks>
/// <para>
/// The locations of the views returned from controllers that belong to an area.
/// Locations are composite format strings (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx),
/// which may contain the following format items:
/// Locations are format strings (see https://msdn.microsoft.com/en-us/library/txafckwd.aspx) which may contain
/// the following format items:
/// </para>
/// <list type="bullet">
/// <item>

5
src/Microsoft.AspNetCore.Mvc.TagHelpers/InputTagHelper.cs
View File

@ -93,9 +93,8 @@ namespace Microsoft.AspNetCore.Mvc.TagHelpers
public ModelExpression For { get; set; }
/// <summary>
/// The composite format <see cref="string"/> (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx) to
/// apply when converting the <see cref="For"/> result to a <see cref="string"/>. Sets the generated "value"
/// attribute to that formatted <see cref="string"/>.
/// The format string (see https://msdn.microsoft.com/en-us/library/txafckwd.aspx) used to format the
/// <see cref="For"/> result. Sets the generated "value" attribute to that formatted string.
/// </summary>
/// <remarks>
/// Not used if the provided (see <see cref="InputTypeName"/>) or calculated "type" attribute value is

707
src/Microsoft.AspNetCore.Mvc.ViewFeatures/Rendering/HtmlHelperInputExtensions.cs
View File

File diff suppressed because it is too large Load Diff

4
src/Microsoft.AspNetCore.Mvc.ViewFeatures/Rendering/HtmlHelperNameExtensions.cs
View File

@ -11,7 +11,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
public static class HtmlHelperNameExtensions
{
/// <summary>
/// Returns the full HTML element name for the current model.
/// Returns the full HTML element name for the current model. Uses
/// <see cref="ViewFeatures.TemplateInfo.HtmlFieldPrefix"/> (if non-empty) to reflect relationship between
/// current <see cref="ViewFeatures.ViewDataDictionary.Model"/> and the top-level view's model.
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <returns>A <see cref="string"/> containing the element name.</returns>

148
src/Microsoft.AspNetCore.Mvc.ViewFeatures/Rendering/HtmlHelperSelectExtensions.cs
View File

@ -14,15 +14,27 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
public static class HtmlHelperSelectExtensions
{
/// <summary>
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>.
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>. Adds
/// &lt;option&gt; elements based on the <see cref="IHtmlHelper.ViewData"/> entry with full name. Adds a
/// "selected" attribute to an &lt;option&gt; if its <see cref="SelectListItem.Value"/> (if non-<c>null</c>) or
/// <see cref="SelectListItem.Text"/> matches the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewFeatures.ViewDataDictionary.Model"/>.
/// See <see cref="IHtmlHelper.Name"/> for more information about a "full name".
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;select&gt; element.</returns>
/// <remarks>
/// <para>
/// Combines <see cref="ViewFeatures.TemplateInfo.HtmlFieldPrefix"/> and <paramref name="expression"/> to set
/// &lt;select&gt; element's "name" attribute. Sanitizes <paramref name="expression"/> to set element's "id"
/// attribute.
/// </para>
/// <para>
/// The <see cref="IHtmlHelper.ViewData"/> entry with full name must be a non-<c>null</c> collection of
/// <see cref="SelectListItem"/> objects.
/// </para>
/// </remarks>
public static IHtmlContent DropDownList(this IHtmlHelper htmlHelper, string expression)
{
@ -35,8 +47,14 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
}
/// <summary>
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>, using the
/// option label.
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>. Adds
/// &lt;option&gt; elements based on <paramref name="optionLabel"/> and the <see cref="IHtmlHelper.ViewData"/>
/// entry with full name. Adds a "selected" attribute to an &lt;option&gt; if its
/// <see cref="SelectListItem.Value"/> (if non-<c>null</c>) or <see cref="SelectListItem.Text"/> matches the
/// first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewFeatures.ViewDataDictionary.Model"/>.
/// See <see cref="IHtmlHelper.Name"/> for more information about a "full name".
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="expression">Expression name, relative to the current model.</param>
@ -45,9 +63,15 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;select&gt; element.</returns>
/// <remarks>
/// <para>
/// Combines <see cref="ViewFeatures.TemplateInfo.HtmlFieldPrefix"/> and <paramref name="expression"/> to set
/// &lt;select&gt; element's "name" attribute. Sanitizes <paramref name="expression"/> to set element's "id"
/// attribute.
/// </para>
/// <para>
/// The <see cref="IHtmlHelper.ViewData"/> entry with full name must be a non-<c>null</c> collection of
/// <see cref="SelectListItem"/> objects.
/// </para>
/// </remarks>
public static IHtmlContent DropDownList(
this IHtmlHelper htmlHelper,
@ -67,14 +91,22 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
}
/// <summary>
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>, using the
/// specified list items.
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>. Adds
/// &lt;option&gt; elements based on <paramref name="selectList"/>. Adds a "selected" attribute to an
/// &lt;option&gt; if its <see cref="SelectListItem.Value"/> (if non-<c>null</c>) or
/// <see cref="SelectListItem.Text"/> matches the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <see cref="IHtmlHelper.ViewData"/> entry with full name (unless used instead of
/// <paramref name="selectList"/>), or
/// the <paramref name="expression"/> evaluated against <see cref="ViewFeatures.ViewDataDictionary.Model"/>.
/// See <see cref="IHtmlHelper.Name"/> for more information about a "full name".
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <param name="selectList">
/// A collection of <see cref="SelectListItem"/> objects used to populate the &lt;select&gt; element with
/// &lt;optgroup&gt; and &lt;option&gt; elements.
/// &lt;optgroup&gt; and &lt;option&gt; elements. If <c>null</c>, uses the <see cref="IHtmlHelper.ViewData"/>
/// entry with full name and that entry must be a collection of <see cref="SelectListItem"/> objects.
/// </param>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;select&gt; element.</returns>
/// <remarks>
@ -96,14 +128,22 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
}
/// <summary>
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>, using the
/// specified list items and HTML attributes.
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>. Adds
/// &lt;option&gt; elements based on <paramref name="selectList"/>. Adds a "selected" attribute to an
/// &lt;option&gt; if its <see cref="SelectListItem.Value"/> (if non-<c>null</c>) or
/// <see cref="SelectListItem.Text"/> matches the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <see cref="IHtmlHelper.ViewData"/> entry with full name (unless used instead of
/// <paramref name="selectList"/>), or
/// the <paramref name="expression"/> evaluated against <see cref="ViewFeatures.ViewDataDictionary.Model"/>.
/// See <see cref="IHtmlHelper.Name"/> for more information about a "full name".
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <param name="selectList">
/// A collection of <see cref="SelectListItem"/> objects used to populate the &lt;select&gt; element with
/// &lt;optgroup&gt; and &lt;option&gt; elements.
/// &lt;optgroup&gt; and &lt;option&gt; elements. If <c>null</c>, uses the <see cref="IHtmlHelper.ViewData"/>
/// entry with full name and that entry must be a collection of <see cref="SelectListItem"/> objects.
/// </param>
/// <param name="htmlAttributes">
/// An <see cref="object"/> that contains the HTML attributes for the &lt;select&gt; element. Alternatively, an
@ -130,14 +170,22 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
}
/// <summary>
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>, using the
/// specified list items and option label.
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>. Adds
/// &lt;option&gt; elements based on <paramref name="optionLabel"/> and <paramref name="selectList"/>. Adds a
/// "selected" attribute to an &lt;option&gt; if its <see cref="SelectListItem.Value"/> (if non-<c>null</c>) or
/// <see cref="SelectListItem.Text"/> matches the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <see cref="IHtmlHelper.ViewData"/> entry with full name (unless used instead of
/// <paramref name="selectList"/>), or
/// the <paramref name="expression"/> evaluated against <see cref="ViewFeatures.ViewDataDictionary.Model"/>.
/// See <see cref="IHtmlHelper.Name"/> for more information about a "full name".
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <param name="selectList">
/// A collection of <see cref="SelectListItem"/> objects used to populate the &lt;select&gt; element with
/// &lt;optgroup&gt; and &lt;option&gt; elements.
/// &lt;optgroup&gt; and &lt;option&gt; elements. If <c>null</c>, uses the <see cref="IHtmlHelper.ViewData"/>
/// entry with full name and that entry must be a collection of <see cref="SelectListItem"/> objects.
/// </param>
/// <param name="optionLabel">
/// The text for a default empty item. Does not include such an item if argument is <c>null</c>.
@ -163,14 +211,20 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
}
/// <summary>
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>, using the
/// specified list items.
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>. Adds
/// &lt;option&gt; elements based on <paramref name="selectList"/>. Adds a "selected" attribute to an
/// &lt;option&gt; if its <see cref="SelectListItem.Value"/> (if non-<c>null</c>) or
/// <see cref="SelectListItem.Text"/> matches the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewFeatures.ViewDataDictionary.Model"/>.
/// See <see cref="IHtmlHelper{TModel}.NameFor"/> for more information about a "full name".
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper{TModel}"/> instance this method extends.</param>
/// <param name="expression">An expression to be evaluated against the current model.</param>
/// <param name="selectList">
/// A collection of <see cref="SelectListItem"/> objects used to populate the &lt;select&gt; element with
/// &lt;optgroup&gt; and &lt;option&gt; elements.
/// &lt;optgroup&gt; and &lt;option&gt; elements. If <c>null</c>, uses the <see cref="IHtmlHelper.ViewData"/>
/// entry with full name and that entry must be a collection of <see cref="SelectListItem"/> objects.
/// </param>
/// <typeparam name="TModel">The type of the model.</typeparam>
/// <typeparam name="TResult">The type of the <paramref name="expression"/> result.</typeparam>
@ -199,14 +253,20 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
}
/// <summary>
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>, using the
/// specified list items and HTML attributes.
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>. Adds
/// &lt;option&gt; elements based on <paramref name="selectList"/>. Adds a "selected" attribute to an
/// &lt;option&gt; if its <see cref="SelectListItem.Value"/> (if non-<c>null</c>) or
/// <see cref="SelectListItem.Text"/> matches the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewFeatures.ViewDataDictionary.Model"/>.
/// See <see cref="IHtmlHelper{TModel}.NameFor"/> for more information about a "full name".
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper{TModel}"/> instance this method extends.</param>
/// <param name="expression">An expression to be evaluated against the current model.</param>
/// <param name="selectList">
/// A collection of <see cref="SelectListItem"/> objects used to populate the &lt;select&gt; element with
/// &lt;optgroup&gt; and &lt;option&gt; elements.
/// &lt;optgroup&gt; and &lt;option&gt; elements. If <c>null</c>, uses the <see cref="IHtmlHelper.ViewData"/>
/// entry with full name and that entry must be a collection of <see cref="SelectListItem"/> objects.
/// </param>
/// <param name="htmlAttributes">
/// An <see cref="object"/> that contains the HTML attributes for the &lt;select&gt; element. Alternatively, an
@ -244,14 +304,20 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
}
/// <summary>
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>, using the
/// specified list items and option label.
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>. Adds
/// &lt;option&gt; elements based on <paramref name="optionLabel"/> and <paramref name="selectList"/>. Adds a
/// "selected" attribute to an &lt;option&gt; if its <see cref="SelectListItem.Value"/> (if non-<c>null</c>) or
/// <see cref="SelectListItem.Text"/> matches the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewFeatures.ViewDataDictionary.Model"/>.
/// See <see cref="IHtmlHelper{TModel}.NameFor"/> for more information about a "full name".
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper{TModel}"/> instance this method extends.</param>
/// <param name="expression">An expression to be evaluated against the current model.</param>
/// <param name="selectList">
/// A collection of <see cref="SelectListItem"/> objects used to populate the &lt;select&gt; element with
/// &lt;optgroup&gt; and &lt;option&gt; elements.
/// &lt;optgroup&gt; and &lt;option&gt; elements. If <c>null</c>, uses the <see cref="IHtmlHelper.ViewData"/>
/// entry with full name and that entry must be a collection of <see cref="SelectListItem"/> objects.
/// </param>
/// <param name="optionLabel">
/// The text for a default empty item. Does not include such an item if argument is <c>null</c>.
@ -284,15 +350,27 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
}
/// <summary>
/// Returns a multi-selection &lt;select&gt; element for the <paramref name="expression"/>.
/// Returns a multi-selection &lt;select&gt; element for the <paramref name="expression"/>. Adds
/// &lt;option&gt; elements based on the <see cref="IHtmlHelper.ViewData"/> entry with full name. Adds a
/// "selected" attribute to an &lt;option&gt; if its <see cref="SelectListItem.Value"/> (if non-<c>null</c>) or
/// <see cref="SelectListItem.Text"/> matches the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewFeatures.ViewDataDictionary.Model"/>.
/// See <see cref="IHtmlHelper.Name"/> for more information about a "full name".
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;select&gt; element.</returns>
/// <remarks>
/// <para>
/// Combines <see cref="ViewFeatures.TemplateInfo.HtmlFieldPrefix"/> and <paramref name="expression"/> to set
/// &lt;select&gt; element's "name" attribute. Sanitizes <paramref name="expression"/> to set element's "id"
/// attribute.
/// </para>
/// <para>
/// The <see cref="IHtmlHelper.ViewData"/> entry with full name must be a non-<c>null</c> collection of
/// <see cref="SelectListItem"/> objects.
/// </para>
/// </remarks>
public static IHtmlContent ListBox(this IHtmlHelper htmlHelper, string expression)
{
@ -305,14 +383,22 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
}
/// <summary>
/// Returns a multi-selection &lt;select&gt; element for the <paramref name="expression"/>, using the
/// specified list items.
/// Returns a multi-selection &lt;select&gt; element for the <paramref name="expression"/>. Adds
/// &lt;option&gt; elements based on <paramref name="selectList"/>. Adds a "selected" attribute to an
/// &lt;option&gt; if its <see cref="SelectListItem.Value"/> (if non-<c>null</c>) or
/// <see cref="SelectListItem.Text"/> matches the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <see cref="IHtmlHelper.ViewData"/> entry with full name (unless used instead of
/// <paramref name="selectList"/>), or
/// the <paramref name="expression"/> evaluated against <see cref="ViewFeatures.ViewDataDictionary.Model"/>.
/// See <see cref="IHtmlHelper.Name"/> for more information about a "full name".
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <param name="selectList">
/// A collection of <see cref="SelectListItem"/> objects used to populate the &lt;select&gt; element with
/// &lt;optgroup&gt; and &lt;option&gt; elements.
/// &lt;optgroup&gt; and &lt;option&gt; elements. If <c>null</c>, uses the <see cref="IHtmlHelper.ViewData"/>
/// entry with full name and that entry must be a collection of <see cref="SelectListItem"/> objects.
/// </param>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;select&gt; element.</returns>
/// <remarks>
@ -334,14 +420,20 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
}
/// <summary>
/// Returns a multi-selection &lt;select&gt; element for the <paramref name="expression"/>, using the
/// specified list items.
/// Returns a multi-selection &lt;select&gt; element for the <paramref name="expression"/>. Adds
/// &lt;option&gt; elements based on <paramref name="selectList"/>. Adds a "selected" attribute to an
/// &lt;option&gt; if its <see cref="SelectListItem.Value"/> (if non-<c>null</c>) or
/// <see cref="SelectListItem.Text"/> matches the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewFeatures.ViewDataDictionary.Model"/>.
/// See <see cref="IHtmlHelper.Name"/> for more information about a "full name".
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper{TModel}"/> instance this method extends.</param>
/// <param name="expression">An expression to be evaluated against the current model.</param>
/// <param name="selectList">
/// A collection of <see cref="SelectListItem"/> objects used to populate the &lt;select&gt; element with
/// &lt;optgroup&gt; and &lt;option&gt; elements.
/// &lt;optgroup&gt; and &lt;option&gt; elements. If <c>null</c>, uses the <see cref="IHtmlHelper.ViewData"/>
/// entry with full name and that entry must be a collection of <see cref="SelectListItem"/> objects.
/// </param>
/// <typeparam name="TModel">The type of the model.</typeparam>
/// <typeparam name="TResult">The type of the <paramref name="expression"/> result.</typeparam>

63
src/Microsoft.AspNetCore.Mvc.ViewFeatures/Rendering/HtmlHelperValidationExtensions.cs
View File

@ -20,7 +20,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <param name="expression">Expression name, relative to the current model.</param>
/// <returns>
/// A new <see cref="IHtmlContent"/> containing a <see cref="ViewContext.ValidationMessageElement"/> element.
/// <c>null</c> if the <paramref name="expression"/> is valid and client-side validation is disabled.
/// An empty <see cref="IHtmlContent"/> if the <paramref name="expression"/> is valid and client-side
/// validation is disabled.
/// </returns>
/// <remarks>
/// Method extracts an error string from the <see cref="ModelBinding.ModelStateDictionary"/> object. Message
@ -51,7 +52,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>
/// A new <see cref="IHtmlContent"/> containing a <see cref="ViewContext.ValidationMessageElement"/> element.
/// <c>null</c> if the <paramref name="expression"/> is valid and client-side validation is disabled.
/// An empty <see cref="IHtmlContent"/> if the <paramref name="expression"/> is valid and client-side
/// validation is disabled.
/// </returns>
public static IHtmlContent ValidationMessage(
this IHtmlHelper htmlHelper,
@ -80,7 +82,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>
/// A new <see cref="IHtmlContent"/> containing a <see cref="ViewContext.ValidationMessageElement"/> element.
/// <c>null</c> if the <paramref name="expression"/> is valid and client-side validation is disabled.
/// An empty <see cref="IHtmlContent"/> if the <paramref name="expression"/> is valid and client-side
/// validation is disabled.
/// </returns>
/// <remarks>
/// Method extracts an error string from the <see cref="ModelBinding.ModelStateDictionary"/> object. Message
@ -115,8 +118,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <see cref="ViewContext.ValidationMessageElement"/>.
/// </param>
/// <returns>
/// A new <see cref="IHtmlContent"/> containing a <paramref name="tag"/> element. <c>null</c> if the
/// <paramref name="expression"/> is valid and client-side validation is disabled.
/// A new <see cref="IHtmlContent"/> containing a <paramref name="tag"/> element. An empty
/// <see cref="IHtmlContent"/> if the <paramref name="expression"/> is valid and client-side validation is
/// disabled.
/// </returns>
public static IHtmlContent ValidationMessage(
this IHtmlHelper htmlHelper,
@ -151,7 +155,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>
/// A new <see cref="IHtmlContent"/> containing a <see cref="ViewContext.ValidationMessageElement"/> element.
/// <c>null</c> if the <paramref name="expression"/> is valid and client-side validation is disabled.
/// An empty <see cref="IHtmlContent"/> if the <paramref name="expression"/> is valid and client-side
/// validation is disabled.
/// </returns>
public static IHtmlContent ValidationMessage(
this IHtmlHelper htmlHelper,
@ -177,7 +182,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <typeparam name="TResult">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>
/// A new <see cref="IHtmlContent"/> containing a <see cref="ViewContext.ValidationMessageElement"/> element.
/// <c>null</c> if the <paramref name="expression"/> is valid and client-side validation is disabled.
/// An empty <see cref="IHtmlContent"/> if the <paramref name="expression"/> is valid and client-side
/// validation is disabled.
/// </returns>
/// <remarks>
/// Method extracts an error string from the <see cref="ModelBinding.ModelStateDictionary"/> object. Message
@ -215,7 +221,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <typeparam name="TResult">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>
/// A new <see cref="IHtmlContent"/> containing a <see cref="ViewContext.ValidationMessageElement"/> element.
/// <c>null</c> if the <paramref name="expression"/> is valid and client-side validation is disabled.
/// An empty <see cref="IHtmlContent"/> if the <paramref name="expression"/> is valid and client-side
/// validation is disabled.
/// </returns>
public static IHtmlContent ValidationMessageFor<TModel, TResult>(
this IHtmlHelper<TModel> htmlHelper,
@ -256,7 +263,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <typeparam name="TResult">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>
/// A new <see cref="IHtmlContent"/> containing a <see cref="ViewContext.ValidationMessageElement"/> element.
/// <c>null</c> if the <paramref name="expression"/> is valid and client-side validation is disabled.
/// An empty <see cref="IHtmlContent"/> if the <paramref name="expression"/> is valid and client-side
/// validation is disabled.
/// </returns>
public static IHtmlContent ValidationMessageFor<TModel, TResult>(
this IHtmlHelper<TModel> htmlHelper,
@ -295,8 +303,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <typeparam name="TModel">The type of the model.</typeparam>
/// <typeparam name="TResult">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>
/// A new <see cref="IHtmlContent"/> containing the <paramref name="tag"/> element. <c>null</c> if the
/// <paramref name="expression"/> is valid and client-side validation is disabled.
/// A new <see cref="IHtmlContent"/> containing the <paramref name="tag"/> element. An empty
/// <see cref="IHtmlContent"/> if the <paramref name="expression"/> is valid and client-side validation is
/// disabled.
/// </returns>
public static IHtmlContent ValidationMessageFor<TModel, TResult>(
this IHtmlHelper<TModel> htmlHelper,
@ -324,7 +333,7 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <returns>
/// New <see cref="IHtmlContent"/> containing a &lt;div&gt; element wrapping the &lt;ul&gt; element.
/// <see cref="HtmlString.Empty"/> if the current model is valid and client-side validation is disabled).
/// An empty <see cref="IHtmlContent"/> if the current model is valid and client-side validation is disabled.
/// </returns>
public static IHtmlContent ValidationSummary(this IHtmlHelper htmlHelper)
{
@ -350,7 +359,7 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>
/// New <see cref="IHtmlContent"/> containing a &lt;div&gt; element wrapping the &lt;ul&gt; element.
/// <see cref="HtmlString.Empty"/> if the current model is valid and client-side validation is disabled).
/// An empty <see cref="IHtmlContent"/> if the current model is valid and client-side validation is disabled.
/// </returns>
public static IHtmlContent ValidationSummary(this IHtmlHelper htmlHelper, bool excludePropertyErrors)
{
@ -375,8 +384,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <returns>
/// New <see cref="IHtmlContent"/> containing a &lt;div&gt; element wrapping the
/// <see cref="ViewContext.ValidationSummaryMessageElement" /> element (which wraps the
/// <paramref name="message"/>) and the &lt;ul&gt; element. <see cref="HtmlString.Empty"/> if the current model
/// is valid and client-side validation is disabled).
/// <paramref name="message"/>) and the &lt;ul&gt; element. An empty <see cref="IHtmlContent"/> if the current
/// model is valid and client-side validation is disabled.
/// </returns>
public static IHtmlContent ValidationSummary(this IHtmlHelper htmlHelper, string message)
{
@ -404,8 +413,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>
/// New <see cref="IHtmlContent"/> containing a &lt;div&gt; element wrapping the <paramref name="tag"/> element
/// and the &lt;ul&gt; element. <see cref="HtmlString.Empty"/> if the current model is valid and client-side
/// validation is disabled).
/// and the &lt;ul&gt; element. An empty <see cref="IHtmlContent"/> if the current model is valid and
/// client-side validation is disabled.
/// </returns>
public static IHtmlContent ValidationSummary(this IHtmlHelper htmlHelper, string message, string tag)
{
@ -433,8 +442,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <returns>
/// New <see cref="IHtmlContent"/> containing a &lt;div&gt; element wrapping the
/// <see cref="ViewContext.ValidationSummaryMessageElement" /> element (which, in turn, wraps the
/// <paramref name="message"/>) and the &lt;ul&gt; element. <see cref="HtmlString.Empty"/> if the current model
/// is valid and client-side validation is disabled).
/// <paramref name="message"/>) and the &lt;ul&gt; element. An empty <see cref="IHtmlContent"/> if the current
/// model is valid and client-side validation is disabled.
/// </returns>
public static IHtmlContent ValidationSummary(
this IHtmlHelper htmlHelper,
@ -467,8 +476,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <returns>
/// New <see cref="IHtmlContent"/> containing a &lt;div&gt; element wrapping the
/// <see cref="ViewContext.ValidationSummaryMessageElement" /> element (which wraps the
/// <paramref name="message"/>) and the &lt;ul&gt; element. <see cref="HtmlString.Empty"/> if the current model
/// is valid and client-side validation is disabled).
/// <paramref name="message"/>) and the &lt;ul&gt; element. An empty <see cref="IHtmlContent"/> if the current
/// model is valid and client-side validation is disabled.
/// </returns>
public static IHtmlContent ValidationSummary(
this IHtmlHelper htmlHelper,
@ -504,8 +513,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>
/// New <see cref="IHtmlContent"/> containing a &lt;div&gt; element wrapping the <paramref name="tag"/> element
/// and the &lt;ul&gt; element. <see cref="HtmlString.Empty"/> if the current model is valid and client-side
/// validation is disabled).
/// and the &lt;ul&gt; element. An empty <see cref="IHtmlContent"/> if the current model is valid and
/// client-side validation is disabled.
/// </returns>
public static IHtmlContent ValidationSummary(
this IHtmlHelper htmlHelper,
@ -540,8 +549,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>
/// New <see cref="IHtmlContent"/> containing a &lt;div&gt; element wrapping the <paramref name="tag"/> element
/// and the &lt;ul&gt; element. <see cref="HtmlString.Empty"/> if the current model is valid and client-side
/// validation is disabled).
/// and the &lt;ul&gt; element. An empty <see cref="IHtmlContent"/> if the current model is valid and
/// client-side validation is disabled.
/// </returns>
public static IHtmlContent ValidationSummary(
this IHtmlHelper htmlHelper,
@ -578,8 +587,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <returns>
/// New <see cref="IHtmlContent"/> containing a &lt;div&gt; element wrapping the
/// <see cref="ViewContext.ValidationSummaryMessageElement" /> element (which wraps the
/// <paramref name="message"/>) and the &lt;ul&gt; element. <see cref="HtmlString.Empty"/> if the current model
/// is valid and client-side validation is disabled).
/// <paramref name="message"/>) and the &lt;ul&gt; element. An empty <see cref="IHtmlContent"/> if the current
/// model is valid and client-side validation is disabled.
/// </returns>
public static IHtmlContent ValidationSummary(
this IHtmlHelper htmlHelper,

30
src/Microsoft.AspNetCore.Mvc.ViewFeatures/Rendering/HtmlHelperValueExtensions.cs
View File

@ -12,7 +12,12 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
public static class HtmlHelperValueExtensions
{
/// <summary>
/// Returns the formatted value for the specified <paramref name="expression"/>.
/// Returns the formatted value for the specified <paramref name="expression"/>. Specifically, returns the
/// first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <see cref="IHtmlHelper.ViewData"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewFeatures.ViewDataDictionary.Model"/>.
/// See <see cref="IHtmlHelper.Name"/> for more information about a "full name".
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="expression">Expression name, relative to the current model.</param>
@ -31,7 +36,11 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
}
/// <summary>
/// Returns the formatted value for the specified <paramref name="expression"/>.
/// Returns the formatted value for the specified <paramref name="expression"/>. Specifically, returns the
/// first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewFeatures.ViewDataDictionary.Model"/>.
/// See <see cref="IHtmlHelper{TModel}.NameFor"/> for more information about a "full name".
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper{TModel}"/> instance this method extends.</param>
/// <param name="expression">An expression to be evaluated against the current model.</param>
@ -59,7 +68,12 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
}
/// <summary>
/// Returns the formatted value for the current model.
/// Returns the formatted value for the current model. Specifically, returns the
/// first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <see cref="IHtmlHelper.ViewData"/> entry with full name, or
/// the <see cref="ViewFeatures.ViewDataDictionary.Model"/>.
/// See <see cref="IHtmlHelper.Name"/> for more information about a "full name".
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <returns>A <see cref="string"/> containing the formatted value.</returns>
@ -77,11 +91,17 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
}
/// <summary>
/// Returns the formatted value for the current model.
/// Returns the formatted value for the current model. Specifically, returns the
/// first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <see cref="IHtmlHelper.ViewData"/> entry with full name, or
/// the <see cref="ViewFeatures.ViewDataDictionary.Model"/>.
/// See <see cref="IHtmlHelper.Name"/> for more information about a "full name".
/// </summary>
/// <param name="htmlHelper">The <see cref="IHtmlHelper"/> instance this method extends.</param>
/// <param name="format">
/// The composite format <see cref="string"/> (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// The format string (see https://msdn.microsoft.com/en-us/library/txafckwd.aspx) used to format the return
/// value unless that came from model binding.
/// </param>
/// <returns>A <see cref="string"/> containing the formatted value.</returns>
/// <remarks>

260
src/Microsoft.AspNetCore.Mvc.ViewFeatures/Rendering/IHtmlHelper.cs
View File

@ -169,7 +169,16 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <summary>
/// Returns an &lt;input&gt; element of type "checkbox" with value "true" and an &lt;input&gt; element of type
/// "hidden" with value "false".
/// "hidden" with value "false" for the specified <paramref name="expression"/>. Adds a "checked" attribute to
/// the "checkbox" element based on the first non-<c>null</c> value found in:
/// the <paramref name="htmlAttributes"/> dictionary entry with key "checked",
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <see cref="ViewData"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewDataDictionary.Model"/>.
/// If <paramref name="isChecked"/> is non-<c>null</c>, instead uses the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="isChecked"/> parameter.
/// See <see cref="Name"/> for more information about a "full name".
/// </summary>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <param name="isChecked">If <c>true</c>, checkbox is initially checked.</param>
@ -179,35 +188,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;input&gt; elements.</returns>
/// <remarks>
/// <para>
/// Combines <see cref="TemplateInfo.HtmlFieldPrefix"/> and <paramref name="expression"/> to set checkbox
/// element's "name" attribute. Sanitizes <paramref name="expression"/> to set checkbox element's "id"
/// attribute.
/// </para>
/// <para>Determines checkbox element's "checked" attribute based on the following precedence:</para>
/// <list type="number">
/// <item>
/// <see cref="ModelStateDictionary"/> entry for <paramref name="expression"/> (converted to a fully-qualified
/// name) if entry exists and can be converted to a <see cref="bool"/>.
/// </item>
/// <item><paramref name="isChecked"/> if non-<c>null</c>.</item>
/// <item>
/// <see cref="ViewData"/> entry for <paramref name="expression"/> (converted to a fully-qualified name)
/// if entry exists and can be converted to a <see cref="bool"/>.
/// </item>
/// <item>
/// Linq expression based on <paramref name="expression"/> (converted to a fully-qualified name) run against
/// current model if result is non-<c>null</c> and can be converted to a <see cref="bool"/>. For example
/// <c>string.Empty</c> identifies the current model and <c>"prop"</c> identifies the current model's "prop"
/// property.
/// </item>
/// <item>Existing "checked" entry in <paramref name="htmlAttributes"/> if any.</item>
/// <item>Otherwise, does not include a "checked" attribute.</item>
/// </list>
/// <para>
/// In all but the <paramref name="htmlAttributes"/> and default cases, includes a "checked" attribute with
/// value "checked" if the <see cref="bool"/> values is <c>true</c>; does not include the attribute otherwise.
/// </para>
/// </remarks>
IHtmlContent CheckBox(string expression, bool? isChecked, object htmlAttributes);
@ -240,6 +223,10 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// Example <paramref name="expression"/>s include <c>string.Empty</c> which identifies the current model and
/// <c>"prop"</c> which identifies the current model's "prop" property.
/// </para>
/// <para>
/// Custom templates are found under a <c>DisplayTemplates</c> folder. The folder name is case-sensitive on
/// case-sensitive file systems.
/// </para>
/// </remarks>
IHtmlContent Display(
string expression,
@ -265,13 +252,20 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
string DisplayText(string expression);
/// <summary>
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>,
/// using the specified list items, option label, and HTML attributes.
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>. Adds
/// &lt;option&gt; elements based on <paramref name="optionLabel"/> and <paramref name="selectList"/>. Adds a
/// "selected" attribute to an &lt;option&gt; if its <see cref="SelectListItem.Value"/> (if non-<c>null</c>) or
/// <see cref="SelectListItem.Text"/> matches the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <see cref="ViewData"/> entry with full name (unless used instead of <paramref name="selectList"/>), or
/// the <paramref name="expression"/> evaluated against <see cref="ViewDataDictionary.Model"/>.
/// See <see cref="Name"/> for more information about a "full name".
/// </summary>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <param name="selectList">
/// A collection of <see cref="SelectListItem"/> objects used to populate the &lt;select&gt; element with
/// &lt;optgroup&gt; and &lt;option&gt; elements.
/// &lt;optgroup&gt; and &lt;option&gt; elements. If <c>null</c>, uses the <see cref="ViewData"/> entry with
/// full name and that entry must be a collection of <see cref="SelectListItem"/> objects.
/// </param>
/// <param name="optionLabel">
/// The text for a default empty item. Does not include such an item if argument is <c>null</c>.
@ -321,6 +315,10 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// Example <paramref name="expression"/>s include <c>string.Empty</c> which identifies the current model and
/// <c>"prop"</c> which identifies the current model's "prop" property.
/// </para>
/// <para>
/// Custom templates are found under a <c>EditorTemplates</c> folder. The folder name is case-sensitive on
/// case-sensitive file systems.
/// </para>
/// </remarks>
IHtmlContent Editor(string expression, string templateName, string htmlFieldName, object additionalViewData);
@ -351,7 +349,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </summary>
/// <param name="value">The value.</param>
/// <param name="format">
/// The composite format <see cref="string"/> (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// The format string (see https://msdn.microsoft.com/en-us/library/txafckwd.aspx) used to format the return
/// value.
/// </param>
/// <returns>A <see cref="string"/> containing the formatted value.</returns>
/// <remarks>
@ -364,7 +363,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// Returns an HTML element Id for the specified expression <paramref name="fullName"/>.
/// </summary>
/// <param name="fullName">
/// Fully-qualified expression name, ignoring the current model. Must not be <c>null</c>.
/// Fully-qualified expression name, ignoring the current model. Must not be <c>null</c>. See
/// <see cref="Name"/> for more information about a "full name".
/// </param>
/// <returns>A <see cref="string"/> containing the element Id.</returns>
string GenerateIdFromName(string fullName);
@ -398,7 +398,14 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
IEnumerable<SelectListItem> GetEnumSelectList(Type enumType);
/// <summary>
/// Returns an &lt;input&gt; element of type "hidden" for the specified <paramref name="expression"/>.
/// Returns an &lt;input&gt; element of type "hidden" for the specified <paramref name="expression"/>. Adds a
/// "value" attribute to the element containing the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <paramref name="value"/> parameter,
/// the <see cref="ViewData"/> entry with full name,
/// the <paramref name="expression"/> evaluated against <see cref="ViewDataDictionary.Model"/>, or
/// the <paramref name="htmlAttributes"/> dictionary entry with key "value".
/// See <see cref="Name"/> for more information about a "full name".
/// </summary>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <param name="value">If non-<c>null</c>, value to include in the element.</param>
@ -408,31 +415,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;input&gt; element.</returns>
/// <remarks>
/// <para>
/// Combines <see cref="TemplateInfo.HtmlFieldPrefix"/> and <paramref name="expression"/> to set
/// &lt;input&gt; element's "name" attribute. Sanitizes <paramref name="expression"/> to set element's "id"
/// attribute.
/// </para>
/// <para>Determines &lt;input&gt; element's "value" attribute based on the following precedence:</para>
/// <list type="number">
/// <item>
/// <see cref="ModelStateDictionary"/> entry for <paramref name="expression"/> (converted to a fully-qualified
/// name) if entry exists and can be converted to a <see cref="string"/>.
/// </item>
/// <item><paramref name="value"/> if non-<c>null</c>.</item>
/// <item>
/// <see cref="ViewData"/> entry for <paramref name="expression"/> (converted to a fully-qualified name)
/// if entry exists and can be converted to a <see cref="string"/>.
/// </item>
/// <item>
/// Linq expression based on <paramref name="expression"/> (converted to a fully-qualified name) run against
/// current model if result is non-<c>null</c> and can be converted to a <see cref="string"/>. For example
/// <c>string.Empty</c> identifies the current model and <c>"prop"</c> identifies the current model's "prop"
/// property.
/// </item>
/// <item>Existing "value" entry in <paramref name="htmlAttributes"/> if any.</item>
/// <item>Otherwise, <c>string.Empty</c>.</item>
/// </list>
/// </remarks>
IHtmlContent Hidden(string expression, object value, object htmlAttributes);
@ -456,13 +441,20 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
IHtmlContent Label(string expression, string labelText, object htmlAttributes);
/// <summary>
/// Returns a multi-selection &lt;select&gt; element for the <paramref name="expression"/>, using the
/// specified list items and HTML attributes.
/// Returns a multi-selection &lt;select&gt; element for the <paramref name="expression"/>. Adds
/// &lt;option&gt; elements based on <paramref name="selectList"/>. Adds a "selected" attribute to an
/// &lt;option&gt; if its <see cref="SelectListItem.Value"/> (if non-<c>null</c>) or
/// <see cref="SelectListItem.Text"/> matches an entry in the first non-<c>null</c> collection found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <see cref="ViewData"/> entry with full name (unless used instead of <paramref name="selectList"/>), or
/// the <paramref name="expression"/> evaluated against <see cref="ViewDataDictionary.Model"/>.
/// See <see cref="Name"/> for more information about a "full name".
/// </summary>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <param name="selectList">
/// A collection of <see cref="SelectListItem"/> objects used to populate the &lt;select&gt; element with
/// &lt;optgroup&gt; and &lt;option&gt; elements.
/// &lt;optgroup&gt; and &lt;option&gt; elements. If <c>null</c>, finds the <see cref="SelectListItem"/>
/// collection with name <paramref name="expression"/> in <see cref="ViewData"/>.
/// </param>
/// <param name="htmlAttributes">
/// An <see cref="object"/> that contains the HTML attributes for the &lt;select&gt; element. Alternatively, an
@ -477,7 +469,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
IHtmlContent ListBox(string expression, IEnumerable<SelectListItem> selectList, object htmlAttributes);
/// <summary>
/// Returns the full HTML element name for the specified <paramref name="expression"/>.
/// Returns the full HTML element name for the specified <paramref name="expression"/>. Uses
/// <see cref="TemplateInfo.HtmlFieldPrefix"/> (if non-empty) to reflect relationship between current
/// <see cref="ViewDataDictionary.Model"/> and the top-level view's model.
/// </summary>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <returns>A <see cref="string"/> containing the element name.</returns>
@ -498,7 +492,10 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
Task<IHtmlContent> PartialAsync(string partialViewName, object model, ViewDataDictionary viewData);
/// <summary>
/// Returns an &lt;input&gt; element of type "password" for the specified <paramref name="expression"/>.
/// Returns an &lt;input&gt; element of type "password" for the specified <paramref name="expression"/>. Adds a
/// "value" attribute containing the first non-<c>null</c> value in:
/// the <paramref name="value"/> parameter, or
/// the <paramref name="htmlAttributes"/> dictionary entry with key "value".
/// </summary>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <param name="value">If non-<c>null</c>, value to include in the element.</param>
@ -508,22 +505,27 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;input&gt; element.</returns>
/// <remarks>
/// <para>
/// Combines <see cref="TemplateInfo.HtmlFieldPrefix"/> and <paramref name="expression"/> to set
/// &lt;input&gt; element's "name" attribute. Sanitizes <paramref name="expression"/> to set element's "id"
/// attribute.
/// </para>
/// <para>Determines &lt;input&gt; element's "value" attribute based on the following precedence:</para>
/// <list type="number">
/// <item><paramref name="value"/> if non-<c>null</c>.</item>
/// <item>Existing "value" entry in <paramref name="htmlAttributes"/> if any.</item>
/// <item>Otherwise, <c>string.Empty</c>.</item>
/// </list>
/// </remarks>
IHtmlContent Password(string expression, object value, object htmlAttributes);
/// <summary>
/// Returns an &lt;input&gt; element of type "radio" for the specified <paramref name="expression"/>.
/// Adds a "value" attribute to the element containing the first non-<c>null</c> value found in:
/// the <paramref name="value"/> parameter, or
/// the <paramref name="htmlAttributes"/> dictionary entry with key "value".
/// Adds a "checked" attribute to the element if <paramref name="value"/> matches the first non-<c>null</c>
/// value found in:
/// the <paramref name="htmlAttributes"/> dictionary entry with key "checked",
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <see cref="ViewData"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewDataDictionary.Model"/>.
/// If <paramref name="isChecked"/> is non-<c>null</c>, instead uses the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="isChecked"/> parameter.
/// See <see cref="Name"/> for more information about a "full name".
/// </summary>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <param name="value">
@ -542,43 +544,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;input&gt; element.</returns>
/// <remarks>
/// <para>
/// Combines <see cref="TemplateInfo.HtmlFieldPrefix"/> and <paramref name="expression"/> to set
/// &lt;input&gt; element's "name" attribute. Sanitizes <paramref name="expression"/> to set element's "id"
/// attribute.
/// </para>
/// <para>Determines element's "value" attribute based on the following precedence:</para>
/// <list type="number">
/// <item><paramref name="value"/> if non-<c>null</c>.</item>
/// <item>Existing "value" entry in <paramref name="htmlAttributes"/> if any.</item>
/// <item>Otherwise, <c>string.Empty</c>.</item>
/// </list>
/// <para>Determines &lt;input&gt; element's "checked" attribute based on the following precedence:</para>
/// <list type="number">
/// <item>
/// <see cref="ModelStateDictionary"/> entry for <paramref name="expression"/> (converted to a fully-qualified
/// name) if entry exists and can be converted to a <see cref="string"/>.
/// </item>
/// <item><paramref name="isChecked"/> if non-<c>null</c>.</item>
/// <item>Existing "checked" entry in <paramref name="htmlAttributes"/> if any.</item>
/// <item>
/// <see cref="ViewData"/> entry for <paramref name="expression"/> (converted to a fully-qualified name)
/// if entry exists and can be converted to a <see cref="string"/>.
/// </item>
/// <item>
/// Linq expression based on <paramref name="expression"/> (converted to a fully-qualified name) run against
/// current model if result is non-<c>null</c> and can be converted to a <see cref="string"/>. For example
/// <c>string.Empty</c> identifies the current model and <c>"prop"</c> identifies the current model's "prop"
/// property.
/// </item>
/// <item>Otherwise, does not include a "checked" attribute.</item>
/// </list>
/// <para>
/// In all but the <paramref name="htmlAttributes"/> and default cases, includes a "checked" attribute with
/// value "checked" if the <see cref="string"/> values is equal to a converted <see cref="string"/> for
/// <paramref name="value"/> or <paramref name="isChecked"/> is <c>true</c> (for that case); does not include
/// the attribute otherwise.
/// </para>
/// </remarks>
IHtmlContent RadioButton(string expression, object value, bool? isChecked, object htmlAttributes);
@ -641,7 +609,13 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
object htmlAttributes);
/// <summary>
/// Returns a &lt;textarea&gt; element for the specified <paramref name="expression"/>.
/// Returns a &lt;textarea&gt; element for the specified <paramref name="expression"/>. Adds content to the
/// element body based on the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <paramref name="value"/> parameter,
/// the <see cref="ViewData"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewDataDictionary.Model"/>.
/// See <see cref="Name"/> for more information about a "full name".
/// </summary>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <param name="value">If non-<c>null</c>, value to include in the element.</param>
@ -653,40 +627,27 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;textarea&gt; element.</returns>
/// <remarks>
/// <para>
/// Combines <see cref="TemplateInfo.HtmlFieldPrefix"/> and <paramref name="expression"/> to set
/// &lt;textarea&gt; element's "name" attribute. Sanitizes <paramref name="expression"/> to set element's "id"
/// attribute.
/// </para>
/// <para>Determines &lt;textarea&gt; element's content based on the following precedence:</para>
/// <list type="number">
/// <item>
/// <see cref="ModelStateDictionary"/> entry for <paramref name="expression"/> (converted to a fully-qualified
/// name) if entry exists and can be converted to a <see cref="string"/>.
/// </item>
/// <item><paramref name="value"/> if non-<c>null</c>.</item>
/// <item>
/// <see cref="ViewData"/> entry for <paramref name="expression"/> (converted to a fully-qualified name)
/// if entry exists and can be converted to a <see cref="string"/>.
/// </item>
/// <item>
/// Linq expression based on <paramref name="expression"/> (converted to a fully-qualified name) run against
/// current model if result is non-<c>null</c> and can be converted to a <see cref="string"/>. For example
/// <c>string.Empty</c> identifies the current model and <c>"prop"</c> identifies the current model's "prop"
/// property.
/// </item>
/// <item>Otherwise, <c>string.Empty</c>.</item>
/// </list>
/// </remarks>
IHtmlContent TextArea(string expression, string value, int rows, int columns, object htmlAttributes);
/// <summary>
/// Returns an &lt;input&gt; element of type "text" for the specified <paramref name="current"/>.
/// Returns an &lt;input&gt; element of type "text" for the specified <paramref name="current"/>. Adds a
/// "value" attribute to the element containing the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <paramref name="value"/> parameter,
/// the <see cref="ViewData"/> entry with full name,
/// the <paramref name="current"/> evaluated against <see cref="ViewDataDictionary.Model"/>, or
/// the <paramref name="htmlAttributes"/> dictionary entry with key "value".
/// See <see cref="Name"/> for more information about a "full name".
/// </summary>
/// <param name="current">Expression name, relative to the current model.</param>
/// <param name="value">If non-<c>null</c>, value to include in the element.</param>
/// <param name="format">
/// The composite format <see cref="string"/> (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// The format string (see https://msdn.microsoft.com/en-us/library/txafckwd.aspx) used to format the "value"
/// attribute unless that came from model binding.
/// </param>
/// <param name="htmlAttributes">
/// An <see cref="object"/> that contains the HTML attributes for the element. Alternatively, an
@ -694,37 +655,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;input&gt; element.</returns>
/// <remarks>
/// <para>
/// Combines <see cref="TemplateInfo.HtmlFieldPrefix"/> and <paramref name="current"/> to set
/// &lt;input&gt; element's "name" attribute. Sanitizes <paramref name="current"/> to set element's "id"
/// attribute.
/// </para>
/// <para>Determines &lt;input&gt; element's "value" attribute based on the following precedence:</para>
/// <list type="number">
/// <item>
/// <see cref="ModelStateDictionary"/> entry for <paramref name="current"/> (converted to a fully-qualified
/// name) if entry exists and can be converted to a <see cref="string"/>.
/// </item>
/// <item>
/// <paramref name="value"/> if non-<c>null</c>. Formats <paramref name="value"/> using
/// <paramref name="format"/> or converts <paramref name="value"/> to a <see cref="string"/> directly if
/// <paramref name="format"/> is <c>null</c> or empty.
/// </item>
/// <item>
/// <see cref="ViewData"/> entry for <paramref name="current"/> (converted to a fully-qualified name) if entry
/// exists and can be converted to a <see cref="string"/>. Formats entry using <paramref name="format"/> or
/// converts entry to a <see cref="string"/> directly if <paramref name="format"/> is <c>null</c> or empty.
/// </item>
/// <item>
/// Linq expression based on <paramref name="current"/> (converted to a fully-qualified name) run against
/// current model if result is non-<c>null</c> and can be converted to a <see cref="string"/>. For example
/// <c>string.Empty</c> identifies the current model and <c>"prop"</c> identifies the current model's "prop"
/// property. Formats result using <paramref name="format"/> or converts result to a <see cref="string"/>
/// directly if <paramref name="format"/> is <c>null</c> or empty.
/// </item>
/// <item>Existing "value" entry in <paramref name="htmlAttributes"/> if any.</item>
/// <item>Otherwise, <c>string.Empty</c>.</item>
/// </list>
/// </remarks>
IHtmlContent TextBox(string current, object value, string format, object htmlAttributes);
@ -747,8 +680,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <see cref="ViewContext.ValidationMessageElement"/>.
/// </param>
/// <returns>
/// A new <see cref="IHtmlContent"/> containing a <paramref name="tag"/> element. <c>null</c> if the
/// <paramref name="expression"/> is valid and client-side validation is disabled.
/// A new <see cref="IHtmlContent"/> containing a <paramref name="tag"/> element. An empty
/// <see cref="IHtmlContent"/> if the <paramref name="expression"/> is valid and client-side validation is
/// disabled.
/// </returns>
IHtmlContent ValidationMessage(string expression, string message, object htmlAttributes, string tag);
@ -770,8 +704,8 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>
/// New <see cref="IHtmlContent"/> containing a &lt;div&gt; element wrapping the <paramref name="tag"/> element
/// and the &lt;ul&gt; element. <see cref="HtmlString.Empty"/> if the current model is valid and client-side
/// validation is disabled).
/// and the &lt;ul&gt; element. An empty <see cref="IHtmlContent"/> if the current model is valid and
/// client-side validation is disabled.
/// </returns>
IHtmlContent ValidationSummary(
bool excludePropertyErrors,
@ -780,11 +714,17 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
string tag);
/// <summary>
/// Returns the formatted value for the specified <paramref name="expression"/>.
/// Returns the formatted value for the specified <paramref name="expression"/>. Specifically, returns the
/// first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <see cref="ViewData"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewDataDictionary.Model"/>.
/// See <see cref="Name"/> for more information about a "full name".
/// </summary>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <param name="format">
/// The composite format <see cref="string"/> (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// The format string (see https://msdn.microsoft.com/en-us/library/txafckwd.aspx) used to format the return
/// value unless that came from model binding.
/// </param>
/// <returns>A <see cref="string"/> containing the formatted value.</returns>
/// <remarks>

195
src/Microsoft.AspNetCore.Mvc.ViewFeatures/Rendering/IHtmlHelperOfT.cs
View File

@ -22,7 +22,15 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <summary>
/// Returns an &lt;input&gt; element of type "checkbox" with value "true" and an &lt;input&gt; element of type
/// "hidden" with value "false".
/// "hidden" with value "false" for the specified <paramref name="expression"/>. Adds a "checked" attribute to
/// the "checkbox" element based on the first non-<c>null</c> value found in:
/// the <paramref name="htmlAttributes"/> dictionary entry with key "checked", or
/// the <see cref="ActionContext.ModelState"/> entry with full name.
/// If <paramref name="expression"/> evaluates to a non-<c>null</c> value, instead uses the first
/// non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewDataDictionary.Model"/>.
/// See <see cref="NameFor"/> for more information about a "full name".
/// </summary>
/// <param name="expression">An expression to be evaluated against the current model.</param>
/// <param name="htmlAttributes">
@ -31,28 +39,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// </param>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;input&gt; elements.</returns>
/// <remarks>
/// <para>
/// Combines <see cref="TemplateInfo.HtmlFieldPrefix"/> and the string representation of the
/// <paramref name="expression"/> to set checkbox element's "name" attribute. Sanitizes the string
/// representation of the <paramref name="expression"/> to set checkbox element's "id" attribute.
/// </para>
/// <para>Determines checkbox element's "checked" attribute based on the following precedence:</para>
/// <list type="number">
/// <item>
/// <see cref="ModelBinding.ModelStateDictionary"/> entry for the string representation of the
/// <paramref name="expression"/> if entry exists and can be converted to a <see cref="bool"/>.
/// </item>
/// <item>
/// <paramref name="expression"/> result if it is non-<c>null</c> and can be parsed as a
/// <see cref="bool"/>.
/// </item>
/// <item>Existing "checked" entry in <paramref name="htmlAttributes"/> if any.</item>
/// <item>Otherwise, does not include a "checked" attribute.</item>
/// </list>
/// <para>
/// In all but the <paramref name="htmlAttributes"/> case, includes a "checked" attribute with value "checked"
/// if the <see cref="bool"/> values is <c>true</c>; does not include the attribute otherwise.
/// </para>
/// </remarks>
IHtmlContent CheckBoxFor(Expression<Func<TModel, bool>> expression, object htmlAttributes);
@ -75,8 +64,14 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <typeparam name="TResult">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>A new <see cref="IHtmlContent"/> containing the created HTML.</returns>
/// <remarks>
/// <para>
/// For example the default <see cref="object"/> display template includes markup for each property in the
/// <paramref name="expression"/> result.
/// </para>
/// <para>
/// Custom templates are found under a <c>DisplayTemplates</c> folder. The folder name is case-sensitive on
/// case-sensitive file systems.
/// </para>
/// </remarks>
IHtmlContent DisplayFor<TResult>(
Expression<Func<TModel, TResult>> expression,
@ -116,13 +111,19 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
string DisplayTextFor<TResult>(Expression<Func<TModel, TResult>> expression);
/// <summary>
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>, using the
/// specified list items, option label, and HTML attributes.
/// Returns a single-selection HTML &lt;select&gt; element for the <paramref name="expression"/>. Adds
/// &lt;option&gt; elements based on <paramref name="optionLabel"/> and <paramref name="selectList"/>. Adds a
/// "selected" attribute to an &lt;option&gt; if its <see cref="SelectListItem.Value"/> (if non-<c>null</c>) or
/// <see cref="SelectListItem.Text"/> matches the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewDataDictionary.Model"/>.
/// See <see cref="NameFor"/> for more information about a "full name".
/// </summary>
/// <param name="expression">An expression to be evaluated against the current model.</param>
/// <param name="selectList">
/// A collection of <see cref="SelectListItem"/> objects used to populate the &lt;select&gt; element with
/// &lt;optgroup&gt; and &lt;option&gt; elements.
/// &lt;optgroup&gt; and &lt;option&gt; elements. If <c>null</c>, uses the <see cref="ViewData"/> entry with
/// full name and that entry must be a collection of <see cref="SelectListItem"/> objects.
/// </param>
/// <param name="optionLabel">
/// The text for a default empty item. Does not include such an item if argument is <c>null</c>.
@ -163,8 +164,14 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <typeparam name="TResult">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;input&gt; element(s).</returns>
/// <remarks>
/// <para>
/// For example the default <see cref="object"/> editor template includes &lt;label&gt; and &lt;input&gt;
/// elements for each property in the <paramref name="expression"/> result.
/// </para>
/// <para>
/// Custom templates are found under a <c>EditorTemplates</c> folder. The folder name is case-sensitive on
/// case-sensitive file systems.
/// </para>
/// </remarks>
IHtmlContent EditorFor<TResult>(
Expression<Func<TModel, TResult>> expression,
@ -179,7 +186,12 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
new string Encode(string value);
/// <summary>
/// Returns an &lt;input&gt; element of type "hidden" for the specified <paramref name="expression"/>.
/// Returns an &lt;input&gt; element of type "hidden" for the specified <paramref name="expression"/>. Adds a
/// "value" attribute to the element containing the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <paramref name="expression"/> evaluated against <see cref="ViewDataDictionary.Model"/>, or
/// the <paramref name="htmlAttributes"/> dictionary entry with key "value".
/// See <see cref="NameFor"/> for more information about a "full name".
/// </summary>
/// <param name="expression">An expression to be evaluated against the current model.</param>
/// <param name="htmlAttributes">
@ -189,24 +201,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <typeparam name="TResult">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;input&gt; element.</returns>
/// <remarks>
/// <para>
/// Combines <see cref="TemplateInfo.HtmlFieldPrefix"/> and the string representation of the
/// <paramref name="expression"/> to set &lt;input&gt; element's "name" attribute. Sanitizes the string
/// representation of the <paramref name="expression"/> to set element's "id" attribute.
/// </para>
/// <para>Determines &lt;input&gt; element's "value" attribute based on the following precedence:</para>
/// <list type="number">
/// <item>
/// <see cref="ModelBinding.ModelStateDictionary"/> entry for the string representation of the
/// <paramref name="expression"/> if entry exists and can be converted to a <see cref="string"/>.
/// </item>
/// <item>
/// <paramref name="expression"/> result if it is non-<c>null</c> and can be parsed as a
/// <see cref="string"/>.
/// </item>
/// <item>Existing "value" entry in <paramref name="htmlAttributes"/> if any.</item>
/// <item>Otherwise, <c>string.Empty</c>.</item>
/// </list>
/// </remarks>
IHtmlContent HiddenFor<TResult>(
Expression<Func<TModel, TResult>> expression,
@ -237,13 +234,19 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
object htmlAttributes);
/// <summary>
/// Returns a multi-selection &lt;select&gt; element for the <paramref name="expression"/>, using the
/// specified list items and HTML attributes.
/// Returns a multi-selection &lt;select&gt; element for the <paramref name="expression"/>. Adds
/// &lt;option&gt; elements based on <paramref name="selectList"/>. Adds a "selected" attribute to an
/// &lt;option&gt; if its <see cref="SelectListItem.Value"/> (if non-<c>null</c>) or
/// <see cref="SelectListItem.Text"/> matches an entry in the first non-<c>null</c> collection found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewDataDictionary.Model"/>.
/// See <see cref="NameFor"/> for more information about a "full name".
/// </summary>
/// <param name="expression">An expression to be evaluated against the current model.</param>
/// <param name="selectList">
/// A collection of <see cref="SelectListItem"/> objects used to populate the &lt;select&gt; element with
/// &lt;optgroup&gt; and &lt;option&gt; elements.
/// &lt;optgroup&gt; and &lt;option&gt; elements. If <c>null</c>, finds the <see cref="SelectListItem"/>
/// collection with name <paramref name="expression"/> in <see cref="ViewData"/>.
/// </param>
/// <param name="htmlAttributes">
/// An <see cref="object"/> that contains the HTML attributes for the &lt;select&gt; element. Alternatively, an
@ -262,7 +265,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
object htmlAttributes);
/// <summary>
/// Returns the full HTML element name for the specified <paramref name="expression"/>.
/// Returns the full HTML element name for the specified <paramref name="expression"/>. Uses
/// <see cref="TemplateInfo.HtmlFieldPrefix"/> (if non-empty) to reflect relationship between current
/// <see cref="ViewDataDictionary.Model"/> and the top-level view's model.
/// </summary>
/// <param name="expression">An expression to be evaluated against the current model.</param>
/// <typeparam name="TResult">The type of the <paramref name="expression"/> result.</typeparam>
@ -270,7 +275,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
string NameFor<TResult>(Expression<Func<TModel, TResult>> expression);
/// <summary>
/// Returns an &lt;input&gt; element of type "password" for the specified <paramref name="expression"/>.
/// Returns an &lt;input&gt; element of type "password" for the specified <paramref name="expression"/>. Adds a
/// "value" attribute containing the <paramref name="htmlAttributes"/> dictionary entry with key "value" (if
/// any).
/// </summary>
/// <param name="expression">An expression to be evaluated against the current model.</param>
/// <param name="htmlAttributes">
@ -280,20 +287,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <typeparam name="TResult">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;input&gt; element.</returns>
/// <remarks>
/// <para>
/// Combines <see cref="TemplateInfo.HtmlFieldPrefix"/> and the string representation of the
/// <paramref name="expression"/> to set &lt;input&gt; element's "name" attribute. Sanitizes the string
/// representation of the <paramref name="expression"/> to set element's "id" attribute.
/// </para>
/// <para>Determines &lt;input&gt; element's "value" attribute based on the following precedence:</para>
/// <list type="number">
/// <item>
/// <paramref name="expression"/> result if it is non-<c>null</c> and can be parsed as a
/// <see cref="string"/>.
/// </item>
/// <item>Existing "value" entry in <paramref name="htmlAttributes"/> if any.</item>
/// <item>Otherwise, <c>string.Empty</c>.</item>
/// </list>
/// </remarks>
IHtmlContent PasswordFor<TResult>(
Expression<Func<TModel, TResult>> expression,
@ -301,6 +297,19 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <summary>
/// Returns an &lt;input&gt; element of type "radio" for the specified <paramref name="expression"/>.
/// Adds a "value" attribute to the element containing the first non-<c>null</c> value found in:
/// the <paramref name="value"/> parameter, or
/// the <paramref name="htmlAttributes"/> dictionary entry with key "value".
/// Adds a "checked" attribute to the element if <paramref name="value"/> matches the first non-<c>null</c>
/// value found in:
/// the <paramref name="htmlAttributes"/> dictionary entry with key "checked", or
/// the <see cref="ActionContext.ModelState"/> entry with full name.
/// If <paramref name="expression"/> evaluates to a non-<c>null</c> value, instead uses the first
/// non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewDataDictionary.Model"/>.
/// See <see cref="NameFor"/> for more information about a "full name".
/// Adds a "value" attribute to the element containing the <paramref name="value"/> parameter.
/// </summary>
/// <param name="expression">An expression to be evaluated against the current model.</param>
/// <param name="value">Value to include in the element. Must not be <c>null</c>.</param>
@ -311,29 +320,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <typeparam name="TResult">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;input&gt; element.</returns>
/// <remarks>
/// <para>
/// Combines <see cref="TemplateInfo.HtmlFieldPrefix"/> and the string representation of the
/// <paramref name="expression"/> to set &lt;select&gt; element's "name" attribute. Sanitizes the string
/// representation of the <paramref name="expression"/> to set element's "id" attribute. Converts the
/// <paramref name="value"/> to a <see cref="string"/> to set element's "value" attribute.
/// </para>
/// <para>Determines &lt;input&gt; element's "checked" attribute based on the following precedence:</para>
/// <list type="number">
/// <item>
/// <see cref="ModelBinding.ModelStateDictionary"/> entry for the string representation of the
/// <paramref name="expression"/> if entry exists and can be converted to a <see cref="string"/>.
/// </item>
/// <item>
/// <paramref name="expression"/> result if it is non-<c>null</c> and can be parsed as a <see cref="string"/>.
/// </item>
/// <item>Existing "checked" entry in <paramref name="htmlAttributes"/> if any.</item>
/// <item>Otherwise, does not include a "checked" attribute.</item>
/// </list>
/// <para>
/// In all but the <paramref name="htmlAttributes"/> and default cases, includes a "checked" attribute with
/// value "checked" if the <see cref="string"/> values is equal to a converted <see cref="string"/> for
/// <paramref name="value"/>; does not include the attribute otherwise.
/// </para>
/// representation of the <paramref name="expression"/> to set element's "id" attribute.
/// </remarks>
IHtmlContent RadioButtonFor<TResult>(
Expression<Func<TModel, TResult>> expression,
@ -347,7 +336,11 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
new IHtmlContent Raw(string value);
/// <summary>
/// Returns a &lt;textarea&gt; element for the specified <paramref name="expression"/>.
/// Returns a &lt;textarea&gt; element for the specified <paramref name="expression"/>. Adds content to the
/// element body based on the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewDataDictionary.Model"/>.
/// See <see cref="NameFor"/> for more information about a "full name".
/// </summary>
/// <param name="expression">An expression to be evaluated against the current model.</param>
/// <param name="rows">Number of rows in the textarea.</param>
@ -359,22 +352,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <typeparam name="TResult">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;textarea&gt; element.</returns>
/// <remarks>
/// <para>
/// Combines <see cref="TemplateInfo.HtmlFieldPrefix"/> and the string representation of the
/// <paramref name="expression"/> to set &lt;textarea&gt; element's "name" attribute. Sanitizes the string
/// representation of the <paramref name="expression"/> to set element's "id" attribute.
/// </para>
/// <para>Determines &lt;textarea&gt; element's content based on the following precedence:</para>
/// <list type="number">
/// <item>
/// <see cref="ModelBinding.ModelStateDictionary"/> entry for the string representation of the
/// <paramref name="expression"/> if entry exists and can be converted to a <see cref="string"/>.
/// </item>
/// <item>
/// <paramref name="expression"/> result if it is non-<c>null</c> and can be parsed as a <see cref="string"/>.
/// </item>
/// <item>Otherwise, <c>string.Empty</c>.</item>
/// </list>
/// </remarks>
IHtmlContent TextAreaFor<TResult>(
Expression<Func<TModel, TResult>> expression,
@ -383,11 +363,17 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
object htmlAttributes);
/// <summary>
/// Returns an &lt;input&gt; element of type "text" for the specified <paramref name="expression"/>.
/// Returns an &lt;input&gt; element of type "text" for the specified <paramref name="expression"/>. Adds a
/// "value" attribute to the element containing the first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name,
/// the <paramref name="expression"/> evaluated against <see cref="ViewDataDictionary.Model"/>, or
/// the <paramref name="htmlAttributes"/> dictionary entry with key "value".
/// See <see cref="NameFor"/> for more information about a "full name".
/// </summary>
/// <param name="expression">An expression to be evaluated against the current model.</param>
/// <param name="format">
/// The composite format <see cref="string"/> (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// The format string (see https://msdn.microsoft.com/en-us/library/txafckwd.aspx) used to format the
/// <paramref name="expression"/> value when using that in the "value" attribute.
/// </param>
/// <param name="htmlAttributes">
/// An <see cref="object"/> that contains the HTML attributes for the element. Alternatively, an
@ -396,25 +382,9 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// <typeparam name="TResult">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>A new <see cref="IHtmlContent"/> containing the &lt;input&gt; element.</returns>
/// <remarks>
/// <para>
/// Combines <see cref="TemplateInfo.HtmlFieldPrefix"/> and the string representation of the
/// <paramref name="expression"/> to set &lt;input&gt; element's "name" attribute. Sanitizes the string
/// representation of the <paramref name="expression"/> to set element's "id" attribute.
/// </para>
/// <para>Determines &lt;input&gt; element's "value" attribute based on the following precedence:</para>
/// <list type="number">
/// <item>
/// <see cref="ModelBinding.ModelStateDictionary"/> entry for the string representation of the
/// <paramref name="expression"/> if entry exists and can be converted to a <see cref="string"/>.
/// </item>
/// <item>
/// <paramref name="expression"/> result if it is non-<c>null</c> and can be parsed as a <see cref="string"/>.
/// Formats result using <paramref name="format"/> or converts result to a <see cref="string"/> directly if
/// <paramref name="format"/> is <c>null</c> or empty.
/// </item>
/// <item>Existing "value" entry in <paramref name="htmlAttributes"/> if any.</item>
/// <item>Otherwise, <c>string.Empty</c>.</item>
/// </list>
/// </remarks>
IHtmlContent TextBoxFor<TResult>(
Expression<Func<TModel, TResult>> expression,
@ -451,11 +421,16 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
string tag);
/// <summary>
/// Returns the formatted value for the specified <paramref name="expression"/>.
/// Returns the formatted value for the specified <paramref name="expression"/>. Specifically, returns the
/// first non-<c>null</c> value found in:
/// the <see cref="ActionContext.ModelState"/> entry with full name, or
/// the <paramref name="expression"/> evaluated against <see cref="ViewDataDictionary.Model"/>.
/// See <see cref="NameFor"/> for more information about a "full name".
/// </summary>
/// <param name="expression">An expression to be evaluated against the current model.</param>
/// <param name="format">
/// The composite format <see cref="string"/> (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// The format string (see https://msdn.microsoft.com/en-us/library/txafckwd.aspx) used to format the
/// <paramref name="expression"/> value when returning that value.
/// </param>
/// <typeparam name="TResult">The type of the <paramref name="expression"/> result.</typeparam>
/// <returns>A <see cref="string"/> containing the formatted value.</returns>

2
src/Microsoft.AspNetCore.Mvc.ViewFeatures/Rendering/TagBuilder.cs
View File

@ -120,7 +120,7 @@ namespace Microsoft.AspNetCore.Mvc.Rendering
/// Valid HTML 4.01 "id" attribute value for an element with the given <paramref name="name"/>.
/// </returns>
/// <remarks>
/// Valid "id" attributes are defined in http://www.w3.org/TR/html401/types.html#type-id
/// Valid "id" attributes are defined in https://www.w3.org/TR/html401/types.html#type-id.
/// </remarks>
public static string CreateSanitizedId(string name, string invalidCharReplacement)
{

4
src/Microsoft.AspNetCore.Mvc.ViewFeatures/ViewFeatures/ViewDataDictionary.cs
View File

@ -379,7 +379,7 @@ namespace Microsoft.AspNetCore.Mvc.ViewFeatures
/// </summary>
/// <param name="expression">Expression name, relative to the current model.</param>
/// <param name="format">
/// The composite format <see cref="string"/> (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// The format string (see https://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// </param>
/// <returns>
/// Value of named <paramref name="expression"/> in this <see cref="ViewDataDictionary"/>, formatted using
@ -400,7 +400,7 @@ namespace Microsoft.AspNetCore.Mvc.ViewFeatures
/// </summary>
/// <param name="value">The value to format.</param>
/// <param name="format">
/// The composite format <see cref="string"/> (see http://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// The format string (see https://msdn.microsoft.com/en-us/library/txafckwd.aspx).
/// </param>
/// <returns>The formatted <see cref="string"/>.</returns>
public static string FormatValue(object value, string format)

2
src/Microsoft.AspNetCore.Mvc.WebApiCompatShim/ContentNegotiator/MediaTypeConstants.cs
View File

@ -101,7 +101,7 @@ namespace System.Net.Http.Formatting
/// </value>
/// <remarks>
/// Not yet a standard. In particular this media type is not currently listed at
/// http://www.iana.org/assignments/media-types/application.
/// https://www.iana.org/assignments/media-types/application.
/// </remarks>
public static MediaTypeHeaderValue ApplicationBsonMediaType
{

2
test/Microsoft.AspNetCore.Mvc.WebApiCompatShimTest/TestUtils/MediaTypeConstants.cs
View File

@ -99,7 +99,7 @@ namespace System.Net.Http.Formatting
/// </value>
/// <remarks>
/// Not yet a standard. In particular this media type is not currently listed at
/// http://www.iana.org/assignments/media-types/application.
/// https://www.iana.org/assignments/media-types/application.
/// </remarks>
public static MediaTypeHeaderValue ApplicationBsonMediaType
{