System::Xml::Schema::XmlSchema class

XmlSchema class

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.

class XmlSchema : public System::Xml::Schema::XmlSchemaObject

Methods

MethodDescription
Compile(ValidationEventHandler)Compiles the XML SchemaObject 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.
Compile(ValidationEventHandler, const SharedPtr<XmlResolver>&)Compiles the XML SchemaObject 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.
get_AttributeFormDefault()Returns the form for attributes declared in the target namespace of the schema.
get_AttributeGroups()Returns the post-schema-compilation value of all the global attribute groups in the schema.
get_Attributes()Returns the post-schema-compilation value for all the attributes in the schema.
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.
get_ElementFormDefault()Returns the form for elements declared in the target namespace of the schema.
get_Elements()Returns the post-schema-compilation value for all the elements in the schema.
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.
get_Groups()Returns the post-schema-compilation value of all the groups in the schema.
get_Id()Returns the string ID.
get_Includes()Returns the collection of included and imported schemas.
get_IsCompiled()Indicates if the schema has been compiled.
get_Items()Returns the collection of schema elements in the schema and is used to add new element types at the schema element level.
get_LineNumber()Returns the line number in the file to which the schema element refers.
get_LinePosition()Returns the line position in the file to which the schema element refers.
get_Namespaces()Returns the XmlSerializerNamespaces to use with this schema object.
get_Notations()Returns the post-schema-compilation value for all notations in the schema.
get_Parent()Returns the parent of this XmlSchemaObject.
get_SchemaTypes()Returns the post-schema-compilation value of all schema types in the schema.
get_SourceUri()Returns the source location for the file that loaded the schema.
get_TargetNamespace()Returns the Uniform Resource Identifier (URI) of the schema target namespace.
get_UnhandledAttributes()Returns the qualified attributes which do not belong to the schema target namespace.
get_Version()Returns the version of the schema.
static Read(const SharedPtr<IO::TextReader>&, ValidationEventHandler)Reads an XML Schema from the supplied IO::TextReader.
static Read(const SharedPtr<IO::Stream>&, ValidationEventHandler)Reads an XML Schema from the supplied stream.
static Read(const SharedPtr<XmlReader>&, ValidationEventHandler)Reads an XML Schema from the supplied XmlReader.
set_AttributeFormDefault(XmlSchemaForm)Sets the form for attributes declared in the target namespace of the schema.
set_BlockDefault(XmlSchemaDerivationMethod)Sets the blockDefault attribute which sets the default value of the block attribute on element and complex types in the targetNamespace of the schema.
set_ElementFormDefault(XmlSchemaForm)Sets the form for elements declared in the target namespace of the schema.
set_FinalDefault(XmlSchemaDerivationMethod)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.
set_Id(const String&)Sets the string ID.
set_LineNumber(int32_t)Sets the line number in the file to which the schema element refers.
set_LinePosition(int32_t)Sets the line position in the file to which the schema element refers.
set_Namespaces(const SharedPtr<System::Xml::Serialization::XmlSerializerNamespaces>&)Sets the XmlSerializerNamespaces to use with this schema object.
set_Parent(const SharedPtr<XmlSchemaObject>&)Sets the parent of this XmlSchemaObject.
set_SourceUri(const String&)Sets the source location for the file that loaded the schema.
set_TargetNamespace(const String&)Sets the Uniform Resource Identifier (URI) of the schema target namespace.
set_UnhandledAttributes(const ArrayPtr<SharedPtr<XmlAttribute>>&)Sets the qualified attributes which do not belong to the schema target namespace.
set_Version(const String&)Sets the version of the schema.
Write(const SharedPtr<IO::Stream>&)Writes the XML Schema to the supplied data stream.
Write(const SharedPtr<IO::Stream>&, const SharedPtr<XmlNamespaceManager>&)Writes the XML Schema to the supplied Stream using the XmlNamespaceManager specified.
Write(const SharedPtr<IO::TextWriter>&)Writes the XML Schema to the supplied IO::TextWriter.
Write(const SharedPtr<IO::TextWriter>&, const SharedPtr<XmlNamespaceManager>&)Writes the XML Schema to the supplied TextWriter.
Write(const SharedPtr<XmlWriter>&)Writes the XML Schema to the supplied XmlWriter.
Write(const SharedPtr<XmlWriter>&, const SharedPtr<XmlNamespaceManager>&)Writes the XML Schema to the supplied XmlWriter.
XmlSchema()Initializes a new instance of the XmlSchema class.
XmlSchemaObject()Initializes a new instance of the XmlSchemaObject class.

Fields

FieldDescription
static InstanceNamespaceThe XML schema instance namespace. This field is constant.
static NamespaceThe XML schema namespace. This field is constant.

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