XmlWriter.WriteProcessingInstruction(String, String) Metoda

Definicja

Przestrzeń nazw:

System.Xml

Zestaw:

System.Xml.ReaderWriter.dll

Źródło:

XmlWriter.cs

Po zastąpieniu klasy pochodnej zapisuje instrukcję przetwarzania z spacją między nazwą a tekstem w następujący sposób: <?name text?>.

public:
 abstract void WriteProcessingInstruction(System::String ^ name, System::String ^ text);

public abstract void WriteProcessingInstruction (string name, string? text);

abstract member WriteProcessingInstruction : string * string -> unit

Public MustOverride Sub WriteProcessingInstruction (name As String, text As String)

Parametry

name

String

Nazwa instrukcji przetwarzania.

text

String

Tekst do uwzględnienia w instrukcji przetwarzania.

Wyjątki

ArgumentException

Tekst spowoduje, że dokument XML nie jest dobrze sformułowany.

Parametr name ma wartość null lub String.Empty.

Ta metoda jest używana do tworzenia deklaracji XML po WriteStartDocument() wywołaniu.

InvalidOperationException

Metoda XmlWriter została wywołana przed zakończeniem poprzedniej operacji asynchronicznej. W tym przypadku InvalidOperationException jest zgłaszany komunikat "Operacja asynchroniczna jest już w toku".

Przykłady

Poniższy przykład zapisuje plik XML reprezentujący książkę.

using System;
using System.IO;
using System.Xml;

public class Sample {

  private const string filename = "sampledata.xml";

  public static void Main() {

     XmlWriterSettings settings = new XmlWriterSettings();
     settings.Indent = true;
     XmlWriter writer = XmlWriter.Create(filename, settings);

     // Write the Processing Instruction node.
     String PItext="type=\"text/xsl\" href=\"book.xsl\"";
     writer.WriteProcessingInstruction("xml-stylesheet", PItext);

     // Write the DocumentType node.
     writer.WriteDocType("book", null , null, "<!ENTITY h \"hardcover\">");

     // Write a Comment node.
     writer.WriteComment("sample XML");

     // Write the root element.
     writer.WriteStartElement("book");

     // Write the genre attribute.
     writer.WriteAttributeString("genre", "novel");

     // Write the ISBN attribute.
     writer.WriteAttributeString("ISBN", "1-8630-014");

     // Write the title.
     writer.WriteElementString("title", "The Handmaid's Tale");

     // Write the style element.
     writer.WriteStartElement("style");
     writer.WriteEntityRef("h");
     writer.WriteEndElement();

     // Write the price.
     writer.WriteElementString("price", "19.95");

     // Write CDATA.
     writer.WriteCData("Prices 15% off!!");

     // Write the close tag for the root element.
     writer.WriteEndElement();

     writer.WriteEndDocument();

     // Write the XML to file and close the writer.
     writer.Flush();
     writer.Close();
  }
}

Option Strict
Option Explicit

Imports System.IO
Imports System.Xml

Public Class Sample
    Private Const filename As String = "sampledata.xml"
    
  Public Shared Sub Main()

     Dim settings As XmlWriterSettings = new XmlWriterSettings()
     settings.Indent = true
     Dim writer As XmlWriter = XmlWriter.Create(filename, settings)
        
     ' Write the Processing Instruction node.
     Dim PItext As String = "type=""text/xsl"" href=""book.xsl"""
     writer.WriteProcessingInstruction("xml-stylesheet", PItext)
        
     'Write the DocumentType node.
     writer.WriteDocType("book", Nothing, Nothing, "<!ENTITY h ""hardcover"">")
        
     ' Write a Comment node.
     writer.WriteComment("sample XML")
        
     ' Write the root element.
     writer.WriteStartElement("book")
        
     ' Write the genre attribute
     writer.WriteAttributeString("genre", "novel")
        
     ' Write the ISBN attribute.
     writer.WriteAttributeString("ISBN", "1-8630-014")
        
     ' Write the title.
     writer.WriteElementString("title", "The Handmaid's Tale")
        
     ' Write the style element.
     writer.WriteStartElement("style")
     writer.WriteEntityRef("h")
     writer.WriteEndElement()
       
     ' Write the price.
     writer.WriteElementString("price", "19.95")
        
     ' Write CDATA.
     writer.WriteCData("Prices 15% off!!")
        
     ' Write the close tag for the root element.
     writer.WriteEndElement()
        
     writer.WriteEndDocument()
        
     ' Write the XML to file and close the writer
     writer.Flush()
     writer.Close()
        
    End Sub
End Class

Uwagi

Tej metody można użyć do zapisania deklaracji XML (zamiast WriteStartDocument). Może to spowodować niepoprawne zapisanie atrybutu kodowania. Na przykład poniższy kod języka C# spowoduje nieprawidłowy dokument XML, ponieważ domyślne kodowanie to UTF-8.

XmlWriter writer = XmlWriter.Create("output.xml");
writer.WriteProcessingInstruction("xml", "version='1.0' encoding='UTF-16'");
writer.WriteStartElement("root");
writer.Close();

Jeśli text jest albo null , String.Emptyta metoda zapisuje wartość ProcessingInstruction bez zawartości danych, na przykład <?name?>.

Jeśli tekst zawiera nieprawidłową sekwencję "?>", XmlWriter może zgłosić ArgumentException (XmlTextWriter obiekty) lub wstawić spację "? >" aby uniknąć pisania nieprawidłowego kodu XML (XmlWriter obiektów utworzonych przez metodę Create ).

Aby uzyskać asynchroniczną wersję tej metody, zobacz WriteProcessingInstructionAsync.