XmlReaderSettings

XmlReaderSettings class

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

class XmlReaderSettings : public System::Object

Methods

MethodDescription
void CheckReadOnly(const String&)
SharedPtr<XmlReaderSettings> Clone()Creates a copy of the XmlReaderSettings instance.
virtual bool Equals(ptr)Compares objects using C# Object.Equals semantics.
static std::enable_if<IsSmartPtr<T1>::value&&IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)Compares reference type objects in C# style.
static std::enable_if<!IsSmartPtr<T1>::value&&!IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)Compares value type objects in C# style.
static bool Equals(float const&, float const&)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.
static bool Equals(double const&, double const&)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.
virtual bool FastCast(const Details::FastRttiBase&, void **) constFor internal purposes only.
bool get_CheckCharacters()Returns a value indicating whether to do character checking.
bool get_CloseInput()Returns a value indicating whether the underlying stream or TextReader should be closed when the reader is closed.
System::Xml::ConformanceLevel get_ConformanceLevel()Returns the level of conformance which the XmlReader will comply.
System::Xml::DtdProcessing get_DtdProcessing()Returns a value that determines the processing of DTDs.
bool get_IgnoreComments()Returns a value indicating whether to ignore comments.
bool get_IgnoreProcessingInstructions()Returns a value indicating whether to ignore processing instructions.
bool get_IgnoreWhitespace()Returns a value indicating whether to ignore insignificant white space.
int32_t get_LineNumberOffset()Returns line number offset of the XmlReader object.
int32_t get_LinePositionOffset()Returns line position offset of the XmlReader object.
int64_t get_MaxCharactersFromEntities()Returns a value indicating the maximum allowable number of characters in a document that result from expanding entities.
int64_t 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.
SharedPtr<XmlNameTable> get_NameTable()Returns the XmlNameTable used for atomized string comparisons.
bool get_ProhibitDtd()Returns a value indicating whether to prohibit document type definition (DTD) processing.
SharedPtr<Schema::XmlSchemaSet> get_Schemas()Returns the XmlSchemaSet to use when performing schema validation.
Schema::XmlSchemaValidationFlags 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).
System::Xml::ValidationType get_ValidationType()Returns a value indicating whether the XmlReader will perform validation or type assignment when reading.
Detail::SmartPtrCounter * GetCounter()Gets reference counter data structure associated with the object.
virtual int32_t GetHashCode() constAnalog of C# Object.GetHashCode() method. Enables hashing of custom objects.
virtual const TypeInfo& GetType() constGets actual type of object. Analog of C# System.Object.GetType() call.
virtual bool Is(const TypeInfo&) constCheck if object represents an instance of type described by targetType. Analog of C# ‘is’ operator.
void Lock()Implements C# lock() statement locking. Call directly or use LockContext sentry object.
virtual ptr MemberwiseClone() constAnalog of C# Object.MemberwiseClone() method. Enables cloning custom types.
Object()Creates object. Initializes all internal data structures.
Object(Object const&)Copy constructor. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
Object& operator=(Object const&)Assignment operator. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
static bool ReferenceEquals(ptr const&, ptr const&)Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, T const&)Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, std::nullptr_t)Reference-compares value type object with nullptr.
bool ReferenceEquals(String const&, std::nullptr_t)Specialization of Object::ReferenceEquals for case of string and nullptr.
bool ReferenceEquals(String const&, String const&)Specialization of Object::ReferenceEquals for case of strings.
int RemovedSharedRefs(int)Decreases shared reference count by specified value.
void Reset()Resets the members of the settings class to their default values.
void set_CheckCharacters(bool)Sets a value indicating whether to do character checking.
void set_CloseInput(bool)Sets a value indicating whether the underlying stream or TextReader should be closed when the reader is closed.
void set_ConformanceLevel(System::Xml::ConformanceLevel)Sets the level of conformance which the XmlReader will comply.
void set_DtdProcessing(System::Xml::DtdProcessing)Sets a value that determines the processing of DTDs.
void set_IgnoreComments(bool)Sets a value indicating whether to ignore comments.
void set_IgnoreProcessingInstructions(bool)Sets a value indicating whether to ignore processing instructions.
void set_IgnoreWhitespace(bool)Sets a value indicating whether to ignore insignificant white space.
void set_LineNumberOffset(int32_t)Sets line number offset of the XmlReader object.
void set_LinePositionOffset(int32_t)Sets line position offset of the XmlReader object.
void set_MaxCharactersFromEntities(int64_t)Sets a value indicating the maximum allowable number of characters in a document that result from expanding entities.
void set_MaxCharactersInDocument(int64_t)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.
void set_NameTable(const SharedPtr<XmlNameTable>&)Sets the XmlNameTable used for atomized string comparisons.
void set_ProhibitDtd(bool)Sets a value indicating whether to prohibit document type definition (DTD) processing.
void set_Schemas(const SharedPtr<Schema::XmlSchemaSet>&)Sets the XmlSchemaSet to use when performing schema validation.
void set_ValidationFlags(Schema::XmlSchemaValidationFlags)Sets a value indicating the schema validation settings. This setting applies to XmlReader objects that validate schemas (XmlReaderSettings::get_ValidationType value is ValidationType::Schema).
void set_ValidationType(System::Xml::ValidationType)Sets a value indicating whether the XmlReader will perform validation or type assignment when reading.
void set_XmlResolver(const SharedPtr<System::Xml::XmlResolver>&)Sets the XmlResolver used to access external documents.
virtual void SetTemplateWeakPtr(uint32_t)Set n’th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.
int SharedCount() constGets current value of shared reference counter.
Object * SharedRefAdded()Increments shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
int SharedRefRemovedSafe()Decrements and returns shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
virtual String ToString() constAnalog of C# Object.ToString() method. Enables converting custom objects to string.
static const TypeInfo& Type()Implements C# typeof(System.Object) construct.
void Unlock()Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.
void ValidationEventHandler_add(Args…)Adds an event handler that occurs when the reader encounters validation errors.
void ValidationEventHandler_remove(Args…)Removes an event handler that occurs when the reader encounters validation errors.
Detail::SmartPtrCounter * WeakRefAdded()Increments weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
void WeakRefRemoved()Decrements weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
XmlReaderSettings()Initializes a new instance of the XmlReaderSettings class.
virtual ~Object()Destroys object. Frees all internal data structures.

Typedefs

TypedefDescription
PtrAn alias for shared pointer to an instance of this class.

Remarks

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.

See Also