AutoGeneratedField Class
TOC
Collapse the table of content
Expand the table of content

AutoGeneratedField Class

 

Represents an automatically generated field in a data-bound control. This class cannot be inherited.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

System.Object
  System.Web.UI.WebControls.DataControlField
    System.Web.UI.WebControls.BoundField
      System.Web.UI.WebControls.AutoGeneratedField

public sealed class AutoGeneratedField : BoundField

NameDescription
System_CAPS_pubmethodAutoGeneratedField(String)

Initializes a new instance of the AutoGeneratedField class with the specified data field.

NameDescription
System_CAPS_pubpropertyAccessibleHeaderText

Gets or sets text that is rendered as the AbbreviatedText property value in some controls.(Inherited from DataControlField.)

System_CAPS_pubpropertyApplyFormatInEditMode

Gets or sets a value indicating whether the formatting string specified by the DataFormatString property is applied to field values when the data-bound control that contains the BoundField object is in edit mode.(Inherited from BoundField.)

System_CAPS_pubpropertyControlStyle

Gets the style of any Web server controls contained by the DataControlField object.(Inherited from DataControlField.)

System_CAPS_pubpropertyConvertEmptyStringToNull

Gets or sets a value indicating whether empty string ("") values are converted to null when the field values are retrieved from the data source.(Overrides BoundField.ConvertEmptyStringToNull.)

System_CAPS_pubpropertyDataField

Gets or sets the name of the data field to bind to the BoundField object.(Inherited from BoundField.)

System_CAPS_pubpropertyDataFormatString

Gets or sets the string that specifies the format in which the alternate text for each image in an AutoGeneratedField object is rendered.(Overrides BoundField.DataFormatString.)

System_CAPS_pubpropertyDataType

Gets or sets the data type of the values displayed in an AutoGeneratedField object.

System_CAPS_pubpropertyFooterStyle

Gets or sets the style of the footer of the data control field.(Inherited from DataControlField.)

System_CAPS_pubpropertyFooterText

Gets or sets the text that is displayed in the footer item of a data control field.(Inherited from DataControlField.)

System_CAPS_pubpropertyHeaderImageUrl

Gets or sets the URL of an image that is displayed in the header item of a data control field.(Inherited from DataControlField.)

System_CAPS_pubpropertyHeaderStyle

Gets or sets the style of the header of the data control field.(Inherited from DataControlField.)

System_CAPS_pubpropertyHeaderText

Gets or sets the text that is displayed in the header of a data control.(Inherited from BoundField.)

System_CAPS_pubpropertyHtmlEncode

Gets or sets a value indicating whether field values are HTML-encoded before they are displayed in a BoundField object.(Inherited from BoundField.)

System_CAPS_pubpropertyHtmlEncodeFormatString

Gets or sets a value that indicates whether text that is created by applying the DataFormatString property to the BoundField value should be HTML encoded when it is displayed.(Inherited from BoundField.)

System_CAPS_pubpropertyInsertVisible

Gets or sets a value indicating whether the AutoGeneratedField object is visible in insert mode.(Overrides DataControlField.InsertVisible.)

System_CAPS_pubpropertyItemStyle

Gets the style of any text-based content displayed by a data control field.(Inherited from DataControlField.)

System_CAPS_pubpropertyNullDisplayText

Gets or sets the caption displayed for a field when the field's value is null.(Inherited from BoundField.)

System_CAPS_pubpropertyReadOnly

Gets or sets a value indicating whether the value of the field can be modified in edit mode.(Inherited from BoundField.)

System_CAPS_pubpropertyShowHeader

Gets or sets a value indicating whether the header item of a data control field is rendered.(Inherited from DataControlField.)

System_CAPS_pubpropertySortExpression

Gets or sets a sort expression that is used by a data source control to sort data.(Inherited from DataControlField.)

System_CAPS_pubpropertyValidateRequestMode

Gets or sets a value that determines whether the control validates client input or not.(Inherited from BoundField.)

System_CAPS_pubpropertyVisible

Gets or sets a value indicating whether a data control field is rendered.(Inherited from DataControlField.)

NameDescription
System_CAPS_protmethodCloneField()

This API supports the product infrastructure and is not intended to be used directly from your code. Creates a duplicate copy of the current DataControlField-derived object.(Inherited from DataControlField.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodExtractValuesFromCell(IOrderedDictionary, DataControlFieldCell, DataControlRowState, Boolean)
System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitialize(Boolean, Control)

Initializes the BoundField object.(Inherited from BoundField.)

System_CAPS_pubmethodInitializeCell(DataControlFieldCell, DataControlCellType, DataControlRowState, Int32)

Initializes the specified TableCell object to the specified row state.(Inherited from BoundField.)

System_CAPS_pubmethodToString()

Returns a string that represents this DataControlField object.(Inherited from DataControlField.)

System_CAPS_pubmethodValidateSupportsCallback()

Determines whether the controls contained in an AutoGeneratedField object support callbacks.(Overrides BoundField.ValidateSupportsCallback().)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.LoadViewState(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Restores the data control field's previously saved view state.(Inherited from DataControlField.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.SaveViewState()

This API supports the product infrastructure and is not intended to be used directly from your code. Saves the changes made to the DataControlField view state since the time the page was posted back to the server.(Inherited from DataControlField.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.TrackViewState()

This API supports the product infrastructure and is not intended to be used directly from your code. Causes the DataControlField object to track changes to its view state so they can be stored in the control's ViewState property and persisted across requests for the same page.(Inherited from DataControlField.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataSourceViewSchemaAccessor.DataSourceViewSchema

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the schema associated with this DataControlField object.(Inherited from DataControlField.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIStateManager.IsTrackingViewState

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value indicating whether the DataControlField object is saving changes to its view state.(Inherited from DataControlField.)

The AutoGeneratedField class is used to represent an automatically generated field in a data-bound control, such as GridView or DetailsView. Automatically generated fields are created by a data-bound control when the appropriate property is set to true (for example, the AutoGenerateColumns property for the GridView control, the AutoGenerateRows property for the DetailsView control, and so on).

System_CAPS_noteNote

Automatically generated fields are not added to the field collection of a data-bound control (for example, the Columns collection for the GridView control, the Fields collection for the DetailsView control, and so on).

The AutoGeneratedField class is intended for use internally by data-bound controls. Unlike other data fields (such as BoundField, CheckBoxField, TemplateField, and so on), the AutoGeneratedField class cannot be placed declaratively on a page as part of a field collection. Although you can programmatically add an AutoGeneratedField object to a field collection, this design pattern should be avoided.

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 AutoGeneratedField objects. If the automatic rendering is not suitable for your needs, define your own data fields for the field collection of the control.

The following example demonstrates how to create an AutoGeneratedField object for a custom control that derives from the DetailsView control.


using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Text;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Security.Permissions;
using System.Web;

namespace Samples.AspNet.CS.Controls
{

    [AspNetHostingPermission(SecurityAction.Demand, Level=AspNetHostingPermissionLevel.Minimal)]
    [AspNetHostingPermission(SecurityAction.InheritanceDemand, Level=AspNetHostingPermissionLevel.Minimal)]
    public class SimpleCustomControl : DetailsView
    {

        protected override AutoGeneratedField CreateAutoGeneratedRow(AutoGeneratedFieldProperties fieldProperties) 
        {

            // Create an AutoGeneratedField object.
            AutoGeneratedField field = new AutoGeneratedField(fieldProperties.DataField);

            // Set the properties of the AutoGeneratedField using
            // the values from the AutoGeneratedFieldProperties 
            // object contained in the fieldProperties parameter.
            ((IStateManager)field).TrackViewState();
            field.HeaderText = fieldProperties.Name;
            field.SortExpression = fieldProperties.Name;
            field.ReadOnly = fieldProperties.IsReadOnly;
            field.DataType = fieldProperties.Type;

            return field;
        }

    }
}

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft