.NET Framework Class Library
ViewStateModeByIdAttribute Class

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

Inheritance Hierarchy
SystemObject
   SystemAttribute
    System.Web.UIViewStateModeByIdAttribute

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)
Syntax
<[%$TOPIC/ms153662_en-us_VS_110_3_0_0_0_0%]([%$TOPIC/ms153662_en-us_VS_110_3_0_0_0_1%].Class)> _
Public NotInheritable Class ViewStateModeByIdAttribute _
	Inherits [%$TOPIC/ms153662_en-us_VS_110_3_0_0_0_2%]
[[%$TOPIC/ms153662_en-us_VS_110_3_0_1_0_0%]([%$TOPIC/ms153662_en-us_VS_110_3_0_1_0_1%].Class)]
public sealed class ViewStateModeByIdAttribute : [%$TOPIC/ms153662_en-us_VS_110_3_0_1_0_2%]
[[%$TOPIC/ms153662_en-us_VS_110_3_0_2_0_0%]([%$TOPIC/ms153662_en-us_VS_110_3_0_2_0_1%]::Class)]
public ref class ViewStateModeByIdAttribute sealed : public [%$TOPIC/ms153662_en-us_VS_110_3_0_2_0_2%]
[<[%$TOPIC/ms153662_en-us_VS_110_3_0_3_0_0%]>]
[<[%$TOPIC/ms153662_en-us_VS_110_3_0_3_0_1%]([%$TOPIC/ms153662_en-us_VS_110_3_0_3_0_2%].Class)>]
type ViewStateModeByIdAttribute =  
    class 
        inherit [%$TOPIC/ms153662_en-us_VS_110_3_0_3_0_3%] 
    end

The ViewStateModeByIdAttribute type exposes the following members.

Constructors
  NameDescription
Public method ViewStateModeByIdAttributeInitializes a new instance of the ViewStateModeByIdAttribute class.
Top
Properties
  NameDescription
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

The ViewStateModeByIdAttribute class is used to specify a control that requires view-state loading by ID. 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 ID 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 LoadViewStateByID property of the control returns true. If the ViewStateModeByIdAttribute class is not used, the LoadViewStateByID property of the control returns its default value of false, which means that the control does not load its view-state information by ID.

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.

Version Information

.NET Framework

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

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.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.