XmlSchemaAnnotation クラス

[アーティクル]
03/28/2008

注釈は、スキーマまたはその要素に関する追加情報を格納するために使用します。この情報は、ユーザーによる利用のために指定するか (xs:documentation)、またはソフトウェアのために指定します (xs:appinfo)。注釈は、ほとんどのスキーマ要素の最初の要素とすることができますが、schema 要素の下であればどこに配置してもかまいません。W3C (World Wide Web Consortium) annotation 要素を表します。

この型のすべてのメンバの一覧については、XmlSchemaAnnotation メンバを参照してください。

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

Public Class XmlSchemaAnnotation
   Inherits XmlSchemaObject
[C#]
public class XmlSchemaAnnotation : XmlSchemaObject
[C++]
public __gc class XmlSchemaAnnotation : public XmlSchemaObject
[JScript]
public class XmlSchemaAnnotation extends XmlSchemaObject

スレッドセーフ

この型の public static (Visual Basicでは Shared) のすべてのメンバは、マルチスレッド操作で安全に使用できます。インスタンスのメンバの場合は、スレッドセーフであるとは限りません。

解説

annotation 要素には、1 つ以上の XmlSchemaAppInfo インスタンス (アプリケーションに対する情報) および XmlSchemaDocumentation インスタンス (ユーザーに対するコメントまたはテキスト) を含めることができます。

使用例

[Visual Basic, C#, C++] annotation 要素を作成する例を次に示します。

 
Option Explicit
Option Strict

Imports System
Imports System.Xml
Imports System.Xml.Schema

Class XMLSchemaExamples
    Public Shared Sub Main()
        Dim schema As New XmlSchema()
        
        ' <xs:simpleType name="northwestStates">
        Dim simpleType As New XmlSchemaSimpleType()
        simpleType.Name = "northwestStates"
        schema.Items.Add(simpleType)
        
        ' <xs:annotation>
        Dim annNorthwestStates As New XmlSchemaAnnotation()
        simpleType.Annotation = annNorthwestStates
        
        ' <xs:documentation>States in the Pacific Northwest of US</xs:documentation>
        Dim docNorthwestStates As New XmlSchemaDocumentation()
        annNorthwestStates.Items.Add(docNorthwestStates)
        docNorthwestStates.Markup = TextToNodeArray("States in the Pacific Northwest of US")
        
        ' <xs:restriction base="xs:string">
        Dim restriction As New XmlSchemaSimpleTypeRestriction()
        simpleType.Content = restriction
        restriction.BaseTypeName = New XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema")
        
        ' <xs:enumeration value='WA'>
        Dim enumerationWA As New XmlSchemaEnumerationFacet()
        restriction.Facets.Add(enumerationWA)
        enumerationWA.Value = "WA"
        
        ' <xs:annotation>
        Dim annWA As New XmlSchemaAnnotation()
        enumerationWA.Annotation = annWA
        
        ' <xs:documentation>Washington</documentation>
        Dim docWA As New XmlSchemaDocumentation()
        annWA.Items.Add(docWA)
        docWA.Markup = TextToNodeArray("Washington")
        
        ' <xs:enumeration value='OR'>
        Dim enumerationOR As New XmlSchemaEnumerationFacet()
        restriction.Facets.Add(enumerationOR)
        enumerationOR.Value = "OR"
        
        ' <xs:annotation>
        Dim annOR As New XmlSchemaAnnotation()
        enumerationOR.Annotation = annOR
        
        ' <xs:documentation>Oregon</xs:documentation>
        Dim docOR As New XmlSchemaDocumentation()
        annOR.Items.Add(docOR)
        docOR.Markup = TextToNodeArray("Oregon")
        
        ' <xs:enumeration value='ID'>
        Dim enumerationID As New XmlSchemaEnumerationFacet()
        restriction.Facets.Add(enumerationID)
        enumerationID.Value = "ID"
        
        ' <xs:annotation>
        Dim annID As New XmlSchemaAnnotation()
        enumerationID.Annotation = annID
        
        ' <xs:documentation>Idaho</xs:documentation>
        Dim docID As New XmlSchemaDocumentation()
        annID.Items.Add(docID)
        docID.Markup = TextToNodeArray("Idaho")
        
        schema.Compile(AddressOf ValidationCallbackOne)
        Dim nsmgr As New XmlNamespaceManager(New NameTable())
        nsmgr.AddNamespace("xs", "http://www.w3.org/2001/XMLSchema")
        schema.Write(Console.Out, nsmgr)
    End Sub 'Main
    
    
    Public Shared Sub ValidationCallbackOne(sender As Object, args As ValidationEventArgs)
        Console.WriteLine(args.Message)
    End Sub 'ValidationCallbackOne
    
    
    Public Shared Function TextToNodeArray(text As String) As XmlNode()
        Dim doc As New XmlDocument()
        Return New XmlNode(0) {doc.CreateTextNode(text)}
    End Function 'TextToNodeArray
End Class 'XMLSchemaExamples 

[C#] 
using System;
using System.Xml;  
using System.Xml.Schema;

class XMLSchemaExamples {
    public static void Main() {
 
        XmlSchema schema = new XmlSchema();
        
        // <xs:simpleType name="northwestStates">
        XmlSchemaSimpleType simpleType = new XmlSchemaSimpleType();
        simpleType.Name = "northwestStates";
        schema.Items.Add(simpleType);
            
        // <xs:annotation>
        XmlSchemaAnnotation annNorthwestStates = new XmlSchemaAnnotation();
        simpleType.Annotation = annNorthwestStates;
        
        // <xs:documentation>States in the Pacific Northwest of US</xs:documentation>
        XmlSchemaDocumentation docNorthwestStates = new XmlSchemaDocumentation();
        annNorthwestStates.Items.Add(docNorthwestStates);
        docNorthwestStates.Markup = TextToNodeArray("States in the Pacific Northwest of US");

        // <xs:restriction base="xs:string">
        XmlSchemaSimpleTypeRestriction restriction = new XmlSchemaSimpleTypeRestriction();
        simpleType.Content = restriction;
        restriction.BaseTypeName = new XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema");
        
        // <xs:enumeration value='WA'>
        XmlSchemaEnumerationFacet enumerationWA = new XmlSchemaEnumerationFacet();
        restriction.Facets.Add(enumerationWA);
        enumerationWA.Value = "WA";
        
        // <xs:annotation>
        XmlSchemaAnnotation annWA = new XmlSchemaAnnotation();
        enumerationWA.Annotation = annWA;

        // <xs:documentation>Washington</documentation>
        XmlSchemaDocumentation docWA = new XmlSchemaDocumentation();
        annWA.Items.Add(docWA);
        docWA.Markup = TextToNodeArray("Washington");
        
        // <xs:enumeration value='OR'>
        XmlSchemaEnumerationFacet enumerationOR = new XmlSchemaEnumerationFacet();
        restriction.Facets.Add(enumerationOR);
        enumerationOR.Value = "OR";
        
        // <xs:annotation>
        XmlSchemaAnnotation annOR = new XmlSchemaAnnotation();
        enumerationOR.Annotation = annOR;

        // <xs:documentation>Oregon</xs:documentation>
        XmlSchemaDocumentation docOR = new XmlSchemaDocumentation();
        annOR.Items.Add(docOR);
        docOR.Markup = TextToNodeArray("Oregon");

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

        restriction.Facets.Add(enumerationID);
        enumerationID.Value = "ID";
        
        // <xs:annotation>
        XmlSchemaAnnotation annID = new XmlSchemaAnnotation();
        enumerationID.Annotation = annID;

        // <xs:documentation>Idaho</xs:documentation>
        XmlSchemaDocumentation docID = new XmlSchemaDocumentation();
        annID.Items.Add(docID);
        docID.Markup = TextToNodeArray("Idaho");

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

    public static XmlNode[] TextToNodeArray(string text) {
        XmlDocument doc = new XmlDocument();
        return new XmlNode[1] {doc.CreateTextNode(text)};
    }

}

[C++] 
#using <mscorlib.dll>
#using <System.Xml.dll>
using namespace System;
using namespace System::Xml;  
using namespace System::Xml::Schema;

__gc class XMLSchemaExamples {
public:
    static void main() {
        XmlSchema* schema = new XmlSchema();

        // <xs:simpleType name="northwestStates">
        XmlSchemaSimpleType* simpleType = new XmlSchemaSimpleType();
        simpleType->Name = S"northwestStates";
        schema->Items->Add(simpleType);

        // <xs:annotation>
        XmlSchemaAnnotation* annNorthwestStates = new XmlSchemaAnnotation();
        simpleType->Annotation = annNorthwestStates;

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

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

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

        // <xs:annotation>
        XmlSchemaAnnotation* annWA = new XmlSchemaAnnotation();
        enumerationWA->Annotation = annWA;

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

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

        // <xs:annotation>
        XmlSchemaAnnotation* annOR = new XmlSchemaAnnotation();
        enumerationOR->Annotation = annOR;

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

        // <xs:enumeration value='ID'>
        XmlSchemaEnumerationFacet* enumerationID = new XmlSchemaEnumerationFacet();

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

        // <xs:annotation>
        XmlSchemaAnnotation* annID = new XmlSchemaAnnotation();
        enumerationID->Annotation = annID;

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

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

    static void ValidationCallbackOne(Object* /*sender*/, ValidationEventArgs* args) {
        Console::WriteLine(args->Message);
    }

    static XmlNode* TextToNodeArray(String* text)[] {
        XmlDocument* doc = new XmlDocument();
        XmlNode* temp[] = {doc->CreateTextNode(text)};
        return temp;
    }
};

int main()
{
    XMLSchemaExamples::main();
}

[Visual Basic, C#, C++] 前述のコード例に対して生成される XML ファイルを次に示します。

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

[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタボタンをクリックします。

必要条件

名前空間: System.Xml.Schema

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

アセンブリ: System.Xml (System.Xml.dll 内)

参照

XmlSchemaAnnotation メンバ | System.Xml.Schema 名前空間

次の方法で共有

XmlSchemaAnnotation クラス

スレッドセーフ

解説

使用例

必要条件

参照

その他のリソース