File: XmlNamespaceManager.xml

package info (click to toggle)
monodoc 1.1.18-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 58,432 kB
  • ctags: 4,991
  • sloc: xml: 718,392; cs: 38,337; sh: 3,172; perl: 554; makefile: 303
file content (483 lines) | stat: -rwxr-xr-x 21,029 bytes parent folder | download
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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
<Type Name="XmlNamespaceManager" FullName="System.Xml.XmlNamespaceManager" FullNameSP="System_Xml_XmlNamespaceManager" Maintainer="ecma">
  <TypeSignature Language="ILASM" Value=".class public XmlNamespaceManager extends System.Object implements System.Collections.IEnumerable" />
  <TypeSignature Language="C#" Value="public class XmlNamespaceManager : System.Collections.IEnumerable, System.Xml.IXmlNamespaceResolver" />
  <MemberOfLibrary>XML</MemberOfLibrary>
  <AssemblyInfo>
    <AssemblyName>System.Xml</AssemblyName>
    <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  </AssemblyInfo>
  <ThreadingSafetyStatement>All public static members of this type are safe for multithreaded operations. No instance members are guaranteed to be thread safe.</ThreadingSafetyStatement>
  <Docs>
    <summary>
      <para>Resolves, adds, and removes namespaces in a collection and
      provides scope management for these namespaces. This class is used by
      the <see cref="T:System.Xml.XmlReader" />
      and <see cref="T:System.Xml.XmlTextReader" /> classes.</para>
    </summary>
    <remarks>
      <para>This class stores prefixes and namespaces
      as unique <see cref="T:System.String" qualify="true" />
      objects.</para>
      <para>
        <see cref="T:System.Xml.XmlNamespaceManager" /> assumes all prefixes and
   namespaces are
   valid.</para>
      <para> If the prefix
   and namespace already exist within the current scope, they will replace the existing prefix/namespace combination. The
   same prefix and namespace combination can exist across different scopes.</para>
      <para>The following prefix/namespace pairs are added by default
   to the <see cref="T:System.Xml.XmlNamespaceManager" />. They can be determined at any
   scope.</para>
      <list type="table">
        <listheader>
          <term>Prefix</term>
          <description>Namespace </description>
        </listheader>
        <item>
          <term> xmlns</term>
          <description>http://www.w3.org/2000/xmlns/
         (the xmlns prefix namespace)</description>
        </item>
        <item>
          <term> xml</term>
          <description>http://www.w3.org/XML/1998/namespace (The XML namespace)</description>
        </item>
        <item>
          <term>
            <see cref="F:System.String.Empty" qualify="true" />
          </term>
          <description>
            <see cref="F:System.String.Empty" />. The empty namespace can be reassigned a
   different prefix. For example, <c>xmlns=""</c> defines the default namespace to
be the empty namespace.</description>
        </item>
      </list>
    </remarks>
  </Docs>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>System.Collections.IEnumerable</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>System.Xml.IXmlNamespaceResolver</InterfaceName>
    </Interface>
  </Interfaces>
  <Members>
    <Member MemberName="GetEnumerator">
      <MemberSignature Language="ILASM" Value=".method public hidebysig virtual class System.Collections.IEnumerator GetEnumerator()" />
      <MemberSignature Language="C#" Value="public virtual System.Collections.IEnumerator GetEnumerator ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Collections.IEnumerator</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para>Provides support for iteration over
      the collection of namespaces maintained by the current instance.</para>
        </summary>
        <returns>
          <para>A <see cref="T:System.Collections.IEnumerator" qualify="true" />.</para>
        </returns>
        <remarks>
          <para>
            <block subset="none" type="behaviors"> As described above. </block>
          </para>
          <para>
            <block subset="none" type="overrides">  Override this
      method to customize the behavior of this method in types derived from
      the <see cref="T:System.Xml.XmlNamespaceManager" />
      class.

      </block>
          </para>
          <para>
            <block subset="none" type="usage"> Use this method to iterate through the collection of
      namespaces in <see cref="P:System.Xml.XmlNamespaceManager.NameTable" />.
      </block>
          </para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="HasNamespace">
      <MemberSignature Language="ILASM" Value=".method public hidebysig virtual bool HasNamespace(string prefix)" />
      <MemberSignature Language="C#" Value="public virtual bool HasNamespace (string prefix);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="prefix" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>
          <para>Gets a value indicating whether the supplied prefix has
      a namespace defined for the current pushed scope.</para>
        </summary>
        <param name="prefix">A <see cref="T:System.String" qualify="true" /> containing the prefix of the namespace to find.</param>
        <returns>
          <para>A <see cref="T:System.Boolean" qualify="true" /> where <see langword="true" /> indicates there is a
   namespace defined; otherwise, <see langword="false" />. If <paramref name="prefix" /> is <see langword="null" />, returns <see langword="false" />.</para>
        </returns>
        <remarks>
          <para>
            <block subset="none" type="behaviors"> As described above. </block>
          </para>
          <para>
            <block subset="none" type="default"> When
      <paramref name="prefix" /> is set to <see cref="F:System.String.Empty" qualify="true" />, this method returns
      <see langword="true" /> to indicate a default empty namespace is defined in the current scope. </block>
          </para>
          <para>
            <block subset="none" type="overrides"> Override this
      method to customize the behavior of this method in types derived from
      the <see cref="T:System.Xml.XmlNamespaceManager" />
      class.
      </block>
          </para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="LookupPrefix">
      <MemberSignature Language="ILASM" Value=".method public hidebysig virtual string LookupPrefix(string uri)" />
      <MemberSignature Language="C#" Value="public virtual string LookupPrefix (string uri);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="uri" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>
          <para> Gets the prefix associated with the given
      namespace URI.</para>
        </summary>
        <param name="uri">A <see cref="T:System.String" qualify="true" /> containing the namespace to resolve for the prefix.</param>
        <returns>
          <para>A <see cref="T:System.String" qualify="true" /> containing the
   matching prefix. If there is no mapped prefix, this method returns
<see cref="F:System.String.Empty" />. If a <see langword="null" /> 
value is supplied, then
<see langword="null" /> is returned.</para>
        </returns>
        <remarks>
          <para>
            <block subset="none" type="behaviors"> As described above.
      </block>
          </para>
          <para>
            <block subset="none" type="overrides"> Override this
      method to customize the behavior of this method in types derived from
      the <see cref="T:System.Xml.XmlNamespaceManager" />
      class.
      </block>
          </para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="LookupNamespace">
      <MemberSignature Language="ILASM" Value=".method public hidebysig virtual string LookupNamespace(string prefix)" />
      <MemberSignature Language="C#" Value="public virtual string LookupNamespace (string prefix);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="prefix" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>
          <para>Gets the namespace URI associated with the specified
      prefix.</para>
        </summary>
        <param name="prefix">A <see cref="T:System.String" qualify="true" /> containing the prefix whose namespace URI to resolve. To match the default namespace, pass <see cref="F:System.String.Empty" />.</param>
        <returns>
          <para>A <see cref="T:System.String" qualify="true" /> containing the namespace URI for <paramref name="prefix" />, or <see langword="null" />
if there is
no mapped namespace.</para>
        </returns>
        <remarks>
          <para>
            <block subset="none" type="behaviors"> As described above. </block>
          </para>
          <para>
            <block subset="none" type="overrides">  Override this
      method to customize the behavior of this method in types derived from
      the <see cref="T:System.Xml.XmlNamespaceManager" />
      class.
      </block>
          </para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="RemoveNamespace">
      <MemberSignature Language="ILASM" Value=".method public hidebysig virtual void RemoveNamespace(string prefix, string uri)" />
      <MemberSignature Language="C#" Value="public virtual void RemoveNamespace (string prefix, string uri);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="prefix" Type="System.String" />
        <Parameter Name="uri" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="prefix">A <see cref="T:System.String" qualify="true" /> specifying the prefix.</param>
        <param name="uri">A <see cref="T:System.String" qualify="true" /> specifying the namespace to remove.</param>
        <summary>
          <para>Removes the specified namespace associated with the
      specified prefix from the namespace collection maintained by the current
      instance.</para>
        </summary>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="prefix" /> is <see langword="null" />, or <paramref name="uri" /> is <see langword="null" />.</exception>
        <remarks>
          <para>
            <block subset="none" type="behaviors"> As described above. </block>
          </para>
          <para>
            <block subset="none" type="default"> The namespace
      removed is from the current namespace scope. Namespaces outside the current
      scope are ignored. If <paramref name="prefix" /> or <paramref name=" uri" /> does not exist
      in the collection, this method simply returns. </block>
          </para>
          <para>
            <block subset="none" type="overrides"> Override this
      method to customize the behavior of this method in types derived from
      the <see cref="T:System.Xml.XmlNamespaceManager" />
      class.
      </block>
          </para>
        </remarks>
        <param name="uri">To be added.</param>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="AddNamespace">
      <MemberSignature Language="ILASM" Value=".method public hidebysig virtual void AddNamespace(string prefix, string uri)" />
      <MemberSignature Language="C#" Value="public virtual void AddNamespace (string prefix, string uri);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="prefix" Type="System.String" />
        <Parameter Name="uri" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="prefix">A <see cref="T:System.String" qualify="true" /> specifying the prefix to associate with the namespace being added. Use <see cref="F:System.String.Empty" qualify="true" /> to add a default namespace.</param>
        <param name="uri">A <see cref="T:System.String" /> specifying the namespace to add.</param>
        <summary>
          <para>Adds the given namespace to the collection of namespaces
      maintained by the current instance in <see cref="P:System.Xml.XmlNamespaceManager.NameTable" />.</para>
        </summary>
        <exception cref="T:System.ArgumentException">
          <paramref name="prefix" /> is "xml" or "xmlns".</exception>
        <exception cref="T:System.ArgumentNullException">
          <para>
            <paramref name="prefix" /> is <see langword="null" />, or <paramref name="uri" /> is <see langword="null" />.</para>
        </exception>
        <remarks>
          <block subset="none" type="note">
            <para>The same prefix and namespace combination can exist
         across different scopes.</para>
          </block>
          <para>
            <block subset="none" type="behaviors">
      
      As described above.</block>
          </para>
          <block subset="none" type="default">
            <para> This
      method assumes all prefixes and namespaces are valid but does not check
   <paramref name="prefix" /> and <paramref name="uri" /> for
      conformance to the W3C specification.</para>
            <para> If the specified prefix/namespace
      combination already exists within the current scope,
      their <see cref="T:System.String" /> instances will be replaced
      in <see cref="P:System.Xml.XmlNamespaceManager.NameTable" /> with the
      new <see cref="T:System.String" />
      instances of <paramref name="prefix" /> and <paramref name="uri" />.</para>
          </block>
          <para>
            <block subset="none" type="overrides"> Override this
   method to check <paramref name="prefix" /> and <paramref name=" uri" /> for conformance to the W3C specification. </block>
          </para>
        </remarks>
        <param name="uri">To be added.</param>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="PopScope">
      <MemberSignature Language="ILASM" Value=".method public hidebysig virtual bool PopScope()" />
      <MemberSignature Language="C#" Value="public virtual bool PopScope ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para>Pops a namespace scope off the stack.</para>
        </summary>
        <returns>
          <para>A <see cref="T:System.Boolean" qualify="true" /> where <see langword="true" /> indicates a namespace
   scope was popped off the stack; <see langword="false" /> indicates there were no namespaces
   scopes to pop.</para>
        </returns>
        <remarks>
          <para>
            <block subset="none" type="behaviors"> As described above. </block>
          </para>
          <para>
            <block subset="none" type="default"> This method
      removes all the namespaces that were added to the collection (by calling
      <see cref="M:System.Xml.XmlNamespaceManager.AddNamespace(System.String,System.String)" />)
      since the last call to the <see cref="M:System.Xml.XmlNamespaceManager.PopScope" />
      
      method. </block>
          </para>
          <para>
            <block subset="none" type="overrides"> Override this
      method to customize the behavior of this method in types derived from
      the <see cref="T:System.Xml.XmlNamespaceManager" />
      class.
      </block>
          </para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="PushScope">
      <MemberSignature Language="ILASM" Value=".method public hidebysig virtual void PushScope()" />
      <MemberSignature Language="C#" Value="public virtual void PushScope ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para>Pushes a namespace scope onto the stack.</para>
        </summary>
        <remarks>
          <para>
            <block subset="none" type="behaviors"> As described above. </block>
          </para>
          <para>
            <block subset="none" type="default"> This method associates the pushed namespace scope
      with all the namespaces added to the collection (by calling
      <see cref="M:System.Xml.XmlNamespaceManager.AddNamespace(System.String,System.String)" />) since the last call to the
      <see cref="M:System.Xml.XmlNamespaceManager.PushScope" />
   method.</block>
          </para>
          <para>
            <block subset="none" type="overrides">  Override this
   method to customize the behavior of this method in types derived from
   the <see cref="T:System.Xml.XmlNamespaceManager" />
   class.
</block>
          </para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(class System.Xml.XmlNameTable nameTable)" />
      <MemberSignature Language="C#" Value="public XmlNamespaceManager (System.Xml.XmlNameTable nameTable);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="nameTable" Type="System.Xml.XmlNameTable" />
      </Parameters>
      <Docs>
        <summary>
          <para>Constructs and initializes a new instance of
      the <see cref="T:System.Xml.XmlNamespaceManager" /> class.</para>
        </summary>
        <param name="nameTable">The <see cref="T:System.Xml.XmlNameTable" /> to use.</param>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="nameTable" /> is <see langword="null" />.</exception>
        <remarks>
          <block subset="none" type="note">
            <para>
              <paramref name="nameTable" />
   is used to look up prefixes and namespaces.</para>
          </block>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="NameTable">
      <MemberSignature Language="ILASM" Value=".property class System.Xml.XmlNameTable NameTable { public hidebysig specialname instance class System.Xml.XmlNameTable get_NameTable() }" />
      <MemberSignature Language="C#" Value="public System.Xml.XmlNameTable NameTable { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Xml.XmlNameTable</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para> Gets the name table used by the current instance to look up prefixes and namespace URIs.</para>
        </summary>
        <value>
          <para> The <see cref="T:System.Xml.XmlNameTable" /> used by the current instance.</para>
        </value>
        <remarks>
          <para>This property is read-only.</para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="DefaultNamespace">
      <MemberSignature Language="ILASM" Value=".property string DefaultNamespace { public hidebysig virtual specialname string get_DefaultNamespace() }" />
      <MemberSignature Language="C#" Value="public virtual string DefaultNamespace { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
          <para>Gets the namespace URI for the default
      namespace.</para>
        </summary>
        <value>
          <para>A <see cref="T:System.String" qualify="true" /> containing the
   namespace URI for the default namespace, or <see cref="F:System.String.Empty" />
   if there is no default namespace.</para>
        </value>
        <remarks>
          <para>This property is read-only.</para>
          <para>
            <block subset="none" type="behaviors"> As described
      above. </block>
          </para>
          <para>
            <block subset="none" type="default"> This method is
      equivalent to calling <see cref="M:System.Xml.XmlNamespaceManager.LookupNamespace(System.String)" />
      (<see cref="F:System.String.Empty" />). </block>
          </para>
          <para>
            <block subset="none" type="overrides"> Override this
      property to customize the behavior of this property in types derived from
      the <see cref="T:System.Xml.XmlNamespaceManager" />
      class.
      </block>
          </para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
  </Members>
  <TypeExcluded>0</TypeExcluded>
</Type>