ViewStateModeByIdAttribute Class
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Defines the metadata attribute that ASP.NET server controls use to specify whether they participate in loading view-state information by . This class cannot be inherited.

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

SystemObject
   SystemAttribute
    System.Web.UIViewStateModeByIdAttribute

[AttributeUsageAttribute(AttributeTargets.Class)]
public sealed class ViewStateModeByIdAttribute : Attribute
[AttributeUsageAttribute(AttributeTargets::Class)]
public ref class ViewStateModeByIdAttribute sealed : Attribute
[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class)>]
type ViewStateModeByIdAttribute = 
    class
        inherit Attribute
    end
<AttributeUsageAttribute(AttributeTargets.Class)>
Public NotInheritable Class ViewStateModeByIdAttribute
	Inherits Attribute
NameDescription
System_CAPS_pubmethod ViewStateModeByIdAttribute

Initializes a new instance of the ViewStateModeByIdAttribute class.

NameDescription
System_CAPS_pubproperty

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

NameDescription
System_CAPS_pubmethod Equals

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod GetHashCode

Returns the hash code for this instance.(Inherited from Attribute.)

System_CAPS_pubmethod GetType

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

System_CAPS_pubmethod IsDefaultAttribute

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)

System_CAPS_pubmethod Match

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetIDsOfNames

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfo

Retrieves the type information for an object, which can be used to get the type information for an interface.(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeGetTypeInfoCount

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterface System_CAPS_privmethod _AttributeInvoke

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

The ViewStateModeByIdAttribute class is used to specify a control that requires view-state loading by . The default view-state loading behavior is for ASP.NET to load the view-state information for a control by its index in the control tree of the page. There is a performance cost for loading view-state information by because the page control tree must be searched for the control specifically before loading its view-state information.

If the ViewStateModeByIdAttribute class is used as a metadata attribute of a custom control class,

the property of the control returns true. If the ViewStateModeByIdAttribute class is not used, the property of the control returns its default value of false, which means that the control does not load its view-state information by .

For more information about using attributes, see Extending Metadata Using Attributes.

The ViewStateModeByIdAttribute class does not apply to saving the view-state information for a control.

The ViewStateModeByIdAttribute class metadata attribute is valid only on class declarations.

.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