An in-memory representation of an XML Schema, as specified in the World Wide Web Consortium (W3C) XML Schema Part 1: Structures and XML Schema Part 2: Datatypes. More...

#include <xml_schema.h>

Inherits System::Xml::Schema::XmlSchemaObject.

Public Types
using	Ptr = SharedPtr< XmlSchema >
	An alias for shared pointer to an instance of this class. More...

Public Types inherited from System::Xml::Schema::XmlSchemaObject
using	Ptr = SharedPtr< XmlSchemaObject >
	An alias for shared pointer to an instance of this class. More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Public Member Functions
XmlSchemaForm	get_AttributeFormDefault ()
	Returns the form for attributes declared in the target namespace of the schema. More...

void	set_AttributeFormDefault (XmlSchemaForm value)
	Sets the form for attributes declared in the target namespace of the schema. More...

XmlSchemaDerivationMethod	get_BlockDefault ()
	Returns the `blockDefault` attribute which sets the default value of the `block` attribute on element and complex types in the `targetNamespace` of the schema. More...

void	set_BlockDefault (XmlSchemaDerivationMethod value)
	Sets the `blockDefault` attribute which sets the default value of the `block` attribute on element and complex types in the `targetNamespace` of the schema. More...

XmlSchemaDerivationMethod	get_FinalDefault ()
	Returns the `finalDefault` attribute which sets the default value of the `final` attribute on elements and complex types in the target namespace of the schema. More...

void	set_FinalDefault (XmlSchemaDerivationMethod value)
	Sets the `finalDefault` attribute which sets the default value of the `final` attribute on elements and complex types in the target namespace of the schema. More...

XmlSchemaForm	get_ElementFormDefault ()
	Returns the form for elements declared in the target namespace of the schema. More...

void	set_ElementFormDefault (XmlSchemaForm value)
	Sets the form for elements declared in the target namespace of the schema. More...

String	get_TargetNamespace ()
	Returns the Uniform Resource Identifier (URI) of the schema target namespace. More...

void	set_TargetNamespace (const String &value)
	Sets the Uniform Resource Identifier (URI) of the schema target namespace. More...

String	get_Version ()
	Returns the version of the schema. More...

void	set_Version (const String &value)
	Sets the version of the schema. More...

SharedPtr< XmlSchemaObjectCollection >	get_Includes ()
	Returns the collection of included and imported schemas. More...

SharedPtr< XmlSchemaObjectCollection >	get_Items ()
	Returns the collection of schema elements in the schema and is used to add new element types at the `schema` element level. More...

bool	get_IsCompiled ()
	Indicates if the schema has been compiled. More...

SharedPtr< XmlSchemaObjectTable >	get_Attributes ()
	Returns the post-schema-compilation value for all the attributes in the schema. More...

SharedPtr< XmlSchemaObjectTable >	get_AttributeGroups ()
	Returns the post-schema-compilation value of all the global attribute groups in the schema. More...

SharedPtr< XmlSchemaObjectTable >	get_SchemaTypes ()
	Returns the post-schema-compilation value of all schema types in the schema. More...

SharedPtr< XmlSchemaObjectTable >	get_Elements ()
	Returns the post-schema-compilation value for all the elements in the schema. More...

String	get_Id ()
	Returns the string ID. More...

void	set_Id (const String &value)
	Sets the string ID. More...

ArrayPtr< SharedPtr< XmlAttribute > >	get_UnhandledAttributes ()
	Returns the qualified attributes which do not belong to the schema target namespace. More...

void	set_UnhandledAttributes (const ArrayPtr< SharedPtr< XmlAttribute > > &value)
	Sets the qualified attributes which do not belong to the schema target namespace. More...

SharedPtr< XmlSchemaObjectTable >	get_Groups ()
	Returns the post-schema-compilation value of all the groups in the schema. More...

SharedPtr< XmlSchemaObjectTable >	get_Notations ()
	Returns the post-schema-compilation value for all notations in the schema. More...

	XmlSchema ()
	Initializes a new instance of the XmlSchema class. More...

void	Write (const SharedPtr< IO::Stream > &stream)
	Writes the XML Schema to the supplied data stream. More...

void	Write (const SharedPtr< IO::Stream > &stream, const SharedPtr< XmlNamespaceManager > &namespaceManager)
	Writes the XML Schema to the supplied Stream using the XmlNamespaceManager specified. More...

void	Write (const SharedPtr< IO::TextWriter > &writer)
	Writes the XML Schema to the supplied IO::TextWriter. More...

void	Write (const SharedPtr< IO::TextWriter > &writer, const SharedPtr< XmlNamespaceManager > &namespaceManager)
	Writes the XML Schema to the supplied TextWriter. More...

void	Write (const SharedPtr< XmlWriter > &writer)
	Writes the XML Schema to the supplied XmlWriter. More...

void	Write (const SharedPtr< XmlWriter > &writer, const SharedPtr< XmlNamespaceManager > &namespaceManager)
	Writes the XML Schema to the supplied XmlWriter. More...

void	Compile (ValidationEventHandler validationEventHandler)
	Compiles the XML Schema Object Model (SOM) into schema information for validation. Used to check the syntactic and semantic structure of the programmatically built SOM. Semantic validation checking is performed during compilation. More...

void	Compile (ValidationEventHandler validationEventHandler, const SharedPtr< XmlResolver > &resolver)
	Compiles the XML Schema Object Model (SOM) into schema information for validation. Used to check the syntactic and semantic structure of the programmatically built SOM. Semantic validation checking is performed during compilation. More...

Public Member Functions inherited from System::Xml::Schema::XmlSchemaObject
int32_t	get_LineNumber ()
	Returns the line number in the file to which the `schema` element refers. More...

void	set_LineNumber (int32_t value)
	Sets the line number in the file to which the `schema` element refers. More...

int32_t	get_LinePosition ()
	Returns the line position in the file to which the `schema` element refers. More...

void	set_LinePosition (int32_t value)
	Sets the line position in the file to which the `schema` element refers. More...

String	get_SourceUri ()
	Returns the source location for the file that loaded the schema. More...

void	set_SourceUri (const String &value)
	Sets the source location for the file that loaded the schema. More...

SharedPtr< XmlSchemaObject >	get_Parent ()
	Returns the parent of this XmlSchemaObject. More...

void	set_Parent (const SharedPtr< XmlSchemaObject > &value)
	Sets the parent of this XmlSchemaObject. More...

SharedPtr< System::Xml::Serialization::XmlSerializerNamespaces >	get_Namespaces ()
	Returns the XmlSerializerNamespaces to use with this schema object. More...

void	set_Namespaces (const SharedPtr< System::Xml::Serialization::XmlSerializerNamespaces > &value)
	Sets the XmlSerializerNamespaces to use with this schema object. More...

	XmlSchemaObject ()
	Initializes a new instance of the XmlSchemaObject class. 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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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...

Static Public Member Functions
static SharedPtr< XmlSchema >	Read (const SharedPtr< IO::TextReader > &reader, ValidationEventHandler validationEventHandler)
	Reads an XML Schema from the supplied IO::TextReader. More...

static SharedPtr< XmlSchema >	Read (const SharedPtr< IO::Stream > &stream, ValidationEventHandler validationEventHandler)
	Reads an XML Schema from the supplied stream. More...

static SharedPtr< XmlSchema >	Read (const SharedPtr< XmlReader > &reader, ValidationEventHandler validationEventHandler)
	Reads an XML Schema from the supplied XmlReader. 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 TypeInfo &	Type ()
	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...

Static Public Attributes
static const String	Namespace
	The XML schema namespace. This field is constant. More...

static const String	InstanceNamespace
	The XML schema instance namespace. This field is constant. More...

Protected Member Functions
virtual	~XmlSchema ()

Detailed Description

An in-memory representation of an XML Schema, as specified in the World Wide Web Consortium (W3C) XML Schema Part 1: Structures and XML Schema Part 2: Datatypes.

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

using System::Xml::Schema::XmlSchema::Ptr = SharedPtr<XmlSchema>

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

Constructor & Destructor Documentation

◆ XmlSchema()

System::Xml::Schema::XmlSchema::XmlSchema ( )

Initializes a new instance of the XmlSchema class.

◆ ~XmlSchema()

virtual System::Xml::Schema::XmlSchema::~XmlSchema ( )

protectedvirtual

Member Function Documentation

◆ Compile() [1/2]

void System::Xml::Schema::XmlSchema::Compile ( ValidationEventHandler validationEventHandler )

Compiles the XML Schema Object Model (SOM) into schema information for validation. Used to check the syntactic and semantic structure of the programmatically built SOM. Semantic validation checking is performed during compilation.

Parameters

validationEventHandler The validation event handler that receives information about XML Schema validation errors.

◆ Compile() [2/2]

void System::Xml::Schema::XmlSchema::Compile	(	ValidationEventHandler	validationEventHandler,
		const SharedPtr< XmlResolver > &	resolver
	)

Compiles the XML Schema Object Model (SOM) into schema information for validation. Used to check the syntactic and semantic structure of the programmatically built SOM. Semantic validation checking is performed during compilation.

Parameters

validationEventHandler	The validation event handler that receives information about the XML Schema validation errors.
resolver	The XmlResolver used to resolve namespaces referenced in `include` and `import` elements.

◆ get_AttributeFormDefault()

XmlSchemaForm System::Xml::Schema::XmlSchema::get_AttributeFormDefault ( )

Returns the form for attributes declared in the target namespace of the schema.

Returns: The XmlSchemaForm value that indicates if attributes from the target namespace are required to be qualified with the namespace prefix. The default is XmlSchemaForm::None.

◆ get_AttributeGroups()

SharedPtr< XmlSchemaObjectTable > System::Xml::Schema::XmlSchema::get_AttributeGroups ( )

Returns the post-schema-compilation value of all the global attribute groups in the schema.

Returns: An XmlSchemaObjectTable collection of all the global attribute groups in the schema.

◆ get_Attributes()

SharedPtr< XmlSchemaObjectTable > System::Xml::Schema::XmlSchema::get_Attributes ( )

Returns the post-schema-compilation value for all the attributes in the schema.

Returns: An XmlSchemaObjectTable collection of all the attributes in the schema.

◆ get_BlockDefault()

XmlSchemaDerivationMethod System::Xml::Schema::XmlSchema::get_BlockDefault ( )

Returns the blockDefault attribute which sets the default value of the block attribute on element and complex types in the targetNamespace of the schema.

Returns: An XmlSchemaDerivationMethod value representing the different methods for preventing derivation. The default value is XmlSchemaDerivationMethod::None.

◆ get_ElementFormDefault()

XmlSchemaForm System::Xml::Schema::XmlSchema::get_ElementFormDefault ( )

Returns the form for elements declared in the target namespace of the schema.

Returns: The XmlSchemaForm value that indicates if elements from the target namespace are required to be qualified with the namespace prefix. The default is XmlSchemaForm::None.

◆ get_Elements()

SharedPtr< XmlSchemaObjectTable > System::Xml::Schema::XmlSchema::get_Elements ( )

Returns the post-schema-compilation value for all the elements in the schema.

Returns: An XmlSchemaObjectTable collection of all the elements in the schema.

◆ get_FinalDefault()

XmlSchemaDerivationMethod System::Xml::Schema::XmlSchema::get_FinalDefault ( )

Returns the finalDefault attribute which sets the default value of the final attribute on elements and complex types in the target namespace of the schema.

Returns: An XmlSchemaDerivationMethod value representing the different methods for preventing derivation. The default value is XmlSchemaDerivationMethod::None.

◆ get_Groups()

SharedPtr< XmlSchemaObjectTable > System::Xml::Schema::XmlSchema::get_Groups ( )

Returns the post-schema-compilation value of all the groups in the schema.

Returns: An XmlSchemaObjectTable collection of all the groups in the schema.

◆ get_Id()

String System::Xml::Schema::XmlSchema::get_Id ( )

Returns the string ID.

Returns: The ID of the string. The default value is String::Empty.

◆ get_Includes()

SharedPtr< XmlSchemaObjectCollection > System::Xml::Schema::XmlSchema::get_Includes ( )

Returns the collection of included and imported schemas.

Returns: An XmlSchemaObjectCollection of the included and imported schemas.

◆ get_IsCompiled()

bool System::Xml::Schema::XmlSchema::get_IsCompiled ( )

Indicates if the schema has been compiled.

Returns: true if schema has been compiled, otherwise, false. The default value is false.

◆ get_Items()

SharedPtr< XmlSchemaObjectCollection > System::Xml::Schema::XmlSchema::get_Items ( )

Returns the collection of schema elements in the schema and is used to add new element types at the schema element level.

Returns: An XmlSchemaObjectCollection of schema elements in the schema.

◆ get_Notations()

SharedPtr< XmlSchemaObjectTable > System::Xml::Schema::XmlSchema::get_Notations ( )

Returns the post-schema-compilation value for all notations in the schema.

Returns: An XmlSchemaObjectTable collection of all notations in the schema.

◆ get_SchemaTypes()

SharedPtr< XmlSchemaObjectTable > System::Xml::Schema::XmlSchema::get_SchemaTypes ( )

Returns the post-schema-compilation value of all schema types in the schema.

Returns: An XmlSchemaObjectCollection of all schema types in the schema.

◆ get_TargetNamespace()

String System::Xml::Schema::XmlSchema::get_TargetNamespace ( )

Returns the Uniform Resource Identifier (URI) of the schema target namespace.

Returns: The schema target namespace.

◆ get_UnhandledAttributes()

ArrayPtr< SharedPtr< XmlAttribute > > System::Xml::Schema::XmlSchema::get_UnhandledAttributes ( )

Returns the qualified attributes which do not belong to the schema target namespace.

Returns: An array of qualified XmlAttribute objects that do not belong to the schema target namespace.

◆ get_Version()

String System::Xml::Schema::XmlSchema::get_Version ( )

Returns the version of the schema.

Returns: The version of the schema. The default value is String::Empty.

◆ Read() [1/3]

static SharedPtr< XmlSchema > System::Xml::Schema::XmlSchema::Read	(	const SharedPtr< IO::Stream > &	stream,
		ValidationEventHandler	validationEventHandler
	)

static

Reads an XML Schema from the supplied stream.

Parameters

stream	The supplied data stream.
validationEventHandler	The validation event handler that receives information about XML Schema syntax errors.

Returns: The XmlSchema object representing the XML Schema.

Exceptions

XmlSchemaException An XmlSchemaException is raised if no ValidationEventHandler is specified.

◆ Read() [2/3]

static SharedPtr< XmlSchema > System::Xml::Schema::XmlSchema::Read	(	const SharedPtr< IO::TextReader > &	reader,
		ValidationEventHandler	validationEventHandler
	)

static

Reads an XML Schema from the supplied IO::TextReader.

Parameters

reader	The IO::TextReader containing the XML Schema to read.
validationEventHandler	The validation event handler that receives information about the XML Schema syntax errors.

Returns: The XmlSchema object representing the XML Schema.

Exceptions

XmlSchemaException An XmlSchemaException is raised if no ValidationEventHandler is specified.

◆ Read() [3/3]

static SharedPtr< XmlSchema > System::Xml::Schema::XmlSchema::Read	(	const SharedPtr< XmlReader > &	reader,
		ValidationEventHandler	validationEventHandler
	)

static

Reads an XML Schema from the supplied XmlReader.

Parameters

reader	The XmlReader containing the XML Schema to read.
validationEventHandler	The validation event handler that receives information about the XML Schema syntax errors.

Returns: The XmlSchema object representing the XML Schema.

Parameters

stream	The supplied data stream.
namespaceManager	The XmlNamespaceManager.

◆ Write() [3/6]

void System::Xml::Schema::XmlSchema::Write ( const SharedPtr< IO::TextWriter > & writer )

Writes the XML Schema to the supplied IO::TextWriter.

Parameters

writer The IO::TextWriter to write to.

◆ Write() [4/6]

void System::Xml::Schema::XmlSchema::Write	(	const SharedPtr< IO::TextWriter > &	writer,
		const SharedPtr< XmlNamespaceManager > &	namespaceManager
	)

Writes the XML Schema to the supplied TextWriter.

Parameters

writer	The IO::TextWriter to write to.
namespaceManager	The XmlNamespaceManager.

◆ Write() [5/6]

void System::Xml::Schema::XmlSchema::Write ( const SharedPtr< XmlWriter > & writer )

Writes the XML Schema to the supplied XmlWriter.

Parameters

writer The XmlWriter to write to.

Exceptions

ArgumentNullException The writer parameter is null.

◆ Write() [6/6]

void System::Xml::Schema::XmlSchema::Write	(	const SharedPtr< XmlWriter > &	writer,
		const SharedPtr< XmlNamespaceManager > &	namespaceManager
	)

Writes the XML Schema to the supplied XmlWriter.

Parameters

writer	The XmlWriter to write to.
namespaceManager	The XmlNamespaceManager.

Member Data Documentation

◆ InstanceNamespace

const String System::Xml::Schema::XmlSchema::InstanceNamespace

static

The XML schema instance namespace. This field is constant.

◆ Namespace

const String System::Xml::Schema::XmlSchema::Namespace

static

The XML schema namespace. This field is constant.

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ XmlSchema()

◆ ~XmlSchema()

Member Function Documentation

◆ Compile() [1/2]

◆ Compile() [2/2]

◆ get_AttributeFormDefault()

◆ get_AttributeGroups()

◆ get_Attributes()

◆ get_BlockDefault()

◆ get_ElementFormDefault()

◆ get_Elements()

◆ get_FinalDefault()

◆ get_Groups()

◆ get_Id()

◆ get_Includes()

◆ get_IsCompiled()

◆ get_Items()

◆ get_Notations()

◆ get_SchemaTypes()

◆ get_TargetNamespace()

◆ get_UnhandledAttributes()

◆ get_Version()

◆ Read() [1/3]

◆ Read() [2/3]

◆ Read() [3/3]

◆ set_AttributeFormDefault()

◆ set_BlockDefault()

◆ set_ElementFormDefault()

◆ set_FinalDefault()

◆ set_Id()

◆ set_TargetNamespace()

◆ set_UnhandledAttributes()

◆ set_Version()

◆ Write() [1/6]

◆ Write() [2/6]

◆ Write() [3/6]

◆ Write() [4/6]

◆ Write() [5/6]

◆ Write() [6/6]

Member Data Documentation

◆ InstanceNamespace

◆ Namespace