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 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
|
<Type Name="XmlTextWriter" FullName="System.Xml.XmlTextWriter" FullNameSP="System_Xml_XmlTextWriter" Maintainer="ecma">
<TypeSignature Language="ILASM" Value=".class public XmlTextWriter extends System.Xml.XmlWriter" />
<TypeSignature Language="C#" Value="public class XmlTextWriter : System.Xml.XmlWriter" />
<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> Represents a writer that provides a fast, non-cached, forward-only way
of generating streams or files containing XML data that conforms to the
W3C Extensible Markup Language (XML) 1.0 and the Namespaces in XML
recommendations.
</para>
</summary>
<remarks>
<para> This class maintains a namespace stack corresponding to
all the namespaces defined in the current element stack. Namespaces can be
declared manually to override the current namespace declaration. Prefixes can be
specified to associate with a namespace. If there are multiple namespace declarations mapping different prefixes to the
same namespace URI, this class walks the stack of namespace declarations backwards
and picks the closest one.</para>
<para> If namespace conflicts occur inside an element, this
class resolves the conflict by generating alternate prefixes. The generated
prefixes are named <c>ni</c>, where <c>n</c> is the literal character 'n' and <c>i</c> is a number beginning at one. The number is reset
to one for each element. See the example section
for a demonstration of this behavior.</para>
<para>Attributes which are associated with a namespace URI
must have a prefix (default namespaces do not apply to attributes). This
conforms to section 5.2 of the W3C Namespaces in XML recommendation. If an
attribute references a namespace URI, but does not specify a prefix, the writer
generates a prefix for the attribute.</para>
<para>When writing an empty element, an additional space is
added between tag name and the closing tag, for example <c><item /></c>. This provides compatibility
with older browsers.</para>
<para>When a <see cref="T:System.String" /> is used as method
parameter, <see langword="null" /> and <see cref="F:System.String.Empty" /> are equivalent.
<see cref="F:System.String.Empty" /> follows
the W3C rules.</para>
<para>This class implements the <see cref="T:System.Xml.XmlWriter" />
class.</para>
</remarks>
<example>
<para>The following example demonstrates how this class
resolves namespace conflicts inside an element. In the example, the writer writes an element that contains two attributes. The element and both
attributes have the same prefix but different namespaces. The resulting XML
fragment is written to the console.</para>
<code lang="C#">using System;
using System.Xml;
public class WriteFragment
{
public static void Main()
{
XmlTextWriter xWriter = new XmlTextWriter(Console.Out);
xWriter.WriteStartElement("prefix", "Element1", "namespace");
xWriter.WriteStartAttribute("prefix", "Attr1", "namespace1");
xWriter.WriteString("value1");
xWriter.WriteStartAttribute("prefix", "Attr2", "namespace2");
xWriter.WriteString("value2");
xWriter.Close();
}
}
</code>
<para>The output is</para>
<para>
<c><prefix:Element1 n1:Attr1="value1" n2:Attr2="value2" xmlns:n2="namespace2"
xmlns:n1="namespace1" xnlns:prefix="namespace" /></c>
</para>
</example>
</Docs>
<Base>
<BaseTypeName>System.Xml.XmlWriter</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="WriteQualifiedName">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteQualifiedName(string localName, string ns)" />
<MemberSignature Language="C#" Value="public override void WriteQualifiedName (string localName, string ns);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="localName" Type="System.String" />
<Parameter Name="ns" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para> Writes out the qualified name.</para>
</summary>
<param name="localName">A <see cref="T:System.String" qualify="true" /> specifying the local name to write.</param>
<param name=" ns">A <see cref="T:System.String" qualify="true" /> specifying the namespace URI to associate with <paramref name="localname" />.</param>
<exception cref="T:System.ArgumentException">
<para>
<paramref name="localName" /> is <see langword="null" /> or <see cref="F:System.String.Empty" qualify="true" />.</para>
<para>-or-</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.Namespaces" /> is <see langword="false" />, and <paramref name="ns" /> is neither <see langword="null" /> nor <see cref="F:System.String.Empty" qualify="true" /> .</para>
</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<exception cref="T:System.Xml.XmlException">
<paramref name="localName" /> is not a valid XML name.</exception>
<remarks>
<para>If <paramref name="ns" /> maps to the current default namespace, no
prefix is generated. </para>
<para>When writing attribute values, this method generates a prefix if <paramref name="ns" /> is not found. When writing element content, this method throws an exception if
<paramref name="ns" /> is not found.</para>
<para>If the current instance supports namespaces (<see cref="P:System.Xml.XmlTextWriter.Namespaces" /> is set to <see langword="true" />), this method looks up the prefix that
is in scope for the given namespace and checks that the name
is valid according to the W3C Namespaces in XML recommendation
(http://www.w3.org/TR/REC-xml-names).</para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteQualifiedName(System.String,System.String)" qualify="true" />.</para>
</block>
</remarks>
<param name="ns">To be added.</param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteName">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteName(string name)" />
<MemberSignature Language="C#" Value="public override void WriteName (string name);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para> Writes out the specified name, ensuring it is a
valid name according to the W3C XML 1.0 recommendation (http://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).</para>
</summary>
<param name="name">A <see cref="T:System.String" qualify="true" /> specifying the name to write.</param>
<exception cref="T:System.ArgumentException">
<para>
<paramref name="name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" qualify="true" />; or <paramref name="name" /> is not a valid XML Name.</para>
</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<para>If <see cref="P:System.Xml.XmlTextWriter.Namespaces" /> is set to <see langword="true" />, this method checks that <paramref name="name" /> is also valid according to the W3C Namespaces in
XML recommendation
(http://www.w3.org/TR/REC-xml-names).</para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteName(System.String)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteNmToken">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteNmToken(string name)" />
<MemberSignature Language="C#" Value="public override void WriteNmToken (string name);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para>Writes out the specified name, ensuring it is a valid name token (Nmtoken) according to
the W3C XML 1.0 recommendation (http://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).</para>
</summary>
<param name="name">A <see cref="T:System.String" qualify="true" /> specifying the name to write.</param>
<exception cref="T:System.ArgumentException">
<para>
<paramref name="name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" qualify="true" />; or <paramref name="name" /> is not a valid XML Nmtoken.</para>
</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteNmToken(System.String)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="LookupPrefix">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual string LookupPrefix(string ns)" />
<MemberSignature Language="C#" Value="public override string LookupPrefix (string ns);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="ns" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para> Returns the prefix defined in the current
namespace scope for the specified namespace URI.</para>
</summary>
<param name="ns">A <see cref="T:System.String" qualify="true" /> specifying the namespace URI.</param>
<returns>
<para>A <see cref="T:System.String" qualify="true" /> containing the
corresponding prefix, or <see cref="F:System.String.Empty" qualify="true" /> if the prefix is not found and <paramref name="ns" /> is
the default namespace, or <see langword="null" /> if no matching namespace URI is found in the current scope.</para>
</returns>
<exception cref="T:System.ArgumentException">
<paramref name="ns " /> is <see langword="null" /> or <see cref="F:System.String.Empty" qualify="true" />.</exception>
<remarks>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.LookupPrefix(System.String)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Flush">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void Flush()" />
<MemberSignature Language="C#" Value="public override void Flush ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Clears all buffers and causes any buffered data to be
written to the
underlying stream.</para>
</summary>
<remarks>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.Flush" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Close">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void Close()" />
<MemberSignature Language="C#" Value="public override void Close ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Closes the writer.</para>
</summary>
<remarks>
<para>This method closes all elements and attributes created
by the <see cref="M:System.Xml.XmlTextWriter.WriteStartElement(System.String,System.String,System.String)" /> and <see cref="M:System.Xml.XmlTextWriter.WriteStartAttribute(System.String,System.String,System.String)" /> methods,
respectively, that are open when the <see cref="M:System.Xml.XmlTextWriter.Close" /> method is
called.</para>
<para> This method calls
the <see cref="M:System.Xml.XmlTextWriter.Flush" />
method to flush the underlying buffered stream and then closes the stream.</para>
<para> This method sets
the <see cref="P:System.Xml.XmlTextWriter.WriteState" /> to <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteBinHex">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteBinHex(class System.Byte[] buffer, int32 index, int32 count)" />
<MemberSignature Language="C#" Value="public override void WriteBinHex (byte[] buffer, int index, int count);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<summary>
<para> Encodes the specified binary bytes as BinHex and writes the resulting text.
</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array containing the bytes to encode. </param>
<param name="index">A <see cref="T:System.Int32" qualify="true" /> specifying the position within the array of the first byte to encode. </param>
<param name="count">A <see cref="T:System.Int32" qualify="true" /> specifying the number of bytes to encode. </param>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The buffer length minus <paramref name="index" /> is less than <paramref name="count" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<block subset="none" type="note">
<para>For information on BinHex encoding, see RFC 1741
(http://www.ietf.org/rfc/rfc1741).</para>
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteBinHex(System.Byte[],System.Int32,System.Int32)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteBase64">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteBase64(class System.Byte[] buffer, int32 index, int32 count)" />
<MemberSignature Language="C#" Value="public override void WriteBase64 (byte[] buffer, int index, int count);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<summary>
<para>Encodes the specified binary bytes as Base64 and writes the resulting text.</para>
</summary>
<param name="buffer">A <see cref="T:System.Byte" qualify="true" /> array containing the bytes to encode.</param>
<param name="index">A <see cref="T:System.Int32" qualify="true" /> specifying the position within the array of the first byte to encode.</param>
<param name="count">A <see cref="T:System.Int32" qualify="true" /> specifying the number of bytes to encode.</param>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The buffer length minus <paramref name="index" /> is less than <paramref name="count" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="index" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<block subset="none" type="note">
<para> Base64 encoding
represents byte sequences in a text form comprised of the 65 US-ASCII
characters (A-Z, a-z, 0-9, +, /, =) where each
character encodes 6 bits of the
binary data.</para>
<para>For more information on Base64 encoding, see RFC 2045 (http://www.ietf.org/rfc/rfc2045).</para>
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteBase64(System.Byte[],System.Int32,System.Int32)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteRaw">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteRaw(string data)" />
<MemberSignature Language="C#" Value="public override void WriteRaw (string data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para> Writes raw text from a string.</para>
</summary>
<param name="data">A <see cref="T:System.String" qualify="true" /> specifying the text to write.</param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<para>If <paramref name="data" /> is <see langword="null" />, <see cref="F:System.String.Empty" /> is written.</para>
<para> This method does not encode any characters.</para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteRaw(System.Char[],System.Int32,System.Int32)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteRaw">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteRaw(class System.Char[] buffer, int32 index, int32 count)" />
<MemberSignature Language="C#" Value="public override void WriteRaw (char[] buffer, int index, int count);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Char[]" />
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<summary>
<para> Writes raw text from a character array.
</para>
</summary>
<param name="buffer">A <see cref="T:System.Char" qualify="true" /> array containing the text to write. </param>
<param name="index">A <see cref="T:System.Int32" qualify="true" /> specifying the position within the array of the start of the text to write. </param>
<param name="count">A <see cref="T:System.Int32" qualify="true" /> specifying the number of characters to write. </param>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<para>
<paramref name="index" /> or <paramref name="count" /> is less than zero.</para>
<para>- or -</para>
<para>The buffer length minus <paramref name="index" /> is less than <paramref name="count" />.</para>
</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<para> This method does not encode any characters.
</para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteRaw(System.Char[],System.Int32,System.Int32)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteChars">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteChars(class System.Char[] buffer, int32 index, int32 count)" />
<MemberSignature Language="C#" Value="public override void WriteChars (char[] buffer, int index, int count);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Char[]" />
<Parameter Name="index" Type="System.Int32" />
<Parameter Name="count" Type="System.Int32" />
</Parameters>
<Docs>
<summary>
<para> Writes text a buffer at a time.
</para>
</summary>
<param name="buffer">A <see cref="T:System.Char" qualify="true" /> array containing the text to write. </param>
<param name="index">A <see cref="T:System.Int32" qualify="true" /> specifying the position within the array of the start of the text to write. </param>
<param name="count">A <see cref="T:System.Int32" qualify="true" /> specifying the number of characters to write. </param>
<exception cref="T:System.ArgumentNullException">
<paramref name="buffer" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<para>
<paramref name="index" /> or <paramref name="count" /> is less than zero.</para>
<para>- or -</para>
<para>The buffer length minus <paramref name="index" /> is less than <paramref name="count" />.</para>
</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<block subset="none" type="note">
<para>This method can be used to write large
amounts of text a buffer at a time.</para>
<para> An exception is thrown if surrogate pair characters would be
split across multiple buffer writes. This exception must be caught in order
to continue writing the next surrogate pair characters. The XML specification defines the
valid ranges for surrogate pairs.</para>
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteChars(System.Char[],System.Int32,System.Int32)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteSurrogateCharEntity">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteSurrogateCharEntity(valuetype System.Char lowChar, valuetype System.Char highChar)" />
<MemberSignature Language="C#" Value="public override void WriteSurrogateCharEntity (char lowChar, char highChar);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="lowChar" Type="System.Char" />
<Parameter Name="highChar" Type="System.Char" />
</Parameters>
<Docs>
<summary>
<para> Generates and writes the surrogate character entity
for the surrogate character pair.</para>
</summary>
<param name="lowChar">A <see cref="T:System.Char" qualify="true" /> containing the low surrogate. This must be a value between 0xDC00 and 0xDFFF. </param>
<param name=" highChar">A <see cref="T:System.Char" qualify="true" /> containing the high surrogate. This must be a value between 0xD800 and 0xDBFF.</param>
<exception cref="T:System.ArgumentException">An invalid surrogate character pair was passed.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<para>This method only applies to a writer that uses the UTF-16 encoding
type.</para>
<para>The surrogate character entity is written in hexadecimal format. The range
for surrogate characters is #x10000 to #x10FFFF. The following formula is used
to generate the surrogate character entity: <c>(</c><paramref name="highChar" /><c> - 0xD800) * 0x400 + (</c><paramref name="lowChar" /><c> - 0xDC00) + 0x10000</c>.</para>
<block subset="none" type="note">
<para>For both HTML and XML, the document character set (and therefore the notation
of numeric character references) is based on UCS [ISO-10646]. A single numeric
character reference in a source document may therefore in some cases correspond
to two 16-bit units in a string (a high surrogate and a low surrogate). These
16-bit units are referred to as a surrogate pair.</para>
<para>For more information regarding surrogates or characters, refer to section 3.7
of the Unicode 3.0/Unicode 2.0 standard located at http://www.unicode.org, or
section 2.2 of the W3C XML 1.0 Recommendation located at
http://www.w3.org/TR/REC-xml#charsets .</para>
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteSurrogateCharEntity(System.Char,System.Char)" qualify="true" />.</para>
</block>
</remarks>
<param name="highChar">To be added.</param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteString">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteString(string text)" />
<MemberSignature Language="C#" Value="public override void WriteString (string text);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para> Writes the specified text.</para>
</summary>
<param name="text">A <see cref="T:System.String" qualify="true" /> specifying the text to write. </param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" /> and <paramref name="text" /> is neither <see langword="null" /> nor <see cref="F:System.String.Empty" qualify="true" />.</exception>
<remarks>
<para>This method performs the following conversions before writing the text:</para>
<list type="bullet">
<item>
<term>
The characters '&', '<', and '>' are
replaced with "&amp;", "&lt;", and "&gt;", respectively.</term>
</item>
<item>
<term>
Character values in the range 0x-0x1F (excluding the
white space characters 0x9, 0x10, and 0x13) are replaced with numeric
character entities ("&#0;" through "&#0x1F").</term>
</item>
<item>
<term>
If called in the context of an attribute value, double
and single quotes are replaced with "&quot;" and "&apos;"
respectively.</term>
</item>
</list>
<para>If <paramref name="text" /> is <see langword="null" /> or <see cref="F:System.String.Empty" qualify="true" />, this method writes a text
node with no data content.</para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteString(System.String)" qualify="true" />.</para>
</block>
</remarks>
<example>
<para>The following example demonstrates the conversions performed by this method.</para>
<code lang="C#">using System;
using System.Xml;
public class WriteFrag {
public static void Main() {
XmlTextWriter xtWriter =
new XmlTextWriter(Console.Out);
xtWriter.WriteString("<1 & 2 = 3>");
}
}
</code>
<para>The output is</para>
<para>&lt;1 &amp; 2 = 3&gt;</para>
</example>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteWhitespace">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteWhitespace(string ws)" />
<MemberSignature Language="C#" Value="public override void WriteWhitespace (string ws);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="ws" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para> Writes the given white space.</para>
</summary>
<param name="ws">A <see cref="T:System.String" qualify="true" /> containing the white space characters.</param>
<exception cref="T:System.ArgumentException">
<paramref name="ws" /> is <see langword="null" /> or <see cref="F:System.String.Empty" qualify="true" /> or contains non-white space characters.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<block subset="none" type="note">
<para>This method is used to manually format a document. Use the <see cref="P:System.Xml.XmlTextWriter.Formatting" /> property to have the current instance
format the output automatically.</para>
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteWhitespace(System.String)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteCharEntity">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteCharEntity(valuetype System.Char ch)" />
<MemberSignature Language="C#" Value="public override void WriteCharEntity (char ch);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="ch" Type="System.Char" />
</Parameters>
<Docs>
<summary>
<para>Forces the
generation of a character entity for the specified Unicode character value.</para>
</summary>
<param name="ch">The <see cref="T:System.Char" qualify="true" /> for which to generate the entity.</param>
<exception cref="T:System.ArgumentException">The character is in the surrogate pair character range, 0xd800 - 0xdfff, or the text would result in a non-well formed XML document.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<para> This method writes the Unicode character in hexadecimal character entity
reference format.</para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteCharEntity(System.Char)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteEntityRef">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteEntityRef(string name)" />
<MemberSignature Language="C#" Value="public override void WriteEntityRef (string name);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para>Writes an entity reference with the specified name.</para>
</summary>
<param name="name">A <see cref="T:System.String" qualify="true" /> specifying the name of the entity reference.</param>
<exception cref="T:System.ArgumentException">A <see cref="T:System.String" qualify="true" /> containing the text would result in a non-well formed XML document, or <paramref name="name" /> is either <see langword="null" /> or <see cref="F:System.String.Empty" qualify="true" />.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<para>This method writes <c>%</c><paramref name="name" /><c>;</c>.</para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteEntityRef(System.String)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteProcessingInstruction">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteProcessingInstruction(string name, string text)" />
<MemberSignature Language="C#" Value="public override void WriteProcessingInstruction (string name, string text);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para> Writes out a processing instruction with the specified
name and text.</para>
</summary>
<param name="name">A <see cref="T:System.String" qualify="true" /> specifying the name of the processing instruction.</param>
<param name=" text">A <see cref="T:System.String" qualify="true" /> specifying the text to include in the processing instruction.</param>
<exception cref="T:System.ArgumentException">
<para> The text would result in a non-well formed XML document.</para>
<para> - or -</para>
<para>
<paramref name="name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" qualify="true" />.</para>
<para> - or -</para>
<para>This method is being used to create an XML declaration after <see cref="M:System.Xml.XmlTextWriter.WriteStartDocument" /> has already been called. </para>
</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<para>This method writes <c><?</c><paramref name="name" /><paramref name="text" /><c>?></c>.</para>
<para>If <paramref name="text" /> is
<see langword="null" /> or <see cref="F:System.String.Empty" qualify="true" />, this method writes a processing
instruction with no text content, <c><?</c><paramref name="name" /><c>?></c>.</para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteProcessingInstruction(System.String,System.String)" qualify="true" />.</para>
</block>
</remarks>
<param name="text">To be added.</param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteComment">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteComment(string text)" />
<MemberSignature Language="C#" Value="public override void WriteComment (string text);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para>Writes out a comment containing
the specified text.</para>
</summary>
<param name="text">A <see cref="T:System.String" qualify="true" /> containing the text to place inside the comment.</param>
<exception cref="T:System.ArgumentException">The text would result in a non-well formed XML document</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<para>This method writes <c><!--</c><paramref name="text" /><c>--></c>.</para>
<para>If <paramref name="text" /> is <see langword="null" /> or <see cref="F:System.String.Empty" qualify="true" /> , this method
writes a comment with no content, <c><!----></c>.</para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteComment(System.String)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteCData">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteCData(string text)" />
<MemberSignature Language="C#" Value="public override void WriteCData (string text);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para>Writes out a CDATA block containing
the specified text.</para>
</summary>
<param name="text">A <see cref="T:System.String" qualify="true" /> specifying the text to place inside the CDATA block.</param>
<exception cref="T:System.ArgumentException">The text would result in a non-well formed XML document.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<para>This method writes <c><![CDATA[</c><paramref name="text" /><c>]]></c>.</para>
<para> If <paramref name="text " /> is <see langword="null" /> or <see cref="F:System.String.Empty" qualify="true" />, this method writes an empty CDATA block,
<c><![CDATA[]]></c>.</para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteCData(System.String)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteEndAttribute">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteEndAttribute()" />
<MemberSignature Language="C#" Value="public override void WriteEndAttribute ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Closes the attribute started with the <see cref="M:System.Xml.XmlTextWriter.WriteStartAttribute(System.String,System.String,System.String)" />
method.</para>
</summary>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<block subset="none" type="note">
<para> The <see cref="M:System.Xml.XmlTextWriter.WriteStartAttribute(System.String,System.String,System.String)" /> and <see cref="M:System.Xml.XmlTextWriter.WriteEndElement" /> methods
also will close an open attribute if one exists when
they are called.</para>
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteEndAttribute" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteStartAttribute">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteStartAttribute(string prefix, string localName, string ns)" />
<MemberSignature Language="C#" Value="public override void WriteStartAttribute (string prefix, string localName, string ns);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="prefix" Type="System.String" />
<Parameter Name="localName" Type="System.String" />
<Parameter Name="ns" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para>Writes the start of an attribute with the specified prefix
and name, and associates the prefix with the specified namespace URI.</para>
</summary>
<param name=" prefix">A <see cref="T:System.String" qualify="true" /> specifying the namespace prefix of the attribute.</param>
<param name="localName">A <see cref="T:System.String" qualify="true" /> specifying the local name of the attribute.</param>
<param name=" ns">A <see cref="T:System.String" qualify="true" /> specifying the namespace URI associated with the attribute.</param>
<exception cref="T:System.ArgumentException">
<see cref="P:System.Xml.XmlTextWriter.Namespaces" /> is <see langword="false" /> for the writer, and <paramref name="prefix" /> and <paramref name="ns" /> are not both <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<para>If any of the input parameters are <see langword="null" /> or <see cref="F:System.String.Empty" qualify="true" />, the start attribute is written with that parameter missing.</para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteStartAttribute(System.String,System.String)" qualify="true" />.</para>
</block>
</remarks>
<param name="prefix">To be added.</param>
<param name="ns">To be added.</param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteFullEndElement">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteFullEndElement()" />
<MemberSignature Language="C#" Value="public override void WriteFullEndElement ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Closes an open element and pops the corresponding namespace scope.</para>
</summary>
<exception cref="T:System.InvalidOperationException">No start tag was open, or the <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<para> This method writes an end element regardless of whether there is any content in the element.</para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteFullEndElement" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteEndElement">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteEndElement()" />
<MemberSignature Language="C#" Value="public override void WriteEndElement ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Closes an open element and pops the corresponding namespace scope.</para>
</summary>
<exception cref="T:System.InvalidOperationException">No element was open, or the <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<para> If the open element does not contain content, it is closed as an empty element using "<c> /></c>"; otherwise an end element is written.</para>
<block subset="none" type="note">
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteEndElement" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteStartElement">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteStartElement(string prefix, string localName, string ns)" />
<MemberSignature Language="C#" Value="public override void WriteStartElement (string prefix, string localName, string ns);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="prefix" Type="System.String" />
<Parameter Name="localName" Type="System.String" />
<Parameter Name="ns" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para> Writes a start element with the specified name, and associates it with the given namespace
and prefix.</para>
</summary>
<param name=" prefix">A <see cref="T:System.String" qualify="true" /> specifying the namespace prefix of the element.</param>
<param name="localName">
<para> A <see cref="T:System.String" qualify="true" /> specifying the local name of the element.</para>
</param>
<param name="ns">
<para>A <see cref="T:System.String" qualify="true" /> specifying the namespace URI to associate with the element.</para>
</param>
<exception cref="T:System.ArgumentException">
<see cref="P:System.Xml.XmlTextWriter.Namespaces" /> is <see langword="false" /> for the writer, and <paramref name="prefix" /> and <paramref name="ns" /> are not both <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is <see cref="F:System.Xml.WriteState.Closed" qualify="true" />.</exception>
<remarks>
<para>If <paramref name="ns" /> is already in scope and has an associated prefix, the
current instance will automatically write that prefix also.</para>
<para>If any of the input parameters are <see langword="null" /> or <see cref="F:System.String.Empty" qualify="true" />, the start element is written with that parameter missing.</para>
<block subset="none" type="note">
<para> Write any attributes using
the <see cref="M:System.Xml.XmlTextWriter.WriteStartAttribute(System.String,System.String,System.String)" />, <see cref="M:System.Xml.XmlTextWriter.WriteString(System.String)" />, and
<see cref="M:System.Xml.XmlTextWriter.WriteEndAttribute" /> methods, then close the element
using the <see cref="M:System.Xml.XmlTextWriter.WriteEndElement" /> method. </para>
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteStartElement(System.String,System.String)" qualify="true" />.</para>
</block>
</remarks>
<example>
<para>This example demonstrates the <see cref="M:System.Xml.XmlTextWriter.WriteStartElement(System.String,System.String,System.String)" />
method, writing the XML to the
console.</para>
<code lang="C#">using System;
using System.Xml;
public class WriteXml
{
public static void Main()
{
XmlTextWriter xWriter =
new XmlTextWriter(Console.Out);
xWriter.WriteStartDocument();
xWriter.WriteStartElement("prefix","element", "namespace");
xWriter.WriteEndDocument();
}
}
</code>
<para>The output is</para>
<para>
<c><?xml version="1.0" encoding=
"someencoding"?></c>
</para>
<para>
<c><prefix:element xmlns:prefix="namespace"
/></c>
</para>
<para> The value of the encoding attribute is the encoding of the output stream of the console.</para>
</example>
<param name="prefix">To be added.</param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteDocType">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteDocType(string name, string pubid, string sysid, string subset)" />
<MemberSignature Language="C#" Value="public override void WriteDocType (string name, string pubid, string sysid, string subset);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="pubid" Type="System.String" />
<Parameter Name="sysid" Type="System.String" />
<Parameter Name="subset" Type="System.String" />
</Parameters>
<Docs>
<summary>
<para> Writes the document type declaration with the specified name
and optional attributes.</para>
</summary>
<param name="name">A <see cref="T:System.String" qualify="true" /> specifying the name of the document type.</param>
<param name="pubid">
<para>A <see cref="T:System.String" qualify="true" /> specifying the public identifier, which is an alternative to the system identifier.</para>
</param>
<param name="sysid">
<para>A <see cref="T:System.String" qualify="true" /> specifying the system identifier, which is the URI of the DTD (document type definition) for the document.</para>
</param>
<param name="subset">
<para>A <see cref="T:System.String" qualify="true" /> specifying a URI that contains markup declarations. </para>
</param>
<exception cref="T:System.ArgumentException">
<para>
<paramref name="name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" qualify="true" />.</para>
<para>-or-</para>
<para>The value for <paramref name="name" /> would result in invalid XML.</para>
</exception>
<exception cref="T:System.InvalidOperationException">This method was called outside the prolog (after the root element).</exception>
<remarks>
<para>The optional attributes, <paramref name="pubid" />, <paramref name="sysid" />, and <paramref name=" subset" />, are not checked for invalid
characters.</para>
<block subset="none" type="note">
<para>A document type declaration is of the following form:</para>
<para><!DOCTYPE <paramref name="name" /> PUBLIC "<paramref name="pubid" />" "<paramref name="sysid" />" [<paramref name="subset" />]></para>
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteDocType(System.String,System.String,System.String,System.String)" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteEndDocument">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteEndDocument()" />
<MemberSignature Language="C#" Value="public override void WriteEndDocument ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Closes open elements and attributes and sets
the <see cref="P:System.Xml.XmlTextWriter.WriteState" />
back to the <see cref="F:System.Xml.WriteState.Start" qualify="true" />
state.</para>
</summary>
<exception cref="T:System.ArgumentException">The current instance is in the wrong <see cref="T:System.Xml.WriteState" qualify="true" />, or the document does not have a root element.</exception>
<remarks>
<para>This method closes all elements and attributes created by
the <see cref="M:System.Xml.XmlTextWriter.WriteStartElement(System.String,System.String,System.String)" /> and <see cref="M:System.Xml.XmlTextWriter.WriteStartAttribute(System.String,System.String,System.String)" /> methods,
respectively, that are open when the <see cref="M:System.Xml.XmlTextWriter.WriteEndDocument" />
method is called.</para>
<block subset="none" type="note">
<para> After calling this method, the current instance can be used to write a
new XML document.</para>
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteEndDocument" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteStartDocument">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteStartDocument(bool standalone)" />
<MemberSignature Language="C#" Value="public override void WriteStartDocument (bool standalone);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="standalone" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>
<para> Writes the XML declaration with the
version "1.0" and the standalone attribute.</para>
</summary>
<param name="standalone">A <see cref="T:System.Boolean" qualify="true" /> where <see langword="true" /> indicates to write "yes" as the value for the standalone attribute, and <see langword="false" /> indicates to write "no".</param>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is not <see cref="F:System.Xml.WriteState.Start" qualify="true" />.</exception>
<remarks>
<block subset="none" type="note">
<para>When <see cref="T:System.Xml.XmlTextWriter" /> is instantiated, the <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is set to <see cref="F:System.Xml.WriteState.Start" />. All the "write" methods change the
<see cref="P:System.Xml.XmlTextWriter.WriteState" /> to a value other than <see langword="Start" />. Thus,
if this method is not the first "write" method called, a <see cref="T:System.InvalidOperationException" />
is thrown.</para>
<para>If <see cref="M:System.Xml.XmlTextWriter.WriteStartDocument" /> has been called and then the <see cref="M:System.Xml.XmlTextWriter.WriteProcessingInstruction(System.String,System.String)" /> method is
used to create another XML declaration, a <see cref="T:System.ArgumentException" />
will be thrown.</para>
<para> The output of this method with <paramref name="standalone" />
equal to <see langword="true" />, an encoding equal to <see cref="P:System.Text.Encoding.Unicode" qualify="true" />, and using the default <see cref="P:System.Xml.XmlTextWriter.QuoteChar" /> is:</para>
<para>
<c><?xml version="1.0" encoding="utf-16" standalone="yes"?></c>
</para>
<para>Character encoding is set when the writer is instantiated.</para>
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteStartDocument" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteStartDocument">
<MemberSignature Language="ILASM" Value=".method public hidebysig virtual void WriteStartDocument()" />
<MemberSignature Language="C#" Value="public override void WriteStartDocument ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Writes the XML declaration with the version "1.0" and no
standalone attribute.</para>
</summary>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is not <see cref="F:System.Xml.WriteState.Start" qualify="true" />.</exception>
<remarks>
<block subset="none" type="note">
<para>When <see cref="T:System.Xml.XmlTextWriter" /> is instantiated, the <see cref="P:System.Xml.XmlTextWriter.WriteState" /> is set to <see cref="F:System.Xml.WriteState.Start" />. All the "write" methods change the
<see cref="P:System.Xml.XmlTextWriter.WriteState" /> to a value other than <see langword="Start" />. Thus,
if this method is not the first "write" method called, a <see cref="T:System.InvalidOperationException" />
is thrown.</para>
<para>If <see cref="M:System.Xml.XmlTextWriter.WriteStartDocument" /> has been called and then the
<see cref="M:System.Xml.XmlTextWriter.WriteProcessingInstruction(System.String,System.String)" /> method is
used to create another XML declaration, a <see cref="T:System.ArgumentException" /> will be thrown.</para>
<para> The output of this method using an encoding equal to <see cref="P:System.Text.Encoding.Unicode" qualify="true" /> and the default <see cref="P:System.Xml.XmlTextWriter.QuoteChar" /> is</para>
<para>
<c><?xml version="1.0" encoding="utf-16"?></c>
</para>
<para>Character encoding is set when the writer is instantiated.</para>
<para>This method overrides <see cref="M:System.Xml.XmlWriter.WriteStartDocument" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(class System.IO.Stream w, class System.Text.Encoding encoding)" />
<MemberSignature Language="C#" Value="public XmlTextWriter (System.IO.Stream w, System.Text.Encoding encoding);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="w" Type="System.IO.Stream" />
<Parameter Name="encoding" Type="System.Text.Encoding" />
</Parameters>
<Docs>
<param name="w">The <see cref="T:System.IO.Stream" qualify="true" /> to write to.</param>
<param name="encoding">The <see cref="T:System.Text.Encoding" qualify="true" /> to generate, or <see langword="null" />.</param>
<summary>
<para>Constructs and initializes a new instance of the
<see cref="T:System.Xml.XmlTextWriter" /> class using the specified output
stream.</para>
</summary>
<exception cref="T:System.ArgumentException">
<para>
<paramref name="w" /> cannot be written to.</para>
<para> -or-</para>
<para>The encoding is not supported.</para>
</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="w " /> is <see langword="null" />.</exception>
<remarks>
<para> If <paramref name="encoding" /> is <see langword="null" />, the stream
is written as UTF-8 and the encoding attribute is omitted from the processing
instruction.</para>
<para>The following properties are initialized to the
specified values:</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.Formatting" /> to <see cref="F:System.Xml.Formatting.None" qualify="true" />.</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.Indentation" /> to 2.</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.IndentChar" /> to the space character.</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.Namespaces" /> to <see langword="true" />.</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.QuoteChar" /> to the double quote character.</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.WriteState" /> to <see cref="F:System.Xml.WriteState.Start" qualify="true" />.</para>
</remarks>
<param name="encoding">To be added.</param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(string filename, class System.Text.Encoding encoding)" />
<MemberSignature Language="C#" Value="public XmlTextWriter (string filename, System.Text.Encoding encoding);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="filename" Type="System.String" />
<Parameter Name="encoding" Type="System.Text.Encoding" />
</Parameters>
<Docs>
<param name="filename">A <see cref="T:System.String" qualify="true" /> specifying the path and name of the file to write to.</param>
<param name="encoding">The <see cref="T:System.Text.Encoding" qualify="true" /> to generate, or <see langword="null" />.</param>
<summary>
<para>Constructs and initializes a new instance of the <see cref="T:System.Xml.XmlTextWriter" /> class using the
specified
file.</para>
</summary>
<exception cref="T:System.ArgumentException">
<para>
<paramref name="filename" /> is <see cref="F:System.String.Empty" />, contains only white space, or contains one or more implementation-defined invalid characters.</para>
<para>-or-</para>
<para>The encoding is not supported.</para>
</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="filename" /> is <see langword="null" />.</exception>
<exception cref="T:System.IO.DirectoryNotFoundException">The directory path specified in <paramref name="filename" /> does not exist.</exception>
<exception cref="T:System.IO.IOException">
<paramref name="filename" /> includes an invalid syntax for the path or file name.</exception>
<exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceeds the system-defined maximum length.</exception>
<exception cref="T:System.Security.SecurityException">The caller does not have the required permissions.</exception>
<exception cref="T:System.UnauthorizedAccessException">Write access is not permitted by the operating system for the path specified in <paramref name="filename" />.</exception>
<remarks>
<para> If <paramref name="filename" /> exists, it is truncated and overwritten with the new
content.</para>
<para>If <paramref name="encoding" /> is <see langword="null" />, the file is written as UTF-8
and the encoding attribute is omitted from the processing instruction.</para>
<para>The following properties are initialized to the specified values:</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.Formatting" /> to <see cref="F:System.Xml.Formatting.None" qualify="true" />.</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.Indentation" /> to 2.</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.IndentChar" /> to the space character.</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.Namespaces" /> to <see langword="true" />.</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.QuoteChar" /> to the double quote character.</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.WriteState" /> to <see cref="F:System.Xml.WriteState.Start" qualify="true" />.</para>
</remarks>
<permission cref="T:System.Security.Permissions.FileIOPermission">Requires permission to write to files. See <see cref="F:System.Security.Permissions.FileIOPermissionAccess.Write" qualify="true" />.</permission>
<param name="encoding">To be added.</param>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="ILASM" Value="public rtspecialname specialname instance void .ctor(class System.IO.TextWriter w)" />
<MemberSignature Language="C#" Value="public XmlTextWriter (System.IO.TextWriter w);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="w" Type="System.IO.TextWriter" />
</Parameters>
<Docs>
<summary>
<para>Constructs and initializes a new instance of the <see cref="T:System.Xml.XmlTextWriter" />
class.</para>
</summary>
<param name="w">The <see cref="T:System.IO.TextWriter" qualify="true" /> to write to, initialized to the correct encoding. </param>
<remarks>
<para>The following properties are initialized to the specified values:</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.Formatting" /> to <see cref="F:System.Xml.Formatting.None" qualify="true" />.</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.Indentation" /> to 2.</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.IndentChar" /> to the space character.</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.Namespaces" /> to <see langword="true" />.</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.QuoteChar" /> to the double quote character.</para>
<para>
<see cref="P:System.Xml.XmlTextWriter.WriteState" /> to <see cref="F:System.Xml.WriteState.Start" qualify="true" />.</para>
<block subset="none" type="note">
<para> If a specific encoding is necessary, set the encoding using the
constructor of <paramref name="w" /> before instantiating the writer.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="BaseStream">
<MemberSignature Language="ILASM" Value=".property class System.IO.Stream BaseStream { public hidebysig specialname instance class System.IO.Stream get_BaseStream() }" />
<MemberSignature Language="C#" Value="public System.IO.Stream BaseStream { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.IO.Stream</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets the underlying stream used by the writer.</para>
</summary>
<value>
<para> A <see cref="T:System.IO.Stream" qualify="true" />, or <see langword="null" /> if the current
instance does not use an underlying stream.</para>
</value>
<remarks>
<para>This property is read-only.</para>
<para>If the current instance was constructed using
a <see cref="T:System.IO.TextWriter" qualify="true" /> that is a subclass of the <see cref="T:System.IO.StreamWriter" qualify="true" />
class, this property is equivalent to the <see cref="P:System.IO.StreamWriter.BaseStream" />
property.</para>
<para> If the writer was constructed using a
<see cref="T:System.IO.Stream" qualify="true" />, this property returns the <see langword="Stream" /> passed to the constructor.</para>
<para> If the writer was constructed using a file name, this
property returns the <see langword="Stream" /> representing the file.</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Namespaces">
<MemberSignature Language="ILASM" Value=".property bool Namespaces { public hidebysig specialname instance bool get_Namespaces() public hidebysig specialname instance void set_Namespaces(bool value) }" />
<MemberSignature Language="C#" Value="public bool Namespaces { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Gets
or sets a value indicating whether the writer supports namespaces.</para>
</summary>
<value>
<para> A <see cref="T:System.Boolean" qualify="true" /> where <see langword="true" /> indicates the writer supports namespaces; otherwise,
<see langword="false" />. The default is <see langword="true" />.</para>
</value>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.Xml.XmlTextWriter.WriteState" /> of the current instance is not <see cref="F:System.Xml.WriteState.Start" />.</exception>
<remarks>
<para>This property determines whether
the writer supports the XML Namespaces specification (http://www.w3.org/TR/REC-xml-names).</para>
<para> If an attempt is made to set this property after a write
operation has occurred, a <see cref="T:System.InvalidOperationException" />
is thrown.</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Formatting">
<MemberSignature Language="ILASM" Value=".property valuetype System.Xml.Formatting Formatting { public hidebysig specialname instance valuetype System.Xml.Formatting get_Formatting() public hidebysig specialname instance void set_Formatting(valuetype System.Xml.Formatting value) }" />
<MemberSignature Language="C#" Value="public System.Xml.Formatting Formatting { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Xml.Formatting</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Indicates how the output
is formatted.</para>
</summary>
<value>
<para>One of the members of the <see cref="T:System.Xml.Formatting" qualify="true" /> enumeration. The default is <see cref="F:System.Xml.Formatting.None" /> (no
special formatting).</para>
</value>
<remarks>
<para>If this property is set to <see cref="F:System.Xml.Formatting.Indented" />, child elements are indented using
the <see cref="P:System.Xml.XmlTextWriter.Indentation" /> and <see cref="P:System.Xml.XmlTextWriter.IndentChar" />
properties. Only element content will be indented.</para>
<block subset="none" type="note">
<para>Writing any text content, including <see cref="F:System.String.Empty" qualify="true" />, puts
that element into mixed content mode. Child elements do not inherit this "mixed"
mode status. A child element of a "mixed" element will do indenting, unless it
is also contains "mixed" content. Element content
(http://www.w3.org/TR/1998/REC-xml-19980210#sec-element-content) and mixed
content (http://www.w3.org/TR/1998/REC-xml-19980210#sec-mixed-content) are
defined according to the XML 1.0 definitions of these terms. </para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Indentation">
<MemberSignature Language="ILASM" Value=".property int32 Indentation { public hidebysig specialname instance int32 get_Indentation() public hidebysig specialname instance void set_Indentation(int32 value) }" />
<MemberSignature Language="C#" Value="public int Indentation { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Gets or sets how many indentation characters to write for each level
in the hierarchy when <see cref="P:System.Xml.XmlTextWriter.Formatting" /> is set to <see cref="F:System.Xml.Formatting.Indented" qualify="true" />.</para>
</summary>
<value>
<para>A <see cref="T:System.Int32" qualify="true" /> specifying the
number of <see cref="P:System.Xml.XmlTextWriter.IndentChar" /> characters to use for each level. The default is 2.</para>
</value>
<exception cref="T:System.ArgumentException">The value to be set is less than zero.</exception>
<remarks>
<para>Indentation is performed on the following members
of <see cref="T:System.Xml.XmlNodeType" />: <see langword="DocumentType" />,
<see langword="Element" />, <see langword="Comment" />,
<see langword="ProcessingInstruction" />, and <see langword="CDATA" />. All
other node types are not affected. The <see cref="T:System.Xml.XmlTextWriter" /> class
does
not indent the internal DTD subset.
</para>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="IndentChar">
<MemberSignature Language="ILASM" Value=".property valuetype System.Char IndentChar { public hidebysig specialname instance valuetype System.Char get_IndentChar() public hidebysig specialname instance void set_IndentChar(valuetype System.Char value) }" />
<MemberSignature Language="C#" Value="public char IndentChar { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Char</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Gets or sets the character to use for indenting
when <see cref="P:System.Xml.XmlTextWriter.Formatting" /> is set to
<see cref="F:System.Xml.Formatting.Indented" qualify="true" />.</para>
</summary>
<value>
<para>A <see cref="T:System.Char" qualify="true" /> specifying the
character to use for indenting. The default is space
(character code 0x20).</para>
</value>
<remarks>
<block subset="none" type="note">
<para>This property can be set to any character. To ensure valid XML, set this property
to a valid white space character: 0x9, 0x10, 0x13, or 0x20.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="QuoteChar">
<MemberSignature Language="ILASM" Value=".property valuetype System.Char QuoteChar { public hidebysig specialname instance valuetype System.Char get_QuoteChar() public hidebysig specialname instance void set_QuoteChar(valuetype System.Char value) }" />
<MemberSignature Language="C#" Value="public char QuoteChar { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Char</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets or sets the character used to quote the value of an
attribute.</para>
</summary>
<value>
<para>A <see cref="T:System.Char" qualify="true" /> specifying the
quotation mark character (" or ') used to enclose the value of an attribute. The
default is the double quote. </para>
</value>
<exception cref="T:System.ArgumentException">The value to be set is not the single quote or double quote character.</exception>
<remarks>To be added.</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="WriteState">
<MemberSignature Language="ILASM" Value=".property valuetype System.Xml.WriteState WriteState { public hidebysig virtual specialname valuetype System.Xml.WriteState get_WriteState() }" />
<MemberSignature Language="C#" Value="public override System.Xml.WriteState WriteState { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Xml.WriteState</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para>Gets the write state of the writer.</para>
</summary>
<value>
<para> One of the members of the <see cref="T:System.Xml.WriteState" /> enumeration.
</para>
</value>
<remarks>
<para>This property is read-only.</para>
<block subset="none" type="note">
<para>This property overrides <see cref="P:System.Xml.XmlWriter.WriteState" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="XmlSpace">
<MemberSignature Language="ILASM" Value=".property valuetype System.Xml.XmlSpace XmlSpace { public hidebysig virtual specialname valuetype System.Xml.XmlSpace get_XmlSpace() }" />
<MemberSignature Language="C#" Value="public override System.Xml.XmlSpace XmlSpace { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Xml.XmlSpace</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets the white space attribute, <c>xml:space</c>, specifying how white space is handled in the
current element. </para>
</summary>
<value>
<para> One of the members of the <see cref="T:System.Xml.XmlSpace" qualify="true" /> enumeration, or <see cref="F:System.Xml.XmlSpace.None" /> if the white space attribute is not
specified for the element. </para>
</value>
<remarks>
<para>This property is read-only.</para>
<block subset="none" type="note">
<para>This property overrides <see cref="P:System.Xml.XmlWriter.XmlSpace" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="XmlLang">
<MemberSignature Language="ILASM" Value=".property string XmlLang { public hidebysig virtual specialname string get_XmlLang() }" />
<MemberSignature Language="C#" Value="public override string XmlLang { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
<para> Gets the language attribute, <c>xml:lang</c>, specifying the language in which the
content and attribute values of the current element are written.
</para>
</summary>
<value>
<para> A <see cref="T:System.String" qualify="true" />
containing the language attribute, or <see langword="null" /> if the
language attribute is not specified for the element.</para>
</value>
<remarks>
<para>This property is read-only.</para>
<block subset="none" type="note">
<para>This property overrides <see cref="P:System.Xml.XmlWriter.XmlLang" qualify="true" />.</para>
</block>
</remarks>
</Docs>
<Excluded>0</Excluded>
</Member>
</Members>
<TypeExcluded>0</TypeExcluded>
</Type>
|