System::Xml::XmlWriterSettings Class Reference

Inherits System::Object.

Public Member Functions

ASPOSECPP_SHARED_API bool get_CheckCharacters () const
 
ASPOSECPP_SHARED_API void set_CheckCharacters (bool value)
 
ASPOSECPP_SHARED_API bool get_CloseOutput () const
 
ASPOSECPP_SHARED_API void set_CloseOutput (bool value)
 
ASPOSECPP_SHARED_API System::Xml::ConformanceLevel get_ConformanceLevel () const
 Returns the conformance level that the XmlWriter checks the XML output for. More...
 
ASPOSECPP_SHARED_API void set_ConformanceLevel (System::Xml::ConformanceLevel value)
 
ASPOSECPP_SHARED_API bool get_DoNotEscapeUriAttributes () const
 Returns a value that indicates if the XmlWriter should not escape URI attributes. More...
 
ASPOSECPP_SHARED_API void set_DoNotEscapeUriAttributes (bool value)
 
ASPOSECPP_SHARED_API System::SharedPtr< System::Text::Encodingget_Encoding () const
 Returns the encoding to use. More...
 
ASPOSECPP_SHARED_API void set_Encoding (const System::SharedPtr< System::Text::Encoding > &value)
 
ASPOSECPP_SHARED_API bool get_Indent () const
 Returns a value that indicates whether elements should be indented. More...
 
ASPOSECPP_SHARED_API void set_Indent (bool value)
 
ASPOSECPP_SHARED_API String get_IndentChars () const
 Returns a character string used for indenting. More...
 
ASPOSECPP_SHARED_API void set_IndentChars (const String &value)
 
ASPOSECPP_SHARED_API String get_NewLineChars () const
 Returns a string that should be used for line breaks. More...
 
ASPOSECPP_SHARED_API void set_NewLineChars (const String &value)
 
ASPOSECPP_SHARED_API NewLineHandling get_NewLineHandling () const
 Returns a value that specifies how the line endings are handled. More...
 
ASPOSECPP_SHARED_API void set_NewLineHandling (NewLineHandling value)
 
ASPOSECPP_SHARED_API bool get_NewLineOnAttributes () const
 Returns a value that specifies whether attributes should be written on a new line. More...
 
ASPOSECPP_SHARED_API void set_NewLineOnAttributes (bool value)
 
ASPOSECPP_SHARED_API bool get_OmitXmlDeclaration () const
 Returns a value that indicates if an XML declaration should be omitted. More...
 
ASPOSECPP_SHARED_API void set_OmitXmlDeclaration (bool value)
 
ASPOSECPP_SHARED_API XmlOutputMethod get_OutputMethod () const
 Returns a value that indicates the method used to serialize the output. More...
 
ASPOSECPP_SHARED_API XmlWriterSettings ()
 
ASPOSECPP_SHARED_API System::SharedPtr< XmlWriterSettingsClone () const
 Returns a copy of the current object. More...
 
ASPOSECPP_SHARED_API void Reset ()
 Resets all the settings to default values. More...
 
- 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 refernce 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_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 (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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 ()
 Impleemnts C# typeof(System.Object) construct. 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()

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

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

Member Function Documentation

◆ Clone()

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

Returns a copy of the current object.

◆ get_CheckCharacters()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

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

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

◆ get_DoNotEscapeUriAttributes()

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

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

◆ get_Encoding()

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

Returns the encoding to use.

◆ get_Indent()

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

Returns a value that indicates whether elements should be indented.

◆ get_IndentChars()

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

Returns a character string used for indenting.

◆ get_NewLineChars()

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

Returns a string that should be used for line breaks.

◆ get_NewLineHandling()

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

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

◆ get_NewLineOnAttributes()

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

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

◆ get_OmitXmlDeclaration()

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

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

◆ get_OutputMethod()

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

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

◆ Reset()

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

Resets all the settings to 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 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()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

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

Sets a character string used for indenting.

Parameters
valueThe value to set

◆ set_NewLineChars()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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()

ASPOSECPP_SHARED_API 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