Represents a non-cached, forward-only writer way of generating streams or files containing XML data. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Inherits System::Xml::XmlWriter.

Public Types
typedef SharedPtr< XmlTextWriter >	Ptr
	An alias for shared pointer to an instance of this class. More...

Public Types inherited from System::Xml::XmlWriter
typedef SharedPtr< XmlWriter >	Ptr
	An alias for shared pointer to an instance of this class. More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Public Member Functions
	XmlTextWriter (const String &outputFileName, const SharedPtr< System::Text::Encoding > &encoding=SharedPtr< System::Text::Encoding >())
	Constructs an instance of XmlWriter class and initializes it with the specified output file and encoding. More...

	XmlTextWriter (const SharedPtr< System::IO::Stream > &stream, const SharedPtr< System::Text::Encoding > &encoding=SharedPtr< System::Text::Encoding >())
	Constructs an instance of XmlTextWriter class and initializes it with the specified stream. More...

	XmlTextWriter (const SharedPtr< System::IO::TextWriter > &text_writer)
	Constructs an instance of XmlTextWriter class and initializes it with the specified TextWriter. More...

	XmlTextWriter (const SharedPtr< System::Text::StringBuilder > &string_builder)
	Constructs an instance of XmlTextWriter class and initializes it with the specified StringBuilder. More...

	XmlTextWriter (xmlBuffer *buf)
	Constructs a new instance of XmlTextWriter and forces it to use the specified xmlBuffer object. More...

	XmlTextWriter (xmlOutputBuffer *buf)
	Constructs a new instance of XmlTextWriter and forces it to use the specified xmlOutputBuffer object. More...

virtual	~XmlTextWriter ()
	Destructor. More...

WriteState	get_WriteState () override
	Returns a value indicating the state of the current writer. More...

void	Close () override
	Closes the write stream. More...

void	Flush () override
	Flushes the content of the buffers to the underlying stream and also flushes the underlying stream. More...

void	WriteStartDocument () override
	Writes an XML declaration with version "1.0". More...

void	WriteStartDocument (bool standalone) override
	Writes an XML declaration with version "1.0" and the 'standalone' attribute with the specified value. More...

void	WriteStartElement (String localName) override
	Writes out a start tag of an element with the specified local name. More...

void	WriteStartElement (String localName, String ns) override
	Writes out a start tag of an element with the specified local name and associates it with the specified namespace. More...

void	WriteStartElement (String prefix, String localName, String ns) override
	Writes out a start tag of an element with the specified local name and prefix and associates it with the specified namespace. More...

void	WriteStartAttribute (String localName) override
	Writes the start of an attribute with the specified local name. More...

void	WriteStartAttribute (String localName, String ns) override
	Writes the start of an attribute with the specified local name and namespace. More...

void	WriteStartAttribute (String prefix, String localName, String ns) override
	Writes the start of an attribute with the specified prefix, local name and namespace. More...

void	WriteAttributeString (String localName, String value) override
	Writes out an attribute with the specified local name and value. More...

void	WriteAttributeString (String localName, String ns, String value) override
	Writes out an attribute with the specified local name and value and associates it with the specified namespace. More...

void	WriteAttributeString (String prefix, String localName, String ns, String value) override
	Writes out an attribute with the specified prefix, local name and value and associates it with the specified namespace. More...

void	WriteAttributes (SharedPtr< XmlReader > reader, bool defattr) override
	Writes out all the attributes found at the current position in the XmlReader. More...

void	WriteElementString (String localName, String value) override
	Writes out an element with the specified local name and value. More...

void	WriteElementString (String localName, String ns, String value) override
	Writes out an element with the specified local name and value and associates it with the specified namespace. More...

void	WriteElementString (String prefix, String localName, String ns, String value) override
	Writes out an element with the specified prefix, local name and value and associates it with the specified namespace. More...

void	WriteDocType (String name, String pubid, String sysid, String subset) override
	Writes out a DOCTYPE declaration with the specified name and attributes. More...

void	WriteCData (String text) override
	Writes out a CData node. More...

void	WriteComment (String text) override
	Writes out a comment node. More...

void	WriteProcessingInstruction (String name, String text) override
	Writes out a processing instruction with the specified name and text. More...

void	WriteEntityRef (String name) override
	Writes out an entity reference as {ampersand}name;. More...

void	WriteCharEntity (char_t ch) override
	Writes out a character entity for the specified Unicode character value. More...

void	WriteChars (System::ArrayPtr< char16_t > buffer, int32_t index, int32_t count) override
	Writes text one buffer at a time. More...

void	WriteString (String text) override
	Writes the specified text content. More...

void	WriteSurrogateCharEntity (char16_t lowChar, char16_t highChar) override
	Generates and writes the surrogate character entity for the surrogate character pair. More...

void	WriteWhitespace (String ws) override
	Writes the specified white spaces. More...

void	WriteRaw (String text) override
	Writes the specified string content without escaping the special characters. More...

void	WriteRaw (ArrayPtr< char_t > buffer, int index, int count) override
	Writes the specified range of characters without escaping the special characters. More...

void	WriteBase64 (ArrayPtr< uint8_t > buffer, int index, int count) override
	Base64-encodes the specified range of bytes in the specified byte array and writes out the resulting text. More...

void	WriteBinHex (ArrayPtr< uint8_t > buffer, int index, int count) override
	Encodes the specified range of bytes in the specifie array as BinHex and writes out the resulting text. More...

void	WriteEndAttribute () override
	Closes the previous WriteStartAttribute(System::String) call. More...

void	WriteEndElement () override
	Closes an element and pops the corresponding namespace scope. If the element is empty, the short form of the closing tag is used. More...

void	WriteFullEndElement () override
	Closes an element and pops the corresponding namespace scope. The full form of closing tag is used. More...

void	WriteEndDocument () override
	Closes all open elements and attributes and puts the writer in the Start state. More...

String	LookupPrefix (String ns) override
	Gets the closest prefix defined in the current namespace scope for the specified namespace URI. More...

Formatting	get_Formatting () const
	Returns a value that indicates how the output is formatted. More...

void	set_Formatting (Formatting value)
	Sets a value that indicates how the output is formatted. More...

void	set_Namespaces (bool value)
	Sets a value that indicates whether to do namespace support. More...

void	set_Indentation (int value)
	Sets an integer value that indicates how many IndentChars should be writen for each level in the hierarchy when Formatting is set to Formatting::Indented. More...

int	get_Indentation () const
	Returns an integer value that indicates how many IndentChars should be writen for each level in the hierarchy when Formatting is set to Formatting::Indented. More...

void	set_IndentChar (char_t value)
	Sets a character that should be used for indenting when Formatting is set to Formatting::Indented. More...

char_t	get_IndentChar () const
	Returns a character that should be used for indenting when Formatting is set to Formatting::Indented. More...

void	set_QuoteChar (char_t value)
	Sets a character that should be used to quote attribute values. More...

SharedPtr< System::IO::Stream >	get_BaseStream () const
	Returns the underlying stream object. More...

xmlTextWriter *	native () const
	Returns a pointer to the underlying libxml2 xmlTextWriter object. More...

Public Member Functions inherited from System::IDisposable
virtual void	Dispose ()
	Does nothing. More...

Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...

virtual	~Object ()
	Destroys object. Frees all internal data structures. More...

	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Protected Member Functions
void	ApplySettings (const SharedPtr< XmlWriterSettings > &settings)
	Applies XmlWriterSettings to the current XmlWriter object. More...

Protected Member Functions inherited from System::Xml::XmlWriter
	XmlWriter ()
	Constructs a new instance of XmlWriter class. More...

Additional Inherited Members
Static Public Member Functions inherited from System::Xml::XmlWriter
static XmlWriter::Ptr	Create (const String &outputFileName)
	Constructs an instance of XmlWriter class and initializes it with the specified output file. More...

static XmlWriter::Ptr	Create (const String &outputFileName, const SharedPtr< XmlWriterSettings > &settings)
	Constructs an instance of XmlWriter class and initializes it with the specified output file and settings. More...

static XmlWriter::Ptr	Create (const SharedPtr< System::IO::Stream > &stream, const SharedPtr< XmlWriterSettings > &settings=nullptr)
	Constructs an instance of XmlWriter class and initializes it with the specified stream and settings. More...

static XmlWriter::Ptr	Create (const SharedPtr< System::Text::StringBuilder > &builder, const SharedPtr< XmlWriterSettings > &settings)
	Constructs an instance of XmlWriter class and initializes it with the specified StringBuilder and settings. More...

static XmlWriter::Ptr	Create (const SharedPtr< System::IO::TextWriter > &text_writer)
	Constructs an instance of XmlWriter class and initializes it with the specified TextWriter. More...

static XmlWriter::Ptr	Create (const SharedPtr< System::IO::TextWriter > &text_writer, const SharedPtr< XmlWriterSettings > &settings)
	Constructs an instance of XmlWriter class and initializes it with the specified TextWriter and settings. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

Detailed Description

Represents a non-cached, forward-only writer way of generating streams or files containing XML data. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Member Typedef Documentation

◆ Ptr

typedef SharedPtr<XmlTextWriter> System::Xml::XmlTextWriter::Ptr

An alias for shared pointer to an instance of this class.

Constructor & Destructor Documentation

◆ XmlTextWriter() [1/6]

System::Xml::XmlTextWriter::XmlTextWriter	(	const String &	outputFileName,
		const SharedPtr< System::Text::Encoding > &	encoding = `SharedPtr< System::Text::Encoding >()`
	)

Constructs an instance of XmlWriter class and initializes it with the specified output file and encoding.

Parameters

outputFileName	A filesystem path specifying a file to which the writer will write
encoding	The encoding to use

◆ XmlTextWriter() [2/6]

System::Xml::XmlTextWriter::XmlTextWriter	(	const SharedPtr< System::IO::Stream > &	stream,
		const SharedPtr< System::Text::Encoding > &	encoding = `SharedPtr< System::Text::Encoding >()`
	)

Constructs an instance of XmlTextWriter class and initializes it with the specified stream.

Parameters

stream	A stream to which the writer will write
encoding	The encoding to use

◆ XmlTextWriter() [3/6]

System::Xml::XmlTextWriter::XmlTextWriter ( const SharedPtr< System::IO::TextWriter > & text_writer )

Constructs an instance of XmlTextWriter class and initializes it with the specified TextWriter.

Parameters

text_writer A TextWriter to which the writer will write

◆ XmlTextWriter() [4/6]

System::Xml::XmlTextWriter::XmlTextWriter ( const SharedPtr< System::Text::StringBuilder > & string_builder )

Constructs an instance of XmlTextWriter class and initializes it with the specified StringBuilder.

Parameters

string_builder A StringBuilder to which the writer will write

◆ XmlTextWriter() [5/6]

System::Xml::XmlTextWriter::XmlTextWriter ( xmlBuffer * buf )

Constructs a new instance of XmlTextWriter and forces it to use the specified xmlBuffer object.

Parameters

buf	An xmlBuffer object to use

◆ XmlTextWriter() [6/6]

System::Xml::XmlTextWriter::XmlTextWriter ( xmlOutputBuffer * buf )

Constructs a new instance of XmlTextWriter and forces it to use the specified xmlOutputBuffer object.

Parameters

buf	An xmlOutputBuffer object to use

◆ ~XmlTextWriter()

virtual System::Xml::XmlTextWriter::~XmlTextWriter ( )

virtual

Destructor.

Member Function Documentation

◆ ApplySettings()

void System::Xml::XmlTextWriter::ApplySettings ( const SharedPtr< XmlWriterSettings > & settings )

protected

Applies XmlWriterSettings to the current XmlWriter object.

◆ Close()

void System::Xml::XmlTextWriter::Close ( )

overridevirtual

Closes the write stream.

reader	The XmlReader from which to copy the attributes.
defattr	true to copy the default attributes from the XmlReader; otherwise, false.

localName	The attribute's local name
ns	The namespace to associate the attribute with
value	The attribute's value

prefix	The attribute's prefix
localName	The attribute's local name
ns	The namespace to associate the attribute with
value	The attribute's value

buffer	A byte array
index	A 0-based index of the element in the array at which the range to encode begins
count	The number of elements in the range

buffer	Character array containing the text to write.
index	The position in the buffer indicating the start of the text to write.
count	The number of characters to write.

name	The name of DOCTYPE declaration
pubid	The public identifier of DOCTYPE declaration
sysid	The system identifier of DOCTYPE declaration
subset	The subset parameter of DOCTYPE declaration

localName	The element's local name
ns	The namespace to associate the element with
value	The element's value

name	The name of the processing instruction
text	The text to be added to the processing instruction

buffer	The character array
index	A 0-based index at which the range to write begins
count	The number of characters in the range

localName	The attribute's local name
ns	The attribute's namespace

prefix	The element's prefix
localName	The element's local name
ns	The namespace to associate the element with

lowChar	The low surrogate.This must be a value between 0xDC00 and 0xDFFF.
highChar	The high surrogate.This must be a value between 0xD800 and 0xDBFF.

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ XmlTextWriter() [1/6]

◆ XmlTextWriter() [2/6]

◆ XmlTextWriter() [3/6]

◆ XmlTextWriter() [4/6]

◆ XmlTextWriter() [5/6]

◆ XmlTextWriter() [6/6]

◆ ~XmlTextWriter()

Member Function Documentation

◆ ApplySettings()

◆ Close()

◆ Flush()

◆ get_BaseStream()

◆ get_Formatting()

◆ get_Indentation()

◆ get_IndentChar()

◆ get_WriteState()

◆ LookupPrefix()

◆ native()

◆ set_Formatting()

◆ set_Indentation()

◆ set_IndentChar()

◆ set_Namespaces()

◆ set_QuoteChar()

◆ WriteAttributes()

◆ WriteAttributeString() [1/3]

◆ WriteAttributeString() [2/3]

◆ WriteAttributeString() [3/3]

◆ WriteBase64()

◆ WriteBinHex()

◆ WriteCData()

◆ WriteCharEntity()

◆ WriteChars()

◆ WriteComment()

◆ WriteDocType()

◆ WriteElementString() [1/3]

◆ WriteElementString() [2/3]

◆ WriteElementString() [3/3]

◆ WriteEndAttribute()

◆ WriteEndDocument()

◆ WriteEndElement()

◆ WriteEntityRef()

◆ WriteFullEndElement()

◆ WriteProcessingInstruction()

◆ WriteRaw() [1/2]

◆ WriteRaw() [2/2]

◆ WriteStartAttribute() [1/3]

◆ WriteStartAttribute() [2/3]

◆ WriteStartAttribute() [3/3]

◆ WriteStartDocument() [1/2]

◆ WriteStartDocument() [2/2]

◆ WriteStartElement() [1/3]

◆ WriteStartElement() [2/3]

◆ WriteStartElement() [3/3]

◆ WriteString()

◆ WriteSurrogateCharEntity()

◆ WriteWhitespace()