XmlSchemaGroup Class

.NET Framework (current version)

Represents the group element from XML Schema as specified by the World Wide Web Consortium (W3C). This class defines groups at the schema level that are referenced from the complex types. It groups a set of element declarations so that they can be incorporated as a group into complex type definitions.

Namespace: System.Xml.Schema
Assembly: System.Xml (in System.Xml.dll)

Inheritance Hierarchy

System::Object
System.Xml.Schema::XmlSchemaObject
System.Xml.Schema::XmlSchemaAnnotated
System.Xml.Schema::XmlSchemaGroup

Syntax

C++

public ref class XmlSchemaGroup : XmlSchemaAnnotated

Constructors

	Name	Description
	XmlSchemaGroup()	Initializes a new instance of the XmlSchemaGroup class.

Properties

	Name	Description
	Annotation	Gets or sets the annotation property.(Inherited from XmlSchemaAnnotated.)
	Id	Gets or sets the string id.(Inherited from XmlSchemaAnnotated.)
	LineNumber	Gets or sets the line number in the file to which the schema element refers.(Inherited from XmlSchemaObject.)
	LinePosition	Gets or sets the line position in the file to which the schema element refers.(Inherited from XmlSchemaObject.)
	Name	Gets or sets the name of the schema group.
	Namespaces	Gets or sets the XmlSerializerNamespaces to use with this schema object.(Inherited from XmlSchemaObject.)
	Parent	Gets or sets the parent of this XmlSchemaObject.(Inherited from XmlSchemaObject.)
	Particle	Gets or sets one of the XmlSchemaChoice, XmlSchemaAll, or XmlSchemaSequence classes.
	QualifiedName	Gets the qualified name of the schema group.
	SourceUri	Gets or sets the source location for the file that loaded the schema.(Inherited from XmlSchemaObject.)
	UnhandledAttributes	Gets or sets the qualified attributes that do not belong to the current schema's target namespace.(Inherited from XmlSchemaAnnotated.)

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Examples

The following example shows the use of the XmlSchemaGroup class.

C++

#using <mscorlib.dll>
#using <System.Xml.dll>

using namespace System;
using namespace System::Xml;
using namespace System::Xml::Schema;

class XmlSchemaExamples
{
public:

    static void Main()
    {
        XmlSchema^ schema = gcnew XmlSchema();

        // <xs:element name="thing1" type="xs:string"/>
        XmlSchemaElement^ elementThing1 = gcnew XmlSchemaElement();
        schema->Items->Add(elementThing1);
        elementThing1->Name = "thing1";
        elementThing1->SchemaTypeName = gcnew XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema");

        // <xs:element name="thing2" type="xs:string"/>
        XmlSchemaElement^ elementThing2 = gcnew XmlSchemaElement();
        schema->Items->Add(elementThing2);
        elementThing2->Name = "thing2";
        elementThing2->SchemaTypeName = gcnew XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema");

        // <xs:element name="thing3" type="xs:string"/>
        XmlSchemaElement^ elementThing3 = gcnew XmlSchemaElement();
        schema->Items->Add(elementThing3);
        elementThing3->Name = "thing3";
        elementThing3->SchemaTypeName = gcnew XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema");

        // <xs:attribute name="myAttribute" type="xs:decimal"/>
        XmlSchemaAttribute^ myAttribute = gcnew XmlSchemaAttribute();
        schema->Items->Add(myAttribute);
        myAttribute->Name = "myAttribute";
        myAttribute->SchemaTypeName = gcnew XmlQualifiedName("decimal", "http://www.w3.org/2001/XMLSchema");

        // <xs:group name="myGroupOfThings">
        XmlSchemaGroup^ myGroupOfThings = gcnew XmlSchemaGroup();
        schema->Items->Add(myGroupOfThings);
        myGroupOfThings->Name = "myGroupOfThings";

        // <xs:sequence>
        XmlSchemaSequence^ sequence = gcnew XmlSchemaSequence();
        myGroupOfThings->Particle = sequence;

        // <xs:element ref="thing1"/>
        XmlSchemaElement^ elementThing1Ref = gcnew XmlSchemaElement();
        sequence->Items->Add(elementThing1Ref);
        elementThing1Ref->RefName = gcnew XmlQualifiedName("thing1");

        // <xs:element ref="thing2"/>
        XmlSchemaElement^ elementThing2Ref = gcnew XmlSchemaElement();
        sequence->Items->Add(elementThing2Ref);
        elementThing2Ref->RefName = gcnew XmlQualifiedName("thing2");

        // <xs:element ref="thing3"/>
        XmlSchemaElement^ elementThing3Ref = gcnew XmlSchemaElement();
        sequence->Items->Add(elementThing3Ref);
        elementThing3Ref->RefName = gcnew XmlQualifiedName("thing3");

        // <xs:complexType name="myComplexType">
        XmlSchemaComplexType^ myComplexType = gcnew XmlSchemaComplexType();
        schema->Items->Add(myComplexType);
        myComplexType->Name = "myComplexType";

        // <xs:group ref="myGroupOfThings"/>
        XmlSchemaGroupRef^ myGroupOfThingsRef = gcnew XmlSchemaGroupRef();
        myComplexType->Particle = myGroupOfThingsRef;
        myGroupOfThingsRef->RefName = gcnew XmlQualifiedName("myGroupOfThings");

        // <xs:attribute ref="myAttribute"/>
        XmlSchemaAttribute^ myAttributeRef = gcnew XmlSchemaAttribute();
        myComplexType->Attributes->Add(myAttributeRef);
        myAttributeRef->RefName = gcnew XmlQualifiedName("myAttribute");

        XmlSchemaSet^ schemaSet = gcnew XmlSchemaSet();
        schemaSet->ValidationEventHandler += gcnew ValidationEventHandler(ValidationCallbackOne);
        schemaSet->Add(schema);
        schemaSet->Compile();

        XmlSchema^ compiledSchema;

        for each (XmlSchema^ schema1 in schemaSet->Schemas())
        {
            compiledSchema = schema1;
        }

        XmlNamespaceManager^ nsmgr = gcnew XmlNamespaceManager(gcnew NameTable());
        nsmgr->AddNamespace("xs", "http://www.w3.org/2001/XMLSchema");
		compiledSchema->Write(Console::Out, nsmgr);
    }

    static void ValidationCallbackOne(Object^ sender, ValidationEventArgs^ args)
    {
		Console::WriteLine(args->Message);
    }
};

int main()
{
	XmlSchemaExamples::Main();
    return 0;
};

The following XML file is generated for the preceding code example.

XML


<?xml version="1.0" encoding="IBM437"?>
<xs:schema  xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="thing1" type="xs:string"/>
    <xs:element name="thing2" type="xs:string"/>
    <xs:element name="thing3" type="xs:string"/>

    <xs:attribute name="myAttribute" type="xs:decimal"/>

    <xs:group name="myGroupOfThings">
     <xs:sequence>
      <xs:element ref="thing1"/>
      <xs:element ref="thing2"/>
      <xs:element ref="thing3"/>
     </xs:sequence>
    </xs:group>

    <xs:complexType name="myComplexType">
        <xs:group ref="myGroupOfThings"/>
        <xs:attribute ref="myAttribute"/>
    </xs:complexType>
</xs:schema>

Version Information

.NET Framework
Available since 1.1

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.