Export (0) Print
Expand All

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)

'Declaration
Public NotInheritable Class AutoGeneratedField _
	Inherits BoundField

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.)
Protected propertyControlGets a reference to the data control that the DataControlField object is associated with. (Inherited from DataControlField.)
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 Nothing 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.
Protected propertyDesignModeGets a value indicating whether a data control field is currently viewed in a design-time environment. (Inherited from DataControlField.)
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.)
Protected propertyIsTrackingViewStateGets a value indicating whether the DataControlField object is saving changes to its view state. (Inherited from DataControlField.)
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.)
Protected propertySupportsHtmlEncodeGets a value indicating whether HTML encoding is supported by a BoundField object. (Inherited from BoundField.)
Protected propertyViewStateGets 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.)
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.)
Protected methodCopyPropertiesCopies the properties of the current BoundField object to the specified DataControlField object. (Inherited from BoundField.)
Protected methodCreateFieldCreates an empty BoundField object. (Inherited from BoundField.)
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).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodFormatDataValueFormats the specified field value for a cell in the BoundField object. (Inherited from BoundField.)
Protected methodGetDesignTimeValueRetrieves the value used for a field's value when rendering the BoundField object in a designer. (Inherited from BoundField.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodGetValueRetrieves the value of the field bound to the BoundField object. (Inherited from BoundField.)
Public methodInitializeInitializes the BoundField object. (Inherited from BoundField.)
Public methodInitializeCellInitializes the specified TableCell object to the specified row state. (Inherited from BoundField.)
Protected methodInitializeDataCellInitializes the specified TableCell object to the specified row state. (Inherited from BoundField.)
Protected methodLoadViewStateRestores the previously stored view-state information for this field. (Inherited from BoundField.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnDataBindFieldBinds the value of a field to the BoundField object. (Inherited from BoundField.)
Protected methodOnFieldChangedRaises the FieldChanged event. (Inherited from DataControlField.)
Protected methodSaveViewStateSaves the changes made to the DataControlField view state since the time the page was posted back to the server. (Inherited from DataControlField.)
Public methodToStringReturns a string that represents this DataControlField object. (Inherited from DataControlField.)
Protected methodTrackViewStateCauses 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.)
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.



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



.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.

Community Additions

ADD
Show:
© 2015 Microsoft