csharp-to-cpp/apireference/xml__writer_8h_source.html

#pragma once


#include <xml/xml_space.h>

#include <xml/write_state.h>

#include <system/idisposable.h>

#include <system/array.h>

#include <cstdint>


namespace System

{

class DateTime;

class DateTimeOffset;

class Decimal;

namespace IO

{

class Stream;

class TextWriter;

} // namespace IO

namespace Text

{

class StringBuilder;

} // namespace Text

namespace Xml

{

class XmlReader;

class XmlWriterSettings;

namespace XPath

{

class XPathNavigator;

} // namespace XPath

} // namespace Xml

} // namespace System


namespace System {


namespace Xml {


class ASPOSECPP_SHARED_CLASS XmlWriter : public IDisposable

{

    typedef XmlWriter ThisType;

    typedef IDisposable BaseType;


    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;

    ASPOSECPP_SHARED_RTTI_INFO_DECL();


public:


    using Ptr = SharedPtr<XmlWriter>;


public:


    virtual ASPOSECPP_SHARED_API SharedPtr<XmlWriterSettings> get_Settings();

    virtual ASPOSECPP_SHARED_API System::Xml::WriteState get_WriteState() = 0;

    virtual ASPOSECPP_SHARED_API System::Xml::XmlSpace get_XmlSpace();

    virtual ASPOSECPP_SHARED_API String get_XmlLang();


    virtual ASPOSECPP_SHARED_API void WriteStartDocument() = 0;

    virtual ASPOSECPP_SHARED_API void WriteStartDocument(bool standalone) = 0;

    virtual ASPOSECPP_SHARED_API void WriteEndDocument() = 0;

    virtual ASPOSECPP_SHARED_API void WriteDocType(const String& name, const String& pubid, const String& sysid, const String& subset) = 0;

    ASPOSECPP_SHARED_API void WriteStartElement(const String& localName, const String& ns);

    virtual ASPOSECPP_SHARED_API void WriteStartElement(const String& prefix, const String& localName, const String& ns) = 0;

    ASPOSECPP_SHARED_API void WriteStartElement(const String& localName);

    virtual ASPOSECPP_SHARED_API void WriteEndElement() = 0;

    virtual ASPOSECPP_SHARED_API void WriteFullEndElement() = 0;

    ASPOSECPP_SHARED_API void WriteAttributeString(const String& localName, const String& ns, const String& value);

    ASPOSECPP_SHARED_API void WriteAttributeString(const String& localName, const String& value);

    ASPOSECPP_SHARED_API void WriteAttributeString(const String& prefix, const String& localName, const String& ns, const String& value);

    ASPOSECPP_SHARED_API void WriteStartAttribute(const String& localName, const String& ns);

    virtual ASPOSECPP_SHARED_API void WriteStartAttribute(const String& prefix, const String& localName, const String& ns) = 0;

    ASPOSECPP_SHARED_API void WriteStartAttribute(const String& localName);

    virtual ASPOSECPP_SHARED_API void WriteEndAttribute() = 0;

    virtual ASPOSECPP_SHARED_API void WriteCData(String text) = 0;

    virtual ASPOSECPP_SHARED_API void WriteComment(String text) = 0;

    virtual ASPOSECPP_SHARED_API void WriteProcessingInstruction(String name, String text) = 0;

    virtual ASPOSECPP_SHARED_API void WriteEntityRef(const String& name) = 0;

    virtual ASPOSECPP_SHARED_API void WriteCharEntity(char16_t ch) = 0;

    virtual ASPOSECPP_SHARED_API void WriteWhitespace(String ws) = 0;

    virtual ASPOSECPP_SHARED_API void WriteString(const String& text) = 0;

    virtual ASPOSECPP_SHARED_API void WriteSurrogateCharEntity(char16_t lowChar, char16_t highChar) = 0;

    virtual ASPOSECPP_SHARED_API void WriteChars(ArrayPtr<char16_t> buffer, int32_t index, int32_t count) = 0;

    virtual ASPOSECPP_SHARED_API void WriteRaw(ArrayPtr<char16_t> buffer, int32_t index, int32_t count) = 0;

    virtual ASPOSECPP_SHARED_API void WriteRaw(const String& data) = 0;

    virtual ASPOSECPP_SHARED_API void WriteBase64(ArrayPtr<uint8_t> buffer, int32_t index, int32_t count) = 0;

    virtual ASPOSECPP_SHARED_API void WriteBinHex(ArrayPtr<uint8_t> buffer, int32_t index, int32_t count);

    virtual ASPOSECPP_SHARED_API void Close();

    virtual ASPOSECPP_SHARED_API void Flush() = 0;

    virtual ASPOSECPP_SHARED_API String LookupPrefix(String ns) = 0;

    virtual ASPOSECPP_SHARED_API void WriteNmToken(const String& name);

    virtual ASPOSECPP_SHARED_API void WriteName(const String& name);

    virtual ASPOSECPP_SHARED_API void WriteQualifiedName(const String& localName, const String& ns);

    virtual ASPOSECPP_SHARED_API void WriteValue(SharedPtr<Object> value);

    virtual ASPOSECPP_SHARED_API void WriteValue(const String& value);

    virtual ASPOSECPP_SHARED_API void WriteValue(bool value);

    virtual ASPOSECPP_SHARED_API void WriteValue(DateTime value);

    virtual ASPOSECPP_SHARED_API void WriteValue(DateTimeOffset value);

    virtual ASPOSECPP_SHARED_API void WriteValue(double value);

    virtual ASPOSECPP_SHARED_API void WriteValue(float value);

    virtual ASPOSECPP_SHARED_API void WriteValue(Decimal value);

    virtual ASPOSECPP_SHARED_API void WriteValue(int32_t value);

    virtual ASPOSECPP_SHARED_API void WriteValue(int64_t value);

    virtual ASPOSECPP_SHARED_API void WriteAttributes(SharedPtr<XmlReader> reader, bool defattr);

    virtual ASPOSECPP_SHARED_API void WriteNode(SharedPtr<XmlReader> reader, bool defattr);

    virtual ASPOSECPP_SHARED_API void WriteNode(SharedPtr<XPath::XPathNavigator> navigator, bool defattr);

    ASPOSECPP_SHARED_API void WriteElementString(const String& localName, const String& value);

    ASPOSECPP_SHARED_API void WriteElementString(const String& localName, const String& ns, const String& value);

    ASPOSECPP_SHARED_API void WriteElementString(const String& prefix, const String& localName, const String& ns, const String& value);

    ASPOSECPP_SHARED_API void Dispose() override;

    static ASPOSECPP_SHARED_API SharedPtr<XmlWriter> Create(const String& outputFileName);

    static ASPOSECPP_SHARED_API SharedPtr<XmlWriter> Create(const String& outputFileName, SharedPtr<XmlWriterSettings> settings);

    static ASPOSECPP_SHARED_API SharedPtr<XmlWriter> Create(const SharedPtr<IO::Stream>& output);

    static ASPOSECPP_SHARED_API SharedPtr<XmlWriter> Create(const SharedPtr<IO::Stream>& output, SharedPtr<XmlWriterSettings> settings);

    static ASPOSECPP_SHARED_API SharedPtr<XmlWriter> Create(const SharedPtr<IO::TextWriter>& output);

    static ASPOSECPP_SHARED_API SharedPtr<XmlWriter> Create(const SharedPtr<IO::TextWriter>& output, SharedPtr<XmlWriterSettings> settings);

    static ASPOSECPP_SHARED_API SharedPtr<XmlWriter> Create(const SharedPtr<Text::StringBuilder>& output);

    static ASPOSECPP_SHARED_API SharedPtr<XmlWriter> Create(const SharedPtr<Text::StringBuilder>& output, SharedPtr<XmlWriterSettings> settings);

    static ASPOSECPP_SHARED_API SharedPtr<XmlWriter> Create(const SharedPtr<XmlWriter>& output);

    static ASPOSECPP_SHARED_API SharedPtr<XmlWriter> Create(const SharedPtr<XmlWriter>& output, SharedPtr<XmlWriterSettings> settings);


protected:


    virtual ASPOSECPP_SHARED_API void Dispose(bool disposing);


    virtual ASPOSECPP_SHARED_API ~XmlWriter();


    #ifdef ASPOSE_GET_SHARED_MEMBERS

    ASPOSECPP_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;

    #endif


private:


    ArrayPtr<char16_t> _writeNodeBuffer;

    static const int32_t WriteNodeBufferSize;


    void WriteLocalNamespaces(const SharedPtr<XPath::XPathNavigator>& nsNav);


};


} // namespace Xml

} // namespace System


System::DateTime
Represents a specific date and time value on the time continuum. This type should be allocated on sta...
Definition: date_time.h:50

System::DateTimeOffset
Contains the date and time of day relative to Coordinated Universal Time. Objects of this class shoul...
Definition: date_time_offset.h:16

System::Decimal
Represents a decimal number. This type should be allocated on stack and passed to functions by value ...
Definition: decimal.h:107

System::IDisposable
Defines method that releases resources owned by the current object. Objects of this class should only...
Definition: idisposable.h:30

System::SmartPtr
Pointer class to wrap types being allocated on heap. Use it to manage memory for classes inheriting O...
Definition: smart_ptr.h:180

System::String
String class used across the library. Is a substitute for C# System.String when translating code....
Definition: string.h:122

System::Xml::XmlWriter
Represents a writer that provides a fast, non-cached, forward-only way to generate streams or files t...
Definition: xml_writer.h:45

System::Xml::XmlWriter::WriteValue
virtual void WriteValue(int64_t value)
Writes a Int64 value.

System::Xml::XmlWriter::WriteNmToken
virtual void WriteNmToken(const String &name)
When overridden in a derived class, writes out the specified name, ensuring it is a valid NmToken acc...

System::Xml::XmlWriter::WriteStartElement
void WriteStartElement(const String &localName)
When overridden in a derived class, writes out a start tag with the specified local name.

System::Xml::XmlWriter::Create
static SharedPtr< XmlWriter > Create(const SharedPtr< Text::StringBuilder > &output, SharedPtr< XmlWriterSettings > settings)
Creates a new XmlWriter instance using the Text::StringBuilder and XmlWriterSettings objects.

System::Xml::XmlWriter::get_WriteState
virtual System::Xml::WriteState get_WriteState()=0
When overridden in a derived class, gets the state of the writer.

System::Xml::XmlWriter::WriteEndDocument
virtual void WriteEndDocument()=0
When overridden in a derived class, closes any open elements or attributes and puts the writer back i...

System::Xml::XmlWriter::WriteSurrogateCharEntity
virtual void WriteSurrogateCharEntity(char16_t lowChar, char16_t highChar)=0
When overridden in a derived class, generates and writes the surrogate character entity for the surro...

System::Xml::XmlWriter::WriteElementString
void WriteElementString(const String &localName, const String &value)
Writes an element with the specified local name and value.

System::Xml::XmlWriter::WriteValue
virtual void WriteValue(const String &value)
Writes a String value.

System::Xml::XmlWriter::WriteAttributeString
void WriteAttributeString(const String &localName, const String &value)
When overridden in a derived class, writes out the attribute with the specified local name and value.

System::Xml::XmlWriter::WriteValue
virtual void WriteValue(SharedPtr< Object > value)
Writes the object value.

System::Xml::XmlWriter::WriteAttributeString
void WriteAttributeString(const String &localName, const String &ns, const String &value)
When overridden in a derived class, writes an attribute with the specified local name,...

System::Xml::XmlWriter::get_XmlLang
virtual String get_XmlLang()
When overridden in a derived class, gets the current xml:lang scope.

System::Xml::XmlWriter::WriteStartDocument
virtual void WriteStartDocument(bool standalone)=0
When overridden in a derived class, writes the XML declaration with the version "1....

System::Xml::XmlWriter::WriteValue
virtual void WriteValue(double value)
Writes a Double value.

System::Xml::XmlWriter::WriteStartElement
virtual void WriteStartElement(const String &prefix, const String &localName, const String &ns)=0
When overridden in a derived class, writes the specified start tag and associates it with the given n...

System::Xml::XmlWriter::WriteString
virtual void WriteString(const String &text)=0
When overridden in a derived class, writes the given text content.

System::Xml::XmlWriter::Create
static SharedPtr< XmlWriter > Create(const String &outputFileName)
Creates a new XmlWriter instance using the specified filename.

System::Xml::XmlWriter::WriteValue
virtual void WriteValue(bool value)
Writes a Boolean value.

System::Xml::XmlWriter::WriteRaw
virtual void WriteRaw(const String &data)=0
When overridden in a derived class, writes raw markup manually from a string.

System::Xml::XmlWriter::Create
static SharedPtr< XmlWriter > Create(const SharedPtr< XmlWriter > &output, SharedPtr< XmlWriterSettings > settings)
Creates a new XmlWriter instance using the specified XmlWriter and XmlWriterSettings objects.

System::Xml::XmlWriter::WriteCharEntity
virtual void WriteCharEntity(char16_t ch)=0
When overridden in a derived class, forces the generation of a character entity for the specified Uni...

System::Xml::XmlWriter::Create
static SharedPtr< XmlWriter > Create(const SharedPtr< IO::TextWriter > &output)
Creates a new XmlWriter instance using the specified TextWriter.

System::Xml::XmlWriter::WriteNode
virtual void WriteNode(SharedPtr< XPath::XPathNavigator > navigator, bool defattr)
Copies everything from the XPathNavigator object to the writer. The position of the XPathNavigator re...

System::Xml::XmlWriter::WriteStartAttribute
virtual void WriteStartAttribute(const String &prefix, const String &localName, const String &ns)=0
When overridden in a derived class, writes the start of an attribute with the specified prefix,...

System::Xml::XmlWriter::Dispose
void Dispose() override
Releases all resources used by the current instance of the XmlWriter class.

System::Xml::XmlWriter::WriteName
virtual void WriteName(const String &name)
When overridden in a derived class, writes out the specified name, ensuring it is a valid name accord...

System::Xml::XmlWriter::WriteDocType
virtual void WriteDocType(const String &name, const String &pubid, const String &sysid, const String &subset)=0
When overridden in a derived class, writes the DOCTYPE declaration with the specified name and option...

System::Xml::XmlWriter::WriteAttributeString
void WriteAttributeString(const String &prefix, const String &localName, const String &ns, const String &value)
When overridden in a derived class, writes out the attribute with the specified prefix,...

System::Xml::XmlWriter::WriteComment
virtual void WriteComment(String text)=0
When overridden in a derived class, writes out a comment  containing the specified text.

System::Xml::XmlWriter::WriteChars
virtual void WriteChars(ArrayPtr< char16_t > buffer, int32_t index, int32_t count)=0
When overridden in a derived class, writes text one buffer at a time.

System::Xml::XmlWriter::WriteValue
virtual void WriteValue(float value)
Writes a single-precision floating-point number.

System::Xml::XmlWriter::WriteEndElement
virtual void WriteEndElement()=0
When overridden in a derived class, closes one element and pops the corresponding namespace scope.

System::Xml::XmlWriter::Close
virtual void Close()
When overridden in a derived class, closes this stream and the underlying stream.

System::Xml::XmlWriter::WriteElementString
void WriteElementString(const String &prefix, const String &localName, const String &ns, const String &value)
Writes an element with the specified prefix, local name, namespace URI, and value.

System::Xml::XmlWriter::Dispose
virtual void Dispose(bool disposing)
Optionally releases all resources used by the current instance of the XmlWriter class.

System::Xml::XmlWriter::WriteCData
virtual void WriteCData(String text)=0
When overridden in a derived class, writes out a ... block containing the specified text.

System::Xml::XmlWriter::WriteQualifiedName
virtual void WriteQualifiedName(const String &localName, const String &ns)
When overridden in a derived class, writes out the namespace-qualified name. This method looks up the...

System::Xml::XmlWriter::WriteValue
virtual void WriteValue(Decimal value)
Writes a Decimal value.

System::Xml::XmlWriter::WriteWhitespace
virtual void WriteWhitespace(String ws)=0
When overridden in a derived class, writes out the given white space.

System::Xml::XmlWriter::Create
static SharedPtr< XmlWriter > Create(const SharedPtr< XmlWriter > &output)
Creates a new XmlWriter instance using the specified XmlWriter object.

System::Xml::XmlWriter::WriteStartAttribute
void WriteStartAttribute(const String &localName)
Writes the start of an attribute with the specified local name.

System::Xml::XmlWriter::Create
static SharedPtr< XmlWriter > Create(const SharedPtr< Text::StringBuilder > &output)
Creates a new XmlWriter instance using the specified Text::StringBuilder.

System::Xml::XmlWriter::WriteFullEndElement
virtual void WriteFullEndElement()=0
When overridden in a derived class, closes one element and pops the corresponding namespace scope.

System::Xml::XmlWriter::Create
static SharedPtr< XmlWriter > Create(const String &outputFileName, SharedPtr< XmlWriterSettings > settings)
Creates a new XmlWriter instance using the filename and XmlWriterSettings object.

System::Xml::XmlWriter::Create
static SharedPtr< XmlWriter > Create(const SharedPtr< IO::Stream > &output, SharedPtr< XmlWriterSettings > settings)
Creates a new XmlWriter instance using the stream and XmlWriterSettings object.

System::Xml::XmlWriter::Create
static SharedPtr< XmlWriter > Create(const SharedPtr< IO::Stream > &output)
Creates a new XmlWriter instance using the specified stream.

System::Xml::XmlWriter::WriteStartElement
void WriteStartElement(const String &localName, const String &ns)
When overridden in a derived class, writes the specified start tag and associates it with the given n...

System::Xml::XmlWriter::WriteRaw
virtual void WriteRaw(ArrayPtr< char16_t > buffer, int32_t index, int32_t count)=0
When overridden in a derived class, writes raw markup manually from a character buffer.

System::Xml::XmlWriter::WriteStartDocument
virtual void WriteStartDocument()=0
When overridden in a derived class, writes the XML declaration with the version "1....

System::Xml::XmlWriter::WriteNode
virtual void WriteNode(SharedPtr< XmlReader > reader, bool defattr)
When overridden in a derived class, copies everything from the reader to the writer and moves the rea...

System::Xml::XmlWriter::WriteValue
virtual void WriteValue(DateTimeOffset value)
Writes a DateTimeOffset value.

System::Xml::XmlWriter::LookupPrefix
virtual String LookupPrefix(String ns)=0
When overridden in a derived class, returns the closest prefix defined in the current namespace scope...

System::Xml::XmlWriter::Create
static SharedPtr< XmlWriter > Create(const SharedPtr< IO::TextWriter > &output, SharedPtr< XmlWriterSettings > settings)
Creates a new XmlWriter instance using the TextWriter and XmlWriterSettings objects.

System::Xml::XmlWriter::WriteBase64
virtual void WriteBase64(ArrayPtr< uint8_t > buffer, int32_t index, int32_t count)=0
When overridden in a derived class, encodes the specified binary bytes as Base64 and writes out the r...

System::Xml::XmlWriter::WriteAttributes
virtual void WriteAttributes(SharedPtr< XmlReader > reader, bool defattr)
When overridden in a derived class, writes out all the attributes found at the current position in th...

System::Xml::XmlWriter::WriteEntityRef
virtual void WriteEntityRef(const String &name)=0
When overridden in a derived class, writes out an entity reference as &name;.

System::Xml::XmlWriter::WriteEndAttribute
virtual void WriteEndAttribute()=0
When overridden in a derived class, closes the previous XmlWriter::WriteStartAttribute(String,...

System::Xml::XmlWriter::WriteBinHex
virtual void WriteBinHex(ArrayPtr< uint8_t > buffer, int32_t index, int32_t count)
When overridden in a derived class, encodes the specified binary bytes as BinHex and writes out the r...

System::Xml::XmlWriter::WriteValue
virtual void WriteValue(int32_t value)
Writes a Int32 value.

System::Xml::XmlWriter::WriteValue
virtual void WriteValue(DateTime value)
Writes a DateTime value.

System::Xml::XmlWriter::WriteProcessingInstruction
virtual void WriteProcessingInstruction(String name, String text)=0
When overridden in a derived class, writes out a processing instruction with a space between the name...

System::Xml::XmlWriter::get_Settings
virtual SharedPtr< XmlWriterSettings > get_Settings()
Returns the XmlWriterSettings object used to create this XmlWriter instance.

System::Xml::XmlWriter::~XmlWriter
virtual ~XmlWriter()

System::Xml::XmlWriter::WriteStartAttribute
void WriteStartAttribute(const String &localName, const String &ns)
Writes the start of an attribute with the specified local name and namespace URI.

System::Xml::XmlWriter::get_XmlSpace
virtual System::Xml::XmlSpace get_XmlSpace()
When overridden in a derived class, gets an XmlSpace representing the current xml:space scope.

System::Xml::XmlWriter::WriteElementString
void WriteElementString(const String &localName, const String &ns, const String &value)
Writes an element with the specified local name, namespace URI, and value.

System::Xml::XmlWriter::Flush
virtual void Flush()=0
When overridden in a derived class, flushes whatever is in the buffer to the underlying streams and a...

System::Drawing::Imaging::ColorAdjustType::Text
@ Text
Defines color adjustment information for text.

System::Net::Sockets::SocketType::Stream
@ Stream
The type that supports reliable, two-way, connection-based byte streams without duplication of data a...

System::Xml::XmlSpace
XmlSpace
Specifies the current xml:space scope.
Definition: xml_space.h:15

System::Xml::XmlOutputMethod::Xml
@ Xml
Serialize according to the XML 1.0 rules.

System::Xml::WriteState
WriteState
Specifies the state of the XmlWriter.
Definition: write_state.h:15

System
Definition: db_command.h:9

System::TypeCode::DateTime
@ DateTime
A type representing a date and time value.

System::TypeCode::Decimal
@ Decimal
A simple type representing values ranging from 1.0 x 10 -28 to approximately 7.9 x 10 28 with 28-29 s...