XmlWriter.WriteProcessingInstruction(String, String) Метод

Определение

Пространство имен:

System.Xml

Сборка:

System.Xml.ReaderWriter.dll

Сборка:

System.Xml.dll

Сборка:

netstandard.dll

При переопределении в производном классе считывает инструкцию обработки с пробелом между именем и текстом в следующем виде: <?имя текст?>.

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)

Параметры

name

String

Имя инструкции по обработке.

text

String

Текст, включаемый в инструкцию по обработке.

Исключения

ArgumentException

Текст приведет к неправильному формированию документа XML.

name имеет значение null или String.Empty.

Этот метод используется для создания XML-объявления после того, как метод WriteStartDocument() уже вызван.

InvalidOperationException

Метод XmlWriter вызван перед завершением предыдущей асинхронной операции. В этом случае возникает исключение InvalidOperationException с сообщением "Асинхронная операция уже выполняется".

Примеры

В следующем примере записывается XML-файл, представляющий книгу.

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

Комментарии

Этот метод можно использовать для записи xml-объявления (а не WriteStartDocument). Это может привести к неправильной записи атрибута кодирования. Например, следующий код C# приведет к недопустимому XML-документу, так как кодировка по умолчанию — UTF-8.

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

Если text это или null String.Emptyнет, этот метод записывает содержимое ProcessingInstruction без содержимого данных, например <?name?>.

Если текст содержит недопустимую последовательность "?>", XmlWriter можно создать ArgumentException (XmlTextWriter объекты) или вставить пробел"? >", чтобы избежать записи недопустимого XML (XmlWriter объектов, созданных методом Create ).

Асинхронная версия этого метода см. в разделе WriteProcessingInstructionAsync.