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.

Constructors

Name	Description
DesignerSerializationOptionsAttribute(DesignerSerializationOptions)	Initializes a new instance of the DesignerSerializationOptionsAttribute class.

Properties

Name	Description
DesignerSerializationOptions	Gets the DesignerSerializationOptions set on the attribute.