XmlWriter.WriteProcessingInstruction(String, String) Metod

Definition

Namnområde:
System.Xml
Sammansättningar:
System.Xml.dll, System.Xml.ReaderWriter.dll
Sammansättningar:
netstandard.dll, System.Xml.ReaderWriter.dll
Sammansättning:
System.Xml.ReaderWriter.dll
Sammansättning:
System.Xml.dll
Sammansättning:
netstandard.dll
Källa:
XmlWriter.cs
Källa:
XmlWriter.cs
Källa:
XmlWriter.cs
Källa:
XmlWriter.cs
Källa:
XmlWriter.cs

När du åsidosättas i en härledd klass skriver du ut en bearbetningsinstruktion med ett blanksteg mellan namnet och texten på följande sätt: <?name text?>.

public:
 abstract void WriteProcessingInstruction(System::String ^ name, System::String ^ text);
public abstract void WriteProcessingInstruction(string name, 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)

Parametrar

name
String

Namnet på bearbetningsinstruktionen.

text
String

Texten som ska inkluderas i bearbetningsinstruktionen.

Undantag

ArgumentException

Texten skulle resultera i ett icke-välformat XML-dokument.

name är antingen null eller String.Empty.

Den här metoden används för att skapa en XML-deklaration när WriteStartDocument() den redan har anropats.

InvalidOperationException

En XmlWriter metod anropades innan en tidigare asynkron åtgärd slutfördes. I det här fallet InvalidOperationException genereras meddelandet "En asynkron åtgärd pågår redan".

Exempel

I följande exempel skrivs en XML-fil som representerar en bok.

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

Kommentarer

Den här metoden kan användas för att skriva XML-deklarationen (i stället WriteStartDocumentför ). Detta kan leda till att kodningsattributet skrivs felaktigt. Följande C#-kod skulle till exempel resultera i ett ogiltigt XML-dokument eftersom standardkodningen är UTF-8.

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

Om text är antingen null eller String.Emptyskriver den här metoden en ProcessingInstruction utan datainnehåll, till exempel <?name?>.

Om texten innehåller en ogiltig sekvens av "?>", XmlWriter kan antingen kasta ett ArgumentException (XmlTextWriter objekt) eller infoga ett blanksteg "? >" för att undvika att skriva ogiltig XML (XmlWriter objekt som skapats av Create metoden).

Den asynkrona versionen av den här metoden finns i WriteProcessingInstructionAsync.

Gäller för