DefaultInterfaceAttribute Class

Definition

Specifies the default interface of a managed Windows Runtime class.

public ref class DefaultInterfaceAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface, AllowMultiple=false, Inherited=false)]
public sealed class DefaultInterfaceAttribute : Attribute
type DefaultInterfaceAttribute = class
    inherit Attribute
Public NotInheritable Class DefaultInterfaceAttribute
Inherits Attribute
Inheritance
DefaultInterfaceAttribute
Attributes

Remarks

When you develop Windows Runtime Components, use this attribute when you want to specify the default interface that is used to marshal the class the attribute is applied to. This is not necessary if you allow the class interfaces to be generated automatically.

A Windows Runtime class must have a default interface. If the WinMdExp.exe utility does not detect a default interface for a class when it builds your Windows Runtimecomponent, it chooses an interface as follows:

  • If the class has automatically generated interfaces, it uses the first one as the default.

  • If the class doesn't have any automatically generated interfaces, it uses the first interface in the class's interface implementation list.

You can apply the DefaultInterfaceAttribute attribute to the class, or apply the Windows.Foundations.Metadata.DefaultAttribute attribute to an interface. The latter takes precedence if both attributes are supplied.

Constructors

DefaultInterfaceAttribute(Type)

Initializes a new instance of the DefaultInterfaceAttribute class.

Properties

DefaultInterface

Gets the type of the default interface.

TypeId

When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object)

Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode()

Returns the hash code for this instance.

(Inherited from Attribute)
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(Object)

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)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

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

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to