XmlSchemaElement Class
TOC
Collapse the table of content
Expand the table of content

XmlSchemaElement Class

 

Represents the element element from XML Schema as specified by the World Wide Web Consortium (W3C). This class is the base class for all particle types and is used to describe an element in an XML document.

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

System.Object
  System.Xml.Schema.XmlSchemaObject
    System.Xml.Schema.XmlSchemaAnnotated
      System.Xml.Schema.XmlSchemaParticle
        System.Xml.Schema.XmlSchemaElement

public class XmlSchemaElement : XmlSchemaParticle

NameDescription
System_CAPS_pubmethodXmlSchemaElement()

Initializes a new instance of the XmlSchemaElement class.

NameDescription
System_CAPS_pubpropertyAnnotation

Gets or sets the annotation property.(Inherited from XmlSchemaAnnotated.)

System_CAPS_pubpropertyBlock

Gets or sets a Block derivation.

System_CAPS_pubpropertyBlockResolved

Gets the post-compilation value of the Block property.

System_CAPS_pubpropertyConstraints

Gets the collection of constraints on the element.

System_CAPS_pubpropertyDefaultValue

Gets or sets the default value of the element if its content is a simple type or content of the element is textOnly.

System_CAPS_pubpropertyElementSchemaType

Gets an XmlSchemaType object representing the type of the element based on the SchemaType or SchemaTypeName values of the element.

System_CAPS_pubpropertyElementType

Obsolete.Gets a common language runtime (CLR) object based on the XmlSchemaElement or XmlSchemaElement of the element, which holds the post-compilation value of the ElementType property.

System_CAPS_pubpropertyFinal

Gets or sets the Final property to indicate that no further derivations are allowed.

System_CAPS_pubpropertyFinalResolved

Gets the post-compilation value of the Final property.

System_CAPS_pubpropertyFixedValue

Gets or sets the fixed value.

System_CAPS_pubpropertyForm

Gets or sets the form for the element.

System_CAPS_pubpropertyId

Gets or sets the string id.(Inherited from XmlSchemaAnnotated.)

System_CAPS_pubpropertyIsAbstract

Gets or sets information to indicate if the element can be used in an instance document.

System_CAPS_pubpropertyIsNillable

Gets or sets information that indicates if xsi:nil can occur in the instance data. Indicates if an explicit nil value can be assigned to the element.

System_CAPS_pubpropertyLineNumber

Gets or sets the line number in the file to which the schema element refers.(Inherited from XmlSchemaObject.)

System_CAPS_pubpropertyLinePosition

Gets or sets the line position in the file to which the schema element refers.(Inherited from XmlSchemaObject.)

System_CAPS_pubpropertyMaxOccurs

Gets or sets the maximum number of times the particle can occur.(Inherited from XmlSchemaParticle.)

System_CAPS_pubpropertyMaxOccursString

Gets or sets the number as a string value. Maximum number of times the particle can occur.(Inherited from XmlSchemaParticle.)

System_CAPS_pubpropertyMinOccurs

Gets or sets the minimum number of times the particle can occur.(Inherited from XmlSchemaParticle.)

System_CAPS_pubpropertyMinOccursString

Gets or sets the number as a string value. The minimum number of times the particle can occur.(Inherited from XmlSchemaParticle.)

System_CAPS_pubpropertyName

Gets or sets the name of the element.

System_CAPS_pubpropertyNamespaces

Gets or sets the XmlSerializerNamespaces to use with this schema object.(Inherited from XmlSchemaObject.)

System_CAPS_pubpropertyParent

Gets or sets the parent of this XmlSchemaObject.(Inherited from XmlSchemaObject.)

System_CAPS_pubpropertyQualifiedName

Gets the actual qualified name for the given element.

System_CAPS_pubpropertyRefName

Gets or sets the reference name of an element declared in this schema (or another schema indicated by the specified namespace).

System_CAPS_pubpropertySchemaType

Gets or sets the type of the element. This can either be a complex type or a simple type.

System_CAPS_pubpropertySchemaTypeName

Gets or sets the name of a built-in data type defined in this schema or another schema indicated by the specified namespace.

System_CAPS_pubpropertySourceUri

Gets or sets the source location for the file that loaded the schema.(Inherited from XmlSchemaObject.)

System_CAPS_pubpropertySubstitutionGroup

Gets or sets the name of an element that is being substituted by this element.

System_CAPS_pubpropertyUnhandledAttributes

Gets or sets the qualified attributes that do not belong to the current schema's target namespace.(Inherited from XmlSchemaAnnotated.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_security Security Note
  • Do not use schemas from unknown or untrusted sources or locations. Doing so will compromise the security of your code.

  • XML schemas (including inline schemas) are inherently vulnerable to denial of service attacks; do not accept them in untrusted scenarios.

  • Schema validation error messages and exceptions may expose sensitive information about the content model or URI paths to the schema file. Be careful not to expose this information to untrusted callers.

The following example creates the element element.

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

class XMLSchemaExamples
{
    public static void Main()
    {

        XmlSchema schema = new XmlSchema();

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

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

        // <xs:element name="redDog" substitutionGroup="dog" />
        XmlSchemaElement elementRedDog = new XmlSchemaElement();
        schema.Items.Add(elementRedDog);
        elementRedDog.Name = "redDog";
        elementRedDog.SubstitutionGroup = new XmlQualifiedName("dog");


        // <xs:element name="brownDog" substitutionGroup ="dog" />
        XmlSchemaElement elementBrownDog = new XmlSchemaElement();
        schema.Items.Add(elementBrownDog);
        elementBrownDog.Name = "brownDog";
        elementBrownDog.SubstitutionGroup = new XmlQualifiedName("dog");


        // <xs:element name="pets">
        XmlSchemaElement elementPets = new XmlSchemaElement();
        schema.Items.Add(elementPets);
        elementPets.Name = "pets";

        // <xs:complexType>
        XmlSchemaComplexType complexType = new XmlSchemaComplexType();
        elementPets.SchemaType = complexType;

        // <xs:choice minOccurs="0" maxOccurs="unbounded">
        XmlSchemaChoice choice = new XmlSchemaChoice();
        complexType.Particle = choice;
        choice.MinOccurs = 0;
        choice.MaxOccursString = "unbounded";

        // <xs:element ref="cat"/>
        XmlSchemaElement catRef = new XmlSchemaElement();
        choice.Items.Add(catRef);
        catRef.RefName = new XmlQualifiedName("cat");

        // <xs:element ref="dog"/>
        XmlSchemaElement dogRef = new XmlSchemaElement();
        choice.Items.Add(dogRef);
        dogRef.RefName = new XmlQualifiedName("dog");

        XmlSchemaSet schemaSet = new XmlSchemaSet();
        schemaSet.ValidationEventHandler += new ValidationEventHandler(ValidationCallbackOne);
        schemaSet.Add(schema);
        schemaSet.Compile();

        XmlSchema compiledSchema = null;

        foreach (XmlSchema schema1 in schemaSet.Schemas())
        {
            compiledSchema = schema1;
        }

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

    public static void ValidationCallbackOne(object sender, ValidationEventArgs args)
    {
        Console.WriteLine(args.Message);
    }
}

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

<?xml version="1.0" encoding="IBM437"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
	<xs:element name="cat" type="xs:string"/>
	<xs:element name="dog" type="xs:string"/>
	<xs:element name="redDog" substitutionGroup="dog" />
	<xs:element name="brownDog" substitutionGroup ="dog" />

	<xs:element name="pets">
	  <xs:complexType>
	    <xs:choice minOccurs="0" maxOccurs="unbounded">
	      <xs:element ref="cat"/>
	      <xs:element ref="dog"/>
	    </xs:choice>
	  </xs:complexType>
	</xs:element>
</xs:schema>

.NET Framework
Available since 1.1

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

Return to top
Show:
© 2016 Microsoft