Article
11/18/2011

DefaultPropertyAttribute Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Specifies the default property for a control.

Inheritance Hierarchy

System.Object
System.Attribute
System.ComponentModel.DefaultPropertyAttribute

Namespace: System.ComponentModel
Assembly: System (in System.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class)> _
Public NotInheritable Class DefaultPropertyAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Class)]
public sealed class DefaultPropertyAttribute : Attribute

The DefaultPropertyAttribute type exposes the following members.

Constructors

	Name	Description
	DefaultPropertyAttribute	Initializes a new instance of the DefaultPropertyAttribute class.

Top

Properties

	Name	Description
	Name	Gets the name of the default property for the component this attribute is bound to.

Top

Methods

	Name	Description
	Equals	Returns whether the value of the given object is equal to the current DefaultPropertyAttribute. (Overrides Attribute.Equals(Object).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Overrides Attribute.GetHashCode().)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	Default	Specifies the default value for the DefaultPropertyAttribute, which is nulla null reference (Nothing in Visual Basic). This static field is read-only.

Top

Remarks

Use the Name property to get the name of the default property.

Topic	Location
Developing Custom Data-Bound Web Server Controls for ASP.NET 1.1	Authoring ASP.NET Controls
Walkthrough: Developing and Using a Custom Server Control	Authoring ASP.NET Controls
Developing Custom Data-Bound Web Server Controls for ASP.NET 2.0	Authoring ASP.NET Controls
Walkthrough: Creating a Custom Data-Bound ASP.NET Web Control for ASP.NET 2.0	Authoring ASP.NET Controls
Walkthrough: Creating a Custom Data-Bound ASP.NET Web Control for ASP.NET 1.1	Authoring ASP.NET Controls
Developing Custom Data-Bound Web Server Controls for ASP.NET 1.1	Authoring ASP.NET Controls
Walkthrough: Developing and Using a Custom Server Control	Authoring ASP.NET Controls
Developing Custom Data-Bound Web Server Controls for ASP.NET 2.0	Authoring ASP.NET Controls
Walkthrough: Creating a Custom Data-Bound ASP.NET Web Control for ASP.NET 2.0	Authoring ASP.NET Controls
Walkthrough: Creating a Custom Data-Bound ASP.NET Web Control for ASP.NET 1.1	Authoring ASP.NET Controls
Walkthrough: Developing and Using a Custom Server Control	Authoring ASP.NET Controls
Walkthrough: Developing and Using a Custom Server Control	Authoring ASP.NET Controls
Developing Custom Data-Bound Web Server Controls for ASP.NET 1.1	Authoring ASP.NET Controls
Developing Custom Data-Bound Web Server Controls for ASP.NET 2.0	Authoring ASP.NET Controls
Walkthrough: Creating a Custom Data-Bound ASP.NET Web Control for ASP.NET 2.0	Authoring ASP.NET Controls
Walkthrough: Creating a Custom Data-Bound ASP.NET Web Control for ASP.NET 1.1	Authoring ASP.NET Controls

Examples

The following example defines a control named MyControl. The class is marked with a DefaultPropertyAttribute that specifies MyProperty as the default property.

<DefaultProperty("MyProperty")> _
Public Class MyControl
    Inherits Control

    Public Property MyProperty() As Integer
        Get
            ' Insert code here.
            Return 0
        End Get
        Set(ByVal value As Integer)
            ' Insert code here.
        End Set
    End Property

    ' Insert any additional code.

    [DefaultProperty("MyProperty")]
    public class MyControl : Control
    {

        public int MyProperty
        {
            get
            {
                // Insert code here.
                return 0;
            }
            set
            {
                // Insert code here.
            }
        }

        // Insert any additional code.

Version Information

Silverlight

Supported in: 5, 4

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

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.

Share via