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

<?xml version="1.0" encoding="utf-8"?>
<Type Name="AutoGeneratedField" FullName="System.Web.UI.WebControls.AutoGeneratedField">
  <TypeSignature Language="C#" Value="public sealed class AutoGeneratedField : System.Web.UI.WebControls.BoundField" />
  <AssemblyInfo>
    <AssemblyName>System.Web</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Web.UI.WebControls.BoundField</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <since version=".NET 2.0" />
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>The <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> class is used to represent an automatically generated field in a data-bound control, such as <see cref="T:System.Web.UI.WebControls.GridView" /> or <see cref="T:System.Web.UI.WebControls.DetailsView" />. Automatically generated fields are created by a data-bound control when the appropriate property is set to true (for example, the <see cref="P:System.Web.UI.WebControls.GridView.AutoGenerateColumns" /> property for the <see cref="T:System.Web.UI.WebControls.GridView" /> control, the <see cref="P:System.Web.UI.WebControls.DetailsView.AutoGenerateRows" /> property for the <see cref="T:System.Web.UI.WebControls.DetailsView" /> control, and so on).</para>
      <block subset="none" type="note">
        <para>Automatically generated fields are not added to the field collection of a data-bound control (for example, the <see cref="P:System.Web.UI.WebControls.GridView.Columns" /> collection for the <see cref="T:System.Web.UI.WebControls.GridView" /> control, the <see cref="P:System.Web.UI.WebControls.DetailsView.Fields" /> collection for the <see cref="T:System.Web.UI.WebControls.DetailsView" /> control, and so on).</para>
      </block>
      <para>The <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> class is intended for use internally by data-bound controls. Unlike other data fields (such as <see cref="T:System.Web.UI.WebControls.BoundField" />, <see cref="T:System.Web.UI.WebControls.CheckBoxField" />, <see cref="T:System.Web.UI.WebControls.TemplateField" />, and so on), the <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> class cannot be placed declaratively on a page as part of a field collection. Although you can programmatically add an <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object to a field collection, this design pattern should be avoided.</para>
      <para>Because automatically generated fields represent the automatic rendering of a field, data-bound controls do not typically allow users to modify the properties of the <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> objects. If the automatic rendering is not suitable for your needs, define your own data fields for the field collection of the control.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Represents an automatically generated field in a data-bound control. This class cannot be inherited.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public AutoGeneratedField (string dataField);" />
      <MemberType>Constructor</MemberType>
      <Parameters>
        <Parameter Name="dataField" Type="System.String" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Use this constructor to initialize a new instance of the <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> class. This constructor is generally used by data-bound controls (such as <see cref="T:System.Web.UI.WebControls.GridView" /> and <see cref="T:System.Web.UI.WebControls.DetailsView" />) when creating automatically generated fields.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> class with the specified data field.</para>
        </summary>
        <param name="dataField">
          <attribution license="cc4" from="Microsoft" modified="false" />The name of the data field to bind to the <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" />.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="ConvertEmptyStringToNull">
      <MemberSignature Language="C#" Value="public override bool ConvertEmptyStringToNull { 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>Sometimes a field's value is an empty string ("") in the data source. The <see cref="P:System.Web.UI.WebControls.AutoGeneratedField.ConvertEmptyStringToNull" /> property is used to indicate whether empty string values are converted to null before being displayed in an <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" />.</para>
          <block subset="none" type="note">
            <para>This version of the property has been implemented to always return true. It is not possible to set this property.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets a value indicating whether empty string ("") values are converted to null when the field values are retrieved from the data source.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="CopyProperties">
      <MemberSignature Language="C#" Value="protected override void CopyProperties (System.Web.UI.WebControls.DataControlField newField);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="newField" Type="System.Web.UI.WebControls.DataControlField" />
      </Parameters>
      <Docs>
        <param name="newField">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="CreateField">
      <MemberSignature Language="C#" Value="protected override System.Web.UI.WebControls.DataControlField CreateField ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Web.UI.WebControls.DataControlField</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="DataFormatString">
      <MemberSignature Language="C#" Value="public override string DataFormatString { 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>The <see cref="P:System.Web.UI.WebControls.AutoGeneratedField.DataFormatString" /> property is used to apply a special format to the values displayed in an <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object.</para>
          <block subset="none" type="note">
            <para>This version of the property has been implemented to always return an empty string to indicate that no special formatting is applied to the field values. It is not possible to set this property.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets the string that specifies the format in which the alternate text for each image in an <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object is rendered.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="DataType">
      <MemberSignature Language="C#" Value="public Type DataType { 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.AutoGeneratedField.DataType" /> property to specify the data type of the values displayed in an <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 values displayed in an <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="ExtractValuesFromCell">
      <MemberSignature Language="C#" Value="public override void ExtractValuesFromCell (System.Collections.Specialized.IOrderedDictionary dictionary, System.Web.UI.WebControls.DataControlFieldCell cell, System.Web.UI.WebControls.DataControlRowState rowState, bool includeReadOnly);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="dictionary" Type="System.Collections.Specialized.IOrderedDictionary" />
        <Parameter Name="cell" Type="System.Web.UI.WebControls.DataControlFieldCell" />
        <Parameter Name="rowState" Type="System.Web.UI.WebControls.DataControlRowState" />
        <Parameter Name="includeReadOnly" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.WebControls.AutoGeneratedField.ExtractValuesFromCell(System.Collections.Specialized.IOrderedDictionary,System.Web.UI.WebControls.DataControlFieldCell,System.Web.UI.WebControls.DataControlRowState,System.Boolean)" /> method is a helper method used to retrieve the values of the fields from the specified <see cref="T:System.Web.UI.WebControls.DataControlFieldCell" /> object in an <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object.</para>
          <block subset="none" type="note">
            <para>This method is primarily used by control developers.</para>
          </block>
          <para>This method does not have a return value. Instead, the field values are returned by reference through the <see cref="T:System.Collections.Specialized.IOrderedDictionary" /> object passed in for the <paramref name="dictionary" /> parameter. After the method has been called, iterate through the <see cref="T:System.Collections.Specialized.IOrderedDictionary" /> object to access the field values.</para>
          <block subset="none" type="note">
            <para>To include the read-only field values in the <see cref="T:System.Web.UI.WebControls.DataControlFieldCell" /> object, pass in true for the <paramref name="includeReadOnly" /> parameter.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Fills the specified <see cref="T:System.Collections.Specialized.IOrderedDictionary" /> object with the values from the specified <see cref="T:System.Web.UI.WebControls.DataControlFieldCell" /> object.</para>
        </summary>
        <param name="dictionary">
          <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Collections.Specialized.IOrderedDictionary" /> used to store the values of the specified cell.</param>
        <param name="cell">
          <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.DataControlFieldCell" /> that contains the values to retrieve.</param>
        <param name="rowState">
          <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Web.UI.WebControls.DataControlRowState" /> values.</param>
        <param name="includeReadOnly">
          <attribution license="cc4" from="Microsoft" modified="false" />The value true includes only the values of read-only fields; otherwise, false.</param>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="GetDesignTimeValue">
      <MemberSignature Language="C#" Value="protected override object GetDesignTimeValue ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="InitializeDataCell">
      <MemberSignature Language="C#" Value="protected override void InitializeDataCell (System.Web.UI.WebControls.DataControlFieldCell cell, System.Web.UI.WebControls.DataControlRowState rowState);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="cell" Type="System.Web.UI.WebControls.DataControlFieldCell" />
        <Parameter Name="rowState" Type="System.Web.UI.WebControls.DataControlRowState" />
      </Parameters>
      <Docs>
        <param name="cell">To be added.</param>
        <param name="rowState">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="InsertVisible">
      <MemberSignature Language="C#" Value="public override bool InsertVisible { 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>In data-bound controls that support inserting records (such as the <see cref="T:System.Web.UI.WebControls.DetailsView" /> control), the <see cref="P:System.Web.UI.WebControls.AutoGeneratedField.InsertVisible" /> property is used to specify whether the <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object is displayed when the data-bound control is in insert mode.</para>
          <block subset="none" type="note">
            <para>This version of the property has been implemented to always return true. It is not possible to set this property.</para>
          </block>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets or sets a value indicating whether the <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object is visible in insert mode.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="OnDataBindField">
      <MemberSignature Language="C#" Value="protected override void OnDataBindField (object sender, EventArgs e);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="sender" Type="System.Object" />
        <Parameter Name="e" Type="System.EventArgs" />
      </Parameters>
      <Docs>
        <param name="sender">To be added.</param>
        <param name="e">To be added.</param>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
        <since version=".NET 2.0" />
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
    <Member MemberName="ValidateSupportsCallback">
      <MemberSignature Language="C#" Value="public override void ValidateSupportsCallback ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <since version=".NET 2.0" />
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.Web.UI.WebControls.AutoGeneratedField.ValidateSupportsCallback" /> method is the helper method used to determine whether the controls contained in an <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object support callbacks. This method has been implemented as an empty method (a method that does not contain any code) to indicate that callbacks are supported.</para>
          <block subset="none" type="note">
            <para>This method is primarily used by control developers.</para>
          </block>
          <para>Classes that derive from the <see cref="T:System.Web.UI.WebControls.DataControlField" /> class can override this method to indicate whether the controls contained by the field support callbacks. To indicate that callbacks are supported, implement this method as an empty method that does not throw an exception; otherwise, throw an exception with a useful message describing why callbacks are not supported.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Determines whether the controls contained in an <see cref="T:System.Web.UI.WebControls.AutoGeneratedField" /> object support callbacks.</para>
        </summary>
      </Docs>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
    </Member>
  </Members>
</Type>