Type: System.Xml.Schema.XmlSchemaComplexContentRestriction

System.Xml.Schema.XmlSchemaComplexContentRestriction Class

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

Summary: Class for complex types with a complex content model that are derived by restriction. Restricts the contents of the complex type to a subset of the inherited complex type. Represents the World Wide Web Consortium (W3C) restriction element for complex content.

C# Syntax:


        public class XmlSchemaComplexContentRestriction : XmlSchemaContent

Example

The following example creates a complexContent element extended by restriction.

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

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

        // <xs:complexType name="phoneNumber">
        XmlSchemaComplexType phoneNumber = new XmlSchemaComplexType();
        phoneNumber.Name = "phoneNumber";
                
        // <xs:sequence>
        XmlSchemaSequence phoneNumberSequence = new XmlSchemaSequence();

        // <xs:element name="areaCode"/>
        XmlSchemaElement areaCode1 = new XmlSchemaElement();
        areaCode1.MinOccurs = 0;
        areaCode1.MaxOccursString = "1";
        areaCode1.Name = "areaCode";
        phoneNumberSequence.Items.Add(areaCode1);

        // <xs:element name="prefix"/>
        XmlSchemaElement prefix1 = new XmlSchemaElement();
        prefix1.MinOccurs = 1;
        prefix1.MaxOccursString = "1";
        prefix1.Name = "prefix";
        phoneNumberSequence.Items.Add(prefix1);

        // <xs:element name="number"/>
        XmlSchemaElement number1 = new XmlSchemaElement();
        number1.MinOccurs = 1;
        number1.MaxOccursString = "1";
        number1.Name = "number";
        phoneNumberSequence.Items.Add(number1);

        phoneNumber.Particle = phoneNumberSequence;
                
        schema.Items.Add(phoneNumber);

        // <xs:complexType name="localPhoneNumber">
        XmlSchemaComplexType localPhoneNumber = new XmlSchemaComplexType();
        localPhoneNumber.Name = "localPhoneNumber";

        // <xs:complexContent>
        XmlSchemaComplexContent complexContent = new XmlSchemaComplexContent();
                
        // <xs:restriction base="phoneNumber">
        XmlSchemaComplexContentRestriction restriction = new XmlSchemaComplexContentRestriction();
        restriction.BaseTypeName = new XmlQualifiedName("phoneNumber", "");
                        
        // <xs:sequence>
        XmlSchemaSequence sequence2 = new XmlSchemaSequence();

        // <xs:element name="areaCode" minOccurs="0"/>
        XmlSchemaElement areaCode2 = new XmlSchemaElement();
        areaCode2.MinOccurs = 0;
        areaCode2.MaxOccursString = "1";
        areaCode2.Name = "areaCode";
        sequence2.Items.Add(areaCode2);

        // <xs:element name="prefix"/>
        XmlSchemaElement prefix2 = new XmlSchemaElement();
        prefix2.MinOccurs = 1;
        prefix2.MaxOccursString = "1";
        prefix2.Name = "prefix";
        sequence2.Items.Add(prefix2);

        // <xs:element name="number"/>
        XmlSchemaElement number2 = new XmlSchemaElement();
        number2.MinOccurs = 1;
        number2.MaxOccursString = "1";
        number2.Name = "number";
        sequence2.Items.Add(number2);

        restriction.Particle = sequence2;
        complexContent.Content = restriction;
        localPhoneNumber.ContentModel = complexContent;
                
        schema.Items.Add(localPhoneNumber);


        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:complexType name="phoneNumber">
        <xs:sequence>
            <xs:element name="areaCode" minOccurs="0" maxOccurs="1"/>
            <xs:element name="prefix" minOccurs="1" maxOccurs="1"/>
            <xs:element name="number" minOccurs="1" maxOccurs="1"/>
        </xs:sequence>
    </xs:complexType>

    <xs:complexType name="localPhoneNumber">
        <xs:complexContent mixed="false">
            <xs:restriction base="phoneNumber">
                <xs:sequence>
                    <xs:element name="areaCode" minOccurs="0" maxOccurs="1"/>
                    <xs:element name="prefix" minOccurs="1" maxOccurs="1"/>
                    <xs:element name="number" minOccurs="1" maxOccurs="1"/>
                </xs:sequence>
            </xs:restriction>
        </xs:complexContent>
    </xs:complexType>
    
</xs:schema>

See also:

System.Xml.Schema Namespace

System.Xml.Schema.XmlSchemaComplexContentRestriction 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.
AnyAttribute	Read-write Gets or sets the XmlSchemaAnyAttribute component of the complex content model.
Attributes	Read-only Gets the collection of attributes for the complex type. Contains the XmlSchemaAttribute and XmlSchemaAttributeGroupRef elements.
BaseTypeName	Read-write Gets or sets the name of a complex type from which this type is derived by restriction.
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.
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 XmlSchemaGroupRef, 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.XmlSchemaContent

System.Xml.Schema.XmlSchemaComplexContentRestriction

System.Xml.Schema.XmlSchemaComplexContentRestriction Member Details

ctor #1

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

C# Syntax:


            public XmlSchemaComplexContentRestriction();

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: AnyAttribute (read-write)

Summary: Gets or sets the XmlSchemaAnyAttribute component of the complex content model.

C# Syntax:


            public XmlSchemaAnyAttribute AnyAttribute {get; set;}

Return to top

Property: Attributes (read-only)

Summary: Gets the collection of attributes for the complex type. Contains the XmlSchemaAttribute and XmlSchemaAttributeGroupRef elements.

C# Syntax:


            public XmlSchemaObjectCollection Attributes {get;}

Return to top

Property: BaseTypeName (read-write)

Summary: Gets or sets the name of a complex type from which this type is derived by restriction.

C# Syntax:


            public XmlQualifiedName BaseTypeName {get; set;}

Remarks

The value must be a QName. It is the name of the complex type specified by the base attribute of the restriction element.

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: 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 XmlSchemaGroupRef, XmlSchemaChoice, XmlSchemaAll, or XmlSchemaSequence classes.

C# Syntax:


            public XmlSchemaParticle 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
);