/
TagMapInfo.xml
316 lines (287 loc) · 18.5 KB
/
TagMapInfo.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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
<Type Name="TagMapInfo" FullName="System.Web.Configuration.TagMapInfo">
<TypeSignature Language="C#" Value="public sealed class TagMapInfo : System.Configuration.ConfigurationElement" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed TagMapInfo extends System.Configuration.ConfigurationElement" />
<TypeSignature Language="DocId" Value="T:System.Web.Configuration.TagMapInfo" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class TagMapInfo
Inherits ConfigurationElement" />
<TypeSignature Language="F#" Value="type TagMapInfo = class
 inherit ConfigurationElement" />
<TypeSignature Language="C++ CLI" Value="public ref class TagMapInfo 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>Contains a single configuration tag remapping statement. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Configuration.TagMapInfo> class allows you to remap the types of tags at compile time. This remapping causes the mapped type to be used in place of the original tag type for all pages and controls in the ASP.NET application in the scope of the configuration file.
The <xref:System.Web.Configuration.TagMapCollection> class allows you to programmatically access and modify the `tagMapping` subsection of the `pages` section of a configuration file. Within the `tagMappings` subsection, you can add and remove mappings between tag types by specifying the fully qualified strong names of the types.
> [!NOTE]
> Unlike other attributes and collections in the `pages` section, tag remapping has no matching ASP.NET page directive.
## Examples
The following configuration file excerpt shows how to declaratively specify values for several properties of the <xref:System.Web.Configuration.TagMapInfo> class.
```
<system.web>
<pages>
<tagMapping>
<add
tagType=
"System.Web.UI.WebControls.WebParts.WebPartManager"
mappedTagType=
"Microsoft.Sharepoint.WebPartPartManager,
MSPS.Web.dll, Version='2.0.0.0'"
/>
</tagMapping>
</pages>
</system.web>
```
The following code example shows how to use the <xref:System.Web.Configuration.TagMapCollection> class to programmatically modify tag-mapping settings. This code example is part of a larger example provided for the <xref:System.Web.Configuration.PagesSection> class.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/CS/usingpagessection.cs" id="Snippet17":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/VB/usingpagessection.vb" id="Snippet17":::
]]></format>
</remarks>
<altmember cref="T:System.Web.Configuration.PagesSection" />
<altmember cref="T:System.Web.Configuration.TagMapCollection" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TagMapInfo (string tagTypeName, string mappedTagTypeName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string tagTypeName, string mappedTagTypeName) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Configuration.TagMapInfo.#ctor(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (tagTypeName As String, mappedTagTypeName As String)" />
<MemberSignature Language="F#" Value="new System.Web.Configuration.TagMapInfo : string * string -> System.Web.Configuration.TagMapInfo" Usage="new System.Web.Configuration.TagMapInfo (tagTypeName, mappedTagTypeName)" />
<MemberSignature Language="C++ CLI" Value="public:
 TagMapInfo(System::String ^ tagTypeName, System::String ^ mappedTagTypeName);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="tagTypeName" Type="System.String" />
<Parameter Name="mappedTagTypeName" Type="System.String" />
</Parameters>
<Docs>
<param name="tagTypeName">The fully qualified name of the type for the tag that is being remapped.</param>
<param name="mappedTagTypeName">The name of the type to which the tag is remapped, along with the supporting details.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.Configuration.TagMapInfo" /> class based on the passed property values.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.TagMapInfo.%23ctor%2A> constructor. This code example is part of a larger example provided for the <xref:System.Web.Configuration.PagesSection> class.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/CS/usingpagessection.cs" id="Snippet42":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/VB/usingpagessection.vb" id="Snippet42":::
]]></format>
</remarks>
<altmember cref="T:System.Web.Configuration.PagesSection" />
<altmember cref="P:System.Web.Configuration.TagMapInfo.TagType" />
<altmember cref="P:System.Web.Configuration.TagMapInfo.MappedTagType" />
<altmember cref="P:System.Type.AssemblyQualifiedName" />
<related type="Article" href="/dotnet/standard/assembly/names">Assembly Names</related>
</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.TagMapInfo.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="tagMapInfo.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">Object to compare.</param>
<summary>Compares this instance to another object.</summary>
<returns>
<see langword="true" /> if the objects are identical; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<altmember cref="T:System.Web.Configuration.PagesSection" />
</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.TagMapInfo.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="tagMapInfo.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>Returns a hash value for the current instance.</summary>
<returns>A hash value for the current instance.</returns>
<remarks>To be added.</remarks>
<altmember cref="T:System.Web.Configuration.PagesSection" />
</Docs>
</Member>
<Member MemberName="MappedTagType">
<MemberSignature Language="C#" Value="public string MappedTagType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string MappedTagType" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.TagMapInfo.MappedTagType" />
<MemberSignature Language="VB.NET" Value="Public Property MappedTagType As String" />
<MemberSignature Language="F#" Value="member this.MappedTagType : string with get, set" Usage="System.Web.Configuration.TagMapInfo.MappedTagType" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ MappedTagType { 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("mappedTagType")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("mappedTagType")>]</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 name of the type to which the tag is remapped.</summary>
<value>The name of the type to which the tag is remapped. The default is an empty string.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Tag remapping occurs at compile time. This remapping causes the mapped type (specified by the <xref:System.Web.Configuration.TagMapInfo.MappedTagType%2A> property) to be used in place of the original tag type (specified by the <xref:System.Web.Configuration.TagMapInfo.TagType%2A> property) for all pages and controls in the ASP.NET application in the scope of the configuration file.
> [!NOTE]
> An empty string value for this property will cause the configuration system to throw an exception when the object is serialized.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.TagMapInfo.MappedTagType%2A> property. It is part of a larger example for the <xref:System.Web.Configuration.PagesSection> type.
]]></format>
</remarks>
<altmember cref="T:System.Web.Configuration.PagesSection" />
<altmember cref="P:System.Web.Configuration.TagMapInfo.MappedTagType" />
<altmember cref="P:System.Type.AssemblyQualifiedName" />
<related type="Article" href="/dotnet/standard/assembly/names">Assembly Names</related>
</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.TagMapInfo.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.TagMapInfo.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="SerializeElement">
<MemberSignature Language="C#" Value="protected override bool SerializeElement (System.Xml.XmlWriter writer, bool serializeCollectionKey);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance bool SerializeElement(class System.Xml.XmlWriter writer, bool serializeCollectionKey) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Configuration.TagMapInfo.SerializeElement(System.Xml.XmlWriter,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function SerializeElement (writer As XmlWriter, serializeCollectionKey As Boolean) As Boolean" />
<MemberSignature Language="F#" Value="override this.SerializeElement : System.Xml.XmlWriter * bool -> bool" Usage="tagMapInfo.SerializeElement (writer, serializeCollectionKey)" />
<MemberSignature Language="C++ CLI" Value="protected:
 override bool SerializeElement(System::Xml::XmlWriter ^ writer, bool serializeCollectionKey);" />
<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="writer" Type="System.Xml.XmlWriter" />
<Parameter Name="serializeCollectionKey" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="writer">To be added.</param>
<param name="serializeCollectionKey">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TagType">
<MemberSignature Language="C#" Value="public string TagType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TagType" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.TagMapInfo.TagType" />
<MemberSignature Language="VB.NET" Value="Public Property TagType As String" />
<MemberSignature Language="F#" Value="member this.TagType : string with get, set" Usage="System.Web.Configuration.TagMapInfo.TagType" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ TagType { 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("tagType", DefaultValue="", IsKey=true, IsRequired=true)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("tagType", 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 the name of the original type for the tag that is being remapped.</summary>
<value>The name of the original type for the tag that is being remapped.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Tag remapping occurs at compile time. This remapping causes the mapped type (specified by the <xref:System.Web.Configuration.TagMapInfo.MappedTagType%2A> property) to be used in place of the original tag type (specified by the <xref:System.Web.Configuration.TagMapInfo.TagType%2A> property) for all pages and controls in the ASP.NET application in the scope of the configuration file.
> [!NOTE]
> An empty string value for this property will cause the configuration system to throw an exception when the object is serialized.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.TagMapInfo.TagType%2A> property. This code example is part of a larger example provided for the <xref:System.Web.Configuration.PagesSection> class.
]]></format>
</remarks>
<altmember cref="T:System.Web.Configuration.PagesSection" />
<altmember cref="P:System.Web.Configuration.TagMapInfo.MappedTagType" />
<altmember cref="P:System.Type.AssemblyQualifiedName" />
<related type="Article" href="/dotnet/standard/assembly/names">Assembly Names</related>
</Docs>
</Member>
</Members>
</Type>