Mise en forme d'une sortie XML avec XmlTextWriter
La mise en forme d'une sortie XML avec XmlTextWriter implique plusieurs propriétés qui fonctionnent ensemble pour contrôler la sortie d'un document.
La mise en forme d'une sortie XML avec XmlTextWriter implique plusieurs propriétés qui fonctionnent ensemble pour contrôler la sortie d'un document. Les propriétés de mise en forme de la sortie sont :
Mise en forme
IndentChar ;
Indentation ;
QuoteChar.
Mise en forme de sortie
Les valeurs valides pour la propriété Formatting sont None et Indented, None étant la valeur par défaut. Lorsque la valeur sélectionnée est None, les propriétés IndentChar et Indentation sont ignorées et aucune mise en forme ne se produit. Si la valeur Indented est affectée à la propriété Formatting, l'application consulte la propriété Indentation pour connaître le nombre de caractères IndentChar à écrire pour chaque niveau de la hiérarchie. La propriété IndentChar spécifie ensuite le caractère à utiliser pour la mise en retrait. Si la valeur Indented est affectée à la propriété Formatting, la valeur par défaut de la propriété Indentation est égale à l'écriture de 2 caractères IndentChar pour chaque niveau de la hiérarchie. La valeur par défaut de la propriété IndentChar est une espace. Si la valeur Indented est affectée à Formatting, les éléments enfants sont mis en retrait en fonction des valeurs des propriétés Indentation et IndentChar. La mise en retrait effectuée par XmlTextWriter dépend du type de nœud. Les types de nœuds affectés par la propriété Indentation sont :
DocumentType
Element ;
Comment ;
ProcessingInstruction
CDATASection
Les autres types de nœuds ne sont pas affectés par la propriété Indentation et la mise en retrait ne s'applique pas à eux.
Le sous-ensemble interne de la définition de type de document (DTD) n'est ni mis en retrait, ni mis en forme. Cependant, cela peut être réalisé comme l'illustre l'exemple de code. Cet exemple de code met en forme le sous-ensemble interne DTD.
String name = "Employees";
String pubid = null;
String sysid = null;
String subset = @"
<!ELEMENT Employees (Employee)+>
<!ELEMENT Employee EMPTY>
<!ATTLIST Employee firstname CDATA #REQUIRED>
<!ENTITY Company 'Microsoft'>]>
";
XmlTextWriter tw = new XmlTextWriter(Console.Out);
tw.WriteDocType(name, pubid, sysid, subset);
La propriété QuoteChar définit le caractère à utiliser comme guillemet pour encadrer les valeurs des attributs. Les valeurs valides sont :
le guillemet simple (') ;
le guillemet double (").
La valeur par défaut de la propriété QuoteChar est le double guillemet (").
Exemple
L'exemple suivant écrit un fragment XML en affectant à la propriété Formatting la valeur Indented, un niveau d'indentation de 4 ainsi qu'une espace comme caractère de mise en retrait (valeur par défaut).
Option Explicit
Option Strict
Imports System
Imports System.IO
Imports System.Xml
Public Class Sample
Public Shared Sub Main()
'Create a writer to write XML to the console.
Dim writer As XmlTextWriter = Nothing
writer = New XmlTextWriter(Console.Out)
'Use indentation for readability.
writer.Formatting = Formatting.Indented
writer.Indentation = 4
'Write an element (this one is the root).
writer.WriteStartElement("book")
'Write the title element.
writer.WriteStartElement("title")
writer.WriteString("Pride And Prejudice")
writer.WriteEndElement()
'Write the close tag for the root element.
writer.WriteEndElement()
'Write the XML to file and close the writer.
writer.Close()
End Sub 'Main
End Class 'Sample
using System;
using System.IO;
using System.Xml;
public class Sample
{
public static void Main()
{
//Create a writer to write XML to the console.
XmlTextWriter writer = null;
writer = new XmlTextWriter (Console.Out);
//Use indentation for readability.
writer.Formatting = Formatting.Indented;
writer.Indentation = 4;
//Write an element (this one is the root).
writer.WriteStartElement("book");
//Write the title element.
writer.WriteStartElement("title");
writer.WriteString("Pride And Prejudice");
writer.WriteEndElement();
//Write the close tag for the root element.
writer.WriteEndElement();
//Write the XML to file and close the writer.
writer.Close();
}
}