System::Xml::XmlWriterSettings Class Referencefinal

Inherits System::Object.

Public Types

using Ptr = SharedPtr< XmlWriterSettings >
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

ASPOSECPP_SHARED_API SharedPtr< System::Text::Encodingget_Encoding ()
 
ASPOSECPP_SHARED_API void set_Encoding (const SharedPtr< System::Text::Encoding > &value)
 
ASPOSECPP_SHARED_API bool get_OmitXmlDeclaration ()
 
ASPOSECPP_SHARED_API void set_OmitXmlDeclaration (bool value)
 
ASPOSECPP_SHARED_API System::Xml::NewLineHandling get_NewLineHandling ()
 
ASPOSECPP_SHARED_API void set_NewLineHandling (System::Xml::NewLineHandling value)
 
ASPOSECPP_SHARED_API String get_NewLineChars ()
 
ASPOSECPP_SHARED_API void set_NewLineChars (const String &value)
 
ASPOSECPP_SHARED_API bool get_Indent ()
 
ASPOSECPP_SHARED_API void set_Indent (bool value)
 
ASPOSECPP_SHARED_API String get_IndentChars ()
 
ASPOSECPP_SHARED_API void set_IndentChars (const String &value)
 
ASPOSECPP_SHARED_API bool get_NewLineOnAttributes ()
 
ASPOSECPP_SHARED_API void set_NewLineOnAttributes (bool value)
 
ASPOSECPP_SHARED_API bool get_CloseOutput ()
 
ASPOSECPP_SHARED_API void set_CloseOutput (bool value)
 
ASPOSECPP_SHARED_API System::Xml::ConformanceLevel get_ConformanceLevel ()
 
ASPOSECPP_SHARED_API void set_ConformanceLevel (System::Xml::ConformanceLevel value)
 
ASPOSECPP_SHARED_API bool get_CheckCharacters ()
 
ASPOSECPP_SHARED_API void set_CheckCharacters (bool value)
 
ASPOSECPP_SHARED_API System::Xml::NamespaceHandling get_NamespaceHandling ()
 
ASPOSECPP_SHARED_API void set_NamespaceHandling (System::Xml::NamespaceHandling value)
 
ASPOSECPP_SHARED_API bool get_WriteEndDocumentOnClose ()
 
ASPOSECPP_SHARED_API void set_WriteEndDocumentOnClose (bool value)
 
ASPOSECPP_SHARED_API XmlOutputMethod get_OutputMethod ()
 
ASPOSECPP_SHARED_API bool get_DoNotEscapeUriAttributes ()
 
ASPOSECPP_SHARED_API void set_DoNotEscapeUriAttributes (bool value)
 
ASPOSECPP_SHARED_API XmlWriterSettings ()
 Initializes a new instance of the XmlWriterSettings class. More...
 
ASPOSECPP_SHARED_API void Reset ()
 Resets the members of the settings class to their default values. More...
 
ASPOSECPP_SHARED_API SharedPtr< XmlWriterSettingsClone ()
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API 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 ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Additional Inherited Members

- 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 TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

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

Attention
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.

Member Typedef Documentation

◆ Ptr

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

Constructor & Destructor Documentation

◆ XmlWriterSettings()

ASPOSECPP_SHARED_API System::Xml::XmlWriterSettings::XmlWriterSettings ( )

Initializes a new instance of the XmlWriterSettings class.

Member Function Documentation

◆ Clone()

ASPOSECPP_SHARED_API SharedPtr<XmlWriterSettings> System::Xml::XmlWriterSettings::Clone ( )

Creates a copy of the XmlWriterSettings instance.

Returns
The cloned XmlWriterSettings object.

◆ get_CheckCharacters()

ASPOSECPP_SHARED_API bool System::Xml::XmlWriterSettings::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.

Returns
true to do character checking; otherwise, false. The default is true.

◆ get_CloseOutput()

ASPOSECPP_SHARED_API bool System::Xml::XmlWriterSettings::get_CloseOutput ( )

Returns a value indicating whether the XmlWriter should also close the underlying stream or TextWriter when the XmlWriter::Close method is called.

Returns
true to also close the underlying stream or TextWriter; otherwise, false. The default is false.

◆ get_ConformanceLevel()

ASPOSECPP_SHARED_API System::Xml::ConformanceLevel System::Xml::XmlWriterSettings::get_ConformanceLevel ( )

Returns the level of conformance that the XML writer checks the XML output for.

Returns
One of the enumeration values that specifies the level of conformance (document, fragment, or automatic detection). The default is ConformanceLevel::Document.

◆ get_DoNotEscapeUriAttributes()

ASPOSECPP_SHARED_API bool System::Xml::XmlWriterSettings::get_DoNotEscapeUriAttributes ( )

Returns a value that indicates whether the XmlWriter does not escape URI attributes.

Returns
true if the XmlWriter does not escape URI attributes; otherwise, false. The default is false.

◆ get_Encoding()

ASPOSECPP_SHARED_API SharedPtr<System::Text::Encoding> System::Xml::XmlWriterSettings::get_Encoding ( )

Returns the type of text encoding to use.

Returns
The text encoding to use. The default is Encoding::get_UTF8.

◆ get_Indent()

ASPOSECPP_SHARED_API bool System::Xml::XmlWriterSettings::get_Indent ( )

Returns a value indicating whether to indent elements.

Returns
true to write individual elements on new lines and indent; otherwise, false. The default is false.

◆ get_IndentChars()

ASPOSECPP_SHARED_API String System::Xml::XmlWriterSettings::get_IndentChars ( )

Returns the character string to use when indenting. This setting is used when the XmlWriterSettings::set_Indent value is set to true.

Returns
The character string to use when indenting. This can be set to any string value. However, to ensure valid XML, you should specify only valid white space characters, such as space characters, tabs, carriage returns, or line feeds. The default is two spaces.

◆ get_NamespaceHandling()

ASPOSECPP_SHARED_API System::Xml::NamespaceHandling System::Xml::XmlWriterSettings::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.

Returns
The NamespaceHandling enumeration used to specify whether to remove duplicate namespace declarations in the XmlWriter.

◆ get_NewLineChars()

ASPOSECPP_SHARED_API String System::Xml::XmlWriterSettings::get_NewLineChars ( )

Returns the character string to use for line breaks.

Returns
The character string to use for line breaks. This can be set to any string value. However, to ensure valid XML, you should specify only valid white space characters, such as space characters, tabs, carriage returns, or line feeds. The default is \r\n (carriage return, new line).

◆ get_NewLineHandling()

ASPOSECPP_SHARED_API System::Xml::NewLineHandling System::Xml::XmlWriterSettings::get_NewLineHandling ( )

Returns a value indicating whether to normalize line breaks in the output.

Returns
One of the NewLineHandling values. The default is NewLineHandling::Replace.

◆ get_NewLineOnAttributes()

ASPOSECPP_SHARED_API bool System::Xml::XmlWriterSettings::get_NewLineOnAttributes ( )

Returns a value indicating whether to write attributes on a new line.

Returns
true to write attributes on individual lines; otherwise, false. The default is false.

◆ get_OmitXmlDeclaration()

ASPOSECPP_SHARED_API bool System::Xml::XmlWriterSettings::get_OmitXmlDeclaration ( )

Returns a value indicating whether to omit an XML declaration.

Returns
true to omit the XML declaration; otherwise, false. The default is false, an XML declaration is written.

◆ get_OutputMethod()

ASPOSECPP_SHARED_API XmlOutputMethod System::Xml::XmlWriterSettings::get_OutputMethod ( )

Returns the method used to serialize the XmlWriter output.

Returns
One of the XmlOutputMethod values. The default is XmlOutputMethod::Xml.

◆ get_WriteEndDocumentOnClose()

ASPOSECPP_SHARED_API bool System::Xml::XmlWriterSettings::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.

Returns
true if all unclosed element tags will be closed out; otherwise, false. The default value is true.

◆ Reset()

ASPOSECPP_SHARED_API void System::Xml::XmlWriterSettings::Reset ( )

Resets the members of the settings class to their default values.

◆ set_CheckCharacters()

ASPOSECPP_SHARED_API void System::Xml::XmlWriterSettings::set_CheckCharacters ( bool  value)

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.

Parameters
valueThe value to set.

◆ set_CloseOutput()

ASPOSECPP_SHARED_API void System::Xml::XmlWriterSettings::set_CloseOutput ( bool  value)

Sets a value indicating whether the XmlWriter should also close the underlying stream or TextWriter when the XmlWriter::Close method is called.

Parameters
valueThe value to set.

◆ set_ConformanceLevel()

ASPOSECPP_SHARED_API void System::Xml::XmlWriterSettings::set_ConformanceLevel ( System::Xml::ConformanceLevel  value)

Sets the level of conformance that the XML writer checks the XML output for.

Parameters
valueThe value to set.

◆ set_DoNotEscapeUriAttributes()

ASPOSECPP_SHARED_API void System::Xml::XmlWriterSettings::set_DoNotEscapeUriAttributes ( bool  value)

Sets a value that indicates whether the XmlWriter does not escape URI attributes.

Parameters
valueThe value to set.

◆ set_Encoding()

ASPOSECPP_SHARED_API void System::Xml::XmlWriterSettings::set_Encoding ( const SharedPtr< System::Text::Encoding > &  value)

Sets the type of text encoding to use.

Parameters
valueThe value to set.

◆ set_Indent()

ASPOSECPP_SHARED_API void System::Xml::XmlWriterSettings::set_Indent ( bool  value)

Sets a value indicating whether to indent elements.

Parameters
valueThe value to set.

◆ set_IndentChars()

ASPOSECPP_SHARED_API void System::Xml::XmlWriterSettings::set_IndentChars ( const String value)

Sets the character string to use when indenting. This setting is used when the XmlWriterSettings::set_Indent value is set to true.

Parameters
valueThe value to set.
Exceptions
ArgumentNullExceptionThe value is nullptr.

◆ set_NamespaceHandling()

ASPOSECPP_SHARED_API void System::Xml::XmlWriterSettings::set_NamespaceHandling ( System::Xml::NamespaceHandling  value)

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.

Parameters
valueThe value to set.

◆ set_NewLineChars()

ASPOSECPP_SHARED_API void System::Xml::XmlWriterSettings::set_NewLineChars ( const String value)

Sets the character string to use for line breaks.

Parameters
valueThe value to set.
Exceptions
ArgumentNullExceptionThe value is nullptr.

◆ set_NewLineHandling()

ASPOSECPP_SHARED_API void System::Xml::XmlWriterSettings::set_NewLineHandling ( System::Xml::NewLineHandling  value)

Sets a value indicating whether to normalize line breaks in the output.

Parameters
valueThe value to set.

◆ set_NewLineOnAttributes()

ASPOSECPP_SHARED_API void System::Xml::XmlWriterSettings::set_NewLineOnAttributes ( bool  value)

Sets a value indicating whether to write attributes on a new line.

Parameters
valueThe value to set.

◆ set_OmitXmlDeclaration()

ASPOSECPP_SHARED_API void System::Xml::XmlWriterSettings::set_OmitXmlDeclaration ( bool  value)

Sets a value indicating whether to omit an XML declaration.

Parameters
valueThe value to set.

◆ set_WriteEndDocumentOnClose()

ASPOSECPP_SHARED_API void System::Xml::XmlWriterSettings::set_WriteEndDocumentOnClose ( bool  value)

Sets a value that indicates whether the XmlWriter will add closing tags to all unclosed element tags when the XmlWriter::Close method is called.

Parameters
valueThe value to set.