Asposecpplib
System::Xml::XmlWriterSettings Class Reference

Specifies a set of features to support on the XmlWriter object created by the Create() method. 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::Object.

Public Member Functions

bool get_CheckCharacters () const
 Returns a value that indicates whether the XML writer should determine if all characters in the document conform to the "2.2 Characters" section of the W3C XML 1.0 Recommendation. More...
 
void set_CheckCharacters (bool value)
 Sets a value that indicates whether the XML writer should determine if all characters in the document conform to the "2.2 Characters" section of the W3C XML 1.0 Recommendation. More...
 
bool get_CloseOutput () const
 Returns a value that indicates if the XmlWriter should close the underlying stream or XmlWriter object when method Close() is called. More...
 
void set_CloseOutput (bool value)
 Sets a value that indicates if the XmlWriter should close the underlying stream or XmlWriter object when method Close() is called. More...
 
System::Xml::ConformanceLevel get_ConformanceLevel () const
 Returns the conformance level that the XmlWriter checks the XML output for. More...
 
void set_ConformanceLevel (System::Xml::ConformanceLevel value)
 Sets the conformance level that the XmlWriter checks the XML output for. More...
 
bool get_DoNotEscapeUriAttributes () const
 Returns a value that indicates if the XmlWriter should not escape URI attributes. More...
 
void set_DoNotEscapeUriAttributes (bool value)
 Sets a value that indicates if the XmlWriter should not escape URI attributes. More...
 
System::SharedPtr< System::Text::Encodingget_Encoding () const
 Returns the encoding to use. More...
 
void set_Encoding (const System::SharedPtr< System::Text::Encoding > &value)
 Sets the encoding to use. More...
 
bool get_Indent () const
 Returns a value that indicates whether elements should be indented. More...
 
void set_Indent (bool value)
 Sets a value that indicates whether elements should be indented. More...
 
String get_IndentChars () const
 Returns a character string used for indenting. More...
 
void set_IndentChars (const String &value)
 Sets a character string used for indenting. More...
 
String get_NewLineChars () const
 Returns a string that should be used for line breaks. More...
 
void set_NewLineChars (const String &value)
 Sets the string that should be used for line breaks. More...
 
NewLineHandling get_NewLineHandling () const
 Returns a value that specifies how the line endings are handled. More...
 
void set_NewLineHandling (NewLineHandling value)
 Sets a value that specifies how the line endings are handled. More...
 
bool get_NewLineOnAttributes () const
 Returns a value that specifies whether attributes should be written on a new line. More...
 
void set_NewLineOnAttributes (bool value)
 Sets a value that specifies whether attributes should be written on a new line. More...
 
bool get_OmitXmlDeclaration () const
 Returns a value that indicates if an XML declaration should be omitted. More...
 
void set_OmitXmlDeclaration (bool value)
 Sets a value that indicates if an XML declaration should be omitted. More...
 
XmlOutputMethod get_OutputMethod () const
 Returns a value that indicates the method used to serialize the output. More...
 
 XmlWriterSettings ()
 Constructs an instance of XmlWriterSettings class with all settings set to default values. More...
 
System::SharedPtr< XmlWriterSettingsClone () const
 Returns a copy of the current object. More...
 
void Reset ()
 Resets all the settings to default values. 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...
 
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...
 
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 TypeInfoGetType () 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...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. 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 TypeInfoType ()
 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

Specifies a set of features to support on the XmlWriter object created by the Create() method. 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.

Constructor & Destructor Documentation

◆ XmlWriterSettings()

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

Constructs an instance of XmlWriterSettings class with all settings set to default values.

Member Function Documentation

◆ Clone()

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

Returns a copy of the current object.

◆ get_CheckCharacters()

bool System::Xml::XmlWriterSettings::get_CheckCharacters ( ) const

Returns a value that indicates whether the XML writer should determine if all characters in the document conform to the "2.2 Characters" section of the W3C XML 1.0 Recommendation.

◆ get_CloseOutput()

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

Returns a value that indicates if the XmlWriter should close the underlying stream or XmlWriter object when method Close() is called.

◆ get_ConformanceLevel()

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

Returns the conformance level that the XmlWriter checks the XML output for.

◆ get_DoNotEscapeUriAttributes()

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

Returns a value that indicates if the XmlWriter should not escape URI attributes.

◆ get_Encoding()

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

Returns the encoding to use.

◆ get_Indent()

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

Returns a value that indicates whether elements should be indented.

◆ get_IndentChars()

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

Returns a character string used for indenting.

◆ get_NewLineChars()

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

Returns a string that should be used for line breaks.

◆ get_NewLineHandling()

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

Returns a value that specifies how the line endings are handled.

◆ get_NewLineOnAttributes()

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

Returns a value that specifies whether attributes should be written on a new line.

◆ get_OmitXmlDeclaration()

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

Returns a value that indicates if an XML declaration should be omitted.

◆ get_OutputMethod()

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

Returns a value that indicates the method used to serialize the output.

◆ Reset()

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

Resets all the settings to default values.

◆ set_CheckCharacters()

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

Sets a value that indicates whether the XML writer should determine if 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()

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

Sets a value that indicates if the XmlWriter should close the underlying stream or XmlWriter object when method Close() is called.

Parameters
valueThe value to set

◆ set_ConformanceLevel()

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

Sets the conformance level that the XmlWriter checks the XML output for.

Parameters
valueThe value to set

◆ set_DoNotEscapeUriAttributes()

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

Sets a value that indicates if the XmlWriter should not escape URI attributes.

Parameters
valueThe value to set

◆ set_Encoding()

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

Sets the encoding to use.

Parameters
valueThe value to set

◆ set_Indent()

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

Sets a value that indicates whether elements should be indented.

Parameters
valueThe value to set

◆ set_IndentChars()

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

Sets a character string used for indenting.

Parameters
valueThe value to set

◆ set_NewLineChars()

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

Sets the string that should be used for line breaks.

Parameters
valueThe value to set

◆ set_NewLineHandling()

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

Sets a value that specifies how the line endings are handled.

Parameters
valueThe value to set

◆ set_NewLineOnAttributes()

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

Sets a value that specifies whether attributes should be written on a new line.

Parameters
valueThe value to set

◆ set_OmitXmlDeclaration()

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

Sets a value that indicates if an XML declaration should be omitted.

Parameters
valueThe value to set