0 out of 1 rated this helpful - Rate this topic

DefaultPropertyAttribute Class

.NET Framework 4.5

Other Versions

Specifies the default property for a component.

Inheritance Hierarchy

System.Object
System.Attribute
System.ComponentModel.DefaultPropertyAttribute

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

Syntax

C++

[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.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Methods

	Name	Description
	Equals	Returns whether the value of the given object is equal to the current DefaultPropertyAttribute. (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.)

Top

Fields

	Name	Description
	Default	Specifies the default value for the DefaultPropertyAttribute, which is null. This static field is read-only.

Top

Explicit Interface Implementations

	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.)

Top

Remarks

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

For more information, see Extending Metadata Using Attributes.

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
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
Developing Custom Data-Bound Web Server Controls for ASP.NET 1.1	Building ASP .NET Web Applications in Visual Studio
Walkthrough: Creating a Custom Data-Bound ASP.NET Web Control for ASP.NET 1.1	Building ASP .NET Web Applications in Visual Studio

Examples

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

C++

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

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

    // Insert any additional code.

 }

The next example creates an instance of MyControl. Then it gets the attributes for the class, extracts the DefaultPropertyAttribute, and prints the name of the default property.

C++

public static int Main() {
    // Creates a new control.
    MyControl myNewControl = new MyControl();

    // Gets the attributes for the collection.
    AttributeCollection attributes = TypeDescriptor.GetAttributes(myNewControl);

    /* Prints the name of the default property by retrieving the 
     * DefaultPropertyAttribute from the AttributeCollection. */
    DefaultPropertyAttribute myAttribute = 
       (DefaultPropertyAttribute)attributes[typeof(DefaultPropertyAttribute)];
    Console.WriteLine("The default property is: " + myAttribute.Name);

    return 0;
 }

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

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.

Reference

System.ComponentModel Namespace

Attribute

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)