Type: System.Xml.Schema.XmlSchemaEnumerationFacet

System.Xml.Schema.XmlSchemaEnumerationFacet�Class

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

Summary: Class for defining enumeration facets. Represents the World Wide Web Consortium (W3C) enumeration facet.

C# Syntax:


        public class XmlSchemaEnumerationFacet : XmlSchemaFacet

Example

The following example shows the use of the XmlSchemaEnumerationFacet class.

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

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

        // <xs:simpleType name="SizeType">
        XmlSchemaSimpleType SizeType = new XmlSchemaSimpleType();
        SizeType.Name = "SizeType";

        // <xs:restriction base="xs:string">
        XmlSchemaSimpleTypeRestriction restriction = new XmlSchemaSimpleTypeRestriction();
        restriction.BaseTypeName = new XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema");

        // <xs:enumeration value="Small"/>
        XmlSchemaEnumerationFacet enumerationSmall = new XmlSchemaEnumerationFacet();
        enumerationSmall.Value = "Small";
        restriction.Facets.Add(enumerationSmall);

        // <xs:enumeration value="Medium"/>
        XmlSchemaEnumerationFacet enumerationMedium = new XmlSchemaEnumerationFacet();
        enumerationMedium.Value = "Medium";
        restriction.Facets.Add(enumerationMedium);

        // <xs:enumeration value="Large"/>
        XmlSchemaEnumerationFacet enumerationLarge = new XmlSchemaEnumerationFacet();
        enumerationLarge.Value = "Large";
        restriction.Facets.Add(enumerationLarge);

        SizeType.Content = restriction;

        schema.Items.Add(SizeType);

        // <xs:element name="Item">
        XmlSchemaElement elementItem = new XmlSchemaElement();
        elementItem.Name = "Item";
                
        // <xs:complexType>
        XmlSchemaComplexType complexType = new XmlSchemaComplexType();

        // <xs:attribute name="Size" type="SizeType"/>
        XmlSchemaAttribute attributeSize = new XmlSchemaAttribute();
        attributeSize.Name = "Size";
        attributeSize.SchemaTypeName = new XmlQualifiedName("SizeType", "");
        complexType.Attributes.Add(attributeSize);

        elementItem.SchemaType = complexType;
                
        schema.Items.Add(elementItem);

        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:simpleType name="SizeType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="Small" />
      <xs:enumeration value="Medium" />
      <xs:enumeration value="Large" />
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="Item">
    <xs:complexType>
      <xs:attribute name="Size" type="SizeType" />
    </xs:complexType>
  </xs:element>
</xs:schema>

See also:

System.Xml.Schema Namespace

System.Xml.Schema.XmlSchemaEnumerationFacet 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.
IsFixed (inherited from�System.Xml.Schema.XmlSchemaFacet)	Read-write See base class member description: System.Xml.Schema.XmlSchemaFacet.IsFixed Gets or sets information that indicates that this facet is fixed. This property is unused by XmlSchemaEnumerationFacet and XmlSchemaPatternFacet because these classes cannot be fixed.
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
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.
Value (inherited from�System.Xml.Schema.XmlSchemaFacet)	Read-write See base class member description: System.Xml.Schema.XmlSchemaFacet.Value Gets or sets the value attribute of the facet.

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.XmlSchemaFacet

System.Xml.Schema.XmlSchemaEnumerationFacet

System.Xml.Schema.XmlSchemaEnumerationFacet Member Details

ctor #1

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

C# Syntax:


            public XmlSchemaEnumerationFacet();

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

Inherited
See base class member description: System.Xml.Schema.XmlSchemaFacet.IsFixed

Summary: Gets or sets information that indicates that this facet is fixed.
This property is unused by XmlSchemaEnumerationFacet and XmlSchemaPatternFacet because these classes cannot be fixed.

C# Syntax:


            public virtual bool�IsFixed {get; set;}

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

Property: Value (read-write)

Inherited
See base class member description: System.Xml.Schema.XmlSchemaFacet.Value

Summary: Gets or sets the value attribute of the facet.

C# Syntax:


            public string�Value {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
);