/
SettingsSerializeAsAttribute.xml
159 lines (148 loc) · 10 KB
/
SettingsSerializeAsAttribute.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
<Type Name="SettingsSerializeAsAttribute" FullName="System.Configuration.SettingsSerializeAsAttribute">
<TypeSignature Language="C#" Value="public sealed class SettingsSerializeAsAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SettingsSerializeAsAttribute extends System.Attribute" />
<TypeSignature Language="DocId" Value="T:System.Configuration.SettingsSerializeAsAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class SettingsSerializeAsAttribute
Inherits Attribute" />
<TypeSignature Language="F#" Value="type SettingsSerializeAsAttribute = class
 inherit Attribute" />
<TypeSignature Language="C++ CLI" Value="public ref class SettingsSerializeAsAttribute sealed : Attribute" />
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Configuration.ConfigurationManager</AssemblyName>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeForwardingChain>
<TypeForwarding From="System.Configuration.ConfigurationManager" FromVersion="9.0.0.0" To="System" ToVersion="4.0.0.0" FrameworkAlternate="netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
</TypeForwardingChain>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Property)]</AttributeName>
<AttributeName Language="F#">[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Property)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Specifies the serialization mechanism that the settings provider should use. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A settings provider often supports more than one of the .NET Framework standard serialization schemes. These schemes are outlined by the <xref:System.Configuration.SettingsSerializeAs> enumeration, and include plain text, XML, and binary serialization. In addition, a provider may optionally support a custom serialization scheme.
With the <xref:System.Configuration.SettingsSerializeAsAttribute>, you can specify which serialization mechanism should be used for a given application settings class or property. This attribute is considered a request to the settings provider. It may be ignored or cause an error if the provider or the individual property type does not support the specified serialization scheme. If this attribute is not present, the provider will usually provide a default serialization mechanism, most commonly plain text.
Although the settings provider may provide a way to dynamically change the serialization mechanism during run time, this is not a typical capability.
]]></format>
</remarks>
<altmember cref="T:System.Configuration.SettingsProvider" />
<altmember cref="T:System.Configuration.SettingsSerializeAs" />
<altmember cref="P:System.Configuration.SettingsProperty.SerializeAs" />
<altmember cref="P:System.Configuration.SettingElement.SerializeAs" />
<altmember cref="T:System.Configuration.ISettingsProviderService" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SettingsSerializeAsAttribute (System.Configuration.SettingsSerializeAs serializeAs);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Configuration.SettingsSerializeAs serializeAs) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Configuration.SettingsSerializeAsAttribute.#ctor(System.Configuration.SettingsSerializeAs)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (serializeAs As SettingsSerializeAs)" />
<MemberSignature Language="F#" Value="new System.Configuration.SettingsSerializeAsAttribute : System.Configuration.SettingsSerializeAs -> System.Configuration.SettingsSerializeAsAttribute" Usage="new System.Configuration.SettingsSerializeAsAttribute serializeAs" />
<MemberSignature Language="C++ CLI" Value="public:
 SettingsSerializeAsAttribute(System::Configuration::SettingsSerializeAs serializeAs);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Configuration.ConfigurationManager</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="serializeAs" Type="System.Configuration.SettingsSerializeAs" />
</Parameters>
<Docs>
<param name="serializeAs">A <see cref="T:System.Configuration.SettingsSerializeAs" /> enumerated value that specifies the serialization scheme.</param>
<summary>Initializes an instance of the <see cref="T:System.Configuration.SettingsSerializeAsAttribute" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If the settings provider or the type of the property to be converted does not support the serialization scheme specified by the `serializeAs` parameter, the operation may have one of the following results:
- The settings provider may ignore the attribute and use its default serialization scheme.
- The serialization process may fail without a response. The application settings property will not be persisted.
- An exception may be raised during serialization.
]]></format>
</remarks>
<altmember cref="T:System.Configuration.SettingsSerializeAs" />
</Docs>
</Member>
<Member MemberName="SerializeAs">
<MemberSignature Language="C#" Value="public System.Configuration.SettingsSerializeAs SerializeAs { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Configuration.SettingsSerializeAs SerializeAs" />
<MemberSignature Language="DocId" Value="P:System.Configuration.SettingsSerializeAsAttribute.SerializeAs" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SerializeAs As SettingsSerializeAs" />
<MemberSignature Language="F#" Value="member this.SerializeAs : System.Configuration.SettingsSerializeAs" Usage="System.Configuration.SettingsSerializeAsAttribute.SerializeAs" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Configuration::SettingsSerializeAs SerializeAs { System::Configuration::SettingsSerializeAs get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Configuration.ConfigurationManager</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Configuration.SettingsSerializeAs</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Configuration.SettingsSerializeAs" /> enumeration value that specifies the serialization scheme.</summary>
<value>A <see cref="T:System.Configuration.SettingsSerializeAs" /> enumerated value that specifies the serialization scheme.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property is set in the <xref:System.Configuration.SettingsSerializeAsAttribute.%23ctor%2A> constructor.
]]></format>
</remarks>
<altmember cref="T:System.Configuration.SettingsSerializeAs" />
<altmember cref="P:System.Configuration.SettingsProperty.SerializeAs" />
<altmember cref="P:System.Configuration.SettingElement.SerializeAs" />
</Docs>
</Member>
</Members>
</Type>