Type: System.Xml.Schema.XmlSchemaGroup

System.Xml.Schema.XmlSchemaGroup Class

Assembly: System.Xml.dll
Namespace: System.Xml.Schema

Summary: Class that defines groups at the schema level that are referenced from the complex types. Groups a set of element declarations so that they can be incorporated as a group into complex type definitions. Represents the World Wide Web Consortium (W3C) group element.

C# Syntax:


        public class XmlSchemaGroup : XmlSchemaAnnotated

Example

The following example shows the use of the XmlSchemaGroup class.

using System;
using System.Xml;  
using System.Xml.Schema;

class XMLSchemaExamples {
    public static void Main() {
 
        XmlSchema schema = new XmlSchema();

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

        // <xs:element name="thing3" type="xs:string"/>
        XmlSchemaElement elementThing3 = new XmlSchemaElement();
        schema.Items.Add(elementThing3);
        elementThing3.Name = "thing3";
        elementThing3.SchemaTypeName = new XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema");
        
        // <xs:attribute name="myAttribute" type="xs:decimal"/>
        XmlSchemaAttribute myAttribute = new XmlSchemaAttribute();
        schema.Items.Add(myAttribute);
        myAttribute.Name = "myAttribute";
        myAttribute.SchemaTypeName = new XmlQualifiedName("decimal", "http://www.w3.org/2001/XMLSchema");
        
        // <xs:group name="myGroupOfThings">
        XmlSchemaGroup myGroupOfThings = new XmlSchemaGroup();
        schema.Items.Add(myGroupOfThings);
        myGroupOfThings.Name = "myGroupOfThings";
        
        // <xs:sequence>
        XmlSchemaSequence sequence = new XmlSchemaSequence();
        myGroupOfThings.Particle = sequence;

        // <xs:element ref="thing1"/>
        XmlSchemaElement elementThing1Ref = new XmlSchemaElement();
        sequence.Items.Add(elementThing1Ref);
        elementThing1Ref.RefName = new XmlQualifiedName("thing1");
        
        // <xs:element ref="thing2"/>
        XmlSchemaElement elementThing2Ref = new XmlSchemaElement();
        sequence.Items.Add(elementThing2Ref);
        elementThing2Ref.RefName = new XmlQualifiedName("thing2");

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

        // <xs:complexType name="myComplexType">
        XmlSchemaComplexType myComplexType = new XmlSchemaComplexType();
        schema.Items.Add(myComplexType);
        myComplexType.Name = "myComplexType";
        
        // <xs:group ref="myGroupOfThings"/>
        XmlSchemaGroupRef myGroupOfThingsRef = new XmlSchemaGroupRef();
        myComplexType.Particle = myGroupOfThingsRef;
        myGroupOfThingsRef.RefName = new XmlQualifiedName("myGroupOfThings");

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

        schema.Compile(new ValidationEventHandler(ValidationCallbackOne));
 	XmlNamespaceManager nsmgr = new XmlNamespaceManager(new NameTable());
        nsmgr.AddNamespace("xs", "http://www.w3.org/2001/XMLSchema");
        schema.Write(Console.Out, nsmgr);
    }

    public static void ValidationCallbackOne(object sender, ValidationEventArgs args) {

        Console.WriteLine(args.Message);
    }
}

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


<?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>

See also:

System.Xml.Schema Namespace

System.Xml.Schema.XmlSchemaGroup Member List:

Public Constructors

ctor #1

Default constructor. This constructor is called by derived class constructors to initialize state in this type.

Public Properties

Annotation (inherited from System.Xml.Schema.XmlSchemaAnnotated)	Read-write See base class member description: System.Xml.Schema.XmlSchemaAnnotated.Annotation Gets or sets the annotation property.
Id (inherited from System.Xml.Schema.XmlSchemaAnnotated)	Read-write See base class member description: System.Xml.Schema.XmlSchemaAnnotated.Id Gets or sets the string id.
LineNumber (inherited from System.Xml.Schema.XmlSchemaObject)	Read-write See base class member description: System.Xml.Schema.XmlSchemaObject.LineNumber Gets or sets the line number in the file to which the schema element refers.
LinePosition (inherited from System.Xml.Schema.XmlSchemaObject)	Read-write See base class member description: System.Xml.Schema.XmlSchemaObject.LinePosition Gets or sets the line position in the file to which the schema element refers.
Name	Read-write Gets or sets the name of the schema group.
Namespaces (inherited from System.Xml.Schema.XmlSchemaObject)	Read-write See base class member description: System.Xml.Schema.XmlSchemaObject.Namespaces
Particle	Read-write Gets or sets one of the XmlSchemaChoice, XmlSchemaAll, or XmlSchemaSequence classes.
SourceUri (inherited from System.Xml.Schema.XmlSchemaObject)	Read-write See base class member description: System.Xml.Schema.XmlSchemaObject.SourceUri Gets or sets the source location for the file that loaded the schema.
UnhandledAttributes (inherited from System.Xml.Schema.XmlSchemaAnnotated)	Read-write See base class member description: System.Xml.Schema.XmlSchemaAnnotated.UnhandledAttributes Gets or sets the qualified attributes that do not belong to the schema target namespace.

Public Methods

Equals (inherited from System.Object)	See base class member description: System.Object.Equals Derived from System.Object, the primary base class for all objects.
GetHashCode (inherited from System.Object)	See base class member description: System.Object.GetHashCode Derived from System.Object, the primary base class for all objects.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
ToString (inherited from System.Object)	See base class member description: System.Object.ToString Derived from System.Object, the primary base class for all objects.

Protected Methods

Finalize (inherited from System.Object)	See base class member description: System.Object.Finalize Derived from System.Object, the primary base class for all objects.
MemberwiseClone (inherited from System.Object)	See base class member description: System.Object.MemberwiseClone Derived from System.Object, the primary base class for all objects.

Hierarchy:

System.Object

System.Xml.Schema.XmlSchemaObject

System.Xml.Schema.XmlSchemaAnnotated

System.Xml.Schema.XmlSchemaGroup

System.Xml.Schema.XmlSchemaGroup Member Details

ctor #1

Summary:: Default constructor. This constructor is called by derived class constructors to initialize state in this type.

C# Syntax:


            public XmlSchemaGroup();

Return to top

Property: Annotation (read-write)

Inherited
See base class member description: System.Xml.Schema.XmlSchemaAnnotated.Annotation

Summary: Gets or sets the annotation property.

C# Syntax:


            public XmlSchemaAnnotation Annotation {get; set;}

Return to top

Property: Id (read-write)

Inherited
See base class member description: System.Xml.Schema.XmlSchemaAnnotated.Id

Summary: Gets or sets the string id.

C# Syntax:


            public string Id {get; set;}

Remarks

The id value must be of type ID and be unique within the document containing this element.

Optional.

Return to top

Property: LineNumber (read-write)

Inherited
See base class member description: System.Xml.Schema.XmlSchemaObject.LineNumber

Summary: Gets or sets the line number in the file to which the schema element refers.

C# Syntax:


            public int LineNumber {get; set;}

Remarks

LineNumber is used to store the line number when a schema is read from a file. This is reported through XmlSchemaException for error handling.

Return to top

Property: LinePosition (read-write)

Inherited
See base class member description: System.Xml.Schema.XmlSchemaObject.LinePosition

Summary: Gets or sets the line position in the file to which the schema element refers.

C# Syntax:


            public int LinePosition {get; set;}

Remarks

This is used to store the line position when a schema is read from a file. This is reported through XmlSchemaException for error handling.

Return to top

Property: Name (read-write)

Summary: Gets or sets the name of the schema group.

C# Syntax:


            public string Name {get; set;}

Remarks

The name must be an NCName (no-colon name) as defined in the World Wide Web Consortium (W3C) XML Namespaces specification.

Return to top

Property: Namespaces (read-write)

Inherited
See base class member description: System.Xml.Schema.XmlSchemaObject.Namespaces

C# Syntax:


            public XmlSerializerNamespaces Namespaces {get; set;}

Return to top

Property: Particle (read-write)

Summary: Gets or sets one of the XmlSchemaChoice, XmlSchemaAll, or XmlSchemaSequence classes.

C# Syntax:


            public XmlSchemaGroupBase Particle {get; set;}

Return to top

Property: SourceUri (read-write)

Inherited
See base class member description: System.Xml.Schema.XmlSchemaObject.SourceUri

Summary: Gets or sets the source location for the file that loaded the schema.

C# Syntax:


            public string SourceUri {get; set;}

Remarks

Provides information for exception handling.

Return to top

Property: UnhandledAttributes (read-write)

Inherited
See base class member description: System.Xml.Schema.XmlSchemaAnnotated.UnhandledAttributes

Summary: Gets or sets the qualified attributes that do not belong to the schema target namespace.

C# Syntax:


            public XmlAttribute[] UnhandledAttributes {get; set;}

Return to top

Method: Equals(
object obj
)

Inherited
See base class member description: System.Object.Equals

C# Syntax:


            public virtual bool Equals(
   object obj
);