linux-packaging-mono/mcs/class/System.Web/Documentation/en/System.Web.UI.WebControls/AutoGeneratedFieldProperties.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="AutoGeneratedFieldProperties" FullName="System.Web.UI.WebControls.AutoGeneratedFieldProperties">
  <TypeSignature Language="C#" Value="public sealed class AutoGeneratedFieldProperties : System.Web.UI.IStateManager" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.Web.UI.IStateManager</InterfaceName>
    </Interface>
  </Interfaces>
  <Docs>
    <since version=".NET 2.0" />
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>The <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> class is used by data-bound controls to specify the properties of an <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object when creating an automatically generated field. For example, when the <see cref="T:System.Web.UI.WebControls.DetailsView" /> control creates an automatically generated row, it creates an <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> object with the row's properties and passes it to the <see cref="M:System.Web.UI.WebControls.DetailsView.CreateAutoGeneratedRow(System.Web.UI.WebControls.AutoGeneratedFieldProperties)" /> method. Likewise, the <see cref="T:System.Web.UI.WebControls.GridView" /> control passes an <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> object to the <see cref="M:System.Web.UI.WebControls.GridView.CreateAutoGeneratedColumn(System.Web.UI.WebControls.AutoGeneratedFieldProperties)" /> method when creating an automatically generated column. </para>
      <block subset="none" type="note">
        <para>This class is typically used only when extending the <see cref="T:System.Web.UI.WebControls.GridView" /> or <see cref="T:System.Web.UI.WebControls.DetailsView" /> control.</para>
      </block>
      <para>You can specify the name of the field to bind to an <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object by setting the <see cref="P:System.Web.UI.WebControls.AutoGeneratedFieldProperties.DataField" /> property. To specify the data type of the field values, set the <see cref="P:System.Web.UI.WebControls.AutoGeneratedFieldProperties.Type" /> property. You can prevent users from modifying the field values by setting the <see cref="P:System.Web.UI.WebControls.AutoGeneratedFieldProperties.IsReadOnly" /> property to true. You can also assign a name to an <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object by setting the <see cref="P:System.Web.UI.WebControls.AutoGeneratedFieldProperties.Name" /> property.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Represents the properties of an <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object. This class cannot be inherited.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public AutoGeneratedFieldProperties ();" />
      <MemberType>Constructor</MemberType>
      <Parameters />
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use this constructor to create a new instance of the <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> class.</para>
          <block subset="none" type="note">
            <para>This constructor is primarily used by control developers when extending a data-bound control.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> class.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="DataField">
      <MemberSignature Language="C#" Value="public string DataField { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use the <see cref="P:System.Web.UI.WebControls.AutoGeneratedFieldProperties.DataField" /> property to specify the name of the data field to bind to the <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object. The <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object automatically displays the values in the appropriate control, based on the <see cref="P:System.Web.UI.WebControls.AutoGeneratedFieldProperties.Type" /> property. For example, <see cref="T:System.Boolean" /> values are displayed in check box controls, while <see cref="T:System.String" /> values are displayed as plain text.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the name of the field bound to the <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="IsReadOnly">
      <MemberSignature Language="C#" Value="public bool IsReadOnly { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use the <see cref="P:System.Web.UI.WebControls.AutoGeneratedFieldProperties.IsReadOnly" /> property to specify whether the values of the field bound to an <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object can be modified in edit mode. When a data-bound control is in edit mode, fields that are read-only are displayed as plain text, without any editing controls.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets a value indicating whether the values displayed in an <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object can be modified in edit mode.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="Name">
      <MemberSignature Language="C#" Value="public string Name { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use the <see cref="P:System.Web.UI.WebControls.AutoGeneratedFieldProperties.Name" /> property to specify the name of the <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object. The name is often the name of the field bound to the <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object. The value of this property is also displayed in the header section of the <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object in a <see cref="T:System.Web.UI.WebControls.DetailsView" /> or a <see cref="T:System.Web.UI.WebControls.GridView" /> control.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the name of the <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="System.Web.UI.IStateManager.IsTrackingViewState">
      <MemberSignature Language="C#" Value="bool System.Web.UI.IStateManager.IsTrackingViewState { get; }" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="P:System.Web.UI.WebControls.AutoGeneratedFieldProperties.System#Web#UI#IStateManager#IsTrackingViewState" /> property is used to determine whether the <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> object is tracking its view-state changes.</para>
          <block subset="none" type="note">
            <para>This property is used primarily by control developers.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets a value indicating whether the <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> object is tracking its view-state changes.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="System.Web.UI.IStateManager.LoadViewState">
      <MemberSignature Language="C#" Value="void IStateManager.LoadViewState (object state);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="state" Type="System.Object" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.WebControls.AutoGeneratedFieldProperties.System#Web#UI#IStateManager#LoadViewState(System.Object)" /> method is used to load the previously saved view state of the <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> control.</para>
          <block subset="none" type="note">
            <para>This method is used primarily by control developers when extending the <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> control.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Loads the previously saved view state of the <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> object.</para>
        </summary>
        <param name="state">
          <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Object" /> that represents the state of the <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" />.</param>
      </Docs>
    </Member>
    <Member MemberName="System.Web.UI.IStateManager.SaveViewState">
      <MemberSignature Language="C#" Value="object IStateManager.SaveViewState ();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.WebControls.AutoGeneratedFieldProperties.System#Web#UI#IStateManager#SaveViewState" /> method is a helper method used by the <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> class to save the state of the object.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Saves the current view state of the <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> object.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>An <see cref="T:System.Object" /> that contains the saved state of the <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> object.</para>
        </returns>
      </Docs>
    </Member>
    <Member MemberName="System.Web.UI.IStateManager.TrackViewState">
      <MemberSignature Language="C#" Value="void IStateManager.TrackViewState ();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>This method is overridden to mark the starting point at which to begin tracking and saving changes to the <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> object as part of the object's view state.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Marks the starting point at which to begin tracking and saving view-state changes to the <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> object.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="Type">
      <MemberSignature Language="C#" Value="public Type Type { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Type</ReturnType>
      </ReturnValue>
      <Docs>
        <value>To be added.</value>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use the <see cref="P:System.Web.UI.WebControls.AutoGeneratedFieldProperties.Type" /> property to specify the data type of the value displayed in the <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object. The data type determines what type of control is rendered in an <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object to display the value. For example, a check box control is displayed when the type is <see cref="T:System.Boolean" />.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the data type of the value displayed in an <see cref="T:System.Web.UI.WebControls.AutoGeneratedFieldProperties" /> object.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
</Type>