AutoGeneratedField Class

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class AutoGeneratedField sealed : System::Web::UI::WebControls::BoundField

public sealed class AutoGeneratedField : System.Web.UI.WebControls.BoundField

type AutoGeneratedField = class
    inherit BoundField

Public NotInheritable Class AutoGeneratedField
Inherits BoundField

Inheritance: Object

DataControlField

BoundField
AutoGeneratedField

Examples

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;
        }
    }
}


Imports System.ComponentModel
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Security.Permissions
Imports System.Web

Namespace Samples.AspNet.VB.Controls

    <AspNetHostingPermission(SecurityAction.Demand, Level:=AspNetHostingPermissionLevel.Minimal), AspNetHostingPermission(SecurityAction.InheritanceDemand, Level:=AspNetHostingPermissionLevel.Minimal)> Public Class SimpleCustomControl
        Inherits System.Web.UI.WebControls.DetailsView

        Protected Overrides Function CreateAutoGeneratedRow(ByVal fieldProperties As AutoGeneratedFieldProperties) As AutoGeneratedField

            ' Create an AutoGeneratedField object.
            Dim field As New AutoGeneratedField(fieldProperties.DataField)

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

            Return field

        End Function

    End Class

End Namespace

Remarks

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).

Note

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.

Constructors

AutoGeneratedField(String)

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

Properties

AccessibleHeaderText	Gets or sets text that is rendered as the `AbbreviatedText` property value in some controls. (Inherited from DataControlField)
ApplyFormatInEditMode	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)
Control	Gets a reference to the data control that the DataControlField object is associated with. (Inherited from DataControlField)
ControlStyle	Gets the style of any Web server controls contained by the DataControlField object. (Inherited from DataControlField)
ConvertEmptyStringToNull	Gets or sets a value indicating whether empty string ("") values are converted to `null` when the field values are retrieved from the data source.
DataField	Gets or sets the name of the data field to bind to the BoundField object. (Inherited from BoundField)
DataFormatString	Gets or sets the string that specifies the format in which the alternate text for each image in an AutoGeneratedField object is rendered.
DataType	Gets or sets the data type of the values displayed in an AutoGeneratedField object.
DesignMode	Gets a value indicating whether a data control field is currently viewed in a design-time environment. (Inherited from DataControlField)
FooterStyle	Gets or sets the style of the footer of the data control field. (Inherited from DataControlField)
FooterText	Gets or sets the text that is displayed in the footer item of a data control field. (Inherited from DataControlField)
HeaderImageUrl	Gets or sets the URL of an image that is displayed in the header item of a data control field. (Inherited from DataControlField)
HeaderStyle	Gets or sets the style of the header of the data control field. (Inherited from DataControlField)
HeaderText	Gets or sets the text that is displayed in the header of a data control. (Inherited from BoundField)
HtmlEncode	Gets or sets a value indicating whether field values are HTML-encoded before they are displayed in a BoundField object. (Inherited from BoundField)
HtmlEncodeFormatString	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)
InsertVisible	Gets or sets a value indicating whether the AutoGeneratedField object is visible in insert mode.
IsTrackingViewState	Gets a value indicating whether the DataControlField object is saving changes to its view state. (Inherited from DataControlField)
ItemStyle	Gets the style of any text-based content displayed by a data control field. (Inherited from DataControlField)
NullDisplayText	Gets or sets the caption displayed for a field when the field's value is null. (Inherited from BoundField)
ReadOnly	Gets or sets a value indicating whether the value of the field can be modified in edit mode. (Inherited from BoundField)
ShowHeader	Gets or sets a value indicating whether the header item of a data control field is rendered. (Inherited from DataControlField)
SortExpression	Gets or sets a sort expression that is used by a data source control to sort data. (Inherited from DataControlField)
SupportsHtmlEncode	Gets a value indicating whether HTML encoding is supported by a BoundField object. (Inherited from BoundField)
ValidateRequestMode	Gets or sets a value that determines whether the control validates client input or not. (Inherited from BoundField)
ViewState	Gets a dictionary of state information that allows you to save and restore the view state of a DataControlField object across multiple requests for the same page. (Inherited from DataControlField)
Visible	Gets or sets a value indicating whether a data control field is rendered. (Inherited from DataControlField)

Methods

CloneField()	Creates a duplicate copy of the current DataControlField-derived object. (Inherited from DataControlField)
CopyProperties(DataControlField)	Copies the properties of the current BoundField object to the specified DataControlField object. (Inherited from BoundField)
CreateField()	Creates an empty BoundField object. (Inherited from BoundField)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
ExtractValuesFromCell(IOrderedDictionary, DataControlFieldCell, DataControlRowState, Boolean)	Fills the specified IOrderedDictionary object with the values from the specified DataControlFieldCell object.
FormatDataValue(Object, Boolean)	Formats the specified field value for a cell in the BoundField object. (Inherited from BoundField)
GetDesignTimeValue()	Retrieves the value used for a field's value when rendering the BoundField object in a designer. (Inherited from BoundField)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetValue(Control)	Retrieves the value of the field bound to the BoundField object. (Inherited from BoundField)
Initialize(Boolean, Control)	Initializes the BoundField object. (Inherited from BoundField)
InitializeCell(DataControlFieldCell, DataControlCellType, DataControlRowState, Int32)	Initializes the specified TableCell object to the specified row state. (Inherited from BoundField)
InitializeDataCell(DataControlFieldCell, DataControlRowState)	Initializes the specified TableCell object to the specified row state. (Inherited from BoundField)
LoadViewState(Object)	Restores the previously stored view-state information for this field. (Inherited from BoundField)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnDataBindField(Object, EventArgs)	Binds the value of a field to the BoundField object. (Inherited from BoundField)
OnFieldChanged()	Raises the `FieldChanged` event. (Inherited from DataControlField)
SaveViewState()	Saves the changes made to the DataControlField view state since the time the page was posted back to the server. (Inherited from DataControlField)
ToString()	Returns a string that represents this DataControlField object. (Inherited from DataControlField)
TrackViewState()	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)
ValidateSupportsCallback()	Determines whether the controls contained in an AutoGeneratedField object support callbacks.

Explicit Interface Implementations

IDataSourceViewSchemaAccessor.DataSourceViewSchema	Gets or sets the schema associated with this DataControlField object. (Inherited from DataControlField)
IStateManager.IsTrackingViewState	Gets a value indicating whether the DataControlField object is saving changes to its view state. (Inherited from DataControlField)
IStateManager.LoadViewState(Object)	Restores the data control field's previously saved view state. (Inherited from DataControlField)
IStateManager.SaveViewState()	Saves the changes made to the DataControlField view state since the time the page was posted back to the server. (Inherited from DataControlField)
IStateManager.TrackViewState()	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)

Applies to

Share via