Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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)
[<Sealed>]
type AutoGeneratedField =  
    class 
        inherit BoundField 
    end

The AutoGeneratedField type exposes the following members.

  NameDescription
Public methodAutoGeneratedFieldInitializes a new instance of the AutoGeneratedField class with the specified data field.
Top
  NameDescription
Public propertyAccessibleHeaderTextGets or sets text that is rendered as the AbbreviatedText property value in some controls. (Inherited from DataControlField.)
Public propertyApplyFormatInEditModeGets 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.)
Public propertyControlStyleGets the style of any Web server controls contained by the DataControlField object. (Inherited from DataControlField.)
Public propertyConvertEmptyStringToNullGets or sets a value indicating whether empty string ("") values are converted to a null reference (Nothing in Visual Basic) when the field values are retrieved from the data source. (Overrides BoundField.ConvertEmptyStringToNull.)
Public propertyDataFieldGets or sets the name of the data field to bind to the BoundField object. (Inherited from BoundField.)
Public propertyDataFormatStringGets 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.)
Public propertyDataTypeGets or sets the data type of the values displayed in an AutoGeneratedField object.
Public propertyFooterStyleGets or sets the style of the footer of the data control field. (Inherited from DataControlField.)
Public propertyFooterTextGets or sets the text that is displayed in the footer item of a data control field. (Inherited from DataControlField.)
Public propertyHeaderImageUrlGets or sets the URL of an image that is displayed in the header item of a data control field. (Inherited from DataControlField.)
Public propertyHeaderStyleGets or sets the style of the header of the data control field. (Inherited from DataControlField.)
Public propertyHeaderTextGets or sets the text that is displayed in the header of a data control. (Inherited from BoundField.)
Public propertyHtmlEncodeGets or sets a value indicating whether field values are HTML-encoded before they are displayed in a BoundField object. (Inherited from BoundField.)
Public propertyHtmlEncodeFormatStringGets 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.)
Public propertyInsertVisibleGets or sets a value indicating whether the AutoGeneratedField object is visible in insert mode. (Overrides DataControlField.InsertVisible.)
Public propertyItemStyleGets the style of any text-based content displayed by a data control field. (Inherited from DataControlField.)
Public propertyNullDisplayTextGets or sets the caption displayed for a field when the field's value is null. (Inherited from BoundField.)
Public propertyReadOnlyGets or sets a value indicating whether the value of the field can be modified in edit mode. (Inherited from BoundField.)
Public propertyShowHeaderGets or sets a value indicating whether the header item of a data control field is rendered. (Inherited from DataControlField.)
Public propertySortExpressionGets or sets a sort expression that is used by a data source control to sort data. (Inherited from DataControlField.)
Public propertyValidateRequestModeGets or sets a value that determines whether the control validates client input or not. (Inherited from BoundField.)
Public propertyVisibleGets or sets a value indicating whether a data control field is rendered. (Inherited from DataControlField.)
Top
  NameDescription
Protected methodCloneFieldInfrastructure. Creates a duplicate copy of the current DataControlField-derived object. (Inherited from DataControlField.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodExtractValuesFromCellFills the specified IOrderedDictionary object with the values from the specified DataControlFieldCell object. (Overrides BoundField.ExtractValuesFromCell(IOrderedDictionary, DataControlFieldCell, DataControlRowState, Boolean).)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeInitializes the BoundField object. (Inherited from BoundField.)
Public methodInitializeCellInitializes the specified TableCell object to the specified row state. (Inherited from BoundField.)
Public methodToStringReturns a string that represents this DataControlField object. (Inherited from DataControlField.)
Public methodValidateSupportsCallbackDetermines whether the controls contained in an AutoGeneratedField object support callbacks. (Overrides BoundField.ValidateSupportsCallback().)
Top
  NameDescription
Explicit interface implemetationPrivate propertyIDataSourceViewSchemaAccessor.DataSourceViewSchemaInfrastructure. Gets or sets the schema associated with this DataControlField object. (Inherited from DataControlField.)
Explicit interface implemetationPrivate propertyIStateManager.IsTrackingViewStateInfrastructure. Gets a value indicating whether the DataControlField object is saving changes to its view state. (Inherited from DataControlField.)
Explicit interface implemetationPrivate methodIStateManager.LoadViewStateInfrastructure. Restores the data control field's previously saved view state. (Inherited from DataControlField.)
Explicit interface implemetationPrivate methodIStateManager.SaveViewStateInfrastructure. Saves the changes made to the DataControlField view state since the time the page was posted back to the server. (Inherited from DataControlField.)
Explicit interface implemetationPrivate methodIStateManager.TrackViewStateInfrastructure. 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.)
Top

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

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.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.