FormContext.xml

<Type Name="FormContext" FullName="System.Web.Mvc.FormContext">
  <TypeSignature Language="C#" Value="public class FormContext" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FormContext extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.Web.Mvc.FormContext" />
  <TypeSignature Language="VB.NET" Value="Public Class FormContext" />
  <TypeSignature Language="F#" Value="type FormContext = class" />
  <AssemblyInfo>
    <AssemblyName>System.Web.Mvc</AssemblyName>
    <AssemblyVersion>5.2.6.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Encapsulates information that is required in order to validate and process the input data from an HTML form.</summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public FormContext ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.Mvc.FormContext.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Mvc</AssemblyName>
        <AssemblyVersion>5.2.6.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:System.Web.Mvc.FormContext" /> class.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FieldValidators">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary&lt;string,System.Web.Mvc.FieldValidationMetadata&gt; FieldValidators { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2&lt;string, class System.Web.Mvc.FieldValidationMetadata&gt; FieldValidators" />
      <MemberSignature Language="DocId" Value="P:System.Web.Mvc.FormContext.FieldValidators" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property FieldValidators As IDictionary(Of String, FieldValidationMetadata)" />
      <MemberSignature Language="F#" Value="member this.FieldValidators : System.Collections.Generic.IDictionary&lt;string, System.Web.Mvc.FieldValidationMetadata&gt;" Usage="System.Web.Mvc.FormContext.FieldValidators" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Mvc</AssemblyName>
        <AssemblyVersion>5.2.6.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IDictionary&lt;System.String,System.Web.Mvc.FieldValidationMetadata&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the field validators for the form.</summary>
        <value>A dictionary of field validators for the form.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="FormId">
      <MemberSignature Language="C#" Value="public string FormId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string FormId" />
      <MemberSignature Language="DocId" Value="P:System.Web.Mvc.FormContext.FormId" />
      <MemberSignature Language="VB.NET" Value="Public Property FormId As String" />
      <MemberSignature Language="F#" Value="member this.FormId : string with get, set" Usage="System.Web.Mvc.FormContext.FormId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Mvc</AssemblyName>
        <AssemblyVersion>5.2.6.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the form identifier.</summary>
        <value>The form identifier.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetJsonValidationMetadata">
      <MemberSignature Language="C#" Value="public string GetJsonValidationMetadata ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetJsonValidationMetadata() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.Mvc.FormContext.GetJsonValidationMetadata" />
      <MemberSignature Language="VB.NET" Value="Public Function GetJsonValidationMetadata () As String" />
      <MemberSignature Language="F#" Value="member this.GetJsonValidationMetadata : unit -&gt; string" Usage="formContext.GetJsonValidationMetadata " />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Mvc</AssemblyName>
        <AssemblyVersion>5.2.6.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Returns a serialized object that contains the form identifier and field-validation values for the form.</summary>
        <returns>A serialized object that contains the form identifier and field-validation values for the form.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetValidationMetadataForField">
      <MemberSignature Language="C#" Value="public System.Web.Mvc.FieldValidationMetadata GetValidationMetadataForField (string fieldName);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Web.Mvc.FieldValidationMetadata GetValidationMetadataForField(string fieldName) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.Mvc.FormContext.GetValidationMetadataForField(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetValidationMetadataForField (fieldName As String) As FieldValidationMetadata" />
      <MemberSignature Language="F#" Value="member this.GetValidationMetadataForField : string -&gt; System.Web.Mvc.FieldValidationMetadata" Usage="formContext.GetValidationMetadataForField fieldName" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Mvc</AssemblyName>
        <AssemblyVersion>5.2.6.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Web.Mvc.FieldValidationMetadata</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="fieldName" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="fieldName">The name of the field to retrieve the validation value for.</param>
        <summary>Returns the validation value for the specified input field.</summary>
        <returns>The value to validate the field input with.</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentException">The <paramref name="fieldName" /> parameter is either null or empty.</exception>
      </Docs>
    </Member>
    <Member MemberName="GetValidationMetadataForField">
      <MemberSignature Language="C#" Value="public System.Web.Mvc.FieldValidationMetadata GetValidationMetadataForField (string fieldName, bool createIfNotFound);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Web.Mvc.FieldValidationMetadata GetValidationMetadataForField(string fieldName, bool createIfNotFound) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.Mvc.FormContext.GetValidationMetadataForField(System.String,System.Boolean)" />
      <MemberSignature Language="VB.NET" Value="Public Function GetValidationMetadataForField (fieldName As String, createIfNotFound As Boolean) As FieldValidationMetadata" />
      <MemberSignature Language="F#" Value="member this.GetValidationMetadataForField : string * bool -&gt; System.Web.Mvc.FieldValidationMetadata" Usage="formContext.GetValidationMetadataForField (fieldName, createIfNotFound)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Mvc</AssemblyName>
        <AssemblyVersion>5.2.6.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Web.Mvc.FieldValidationMetadata</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="fieldName" Type="System.String" />
        <Parameter Name="createIfNotFound" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="fieldName">The name of the field to retrieve the validation value for.</param>
        <param name="createIfNotFound">true to create a validation value if one is not found; otherwise, false.</param>
        <summary>Returns the validation value for the specified input field and a value that indicates what to do if the validation value is not found.</summary>
        <returns>The value to validate the field input with.</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentException">The <paramref name="fieldName" /> parameter is either null or empty.</exception>
      </Docs>
    </Member>
    <Member MemberName="RenderedField">
      <MemberSignature Language="C#" Value="public bool RenderedField (string fieldName);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool RenderedField(string fieldName) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.Mvc.FormContext.RenderedField(System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Function RenderedField (fieldName As String) As Boolean" />
      <MemberSignature Language="F#" Value="member this.RenderedField : string -&gt; bool" Usage="formContext.RenderedField fieldName" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Mvc</AssemblyName>
        <AssemblyVersion>5.2.6.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="fieldName" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="fieldName">The field name.</param>
        <summary>Returns a value that indicates whether the specified field has been rendered in the form.</summary>
        <returns>true if the field has been rendered; otherwise, false.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="RenderedField">
      <MemberSignature Language="C#" Value="public void RenderedField (string fieldName, bool value);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RenderedField(string fieldName, bool value) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Web.Mvc.FormContext.RenderedField(System.String,System.Boolean)" />
      <MemberSignature Language="VB.NET" Value="Public Sub RenderedField (fieldName As String, value As Boolean)" />
      <MemberSignature Language="F#" Value="member this.RenderedField : string * bool -&gt; unit" Usage="formContext.RenderedField (fieldName, value)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Mvc</AssemblyName>
        <AssemblyVersion>5.2.6.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="fieldName" Type="System.String" />
        <Parameter Name="value" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <param name="fieldName">The field name.</param>
        <param name="value">true to specify that the field has been rendered in the form; otherwise, false.</param>
        <summary>Sets a value that indicates whether the specified field has been rendered in the form.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ReplaceValidationSummary">
      <MemberSignature Language="C#" Value="public bool ReplaceValidationSummary { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool ReplaceValidationSummary" />
      <MemberSignature Language="DocId" Value="P:System.Web.Mvc.FormContext.ReplaceValidationSummary" />
      <MemberSignature Language="VB.NET" Value="Public Property ReplaceValidationSummary As Boolean" />
      <MemberSignature Language="F#" Value="member this.ReplaceValidationSummary : bool with get, set" Usage="System.Web.Mvc.FormContext.ReplaceValidationSummary" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Mvc</AssemblyName>
        <AssemblyVersion>5.2.6.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Determines whether client validation errors should be dynamically added to the validation summary.</summary>
        <value>true if client validation errors should be added to the validation summary; otherwise, false.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ValidationSummaryId">
      <MemberSignature Language="C#" Value="public string ValidationSummaryId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ValidationSummaryId" />
      <MemberSignature Language="DocId" Value="P:System.Web.Mvc.FormContext.ValidationSummaryId" />
      <MemberSignature Language="VB.NET" Value="Public Property ValidationSummaryId As String" />
      <MemberSignature Language="F#" Value="member this.ValidationSummaryId : string with get, set" Usage="System.Web.Mvc.FormContext.ValidationSummaryId" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Web.Mvc</AssemblyName>
        <AssemblyVersion>5.2.6.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the identifier for the validation summary.</summary>
        <value>The identifier for the validation summary.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>