DesignerSerializationOptionsAttribute Class

Definition

Namespace:

System.Windows.Markup

Assembly:

WindowsBase.dll

Specifies the serialization flags for a property.

public ref class DesignerSerializationOptionsAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Property, AllowMultiple=false)]
public sealed class DesignerSerializationOptionsAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Method | System.AttributeTargets.Property, AllowMultiple=false)>]
type DesignerSerializationOptionsAttribute = class
    inherit Attribute

Public NotInheritable Class DesignerSerializationOptionsAttribute
Inherits Attribute

Inheritance

Object

Attribute

DesignerSerializationOptionsAttribute

Attributes

AttributeUsageAttribute

Remarks

DesignerSerializationOptionsAttribute provides a constraint hint for the form that designers and design surfaces should use when interacting with the attributed property. Generally the reason for doing so is to hint SerializeAsAttribute. You might do this in cases where interacting with that property as a content-serialized form of the string has risk of introducing spurious white space. An example case where DesignerSerializationOptionsAttribute is applied for this reason is FrameworkElement.Name.

Attribute usage for DesignerSerializationOptionsAttribute supports assigning to a method. This enables you to declare serialization options for a XAML attached property, by assigning DesignerSerializationOptionsAttribute on the Get accessor method that supports the attached property usage pattern. An example of this in the WPF types is XmlSpace and its Get accessor GetXmlSpace.

Note that DesignerSerializationOptionsAttribute hints the desired serialization form, not whether the property is or is not serialized. If you want to influence other aspects of property serialization, you can use DesignerSerializationVisibilityAttribute, or can implement ShouldSerialize pattern methods on the owner class. For more information on the general .NET serialization patterns for design time, see Designer Serialization Overview.

Constructors

DesignerSerializationOptionsAttribute(DesignerSerializationOptions)

Initializes a new instance of the DesignerSerializationOptionsAttribute class.

Properties

DesignerSerializationOptions	Gets the DesignerSerializationOptions set on the attribute.
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)