AutoGeneratedFieldProperties 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 the properties of an AutoGeneratedField object. This class cannot be inherited.

public ref class AutoGeneratedFieldProperties sealed : System::Web::UI::IStateManager

public sealed class AutoGeneratedFieldProperties : System.Web.UI.IStateManager

type AutoGeneratedFieldProperties = class
    interface IStateManager

Public NotInheritable Class AutoGeneratedFieldProperties
Implements IStateManager

Inheritance: Object
AutoGeneratedFieldProperties

Implements: IStateManager

Examples

The following code example demonstrates how to use the AutoGeneratedFieldProperties class to create an AutoGeneratedField object in 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 AutoGeneratedFieldProperties class is used by data-bound controls to specify the properties of an AutoGeneratedField object when creating an automatically generated field. For example, when the DetailsView control creates an automatically generated row, it creates an AutoGeneratedFieldProperties object with the row's properties and passes it to the CreateAutoGeneratedRow method. Likewise, the GridView control passes an AutoGeneratedFieldProperties object to the CreateAutoGeneratedColumn method when creating an automatically generated column.

Note

This class is typically used only when extending the GridView or DetailsView control.

You can specify the name of the field to bind to an AutoGeneratedField object by setting the DataField property. To specify the data type of the field values, set the Type property. You can prevent users from modifying the field values by setting the IsReadOnly property to true. You can also assign a name to an AutoGeneratedField object by setting the Name property.

Constructors

AutoGeneratedFieldProperties()

Initializes a new instance of the AutoGeneratedFieldProperties class.

Properties

DataField	Gets or sets the name of the field bound to the AutoGeneratedField object.
IsReadOnly	Gets or sets a value indicating whether the values displayed in an AutoGeneratedField object can be modified in edit mode.
Name	Gets or sets the name of the AutoGeneratedField object.
Type	Gets or sets the data type of the value displayed in an AutoGeneratedFieldProperties object.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

IStateManager.IsTrackingViewState	Gets a value indicating whether the AutoGeneratedFieldProperties object is tracking its view-state changes.
IStateManager.LoadViewState(Object)	Loads the previously saved view state of the AutoGeneratedFieldProperties object.
IStateManager.SaveViewState()	Saves the current view state of the AutoGeneratedFieldProperties object.
IStateManager.TrackViewState()	Marks the starting point at which to begin tracking and saving view-state changes to the AutoGeneratedFieldProperties object.

Applies to