System::Xml::XmlReaderSettings Class Reference

Inherits System::Object.

Public Types

typedef SharedPtr< XmlReaderSettingsPtr
 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...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 

Public Member Functions

 XmlReaderSettings ()
 Constructs a new instance of XmlReaderSettings class. More...
 
bool get_IgnoreWhitespace () const
 
void set_IgnoreWhitespace (bool value)
 
DtdProcessing get_DtdProcessing () const
 Returns a value that determines the processing of DTD. More...
 
void set_DtdProcessing (DtdProcessing value)
 
bool get_ProhibitDtd () const
 Returns a value that indicates if DTD processing should be prohibited. More...
 
void set_ProhibitDtd (bool value)
 
ValidationType get_ValidationType () const
 Returns a value that indicates if the XmlReader will perform validation or type assignment when reading. More...
 
void set_ValidationType (ValidationType value)
 
Schema::XmlSchemaSet::Ptr get_Schemas () const
 Returns a set of XML schemas to use when schema validation is performed. More...
 
void set_Schemas (const Schema::XmlSchemaSet::Ptr &value)
 
Schema::XmlSchemaValidationFlags get_ValidationFlags () const
 Returns schema validation settings. More...
 
void set_ValidationFlags (Schema::XmlSchemaValidationFlags value)
 Sets schema validation settings. More...
 
int get_LineNumberOffset ()
 Returns a line number offset of the XmlReader object. More...
 
int get_LinePositionOffset ()
 Returns a line position offset of the XmlReader object. More...
 
void set_XmlResolver (XmlResolver::Ptr xmlResolver)
 
- 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)
 

Public Attributes

Schema::ValidatingEventSignal ValidationEventHandler
 Occurs when validation errors are encountered by the reader. More...
 

Protected Attributes

ValidationType validation_type
 Specifies if the XmlReader will perform validation or type assignment when reading. More...
 
Schema::XmlSchemaValidationFlags schema_validation_flags
 Schema validation settings. More...
 
DtdProcessing dtd_processing
 Dsetermines the processing of DTD. More...
 
Schema::XmlSchemaSet::Ptr schemas
 XML schemas use when schema validation is performed. More...
 
int lineNumberOffset
 A line number offset of the XmlReader object. More...
 
int linePositionOffset
 A line position offset of the XmlReader object. More...
 
XmlResolver::Ptr xmlResolver
 XML Resolver used when accessing external documents. More...
 
bool IsXmlResolverSet
 Indicates if the XmlResolver object has been set. More...
 

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

Detailed Description

Specifies a set of features to support on the XmlReader 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.

Member Typedef Documentation

◆ Ptr

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

Constructor & Destructor Documentation

◆ XmlReaderSettings()

System::Xml::XmlReaderSettings::XmlReaderSettings ( )
inline

Constructs a new instance of XmlReaderSettings class.

Member Function Documentation

◆ get_DtdProcessing()

DtdProcessing System::Xml::XmlReaderSettings::get_DtdProcessing ( ) const
inline

Returns a value that determines the processing of DTD.

◆ get_IgnoreWhitespace()

bool System::Xml::XmlReaderSettings::get_IgnoreWhitespace ( ) const
inline

Returns a value that indicates if insignificant white spaces should be ignored.

Returns
Always false

◆ get_LineNumberOffset()

int System::Xml::XmlReaderSettings::get_LineNumberOffset ( )
inline

Returns a line number offset of the XmlReader object.

◆ get_LinePositionOffset()

int System::Xml::XmlReaderSettings::get_LinePositionOffset ( )
inline

Returns a line position offset of the XmlReader object.

◆ get_ProhibitDtd()

bool System::Xml::XmlReaderSettings::get_ProhibitDtd ( ) const
inline

Returns a value that indicates if DTD processing should be prohibited.

◆ get_Schemas()

Schema::XmlSchemaSet::Ptr System::Xml::XmlReaderSettings::get_Schemas ( ) const
inline

Returns a set of XML schemas to use when schema validation is performed.

◆ get_ValidationFlags()

Schema::XmlSchemaValidationFlags System::Xml::XmlReaderSettings::get_ValidationFlags ( ) const
inline

Returns schema validation settings.

◆ get_ValidationType()

ValidationType System::Xml::XmlReaderSettings::get_ValidationType ( ) const
inline

Returns a value that indicates if the XmlReader will perform validation or type assignment when reading.

◆ set_DtdProcessing()

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

Sets a value that determines the processing of DTD.

Parameters
valueThe value to set

◆ set_IgnoreWhitespace()

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

Not supported.

Exceptions
NotSupportedExceptionAlways

◆ set_ProhibitDtd()

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

Sets a value that indicates if DTD processing should be prohibited.

Parameters
valueThe value to set

◆ set_Schemas()

void System::Xml::XmlReaderSettings::set_Schemas ( const Schema::XmlSchemaSet::Ptr value)
inline

Sets a set of XML schemas to use when schema validation is performed.

Parameters
valueA shared pointer to XmlSchemaSet object to set

◆ set_ValidationFlags()

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

Sets schema validation settings.

◆ set_ValidationType()

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

Sets a value that indicates if the XmlReader will perform validation or type assignment when reading.

Parameters
valueThe valu to set

◆ set_XmlResolver()

void System::Xml::XmlReaderSettings::set_XmlResolver ( XmlResolver::Ptr  xmlResolver)
inline

Sets the XML Resolver used when accessing external documents.

Parameters
xmlResolverThe XmlResolver object to set

Member Data Documentation

◆ dtd_processing

DtdProcessing System::Xml::XmlReaderSettings::dtd_processing
protected

Dsetermines the processing of DTD.

◆ IsXmlResolverSet

bool System::Xml::XmlReaderSettings::IsXmlResolverSet
protected

Indicates if the XmlResolver object has been set.

◆ lineNumberOffset

int System::Xml::XmlReaderSettings::lineNumberOffset
protected

A line number offset of the XmlReader object.

◆ linePositionOffset

int System::Xml::XmlReaderSettings::linePositionOffset
protected

A line position offset of the XmlReader object.

◆ schema_validation_flags

Schema::XmlSchemaValidationFlags System::Xml::XmlReaderSettings::schema_validation_flags
protected

Schema validation settings.

◆ schemas

Schema::XmlSchemaSet::Ptr System::Xml::XmlReaderSettings::schemas
protected

XML schemas use when schema validation is performed.

◆ validation_type

ValidationType System::Xml::XmlReaderSettings::validation_type
protected

Specifies if the XmlReader will perform validation or type assignment when reading.

◆ ValidationEventHandler

Schema::ValidatingEventSignal System::Xml::XmlReaderSettings::ValidationEventHandler

Occurs when validation errors are encountered by the reader.

◆ xmlResolver

XmlResolver::Ptr System::Xml::XmlReaderSettings::xmlResolver
protected

XML Resolver used when accessing external documents.