XmlWriter.Create メソッド

定義

新しい XmlWriter のインスタンスを作成します。Creates a new XmlWriter instance.

オーバーロード

Create(XmlWriter, XmlWriterSettings)

指定された XmlWriter オブジェクトと XmlWriterSettings オブジェクトを使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the specified XmlWriter and XmlWriterSettings objects.

Create(String, XmlWriterSettings)

ファイル名と XmlWriterSettings オブジェクトを使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the filename and XmlWriterSettings object.

Create(TextWriter, XmlWriterSettings)

TextWriter オブジェクトと XmlWriterSettings オブジェクトを使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the TextWriter and XmlWriterSettings objects.

Create(Stream, XmlWriterSettings)

ストリームと XmlWriterSettings オブジェクトを使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the stream and XmlWriterSettings object.

Create(StringBuilder, XmlWriterSettings)

StringBuilder オブジェクトと XmlWriterSettings オブジェクトを使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the StringBuilder and XmlWriterSettings objects.

Create(StringBuilder)

指定された StringBuilder を使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the specified StringBuilder.

Create(String)

指定されたファイル名を使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the specified filename.

Create(TextWriter)

指定された TextWriter を使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the specified TextWriter.

Create(Stream)

指定されたストリームを使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the specified stream.

Create(XmlWriter)

指定された XmlWriter オブジェクトを使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the specified XmlWriter object.

注釈

一部の Create オーバーロードには、XmlWriterSettings オブジェクトを受け取る settings パラメーターが含まれています。Some of the Create overloads include a settings parameter that accepts an XmlWriterSettings object. このオブジェクトを使用して、次のことを行うことができます。You can use this object to:

  • 作成された XmlWriter オブジェクトでサポートする機能を指定します。Specify which features you want supported on the created XmlWriter object.

  • XmlWriterSettings オブジェクトを再利用して、複数のライターオブジェクトを作成します。Reuse the XmlWriterSettings object to create multiple writer objects. 作成されるライターそれぞれについて、XmlWriterSettings オブジェクトがコピーされ、読み取り専用とマークされます。The XmlWriterSettings object is copied and marked read-only for each created writer. XmlWriterSettings インスタンスの設定が変更されても、同じ設定を使用している既存のライターには影響しません。Changes to the settings on an XmlWriterSettings instance do not affect existing writers with the same settings. したがって、同じ機能を持つ複数のライターの作成に、同じ設定を使用できます。Thus, you can use the same settings to create multiple writers with the same functionality. または、XmlWriterSettings インスタンスの設定を変更して、別の機能セットを持つ新しいライターを作成できます。Or, you can modify the settings on an XmlWriterSettings instance and create a new writer with a different set of features.

  • 既存の XML ライターに機能を追加します。Add features to an existing XML writer. Create メソッドは別の XmlWriter オブジェクトを受け取ることができます。The Create method can accept another XmlWriter object. 基になる XmlWriter オブジェクトは、静的な Create メソッドによって作成された XML ライターである必要はありません。The underlying XmlWriter object does not have to be an XML writer created by the static Create method. たとえば、ユーザー定義の XML ライターを指定して、機能を追加することができます。For example, you can specify a user-defined XML writer to add additional features to.

  • 静的な Create メソッドによって作成された XmlWriter オブジェクトでのみ使用可能な、準拠のチェックやXML 1.0 勧告への準拠などの機能を最大限に活用します。Take full advantage of features such as better conformance checking and compliance to the XML 1.0 recommendation that are available only on XmlWriter objects created by the static Create method.

XmlWriterSettings オブジェクトを受け入れない Create のオーバーロードを使用する場合は、次の既定のライター設定が使用されます。If you use a Create overload that doesn't accept an XmlWriterSettings object, the following default writer settings are used:

設定Setting 既定値Default
CheckCharacters true
CloseOutput false
ConformanceLevel ConformanceLevel.Document
Encoding Encoding.UTF8
Indent false
IndentChars 2 つのスペースTwo spaces
NamespaceHandling Default (削除なし)Default (no removal)
NewLineChars \r\n (キャリッジ リターン、改行)\r\n (carriage return, new line)
NewLineHandling NewLineHandling.Replace
NewLineOnAttributes false
OmitXmlDeclaration false
OutputMethod XmlOutputMethod.Xml
WriteEndDocumentOnClose true

注意

.NET Framework には、XmlWriter クラスの具象実装である XmlTextWriter クラスが含まれていますが、Create メソッドを使用して XmlWriter インスタンスを作成することをお勧めします。Although the .NET Framework includes the XmlTextWriter class, which is a concrete implementation of the XmlWriter class, we recommend that you create XmlWriter instances by using the Create method.

Create(XmlWriter, XmlWriterSettings)

指定された XmlWriter オブジェクトと XmlWriterSettings オブジェクトを使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the specified XmlWriter and XmlWriterSettings objects.

public:
 static System::Xml::XmlWriter ^ Create(System::Xml::XmlWriter ^ output, System::Xml::XmlWriterSettings ^ settings);
public static System.Xml.XmlWriter Create (System.Xml.XmlWriter output, System.Xml.XmlWriterSettings settings);
static member Create : System.Xml.XmlWriter * System.Xml.XmlWriterSettings -> System.Xml.XmlWriter
Public Shared Function Create (output As XmlWriter, settings As XmlWriterSettings) As XmlWriter

パラメーター

output
XmlWriter

基になるライターとして使用する XmlWriter オブジェクト。The XmlWriter object that you want to use as the underlying writer.

settings
XmlWriterSettings

新しい XmlWriter インスタンスを構成するために使用される XmlWriterSettings オブジェクト。The XmlWriterSettings object used to configure the new XmlWriter instance. これが null である場合は、既定の設定で XmlWriterSettings が使用されます。If this is null, a XmlWriterSettings with default settings is used.

XmlWriterTransform(String, XmlWriter) メソッドと組み合わせて使用する場合は、OutputSettings プロパティを使って、正しい設定の割り当てられた XmlWriterSettings オブジェクトを取得する必要があります。If the XmlWriter is being used with the Transform(String, XmlWriter) method, you should use the OutputSettings property to obtain an XmlWriterSettings object with the correct settings. これにより、作成された XmlWriter オブジェクトに正しい出力設定が適用されます。This ensures that the created XmlWriter object has the correct output settings.

戻り値

指定された XmlWriter オブジェクトをラップする XmlWriter オブジェクト。An XmlWriter object that is wrapped around the specified XmlWriter object.

例外

writer 値は null です。The writer value is null.

注釈

このメソッドを使用すると、基になる XmlWriter オブジェクトに機能を追加できます。This method allows you add additional features to an underlying XmlWriter object. 基になる XmlWriter オブジェクトは、XmlWriter.Create メソッドによって作成されたオブジェクト、または XmlTextWriter 実装を使用して作成されたオブジェクトです。The underlying XmlWriter object can be an object created by the XmlWriter.Create method, or an object created using the XmlTextWriter implementation.

Create(String, XmlWriterSettings)

ファイル名と XmlWriterSettings オブジェクトを使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the filename and XmlWriterSettings object.

public:
 static System::Xml::XmlWriter ^ Create(System::String ^ outputFileName, System::Xml::XmlWriterSettings ^ settings);
public static System.Xml.XmlWriter Create (string outputFileName, System.Xml.XmlWriterSettings settings);
static member Create : string * System.Xml.XmlWriterSettings -> System.Xml.XmlWriter
Public Shared Function Create (outputFileName As String, settings As XmlWriterSettings) As XmlWriter

パラメーター

outputFileName
String

書き込み先のファイル。The file to which you want to write. XmlWriter は、指定されたパスにファイルを作成し、XML 1.0 テキスト構文でファイルに書き込みます。The XmlWriter creates a file at the specified path and writes to it in XML 1.0 text syntax. outputFileName はファイル システム パスにする必要があります。The outputFileName must be a file system path.

settings
XmlWriterSettings

新しい XmlWriter インスタンスを構成するために使用される XmlWriterSettings オブジェクト。The XmlWriterSettings object used to configure the new XmlWriter instance. これが null である場合は、既定の設定で XmlWriterSettings が使用されます。If this is null, a XmlWriterSettings with default settings is used.

XmlWriterTransform(String, XmlWriter) メソッドと組み合わせて使用する場合は、OutputSettings プロパティを使って、正しい設定の割り当てられた XmlWriterSettings オブジェクトを取得する必要があります。If the XmlWriter is being used with the Transform(String, XmlWriter) method, you should use the OutputSettings property to obtain an XmlWriterSettings object with the correct settings. これにより、作成された XmlWriter オブジェクトに正しい出力設定が適用されます。This ensures that the created XmlWriter object has the correct output settings.

戻り値

XmlWriter オブジェクト。An XmlWriter object.

例外

url 値は null です。The url value is null.

次の例では、定義された設定を使用して XmlWriter オブジェクトを作成します。The following example creates an XmlWriter object with the defined settings.

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

public class Sample {

  public static void Main() {
  
    XmlWriter writer = null;

    try {

       // Create an XmlWriterSettings object with the correct options. 
       XmlWriterSettings settings = new XmlWriterSettings();
       settings.Indent = true;
       settings.IndentChars = ("\t");
       settings.OmitXmlDeclaration = true;

       // Create the XmlWriter object and write some content.
       writer = XmlWriter.Create("data.xml", settings);
       writer.WriteStartElement("book");
       writer.WriteElementString("item", "tesing");
       writer.WriteEndElement();
    
       writer.Flush();

     } 
     finally  {
        if (writer != null)
          writer.Close();
     }
  } 
} 
Imports System.IO
Imports System.Xml
Imports System.Text

Public Class Sample 

  Public Shared Sub Main() 
  
    Dim writer As XmlWriter = Nothing

    Try 

       ' Create an XmlWriterSettings object with the correct options. 
       Dim settings As XmlWriterSettings = New XmlWriterSettings()
       settings.Indent = true
       settings.IndentChars = (ControlChars.Tab)
       settings.OmitXmlDeclaration = true

       ' Create the XmlWriter object and write some content.
       writer = XmlWriter.Create("data.xml", settings)
       writer.WriteStartElement("book")
       writer.WriteElementString("item", "tesing")
       writer.WriteEndElement()
    
       writer.Flush()

      Finally
         If Not (writer Is Nothing) Then
            writer.Close()
         End If
      End Try

   End Sub 
End Class 

Create(TextWriter, XmlWriterSettings)

TextWriter オブジェクトと XmlWriterSettings オブジェクトを使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the TextWriter and XmlWriterSettings objects.

public:
 static System::Xml::XmlWriter ^ Create(System::IO::TextWriter ^ output, System::Xml::XmlWriterSettings ^ settings);
public static System.Xml.XmlWriter Create (System.IO.TextWriter output, System.Xml.XmlWriterSettings settings);
static member Create : System.IO.TextWriter * System.Xml.XmlWriterSettings -> System.Xml.XmlWriter
Public Shared Function Create (output As TextWriter, settings As XmlWriterSettings) As XmlWriter

パラメーター

output
TextWriter

書き込み先の TextWriterThe TextWriter to which you want to write. XmlWriter は、XML 1.0 テキスト構文を書き込み、指定された TextWriter にそれを付加します。The XmlWriter writes XML 1.0 text syntax and appends it to the specified TextWriter.

settings
XmlWriterSettings

新しい XmlWriter インスタンスを構成するために使用される XmlWriterSettings オブジェクト。The XmlWriterSettings object used to configure the new XmlWriter instance. これが null である場合は、既定の設定で XmlWriterSettings が使用されます。If this is null, a XmlWriterSettings with default settings is used.

XmlWriterTransform(String, XmlWriter) メソッドと組み合わせて使用する場合は、OutputSettings プロパティを使って、正しい設定の割り当てられた XmlWriterSettings オブジェクトを取得する必要があります。If the XmlWriter is being used with the Transform(String, XmlWriter) method, you should use the OutputSettings property to obtain an XmlWriterSettings object with the correct settings. これにより、作成された XmlWriter オブジェクトに正しい出力設定が適用されます。This ensures that the created XmlWriter object has the correct output settings.

戻り値

XmlWriter オブジェクト。An XmlWriter object.

例外

text 値は null です。The text value is null.

次の例では、XML 文字列を書き込みます。The following example writes out an XML string.

XmlWriterSettings settings = new XmlWriterSettings();
settings.OmitXmlDeclaration = true;
StringWriter sw = new StringWriter();

using (XmlWriter writer = XmlWriter.Create(sw, settings))
{
    writer.WriteStartElement("book");
    writer.WriteElementString("price", "19.95");
    writer.WriteEndElement();
    writer.Flush();

    String output = sw.ToString();
}

Dim settings As New XmlWriterSettings()
settings.OmitXmlDeclaration = True
Dim sw As New StringWriter()
        
Using writer As XmlWriter = XmlWriter.Create(sw, settings)
  writer.WriteStartElement("book")
  writer.WriteElementString("price", "19.95")
  writer.WriteEndElement()
  writer.Flush()
            
  Dim output As String = sw.ToString()
End Using

Create(Stream, XmlWriterSettings)

ストリームと XmlWriterSettings オブジェクトを使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the stream and XmlWriterSettings object.

public:
 static System::Xml::XmlWriter ^ Create(System::IO::Stream ^ output, System::Xml::XmlWriterSettings ^ settings);
public static System.Xml.XmlWriter Create (System.IO.Stream output, System.Xml.XmlWriterSettings settings);
static member Create : System.IO.Stream * System.Xml.XmlWriterSettings -> System.Xml.XmlWriter
Public Shared Function Create (output As Stream, settings As XmlWriterSettings) As XmlWriter

パラメーター

output
Stream

書き込み先のストリーム。The stream to which you want to write. XmlWriter は、XML 1.0 テキスト構文を書き込み、指定されたストリームにそれを付加します。The XmlWriter writes XML 1.0 text syntax and appends it to the specified stream.

settings
XmlWriterSettings

新しい XmlWriter インスタンスを構成するために使用される XmlWriterSettings オブジェクト。The XmlWriterSettings object used to configure the new XmlWriter instance. これが null である場合は、既定の設定で XmlWriterSettings が使用されます。If this is null, a XmlWriterSettings with default settings is used.

XmlWriterTransform(String, XmlWriter) メソッドと組み合わせて使用する場合は、OutputSettings プロパティを使って、正しい設定の割り当てられた XmlWriterSettings オブジェクトを取得する必要があります。If the XmlWriter is being used with the Transform(String, XmlWriter) method, you should use the OutputSettings property to obtain an XmlWriterSettings object with the correct settings. これにより、作成された XmlWriter オブジェクトに正しい出力設定が適用されます。This ensures that the created XmlWriter object has the correct output settings.

戻り値

XmlWriter オブジェクト。An XmlWriter object.

例外

stream 値は null です。The stream value is null.

次の例では、XML フラグメントをメモリストリームに書き込みます。The following example writes an XML fragment to a memory stream.

XmlWriterSettings settings = new XmlWriterSettings();
settings.OmitXmlDeclaration = true;
settings.ConformanceLevel = ConformanceLevel.Fragment;
settings.CloseOutput = false;

// Create the XmlWriter object and write some content.
MemoryStream strm = new MemoryStream();
XmlWriter writer = XmlWriter.Create(strm, settings);
writer.WriteElementString("orderID", "1-456-ab");
writer.WriteElementString("orderID", "2-36-00a");
writer.Flush();
writer.Close();

// Do additonal processing on the stream.
Dim settings As XmlWriterSettings = New XmlWriterSettings()
settings.OmitXmlDeclaration = true
settings.ConformanceLevel = ConformanceLevel.Fragment
settings.CloseOutput = false

' Create the XmlWriter object and write some content.
Dim strm as MemoryStream = new MemoryStream()
Dim writer As XmlWriter = XmlWriter.Create(strm, settings)
writer.WriteElementString("orderID", "1-456-ab")
writer.WriteElementString("orderID", "2-36-00a")
writer.Flush()
writer.Close()

' Do additonal processing on the stream.

注釈

XmlWriter は、常に、基になるデータストリームにバイトオーダーマーク (BOM) を書き込みます。ただし、一部のストリームは BOM を持つことはできません。XmlWriter always writes a Byte Order Mark (BOM) to the underlying data stream; however, some streams must not have a BOM. BOM を省略するには、新しい XmlWriterSettings オブジェクトを作成し、Encoding プロパティを新しい UTF8Encoding オブジェクトに設定し、コンストラクターのブール値を false に設定します。To omit the BOM, create a new XmlWriterSettings object and set the Encoding property to be a new UTF8Encoding object with the Boolean value in the constructor set to false.

Create(StringBuilder, XmlWriterSettings)

StringBuilder オブジェクトと XmlWriterSettings オブジェクトを使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the StringBuilder and XmlWriterSettings objects.

public:
 static System::Xml::XmlWriter ^ Create(System::Text::StringBuilder ^ output, System::Xml::XmlWriterSettings ^ settings);
public static System.Xml.XmlWriter Create (System.Text.StringBuilder output, System.Xml.XmlWriterSettings settings);
static member Create : System.Text.StringBuilder * System.Xml.XmlWriterSettings -> System.Xml.XmlWriter
Public Shared Function Create (output As StringBuilder, settings As XmlWriterSettings) As XmlWriter

パラメーター

output
StringBuilder

書き込み先の StringBuilderThe StringBuilder to which to write to. XmlWriter で書き込まれたコンテンツが、StringBuilder に付加されます。Content written by the XmlWriter is appended to the StringBuilder.

settings
XmlWriterSettings

新しい XmlWriter インスタンスを構成するために使用される XmlWriterSettings オブジェクト。The XmlWriterSettings object used to configure the new XmlWriter instance. これが null である場合は、既定の設定で XmlWriterSettings が使用されます。If this is null, a XmlWriterSettings with default settings is used.

XmlWriterTransform(String, XmlWriter) メソッドと組み合わせて使用する場合は、OutputSettings プロパティを使って、正しい設定の割り当てられた XmlWriterSettings オブジェクトを取得する必要があります。If the XmlWriter is being used with the Transform(String, XmlWriter) method, you should use the OutputSettings property to obtain an XmlWriterSettings object with the correct settings. これにより、作成された XmlWriter オブジェクトに正しい出力設定が適用されます。This ensures that the created XmlWriter object has the correct output settings.

戻り値

XmlWriter オブジェクト。An XmlWriter object.

例外

builder 値は null です。The builder value is null.

Create(StringBuilder)

指定された StringBuilder を使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the specified StringBuilder.

public:
 static System::Xml::XmlWriter ^ Create(System::Text::StringBuilder ^ output);
public static System.Xml.XmlWriter Create (System.Text.StringBuilder output);
static member Create : System.Text.StringBuilder -> System.Xml.XmlWriter
Public Shared Function Create (output As StringBuilder) As XmlWriter

パラメーター

output
StringBuilder

書き込み先の StringBuilderThe StringBuilder to which to write to. XmlWriter で書き込まれたコンテンツが、StringBuilder に付加されます。Content written by the XmlWriter is appended to the StringBuilder.

戻り値

XmlWriter オブジェクト。An XmlWriter object.

例外

builder 値は null です。The builder value is null.

注釈

このオーバーロードを使用すると、既定の設定を持つ XmlWriterSettings オブジェクトが XML ライターの作成に使用されます。When you use this overload, an XmlWriterSettings object with default settings is used to create the XML writer.

設定Setting 既定値Default
CheckCharacters true
CloseOutput false
ConformanceLevel ConformanceLevel.Document
Encoding Encoding.UTF8
Indent false
IndentChars 2 つのスペースTwo spaces
NamespaceHandling Default (削除なし)Default (no removal)
NewLineChars \r\n (キャリッジ リターン、改行)\r\n (carriage return, new line)
NewLineHandling NewLineHandling.Replace
NewLineOnAttributes false
OmitXmlDeclaration false
OutputMethod XmlOutputMethod.Xml
WriteEndDocumentOnClose true

作成された XML ライターでサポートする機能を指定する場合は、XmlWriterSettings オブジェクトを引数の1つとして受け取り、XmlWriterSettings オブジェクトをカスタム設定で渡すオーバーロードを使用します。If you want to specify the features to support on the created XML writer, use an overload that takes an XmlWriterSettings object as one of its arguments, and pass in a XmlWriterSettings object with your custom settings.

Create(String)

指定されたファイル名を使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the specified filename.

public:
 static System::Xml::XmlWriter ^ Create(System::String ^ outputFileName);
public static System.Xml.XmlWriter Create (string outputFileName);
static member Create : string -> System.Xml.XmlWriter
Public Shared Function Create (outputFileName As String) As XmlWriter

パラメーター

outputFileName
String

書き込み先のファイル。The file to which you want to write. XmlWriter は、指定されたパスにファイルを作成し、XML 1.0 テキスト構文でファイルに書き込みます。The XmlWriter creates a file at the specified path and writes to it in XML 1.0 text syntax. outputFileName はファイル システム パスにする必要があります。The outputFileName must be a file system path.

戻り値

XmlWriter オブジェクト。An XmlWriter object.

例外

url 値は null です。The url value is null.

次の例では、XmlWriter オブジェクトを作成し、book ノードを書き込みます。The following example creates an XmlWriter object and writes a book node.

using (XmlWriter writer = XmlWriter.Create("output.xml"))
{
    writer.WriteStartElement("book");
    writer.WriteElementString("price", "19.95");
    writer.WriteEndElement();
    writer.Flush();
}

Using writer As XmlWriter = XmlWriter.Create("output.xml")
  writer.WriteStartElement("book")
  writer.WriteElementString("price", "19.95")
  writer.WriteEndElement()
  writer.Flush()
End Using

注釈

このオーバーロードを使用すると、既定の設定を持つ XmlWriterSettings オブジェクトが XML ライターの作成に使用されます。When you use this overload, an XmlWriterSettings object with default settings is used to create the XML writer.

設定Setting 既定値Default
CheckCharacters true
CloseOutput false
ConformanceLevel ConformanceLevel.Document
Encoding Encoding.UTF8
Indent false
IndentChars 2 つのスペースTwo spaces
NamespaceHandling Default (削除なし)Default (no removal)
NewLineChars \r\n (キャリッジ リターン、改行)\r\n (carriage return, new line)
NewLineHandling NewLineHandling.Replace
NewLineOnAttributes false
OmitXmlDeclaration false
OutputMethod XmlOutputMethod.Xml
WriteEndDocumentOnClose true

作成された XML ライターでサポートする機能を指定する場合は、XmlWriterSettings オブジェクトを引数の1つとして受け取り、XmlWriterSettings オブジェクトをカスタム設定で渡すオーバーロードを使用します。If you want to specify the features to support on the created XML writer, use an overload that takes an XmlWriterSettings object as one of its arguments, and pass in a XmlWriterSettings object with your custom settings.

Create(TextWriter)

指定された TextWriter を使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the specified TextWriter.

public:
 static System::Xml::XmlWriter ^ Create(System::IO::TextWriter ^ output);
public static System.Xml.XmlWriter Create (System.IO.TextWriter output);
static member Create : System.IO.TextWriter -> System.Xml.XmlWriter
Public Shared Function Create (output As TextWriter) As XmlWriter

パラメーター

output
TextWriter

書き込み先の TextWriterThe TextWriter to which you want to write. XmlWriter は、XML 1.0 テキスト構文を書き込み、指定された TextWriter にそれを付加します。The XmlWriter writes XML 1.0 text syntax and appends it to the specified TextWriter.

戻り値

XmlWriter オブジェクト。An XmlWriter object.

例外

text 値は null です。The text value is null.

次の例では、コンソールに出力するライターを作成します。The following example creates a writer that outputs to the console.

using (XmlWriter writer = XmlWriter.Create(Console.Out))
{
    writer.WriteStartElement("book");
    writer.WriteElementString("price", "19.95");
    writer.WriteEndElement();
    writer.Flush();
}

Using writer As XmlWriter = XmlWriter.Create(Console.Out)
  writer.WriteStartElement("book")
  writer.WriteElementString("price", "19.95")
  writer.WriteEndElement()
  writer.Flush()
End Using

注釈

このオーバーロードを使用すると、既定の設定を持つ XmlWriterSettings オブジェクトが XML ライターの作成に使用されます。When you use this overload, an XmlWriterSettings object with default settings is used to create the XML writer.

設定Setting 既定値Default
CheckCharacters true
CloseOutput false
ConformanceLevel ConformanceLevel.Document
Encoding Encoding.UTF8
Indent false
IndentChars 2 つのスペースTwo spaces
NamespaceHandling Default (削除なし)Default (no removal)
NewLineChars \r\n (キャリッジ リターン、改行)\r\n (carriage return, new line)
NewLineHandling NewLineHandling.Replace
NewLineOnAttributes false
OmitXmlDeclaration false
OutputMethod XmlOutputMethod.Xml
WriteEndDocumentOnClose true

作成されたライターでサポートする機能を指定する場合は、XmlWriterSettings オブジェクトをその引数の1つとして受け取り、XmlWriterSettings オブジェクトをカスタム設定で渡すオーバーロードを使用します。If you want to specify the features to support on the created writer, use an overload that takes an XmlWriterSettings object as one of its arguments, and pass in an XmlWriterSettings object with your custom settings.

Create(Stream)

指定されたストリームを使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the specified stream.

public:
 static System::Xml::XmlWriter ^ Create(System::IO::Stream ^ output);
public static System.Xml.XmlWriter Create (System.IO.Stream output);
static member Create : System.IO.Stream -> System.Xml.XmlWriter
Public Shared Function Create (output As Stream) As XmlWriter

パラメーター

output
Stream

書き込み先のストリーム。The stream to which you want to write. XmlWriter は、XML 1.0 テキスト構文を書き込み、指定されたストリームにそれを付加します。The XmlWriter writes XML 1.0 text syntax and appends it to the specified stream.

戻り値

XmlWriter オブジェクト。An XmlWriter object.

例外

stream 値は null です。The stream value is null.

次の例では、XML フラグメントをメモリストリームに書き込みます。The following example writes an XML fragment to a memory stream. (Create(Stream, XmlWriterSettings) オーバーロードを使用します。これにより、新しい XML ライターインスタンスでも設定が構成されます)。(It uses the Create(Stream, XmlWriterSettings) overload, which also configures the settings on the new XML writer instance.)

XmlWriterSettings settings = new XmlWriterSettings();
settings.OmitXmlDeclaration = true;
settings.ConformanceLevel = ConformanceLevel.Fragment;
settings.CloseOutput = false;

// Create the XmlWriter object and write some content.
MemoryStream strm = new MemoryStream();
XmlWriter writer = XmlWriter.Create(strm, settings);
writer.WriteElementString("orderID", "1-456-ab");
writer.WriteElementString("orderID", "2-36-00a");
writer.Flush();
writer.Close();

// Do additonal processing on the stream.
Dim settings As XmlWriterSettings = New XmlWriterSettings()
settings.OmitXmlDeclaration = true
settings.ConformanceLevel = ConformanceLevel.Fragment
settings.CloseOutput = false

' Create the XmlWriter object and write some content.
Dim strm as MemoryStream = new MemoryStream()
Dim writer As XmlWriter = XmlWriter.Create(strm, settings)
writer.WriteElementString("orderID", "1-456-ab")
writer.WriteElementString("orderID", "2-36-00a")
writer.Flush()
writer.Close()

' Do additonal processing on the stream.

注釈

このオーバーロードを使用すると、次の既定の設定を持つ XmlWriterSettings オブジェクトを使用して XML ライターが作成されます。When you use this overload, an XmlWriterSettings object with the following default settings is used to create the XML writer:

設定Setting 既定値Default
CheckCharacters true
CloseOutput false
ConformanceLevel ConformanceLevel.Document
Encoding Encoding.UTF8
Indent false
IndentChars 2 つのスペースTwo spaces
NamespaceHandling Default (削除なし)Default (no removal)
NewLineChars \r\n (キャリッジ リターン、改行)\r\n (carriage return, new line)
NewLineHandling NewLineHandling.Replace
NewLineOnAttributes false
OmitXmlDeclaration false
OutputMethod XmlOutputMethod.Xml
WriteEndDocumentOnClose true

作成されたライターでサポートする機能を指定する場合は、XmlWriterSettings オブジェクトをその引数の1つとして受け取り、XmlWriterSettings オブジェクトをカスタム設定で渡すオーバーロードを使用します。If you want to specify the features to support on the created writer, use an overload that takes an XmlWriterSettings object as one of its arguments, and pass in an XmlWriterSettings object with your custom settings.

また、XmlWriter は常に、基になるデータストリームにバイトオーダーマーク (BOM) を書き込みます。ただし、一部のストリームは BOM を持つことはできません。Also, XmlWriter always writes a Byte Order Mark (BOM) to the underlying data stream; however, some streams must not have a BOM. BOM を省略するには、新しい XmlWriterSettings オブジェクトを作成し、Encoding プロパティを新しい UTF8Encoding オブジェクトに設定し、コンストラクターのブール値を false に設定します。To omit the BOM, create a new XmlWriterSettings object and set the Encoding property to be a new UTF8Encoding object with the Boolean value in the constructor set to false.

Create(XmlWriter)

指定された XmlWriter オブジェクトを使用して新しい XmlWriter インスタンスを作成します。Creates a new XmlWriter instance using the specified XmlWriter object.

public:
 static System::Xml::XmlWriter ^ Create(System::Xml::XmlWriter ^ output);
public static System.Xml.XmlWriter Create (System.Xml.XmlWriter output);
static member Create : System.Xml.XmlWriter -> System.Xml.XmlWriter
Public Shared Function Create (output As XmlWriter) As XmlWriter

パラメーター

output
XmlWriter

基になるライターとして使用する XmlWriter オブジェクト。The XmlWriter object that you want to use as the underlying writer.

戻り値

指定された XmlWriter オブジェクトをラップする XmlWriter オブジェクト。An XmlWriter object that is wrapped around the specified XmlWriter object.

例外

writer 値は null です。The writer value is null.

注釈

このメソッドを使用すると、基になる XmlWriter オブジェクトに機能を追加できます。This method allows you add features to an underlying XmlWriter object. 基になる XmlWriter オブジェクトは、XmlWriter.Create メソッドによって作成されたオブジェクト、または XmlTextWriter 実装を使用して作成されたオブジェクトです。The underlying XmlWriter object can be an object created by the XmlWriter.Create method, or an object created using the XmlTextWriter implementation.

このオーバーロードを使用すると、既定の設定を持つ XmlWriterSettings オブジェクトが XML ライターの作成に使用されます。When you use this overload, an XmlWriterSettings object with default settings is used to create the XML writer.

設定Setting 既定値Default
CheckCharacters true
CloseOutput false
ConformanceLevel ConformanceLevel.Document
Encoding Encoding.UTF8
Indent false
IndentChars 2 つのスペースTwo spaces
NamespaceHandling Default (削除なし)Default (no removal)
NewLineChars \r\n (キャリッジ リターン、改行)\r\n (carriage return, new line)
NewLineHandling NewLineHandling.Replace
NewLineOnAttributes false
OmitXmlDeclaration false
OutputMethod XmlOutputMethod.Xml
WriteEndDocumentOnClose true

作成された XML ライターでサポートする機能を指定する場合は、XmlWriterSettings オブジェクトを引数の1つとして受け取り、XmlWriterSettings オブジェクトをカスタム設定で渡すオーバーロードを使用します。If you want to specify the features to support on the created XML writer, use an overload that takes an XmlWriterSettings object as one of its arguments, and pass in a XmlWriterSettings object with your custom settings.

適用対象