/
TransformerInfo.xml
270 lines (245 loc) · 15.8 KB
/
TransformerInfo.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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
<Type Name="TransformerInfo" FullName="System.Web.Configuration.TransformerInfo">
<TypeSignature Language="C#" Value="public sealed class TransformerInfo : System.Configuration.ConfigurationElement" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed TransformerInfo extends System.Configuration.ConfigurationElement" />
<TypeSignature Language="DocId" Value="T:System.Web.Configuration.TransformerInfo" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class TransformerInfo
Inherits ConfigurationElement" />
<TypeSignature Language="F#" Value="type TransformerInfo = class
 inherit ConfigurationElement" />
<TypeSignature Language="C++ CLI" Value="public ref class TransformerInfo sealed : System::Configuration::ConfigurationElement" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.ConfigurationElement</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Specifies a custom class that extends the <see cref="T:System.Web.UI.WebControls.WebParts.WebPartTransformer" /> class for use by Web Part connections.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Web.Configuration.TransformerInfo> objects specify custom classes that extend the <xref:System.Web.UI.WebControls.WebParts.WebPartTransformer> class. These custom transformer classes act as bridges between Web Parts, translating data between Web Parts with incompatible connection points.
## Examples
The following configuration file excerpt shows how to declaratively specify values for several properties of the <xref:System.Web.Configuration.TransformerInfo> class.
```
<system.web>
<webParts>
<transformers>
<add name="RowToFieldTransformer"
type="System.Web.UI.WebControls.WebParts.RowToFieldTransformer" />
<add name="RowToFilterTransformer"
type="System.Web.UI.WebControls.WebParts.RowToFilterTransformer" />
<add name="RowToParametersTransformer"
type="System.Web.UI.WebControls.WebParts.RowToParametersTransformer" />
</transformers>
</webParts>
</system.web>
```
The following code example shows how to use the <xref:System.Web.Configuration.TransformerInfo> class. This code example is part of a larger example provided for the <xref:System.Web.Configuration.WebPartsSection> class.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/CS/usingwebpartssection.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/VB/usingwebpartssection.vb" id="Snippet2":::
]]></format>
</remarks>
<altmember cref="T:System.Configuration.ConfigurationSection" />
<altmember cref="T:System.Web.Configuration.WebPartsSection" />
<altmember cref="T:System.Web.UI.WebControls.WebParts.WebPartTransformer" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/ms178187(v=vs.100)">Web Parts Connections Overview</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TransformerInfo (string name, string type);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, string type) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Configuration.TransformerInfo.#ctor(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, type As String)" />
<MemberSignature Language="F#" Value="new System.Web.Configuration.TransformerInfo : string * string -> System.Web.Configuration.TransformerInfo" Usage="new System.Web.Configuration.TransformerInfo (name, type)" />
<MemberSignature Language="C++ CLI" Value="public:
 TransformerInfo(System::String ^ name, System::String ^ type);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="type" Type="System.String" />
</Parameters>
<Docs>
<param name="name">The name of this transformer type.</param>
<param name="type">A reference to a type that extends the transformer <see cref="T:System.Web.UI.WebControls.WebParts.WebPartTransformer" /> class.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.Configuration.TransformerInfo" /> class with the specified name and type reference.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The configuration system does not validate the specified type to ensure that a valid type name is used.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.TransformerInfo.%23ctor%28System.String%2CSystem.String%29> constructor. This code example is part of a larger example provided for the <xref:System.Web.Configuration.WebPartsSection> class.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/CS/usingwebpartssection.cs" id="Snippet5":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/VB/usingwebpartssection.vb" id="Snippet5":::
]]></format>
</remarks>
<altmember cref="T:System.Web.Configuration.WebPartsSection" />
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object o);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object o) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Configuration.TransformerInfo.Equals(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (o As Object) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : obj -> bool" Usage="transformerInfo.Equals o" />
<MemberSignature Language="C++ CLI" Value="public:
 override bool Equals(System::Object ^ o);" />
<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="o" Type="System.Object" />
</Parameters>
<Docs>
<param name="o">The object to compare to the current object.</param>
<summary>Compares the current <see cref="T:System.Web.Configuration.TransformerInfo" /> object to another <see cref="T:System.Web.Configuration.TransformerInfo" /> object.</summary>
<returns>
<see langword="true" /> if the passed object is equal to the current object; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<altmember cref="T:System.Web.Configuration.WebPartsSection" />
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Configuration.TransformerInfo.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="transformerInfo.GetHashCode " />
<MemberSignature Language="C++ CLI" Value="public:
 override int GetHashCode();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Generates a hash code for the collection.</summary>
<returns>Unique integer hash code for the current object.</returns>
<remarks>To be added.</remarks>
<altmember cref="T:System.Web.Configuration.WebPartsSection" />
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.TransformerInfo.Name" />
<MemberSignature Language="VB.NET" Value="Public Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="System.Web.Configuration.TransformerInfo.Name" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Name { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("name", DefaultValue="", IsKey=true, IsRequired=true)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("name", DefaultValue="", IsKey=true, IsRequired=true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Configuration.StringValidator(MinLength=1)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.StringValidator(MinLength=1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a friendly name for a type that extends the <see cref="T:System.Web.UI.WebControls.WebParts.WebPartTransformer" /> class.</summary>
<value>A friendly name for a type that extends the <see cref="T:System.Web.UI.WebControls.WebParts.WebPartTransformer" /> class.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.TransformerInfo.Name%2A> property. This code example is part of a larger example provided for the <xref:System.Web.Configuration.WebPartsSection> class.
]]></format>
</remarks>
<altmember cref="T:System.Web.Configuration.WebPartsSection" />
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationPropertyCollection Properties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Configuration.ConfigurationPropertyCollection Properties" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.TransformerInfo.Properties" />
<MemberSignature Language="VB.NET" Value="Protected Overrides ReadOnly Property Properties As ConfigurationPropertyCollection" />
<MemberSignature Language="F#" Value="member this.Properties : System.Configuration.ConfigurationPropertyCollection" Usage="System.Web.Configuration.TransformerInfo.Properties" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property System::Configuration::ConfigurationPropertyCollection ^ Properties { System::Configuration::ConfigurationPropertyCollection ^ get(); };" />
<MemberType>Property</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#">[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.ConfigurationPropertyCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public string Type { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Type" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.TransformerInfo.Type" />
<MemberSignature Language="VB.NET" Value="Public Property Type As String" />
<MemberSignature Language="F#" Value="member this.Type : string with get, set" Usage="System.Web.Configuration.TransformerInfo.Type" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Type { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("type", DefaultValue="", IsRequired=true)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("type", DefaultValue="", IsRequired=true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Configuration.StringValidator(MinLength=1)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.StringValidator(MinLength=1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the type reference for a class that extends the <see cref="T:System.Web.UI.WebControls.WebParts.WebPartTransformer" /> class.</summary>
<value>A type reference for a class that extends the <see cref="T:System.Web.UI.WebControls.WebParts.WebPartTransformer" /> class.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The configuration system does not validate the specified type to ensure that a valid type name is used. However, invalid types will cause exceptions when Web pages are loaded.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.TransformerInfo.Type%2A> property. This code example is part of a larger example provided for the <xref:System.Web.Configuration.WebPartsSection> type.
]]></format>
</remarks>
<altmember cref="T:System.Web.Configuration.WebPartsSection" />
<altmember cref="T:System.Web.UI.WebControls.WebParts.WebPartTransformer" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/ms178187(v=vs.100)">Web Parts Connections Overview</related>
</Docs>
</Member>
</Members>
</Type>