This documentation is archived and is not being maintained.

XmlSchemaAnnotation Class

Represents the World Wide Web Consortium (W3C) annotation element.

System::Object
  System.Xml.Schema::XmlSchemaObject
    System.Xml.Schema::XmlSchemaAnnotation

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

public ref class XmlSchemaAnnotation : public XmlSchemaObject

The XmlSchemaAnnotation type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkXmlSchemaAnnotationInitializes a new instance of the XmlSchemaAnnotation class.
Top

  NameDescription
Public propertySupported by the XNA FrameworkIdGets or sets the string id.
Public propertySupported by the XNA FrameworkItemsGets the Items collection that is used to store the appinfo and documentation child elements.
Public propertySupported by the XNA FrameworkLineNumberGets or sets the line number in the file to which the schema element refers. (Inherited from XmlSchemaObject.)
Public propertySupported by the XNA FrameworkLinePositionGets or sets the line position in the file to which the schema element refers. (Inherited from XmlSchemaObject.)
Public propertySupported by the XNA FrameworkNamespacesGets or sets the XmlSerializerNamespaces to use with this schema object. (Inherited from XmlSchemaObject.)
Public propertySupported by the XNA FrameworkParentGets or sets the parent of this XmlSchemaObject. (Inherited from XmlSchemaObject.)
Public propertySupported by the XNA FrameworkSourceUriGets or sets the source location for the file that loaded the schema. (Inherited from XmlSchemaObject.)
Public propertySupported by the XNA FrameworkUnhandledAttributesGets or sets the qualified attributes that do not belong to the schema's target namespace.
Top

  NameDescription
Public methodSupported by the XNA FrameworkEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by the XNA FrameworkGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkToStringReturns a string that represents the current object. (Inherited from Object.)
Top

An annotation element can contain one or more XmlSchemaAppInfo instances (information for applications) and XmlSchemaDocumentation instances (comments or text for humans).

An annotation is used to store extra information about the schema or its elements. These notes are specified for human consumption, xs:documentation, or by software, xs:appinfo. Annotation can be the first element of most schema elements or anywhere under the schema element.

The following example creates the annotation element.


#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:simpleType name="northwestStates">
        XmlSchemaSimpleType^ simpleType = gcnew XmlSchemaSimpleType();
        simpleType->Name = "northwestStates";
        schema->Items->Add(simpleType);

        // <xs:annotation>
        XmlSchemaAnnotation^ annNorthwestStates = gcnew XmlSchemaAnnotation();
        simpleType->Annotation = annNorthwestStates;

        // <xs:documentation>States in the Pacific Northwest of US</xs:documentation>
        XmlSchemaDocumentation^ docNorthwestStates = gcnew XmlSchemaDocumentation();
        annNorthwestStates->Items->Add(docNorthwestStates);
        docNorthwestStates->Markup = TextToNodeArray("States in the Pacific Northwest of US");

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

        // <xs:enumeration value='WA'>
        XmlSchemaEnumerationFacet^ enumerationWA = gcnew XmlSchemaEnumerationFacet();
        restriction->Facets->Add(enumerationWA);
        enumerationWA->Value = "WA";

        // <xs:annotation>
        XmlSchemaAnnotation^ annWA = gcnew XmlSchemaAnnotation();
        enumerationWA->Annotation = annWA;

        // <xs:documentation>Washington</documentation>
        XmlSchemaDocumentation^ docWA = gcnew XmlSchemaDocumentation();
        annWA->Items->Add(docWA);
        docWA->Markup = TextToNodeArray("Washington");

        // <xs:enumeration value='OR'>
        XmlSchemaEnumerationFacet^ enumerationOR = gcnew XmlSchemaEnumerationFacet();
        restriction->Facets->Add(enumerationOR);
        enumerationOR->Value = "OR";

        // <xs:annotation>
        XmlSchemaAnnotation^ annOR = gcnew XmlSchemaAnnotation();
        enumerationOR->Annotation = annOR;

        // <xs:documentation>Oregon</xs:documentation>
        XmlSchemaDocumentation^ docOR = gcnew XmlSchemaDocumentation();
        annOR->Items->Add(docOR);
        docOR->Markup = TextToNodeArray("Oregon");

        // <xs:enumeration value='ID'>
        XmlSchemaEnumerationFacet^ enumerationID = gcnew XmlSchemaEnumerationFacet();

        restriction->Facets->Add(enumerationID);
        enumerationID->Value = "ID";

        // <xs:annotation>
        XmlSchemaAnnotation^ annID = gcnew XmlSchemaAnnotation();
        enumerationID->Annotation = annID;

        // <xs:documentation>Idaho</xs:documentation>
        XmlSchemaDocumentation^ docID = gcnew XmlSchemaDocumentation();
        annID->Items->Add(docID);
        docID->Markup = TextToNodeArray("Idaho");

        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);
    }

	static array<XmlNode^>^ TextToNodeArray(String^ text)
    {
        XmlDocument^ doc = gcnew XmlDocument();
		array<XmlNode^>^ temp = {doc->CreateTextNode(text)};
        return temp;
    }

};

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


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="northwestStates">
    <xs:annotation>
        <xs:documentation>States in the Pacific Northwest of US</xs:documentation>
    </xs:annotation>
        <xs:restriction base="xs:string">
          <xs:enumeration value='WA'>
            <xs:annotation>
              <xs:documentation>Washington</xs:documentation>
            </xs:annotation>
          </xs:enumeration>
          <xs:enumeration value='OR'>
            <xs:annotation>
              <xs:documentation>Oregon</xs:documentation>
            </xs:annotation>
          </xs:enumeration>
          <xs:enumeration value='ID'>
            <xs:annotation>
              <xs:documentation>Idaho</xs:documentation>
            </xs:annotation>
          </xs:enumeration>
        </xs:restriction>
    </xs:simpleType>
</xs:schema>


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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