XmlWriterSettings

XmlWriterSettings class

Specifies a set of features to support on the XmlWriter object created by the XmlWriter::Create method.

class XmlWriterSettings : public System::Object

Methods

MethodDescription
SharedPtr<XmlWriterSettings> Clone()Creates a copy of the XmlWriterSettings instance.
virtual bool Equals(ptr)Compares objects using C# Object.Equals semantics.
static std::enable_if<IsSmartPtr<T1>::value&&IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)Compares reference type objects in C# style.
static std::enable_if<!IsSmartPtr<T1>::value&&!IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)Compares value type objects in C# style.
static bool Equals(float const&, float const&)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.
static bool Equals(double const&, double const&)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.
virtual bool FastCast(const Details::FastRttiBase&, void **) constFor internal purposes only.
bool get_CheckCharacters()Returns a value that indicates whether the XML writer should check to ensure that all characters in the document conform to the "2.2 Characters" section of the W3C XML 1.0 Recommendation.
bool get_CloseOutput()Returns a value indicating whether the XmlWriter should also close the underlying stream or TextWriter when the XmlWriter::Close method is called.
System::Xml::ConformanceLevel get_ConformanceLevel()Returns the level of conformance that the XML writer checks the XML output for.
bool get_DoNotEscapeUriAttributes()Returns a value that indicates whether the XmlWriter does not escape URI attributes.
SharedPtr<System::Text::Encoding> get_Encoding()Returns the type of text encoding to use.
bool get_Indent()Returns a value indicating whether to indent elements.
String get_IndentChars()Returns the character string to use when indenting. This setting is used when the XmlWriterSettings::set_Indent value is set to true.
System::Xml::NamespaceHandling get_NamespaceHandling()Returns a value that indicates whether the XmlWriter should remove duplicate namespace declarations when writing XML content. The default behavior is for the writer to output all namespace declarations that are present in the writer’s namespace resolver.
String get_NewLineChars()Returns the character string to use for line breaks.
System::Xml::NewLineHandling get_NewLineHandling()Returns a value indicating whether to normalize line breaks in the output.
bool get_NewLineOnAttributes()Returns a value indicating whether to write attributes on a new line.
bool get_OmitXmlDeclaration()Returns a value indicating whether to omit an XML declaration.
XmlOutputMethod get_OutputMethod()Returns the method used to serialize the XmlWriter output.
bool get_WriteEndDocumentOnClose()Returns a value that indicates whether the XmlWriter will add closing tags to all unclosed element tags when the XmlWriter::Close method is called.
Detail::SmartPtrCounter * GetCounter()Gets reference counter data structure associated with the object.
virtual int32_t GetHashCode() constAnalog of C# Object.GetHashCode() method. Enables hashing of custom objects.
virtual const TypeInfo& GetType() constGets actual type of object. Analog of C# System.Object.GetType() call.
virtual bool Is(const TypeInfo&) constCheck if object represents an instance of type described by targetType. Analog of C# ‘is’ operator.
void Lock()Implements C# lock() statement locking. Call directly or use LockContext sentry object.
virtual ptr MemberwiseClone() constAnalog of C# Object.MemberwiseClone() method. Enables cloning custom types.
Object()Creates object. Initializes all internal data structures.
Object(Object const&)Copy constructor. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
Object& operator=(Object const&)Assignment operator. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
static bool ReferenceEquals(ptr const&, ptr const&)Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, T const&)Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, std::nullptr_t)Reference-compares value type object with nullptr.
bool ReferenceEquals(String const&, std::nullptr_t)Specialization of Object::ReferenceEquals for case of string and nullptr.
bool ReferenceEquals(String const&, String const&)Specialization of Object::ReferenceEquals for case of strings.
int RemovedSharedRefs(int)Decreases shared reference count by specified value.
void Reset()Resets the members of the settings class to their default values.
void set_CheckCharacters(bool)Sets a value that indicates whether the XML writer should check to ensure that all characters in the document conform to the "2.2 Characters" section of the W3C XML 1.0 Recommendation.
void set_CloseOutput(bool)Sets a value indicating whether the XmlWriter should also close the underlying stream or TextWriter when the XmlWriter::Close method is called.
void set_ConformanceLevel(System::Xml::ConformanceLevel)Sets the level of conformance that the XML writer checks the XML output for.
void set_DoNotEscapeUriAttributes(bool)Sets a value that indicates whether the XmlWriter does not escape URI attributes.
void set_Encoding(const SharedPtr<System::Text::Encoding>&)Sets the type of text encoding to use.
void set_Indent(bool)Sets a value indicating whether to indent elements.
void set_IndentChars(const String&)Sets the character string to use when indenting. This setting is used when the XmlWriterSettings::set_Indent value is set to true.
void set_NamespaceHandling(System::Xml::NamespaceHandling)Sets a value that indicates whether the XmlWriter should remove duplicate namespace declarations when writing XML content. The default behavior is for the writer to output all namespace declarations that are present in the writer’s namespace resolver.
void set_NewLineChars(const String&)Sets the character string to use for line breaks.
void set_NewLineHandling(System::Xml::NewLineHandling)Sets a value indicating whether to normalize line breaks in the output.
void set_NewLineOnAttributes(bool)Sets a value indicating whether to write attributes on a new line.
void set_OmitXmlDeclaration(bool)Sets a value indicating whether to omit an XML declaration.
void set_WriteEndDocumentOnClose(bool)Sets a value that indicates whether the XmlWriter will add closing tags to all unclosed element tags when the XmlWriter::Close method is called.
virtual void SetTemplateWeakPtr(uint32_t)Set n’th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.
int SharedCount() constGets current value of shared reference counter.
Object * SharedRefAdded()Increments shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
int SharedRefRemovedSafe()Decrements and returns shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
virtual String ToString() constAnalog of C# Object.ToString() method. Enables converting custom objects to string.
static const TypeInfo& Type()Implements C# typeof(System.Object) construct.
void Unlock()Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.
Detail::SmartPtrCounter * WeakRefAdded()Increments weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
void WeakRefRemoved()Decrements weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
XmlWriterSettings()Initializes a new instance of the XmlWriterSettings class.
virtual ~Object()Destroys object. Frees all internal data structures.

Typedefs

TypedefDescription
PtrAn alias for shared pointer to an instance of this class.

Remarks

Objects of this class should only be allocated using System::MakeObject() function. Never create instances 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.

See Also