Windows apps
Collapse the table of content
Expand the table of content
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

DesignerSerializationOptionsAttribute Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Specifies the serialization flags for a property.

Namespace:   System.Windows.Markup
Assembly:  WindowsBase (in WindowsBase.dll)


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


Initializes a new instance of the DesignerSerializationOptionsAttribute class.


Gets the DesignerSerializationOptions set on the attribute.


When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)


This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)


Returns the hash code for this instance.(Inherited from Attribute.)


Gets the Type of the current instance.(Inherited from Object.)


When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)


When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)


Returns a string that represents the current object.(Inherited from Object.)

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

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

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


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

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

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.

.NET Framework
Available since 3.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
© 2018 Microsoft