-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
TypeNameConverter.xml
217 lines (199 loc) · 12.7 KB
/
TypeNameConverter.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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
<Type Name="TypeNameConverter" FullName="System.Configuration.TypeNameConverter">
<TypeSignature Language="C#" Value="public sealed class TypeNameConverter : System.Configuration.ConfigurationConverterBase" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit TypeNameConverter extends System.Configuration.ConfigurationConverterBase" />
<TypeSignature Language="DocId" Value="T:System.Configuration.TypeNameConverter" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class TypeNameConverter
Inherits ConfigurationConverterBase" />
<TypeSignature Language="F#" Value="type TypeNameConverter = class
 inherit ConfigurationConverterBase" />
<TypeSignature Language="C++ CLI" Value="public ref class TypeNameConverter sealed : System::Configuration::ConfigurationConverterBase" />
<AssemblyInfo>
<AssemblyName>System.Configuration</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.Configuration" 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.Configuration.ConfigurationConverterBase</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Converts between type and string values. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This type, like all the other configuration converter types, converts strings found in the configuration file to and from the related strongly typed properties.
In particular, the <xref:System.Configuration.TypeNameConverter> class converts a <xref:System.String> value, assigned to a configuration type, to a <xref:System.Type> value and vice versa. The type referred to is the class responsible for processing the configuration it is associated with.
## Examples
The following example shows how to obtain a type associated with a custom section. For the implementation of the custom section, refer to the code example in the <xref:System.Configuration.ConfigurationConverterBase> class reference.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Configuration.TypeNameConverter/CS/TypeNameConverter.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Configuration.TypeNameConverter/VB/TypeNameConverter.vb" id="Snippet1":::
The following example is a configuration excerpt used by the previous example.
```xml
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<configSections>
<section name="CustomSection"
type="Samples.AspNet.CustomSection,
ConfigurationConverters,
Version=1.0.0.0, Culture=neutral,
PublicKeyToken=null"
allowDefinition="Everywhere"
allowExeDefinition="MachineToApplication"
restartOnExternalChanges="true" />
</configSections>
<CustomSection fileName="default.txt" maxIdleTime="90"
timeDelay="infinite" cdStr="str0, str1" permission="Read"
maxUsers="Infinite"/>
</configuration>
```
]]></format>
</remarks>
<altmember cref="T:System.Configuration.GenericEnumConverter" />
<altmember cref="T:System.Configuration.InfiniteIntConverter" />
<altmember cref="T:System.Configuration.InfiniteTimeSpanConverter" />
<altmember cref="T:System.Configuration.TimeSpanMinutesOrInfiniteConverter" />
<altmember cref="T:System.Configuration.TimeSpanSecondsConverter" />
<altmember cref="T:System.Configuration.TimeSpanSecondsOrInfiniteConverter" />
<altmember cref="T:System.Configuration.WhiteSpaceTrimStringConverter" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TypeNameConverter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Configuration.TypeNameConverter.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 TypeNameConverter();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Configuration</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>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Configuration.TypeNameConverter" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Normally, you use the converter types provided by the system. The only time you need to use the <xref:System.Configuration.TypeNameConverter.%23ctor%2A> constructor is when you create your own conversion type.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ConvertFrom">
<MemberSignature Language="C#" Value="public override object ConvertFrom (System.ComponentModel.ITypeDescriptorContext ctx, System.Globalization.CultureInfo ci, object data);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance object ConvertFrom(class System.ComponentModel.ITypeDescriptorContext ctx, class System.Globalization.CultureInfo ci, object data) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Configuration.TypeNameConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ConvertFrom (ctx As ITypeDescriptorContext, ci As CultureInfo, data As Object) As Object" />
<MemberSignature Language="F#" Value="override this.ConvertFrom : System.ComponentModel.ITypeDescriptorContext * System.Globalization.CultureInfo * obj -> obj" Usage="typeNameConverter.ConvertFrom (ctx, ci, data)" />
<MemberSignature Language="C++ CLI" Value="public:
 override System::Object ^ ConvertFrom(System::ComponentModel::ITypeDescriptorContext ^ ctx, System::Globalization::CultureInfo ^ ci, System::Object ^ data);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Configuration</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>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="ctx" Type="System.ComponentModel.ITypeDescriptorContext" />
<Parameter Name="ci" Type="System.Globalization.CultureInfo" />
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<param name="ctx">The <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object used for type conversions.</param>
<param name="ci">The <see cref="T:System.Globalization.CultureInfo" /> object used during conversion.</param>
<param name="data">The <see cref="T:System.String" /> object to convert.</param>
<summary>Converts a <see cref="T:System.String" /> object to a <see cref="T:System.Type" /> object.</summary>
<returns>The <see cref="T:System.Type" /> that represents the <paramref name="data" /> parameter.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The system uses the <xref:System.Configuration.TypeNameConverter.ConvertFrom%2A> method when reading from a configuration file to convert a <xref:System.String> value to a <xref:System.Type> value.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">The <see cref="T:System.Type" /> value cannot be resolved.</exception>
</Docs>
</Member>
<Member MemberName="ConvertTo">
<MemberSignature Language="C#" Value="public override object ConvertTo (System.ComponentModel.ITypeDescriptorContext ctx, System.Globalization.CultureInfo ci, object value, Type type);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance object ConvertTo(class System.ComponentModel.ITypeDescriptorContext ctx, class System.Globalization.CultureInfo ci, object value, class System.Type type) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Configuration.TypeNameConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ConvertTo (ctx As ITypeDescriptorContext, ci As CultureInfo, value As Object, type As Type) As Object" />
<MemberSignature Language="F#" Value="override this.ConvertTo : System.ComponentModel.ITypeDescriptorContext * System.Globalization.CultureInfo * obj * Type -> obj" Usage="typeNameConverter.ConvertTo (ctx, ci, value, type)" />
<MemberSignature Language="C++ CLI" Value="public:
 override System::Object ^ ConvertTo(System::ComponentModel::ITypeDescriptorContext ^ ctx, System::Globalization::CultureInfo ^ ci, System::Object ^ value, Type ^ type);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Configuration</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>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="ctx" Type="System.ComponentModel.ITypeDescriptorContext" />
<Parameter Name="ci" Type="System.Globalization.CultureInfo" />
<Parameter Name="value" Type="System.Object" />
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<param name="ctx">The <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object used for type conversions.</param>
<param name="ci">The <see cref="T:System.Globalization.CultureInfo" /> object used during conversion.</param>
<param name="value">The value to convert to.</param>
<param name="type">The type to convert to.</param>
<summary>Converts a <see cref="T:System.Type" /> object to a <see cref="T:System.String" /> object.</summary>
<returns>The <see cref="T:System.String" /> that represents the <paramref name="value" /> parameter.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The system uses the <xref:System.Configuration.TypeNameConverter.ConvertTo%2A> method when writing to a configuration file to convert a <xref:System.Type> value to a <xref:System.String> value.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>