System::Xml::XmlReaderSettings Class Referencefinal

Inherits System::Object.

Public Types

using Ptr = SharedPtr< XmlReaderSettings >
 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< XmlNameTableget_NameTable ()
 
ASPOSECPP_SHARED_API void set_NameTable (const SharedPtr< XmlNameTable > &value)
 
ASPOSECPP_SHARED_API void set_XmlResolver (const SharedPtr< System::Xml::XmlResolver > &value)
 
ASPOSECPP_SHARED_API int32_t get_LineNumberOffset ()
 
ASPOSECPP_SHARED_API void set_LineNumberOffset (int32_t value)
 
ASPOSECPP_SHARED_API int32_t get_LinePositionOffset ()
 
ASPOSECPP_SHARED_API void set_LinePositionOffset (int32_t 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 int64_t get_MaxCharactersInDocument ()
 
ASPOSECPP_SHARED_API void set_MaxCharactersInDocument (int64_t value)
 
ASPOSECPP_SHARED_API int64_t get_MaxCharactersFromEntities ()
 
ASPOSECPP_SHARED_API void set_MaxCharactersFromEntities (int64_t value)
 
ASPOSECPP_SHARED_API bool get_IgnoreWhitespace ()
 
ASPOSECPP_SHARED_API void set_IgnoreWhitespace (bool value)
 
ASPOSECPP_SHARED_API bool get_IgnoreProcessingInstructions ()
 
ASPOSECPP_SHARED_API void set_IgnoreProcessingInstructions (bool value)
 
ASPOSECPP_SHARED_API bool get_IgnoreComments ()
 
ASPOSECPP_SHARED_API void set_IgnoreComments (bool value)
 
ASPOSECPP_SHARED_API bool get_ProhibitDtd ()
 
ASPOSECPP_SHARED_API void set_ProhibitDtd (bool value)
 
ASPOSECPP_SHARED_API System::Xml::DtdProcessing get_DtdProcessing ()
 
ASPOSECPP_SHARED_API void set_DtdProcessing (System::Xml::DtdProcessing value)
 
ASPOSECPP_SHARED_API bool get_CloseInput ()
 
ASPOSECPP_SHARED_API void set_CloseInput (bool value)
 
ASPOSECPP_SHARED_API System::Xml::ValidationType get_ValidationType ()
 
ASPOSECPP_SHARED_API void set_ValidationType (System::Xml::ValidationType value)
 
ASPOSECPP_SHARED_API Schema::XmlSchemaValidationFlags get_ValidationFlags ()
 
ASPOSECPP_SHARED_API void set_ValidationFlags (Schema::XmlSchemaValidationFlags value)
 
ASPOSECPP_SHARED_API SharedPtr< Schema::XmlSchemaSetget_Schemas ()
 
ASPOSECPP_SHARED_API void set_Schemas (const SharedPtr< Schema::XmlSchemaSet > &value)
 
ASPOSECPP_SHARED_API XmlReaderSettings ()
 Initializes a new instance of the XmlReaderSettings class. More...
 
template<class... Args>
void ValidationEventHandler_add (Args... value)
 
template<class... Args>
void ValidationEventHandler_remove (Args... value)
 
ASPOSECPP_SHARED_API void Reset ()
 Resets the members of the settings class to their default values. More...
 
ASPOSECPP_SHARED_API SharedPtr< XmlReaderSettingsClone ()
 
ASPOSECPP_SHARED_API void CheckReadOnly (const String &propertyName)
 
- 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)
 

Protected Member Functions

virtual ASPOSECPP_SHARED_API ~XmlReaderSettings ()
 

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 XmlReader object created by the XmlReader::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

◆ XmlReaderSettings()

ASPOSECPP_SHARED_API System::Xml::XmlReaderSettings::XmlReaderSettings ( )

Initializes a new instance of the XmlReaderSettings class.

◆ ~XmlReaderSettings()

virtual ASPOSECPP_SHARED_API System::Xml::XmlReaderSettings::~XmlReaderSettings ( )
protectedvirtual

Member Function Documentation

◆ CheckReadOnly()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::CheckReadOnly ( const String propertyName)

◆ Clone()

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

Creates a copy of the XmlReaderSettings instance.

Returns
The cloned XmlReaderSettings object.

◆ get_CheckCharacters()

ASPOSECPP_SHARED_API bool System::Xml::XmlReaderSettings::get_CheckCharacters ( )

Returns a value indicating whether to do character checking.

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

◆ get_CloseInput()

ASPOSECPP_SHARED_API bool System::Xml::XmlReaderSettings::get_CloseInput ( )

Returns a value indicating whether the underlying stream or TextReader should be closed when the reader is closed.

Returns
true to close the underlying stream or TextReader when the reader is closed; otherwise false. The default is false.

◆ get_ConformanceLevel()

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

Returns the level of conformance which the XmlReader will comply.

Returns
One of the enumeration values that specifies the level of conformance that the XML reader will enforce. The default is ConformanceLevel::Document.

◆ get_DtdProcessing()

ASPOSECPP_SHARED_API System::Xml::DtdProcessing System::Xml::XmlReaderSettings::get_DtdProcessing ( )

Returns a value that determines the processing of DTDs.

Returns
One of the enumeration values that determines the processing of DTDs. The default is DtdProcessing::Prohibit.

◆ get_IgnoreComments()

ASPOSECPP_SHARED_API bool System::Xml::XmlReaderSettings::get_IgnoreComments ( )

Returns a value indicating whether to ignore comments.

Returns
true to ignore comments; otherwise false. The default is false.

◆ get_IgnoreProcessingInstructions()

ASPOSECPP_SHARED_API bool System::Xml::XmlReaderSettings::get_IgnoreProcessingInstructions ( )

Returns a value indicating whether to ignore processing instructions.

Returns
true to ignore processing instructions; otherwise false. The default is false.

◆ get_IgnoreWhitespace()

ASPOSECPP_SHARED_API bool System::Xml::XmlReaderSettings::get_IgnoreWhitespace ( )

Returns a value indicating whether to ignore insignificant white space.

Returns
true to ignore white space; otherwise false. The default is false.

◆ get_LineNumberOffset()

ASPOSECPP_SHARED_API int32_t System::Xml::XmlReaderSettings::get_LineNumberOffset ( )

Returns line number offset of the XmlReader object.

Returns
The line number offset. The default is 0.

◆ get_LinePositionOffset()

ASPOSECPP_SHARED_API int32_t System::Xml::XmlReaderSettings::get_LinePositionOffset ( )

Returns line position offset of the XmlReader object.

Returns
The line position offset. The default is 0.

◆ get_MaxCharactersFromEntities()

ASPOSECPP_SHARED_API int64_t System::Xml::XmlReaderSettings::get_MaxCharactersFromEntities ( )

Returns a value indicating the maximum allowable number of characters in a document that result from expanding entities.

Returns
The maximum allowable number of characters from expanded entities. The default is 0.

◆ get_MaxCharactersInDocument()

ASPOSECPP_SHARED_API int64_t System::Xml::XmlReaderSettings::get_MaxCharactersInDocument ( )

Returns a value indicating the maximum allowable number of characters in an XML document. A zero (0) value means no limits on the size of the XML document. A non-zero value specifies the maximum size, in characters.

Returns
The maximum allowable number of characters in an XML document. The default is 0.

◆ get_NameTable()

ASPOSECPP_SHARED_API SharedPtr<XmlNameTable> System::Xml::XmlReaderSettings::get_NameTable ( )

Returns the XmlNameTable used for atomized string comparisons.

Returns
The XmlNameTable that stores all the atomized strings used by all XmlReader instances created using this XmlReaderSettings object. The default is nullptr. The created XmlReader instance will use a new empty NameTable if this value is nullptr.

◆ get_ProhibitDtd()

ASPOSECPP_SHARED_API bool System::Xml::XmlReaderSettings::get_ProhibitDtd ( )

Returns a value indicating whether to prohibit document type definition (DTD) processing.

Deprecated:
This method is obsolete. Use XmlTextReader::get_DtdProcessing instead.
Returns
true to prohibit DTD processing; otherwise false. The default is true.

◆ get_Schemas()

ASPOSECPP_SHARED_API SharedPtr<Schema::XmlSchemaSet> System::Xml::XmlReaderSettings::get_Schemas ( )

Returns the XmlSchemaSet to use when performing schema validation.

Returns
The XmlSchemaSet to use when performing schema validation. The default is an empty XmlSchemaSet object.

◆ get_ValidationFlags()

ASPOSECPP_SHARED_API Schema::XmlSchemaValidationFlags System::Xml::XmlReaderSettings::get_ValidationFlags ( )

Returns a value indicating the schema validation settings. This setting applies to XmlReader objects that validate schemas (XmlReaderSettings::get_ValidationType value is ValidationType::Schema).

Returns
A bitwise combination of enumeration values that specify validation options. XmlSchemaValidationFlags::ProcessIdentityConstraints and XmlSchemaValidationFlags::AllowXmlAttributes are enabled by default. XmlSchemaValidationFlags::ProcessInlineSchema, XmlSchemaValidationFlags::ProcessSchemaLocation and XmlSchemaValidationFlags::ReportValidationWarnings are disabled by default.

◆ get_ValidationType()

ASPOSECPP_SHARED_API System::Xml::ValidationType System::Xml::XmlReaderSettings::get_ValidationType ( )

Returns a value indicating whether the XmlReader will perform validation or type assignment when reading.

Returns
One of the ValidationType values that indicates whether XmlReader will perform validation or type assignment when reading. The default is ValidationType::None.

◆ Reset()

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

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

◆ set_CheckCharacters()

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

Sets a value indicating whether to do character checking.

Parameters
valueThe value to set.

◆ set_CloseInput()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::set_CloseInput ( bool  value)

Sets a value indicating whether the underlying stream or TextReader should be closed when the reader is closed.

Parameters
valueThe value to set.

◆ set_ConformanceLevel()

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

Sets the level of conformance which the XmlReader will comply.

Parameters
valueThe value to set.

◆ set_DtdProcessing()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::set_DtdProcessing ( System::Xml::DtdProcessing  value)

Sets a value that determines the processing of DTDs.

Parameters
valueThe value to set.

◆ set_IgnoreComments()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::set_IgnoreComments ( bool  value)

Sets a value indicating whether to ignore comments.

Parameters
valueThe value to set.

◆ set_IgnoreProcessingInstructions()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::set_IgnoreProcessingInstructions ( bool  value)

Sets a value indicating whether to ignore processing instructions.

Parameters
valueThe value to set.

◆ set_IgnoreWhitespace()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::set_IgnoreWhitespace ( bool  value)

Sets a value indicating whether to ignore insignificant white space.

Parameters
valueThe value to set.

◆ set_LineNumberOffset()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::set_LineNumberOffset ( int32_t  value)

Sets line number offset of the XmlReader object.

Parameters
valueThe value to set.

◆ set_LinePositionOffset()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::set_LinePositionOffset ( int32_t  value)

Sets line position offset of the XmlReader object.

Parameters
valueThe value to set.

◆ set_MaxCharactersFromEntities()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::set_MaxCharactersFromEntities ( int64_t  value)

Sets a value indicating the maximum allowable number of characters in a document that result from expanding entities.

Parameters
valueThe value to set.

◆ set_MaxCharactersInDocument()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::set_MaxCharactersInDocument ( int64_t  value)

Sets a value indicating the maximum allowable number of characters in an XML document. A zero (0) value means no limits on the size of the XML document. A non-zero value specifies the maximum size, in characters.

Parameters
valueThe value to set.

◆ set_NameTable()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::set_NameTable ( const SharedPtr< XmlNameTable > &  value)

Sets the XmlNameTable used for atomized string comparisons.

Parameters
valueThe value to set.

◆ set_ProhibitDtd()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::set_ProhibitDtd ( bool  value)

Sets a value indicating whether to prohibit document type definition (DTD) processing.

Deprecated:
This method is obsolete. Use XmlTextReader::set_DtdProcessing instead.
Parameters
valueThe value to set.

◆ set_Schemas()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::set_Schemas ( const SharedPtr< Schema::XmlSchemaSet > &  value)

Sets the XmlSchemaSet to use when performing schema validation.

Parameters
valueThe value to set.

◆ set_ValidationFlags()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::set_ValidationFlags ( Schema::XmlSchemaValidationFlags  value)

Sets a value indicating the schema validation settings. This setting applies to XmlReader objects that validate schemas (XmlReaderSettings::get_ValidationType value is ValidationType::Schema).

Parameters
valueThe value to set.

◆ set_ValidationType()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::set_ValidationType ( System::Xml::ValidationType  value)

Sets a value indicating whether the XmlReader will perform validation or type assignment when reading.

Parameters
valueThe value to set.

◆ set_XmlResolver()

ASPOSECPP_SHARED_API void System::Xml::XmlReaderSettings::set_XmlResolver ( const SharedPtr< System::Xml::XmlResolver > &  value)

Sets the XmlResolver used to access external documents.

Parameters
valueThe value to set.

◆ ValidationEventHandler_add()

template<class... Args>
void System::Xml::XmlReaderSettings::ValidationEventHandler_add ( Args...  value)
inline

Adds an event handler that occurs when the reader encounters validation errors.

Parameters
valueA bound or static method or ValidationEventHandler instance.

◆ ValidationEventHandler_remove()

template<class... Args>
void System::Xml::XmlReaderSettings::ValidationEventHandler_remove ( Args...  value)
inline

Removes an event handler that occurs when the reader encounters validation errors.

Parameters
valueA bound or static method or ValidationEventHandler instance.