ControlValuePropertyAttribute Class
Specifies the default property of a control that a ControlParameter object binds to at run time. This class cannot be inherited.
Namespace: System.Web.UI
Assembly: System.Web (in System.Web.dll)
The ControlValuePropertyAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | ControlValuePropertyAttribute(String) | Initializes a new instance of the ControlValuePropertyAttribute class using the specified property name. |
![]() | ControlValuePropertyAttribute(String, Object) | Initializes a new instance of the ControlValuePropertyAttribute class using the specified property name and default value. |
![]() | ControlValuePropertyAttribute(String, Type, String) | Initializes a new instance of the ControlValuePropertyAttribute class using the specified property name and default value. The default value is also converted to the specified data type. |
| Name | Description | |
|---|---|---|
![]() | Equals | Determines whether the current instance of the ControlValuePropertyAttribute object is equal to the specified object. (Overrides Attribute.Equals(Object).) |
![]() | GetHashCode | Returns the hash code for this instance. (Overrides Attribute.GetHashCode().) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | 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.) |
![]() | Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() ![]() | _Attribute.GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
![]() ![]() | _Attribute.GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
![]() ![]() | _Attribute.GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
![]() ![]() | _Attribute.Invoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
When defining a ControlParameter object, you typically bind a control's property to a parameter by setting both the ControlID and PropertyName properties. If the PropertyName property is not set, a default property is used. The ControlValuePropertyAttribute attribute is applied to a control to specify its default property that a ControlParameter object binds to at run time.
For more information about using attributes, see Extending Metadata Using Attributes.
For a list of initial property values for an instance of the ControlValuePropertyAttribute class, see the ControlValuePropertyAttribute constructor.
The following code example demonstrates how to apply a ControlValuePropertyAttribute attribute that specifies a default property and value to a custom control.
using System; using System.Collections.Generic; using System.ComponentModel; using System.Text; using System.Web.UI; using System.Web.UI.WebControls; namespace Samples.AspNet.CS.Controls { // Set ControlValueProperty attribute to specify the default // property of this control that a ControlParameter object // binds to at run time. [DefaultProperty("Text")] [ControlValueProperty("Text", "Default Text")] public class SimpleCustomControl : WebControl { private string text; [Bindable(true)] [Category("Appearance")] [DefaultValue("")] public string Text { get { return text; } set { text = value; } } protected override void Render(HtmlTextWriter output) { output.Write(Text); } } }
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.
