ConstructorArgumentAttribute Class

Definition

Namespace:

System.Windows.Markup

Assembly:

System.Xaml.dll

Specifies that an object can be initialized by using a non-parameterless constructor syntax, and that a property of the specified name supplies construction information. This information is primarily for XAML serialization.

public ref class ConstructorArgumentAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)]
public sealed class ConstructorArgumentAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false, Inherited=false)>]
type ConstructorArgumentAttribute = class
    inherit Attribute

Public NotInheritable Class ConstructorArgumentAttribute
Inherits Attribute

Inheritance

Object

Attribute

ConstructorArgumentAttribute

Attributes

AttributeUsageAttribute

Remarks

This attribute specifies that the associated property can be initialized by a constructor parameter and should be ignored for XAML serialization if the constructor is used to construct the instance. This provides better round trip representations for parameterized constructor syntax rather than parameterless constructor instantiation plus specific attributes.

A framework can potentially support preserving markup extension usages and reconstituting them rather than relying on ProvideValue output in the object tree for serialization. In this case, the ConstructorArgumentAttribute information is useful during serialization for producing an accurate representation of the typical markup extension usage. For more information about markup extensions, see Markup Extensions for XAML Overview.

In order to be valid for a ConstructorArgumentAttribute attribution, a type's public non-parameterless constructor must support exactly one parameter. The name of the parameter must correspond to a read/write property. The property must be otherwise serializable. You use this attribute to create the correspondence between the name of the parameter in the constructor, and the property. Specifically, you apply this attribute to the property-level definition of the connecting read/write property.

Consumers of ConstructorArgumentAttribute may throw in cases where ArgumentName does not resolve to type backing, or when applied to a type that does not have the appropriate construction arguments and arity.

In previous versions of the .NET Framework, this class existed in the WPF-specific assembly WindowsBase. In .NET Framework 4, ConstructorArgumentAttribute is in the System.Xaml assembly. For more information, see Types Migrated from WPF to System.Xaml.

WPF Usage Notes

For more information about markup extensions and WPF, see Markup Extensions and WPF XAML.

Constructors

ConstructorArgumentAttribute(String)

Initializes a new instance of the ConstructorArgumentAttribute class.

Properties

ArgumentName	Gets the name parameter of the constructor that will initialize the associated property.
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)

See also

• MarkupExtension
• XAML-related CLR attributes for custom types and libraries
• Define custom types for use with .NET XAML Services
• XAML Services
• Type Converters and Markup Extensions for XAML