/
StringArrayConverter.xml
206 lines (191 loc) · 16.6 KB
/
StringArrayConverter.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
<Type Name="StringArrayConverter" FullName="System.Web.UI.WebControls.StringArrayConverter">
<TypeSignature Language="C#" Value="public class StringArrayConverter : System.ComponentModel.TypeConverter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit StringArrayConverter extends System.ComponentModel.TypeConverter" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.StringArrayConverter" />
<TypeSignature Language="VB.NET" Value="Public Class StringArrayConverter
Inherits TypeConverter" />
<TypeSignature Language="F#" Value="type StringArrayConverter = class
 inherit TypeConverter" />
<TypeSignature Language="C++ CLI" Value="public ref class StringArrayConverter : System::ComponentModel::TypeConverter" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ComponentModel.TypeConverter</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides a type converter to convert a string of comma-separated values to and from an array of strings.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.StringArrayConverter> class converts a string of comma-separated values to and from an array of strings. This class provides the <xref:System.Web.UI.WebControls.StringArrayConverter.ConvertTo%2A> and <xref:System.Web.UI.WebControls.StringArrayConverter.ConvertFrom%2A> methods to perform the type conversions.
This type converter is used by design-time environments to provide values for display in the property grid control for a specified type.
> [!NOTE]
> You should never access a type converter directly. Instead, call the appropriate converter by using the <xref:System.ComponentModel.TypeDescriptor?displayProperty=nameWithType> class. For more information, see the examples in the <xref:System.ComponentModel.TypeConverter> base class.
]]></format>
</remarks>
<altmember cref="M:System.Web.UI.WebControls.StringArrayConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)" />
<altmember cref="M:System.Web.UI.WebControls.StringArrayConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)" />
<altmember cref="T:System.ComponentModel.TypeDescriptor" />
<altmember cref="T:System.ComponentModel.TypeConverter" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/visualstudio/visual-studio-2013/ayybcxe5(v=vs.120)">How to: Implement a Type Converter</related>
<related type="Article" href="https://msdn.microsoft.com/library/49253ae6-7657-4810-82ab-1176a6feeada">Generalized Type Conversion</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public StringArrayConverter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.StringArrayConverter.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 StringArrayConverter();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.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 />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.StringArrayConverter" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
> [!NOTE]
> You should never access a type converter directly. Instead, call the appropriate converter by using a <xref:System.ComponentModel.TypeDescriptor> object. For more information, see the examples in <xref:System.ComponentModel.TypeConverter>.
]]></format>
</remarks>
<related type="Article" href="https://docs.microsoft.com/previous-versions/visualstudio/visual-studio-2013/ayybcxe5(v=vs.120)">How to: Implement a Type Converter</related>
<related type="Article" href="https://msdn.microsoft.com/library/49253ae6-7657-4810-82ab-1176a6feeada">Generalized Type Conversion</related>
</Docs>
</Member>
<Member MemberName="CanConvertFrom">
<MemberSignature Language="C#" Value="public override bool CanConvertFrom (System.ComponentModel.ITypeDescriptorContext context, Type sourceType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool CanConvertFrom(class System.ComponentModel.ITypeDescriptorContext context, class System.Type sourceType) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.StringArrayConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function CanConvertFrom (context As ITypeDescriptorContext, sourceType As Type) As Boolean" />
<MemberSignature Language="F#" Value="override this.CanConvertFrom : System.ComponentModel.ITypeDescriptorContext * Type -> bool" Usage="stringArrayConverter.CanConvertFrom (context, sourceType)" />
<MemberSignature Language="C++ CLI" Value="public:
 override bool CanConvertFrom(System::ComponentModel::ITypeDescriptorContext ^ context, Type ^ sourceType);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
<Parameter Name="sourceType" Type="System.Type" />
</Parameters>
<Docs>
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that provides a format context that can be used to extract additional information about the environment from which this converter is invoked. This parameter or properties of this parameter can be <see langword="null" />.</param>
<param name="sourceType">The <see cref="T:System.Type" /> to convert.</param>
<summary>Determines whether the <see cref="T:System.Web.UI.WebControls.StringArrayConverter" /> can convert the specified source type to an array of strings.</summary>
<returns>
<see langword="true" /> if the converter can perform the operation; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.StringArrayConverter.CanConvertFrom%2A> method determines whether the <xref:System.Web.UI.WebControls.StringArrayConverter> can convert the object specified by `sourceType` to an array of strings. Use this method prior to calling the <xref:System.Web.UI.WebControls.StringArrayConverter.ConvertFrom%2A> method to perform the conversion.
]]></format>
</remarks>
<altmember cref="M:System.Web.UI.WebControls.StringArrayConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)" />
<altmember cref="T:System.ComponentModel.ITypeDescriptorContext" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/visualstudio/visual-studio-2013/ayybcxe5(v=vs.120)">How to: Implement a Type Converter</related>
<related type="Article" href="https://msdn.microsoft.com/library/49253ae6-7657-4810-82ab-1176a6feeada">Generalized Type Conversion</related>
</Docs>
</Member>
<Member MemberName="ConvertFrom">
<MemberSignature Language="C#" Value="public override object ConvertFrom (System.ComponentModel.ITypeDescriptorContext context, System.Globalization.CultureInfo culture, object value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance object ConvertFrom(class System.ComponentModel.ITypeDescriptorContext context, class System.Globalization.CultureInfo culture, object value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.StringArrayConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ConvertFrom (context As ITypeDescriptorContext, culture As CultureInfo, value As Object) As Object" />
<MemberSignature Language="F#" Value="override this.ConvertFrom : System.ComponentModel.ITypeDescriptorContext * System.Globalization.CultureInfo * obj -> obj" Usage="stringArrayConverter.ConvertFrom (context, culture, value)" />
<MemberSignature Language="C++ CLI" Value="public:
 override System::Object ^ ConvertFrom(System::ComponentModel::ITypeDescriptorContext ^ context, System::Globalization::CultureInfo ^ culture, System::Object ^ value);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
<Parameter Name="culture" Type="System.Globalization.CultureInfo" />
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that provides a format context that can be used to extract additional information about the environment from which this converter is invoked. This parameter or properties of this parameter can be <see langword="null" />.</param>
<param name="culture">A <see cref="T:System.Globalization.CultureInfo" /> object. If <see langword="null" />, the current culture is used.</param>
<param name="value">The <see cref="T:System.Object" /> to convert.</param>
<summary>Converts the specified comma-separated string into an array of strings.</summary>
<returns>An <see cref="T:System.Object" /> that represents the converted <paramref name="value" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.StringArrayConverter.ConvertFrom%2A> method parses an object that represents a comma-separated string into an array of strings. Prior to calling this method, you can call the <xref:System.Web.UI.WebControls.StringArrayConverter.CanConvertFrom%2A> method to determine whether the object specified by `value` can be converted to an array of strings.
To convert an array of strings into a comma-separated string, use the <xref:System.Web.UI.WebControls.StringArrayConverter.ConvertTo%2A> method.
]]></format>
</remarks>
<exception cref="T:System.NotSupportedException">The conversion cannot be performed because <paramref name="value" /> is not a string.</exception>
<altmember cref="M:System.Web.UI.WebControls.StringArrayConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)" />
<altmember cref="M:System.Web.UI.WebControls.StringArrayConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/visualstudio/visual-studio-2013/ayybcxe5(v=vs.120)">How to: Implement a Type Converter</related>
<related type="Article" href="https://msdn.microsoft.com/library/49253ae6-7657-4810-82ab-1176a6feeada">Generalized Type Conversion</related>
</Docs>
</Member>
<Member MemberName="ConvertTo">
<MemberSignature Language="C#" Value="public override object ConvertTo (System.ComponentModel.ITypeDescriptorContext context, System.Globalization.CultureInfo culture, object value, Type destinationType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance object ConvertTo(class System.ComponentModel.ITypeDescriptorContext context, class System.Globalization.CultureInfo culture, object value, class System.Type destinationType) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.StringArrayConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ConvertTo (context As ITypeDescriptorContext, culture As CultureInfo, value As Object, destinationType As Type) As Object" />
<MemberSignature Language="F#" Value="override this.ConvertTo : System.ComponentModel.ITypeDescriptorContext * System.Globalization.CultureInfo * obj * Type -> obj" Usage="stringArrayConverter.ConvertTo (context, culture, value, destinationType)" />
<MemberSignature Language="C++ CLI" Value="public:
 override System::Object ^ ConvertTo(System::ComponentModel::ITypeDescriptorContext ^ context, System::Globalization::CultureInfo ^ culture, System::Object ^ value, Type ^ destinationType);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
<Parameter Name="culture" Type="System.Globalization.CultureInfo" />
<Parameter Name="value" Type="System.Object" />
<Parameter Name="destinationType" Type="System.Type" />
</Parameters>
<Docs>
<param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> object that provides a format context that can be used to extract additional information about the environment from which this converter is invoked. This parameter or properties of this parameter can be <see langword="null" />.</param>
<param name="culture">A <see cref="T:System.Globalization.CultureInfo" /> object. If <see langword="null" />, the current culture is used.</param>
<param name="value">The <see cref="T:System.Object" /> to convert.</param>
<param name="destinationType">The <see cref="T:System.Type" /> to convert <paramref name="value" /> to.</param>
<summary>Converts an array of strings into a string of values separated by commas.</summary>
<returns>An <see cref="T:System.Object" /> instance that represents the converted <paramref name="value" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.StringArrayConverter.ConvertTo%2A> method converts an array of strings into a comma-separated string.
To convert a comma-separated string into an array of strings, use the <xref:System.Web.UI.WebControls.StringArrayConverter.ConvertFrom%2A> method.
]]></format>
</remarks>
<exception cref="T:System.NotSupportedException">
<paramref name="destinationType" /> is not of type <see cref="T:System.String" />.</exception>
<altmember cref="M:System.Web.UI.WebControls.StringArrayConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/visualstudio/visual-studio-2013/ayybcxe5(v=vs.120)">How to: Implement a Type Converter</related>
<related type="Article" href="https://msdn.microsoft.com/library/49253ae6-7657-4810-82ab-1176a6feeada">Generalized Type Conversion</related>
</Docs>
</Member>
</Members>
</Type>