XmlSchemaDocumentation クラス

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

注釈内でユーザーが読み取る情報またはユーザーが使用する情報を指定するクラス。W3C (World Wide Web Consortium) documentation 要素を表します。

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

System.Object
System.Xml.Schema.XmlSchemaObject
System.Xml.Schema.XmlSchemaDocumentation

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

スレッドセーフ

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

解説

XmlSchemaDocumentation クラス内で提供される情報は、検証には使用されません。ただし、ツールで取得できる情報を提供する標準化された方法を提供します。

使用例

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

 
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


  Public Shared Sub ValidationCallbackOne(sender as object, args as ValidationEventArgs) 
    Console.WriteLine(args.Message)
  End Sub

    Public Shared Function TextToNodeArray(text as string) as XmlNode()
        Dim doc as New XmlDocument()
        Dim nodeArray(1) as XmlNode
        
        nodeArray(0) = doc.CreateTextNode(text)
        TextToNodeArray =  nodeArray
    End Function

End Class

[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 ValidationCallbackOne(Object* /*sender*/, ValidationEventArgs* args) {
        Console::WriteLine(args->Message);
    }
};

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

int 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, XMLSchemaExamples::ValidationCallbackOne));
    XmlNamespaceManager* nsmgr = new XmlNamespaceManager(new NameTable());
    nsmgr->AddNamespace(S"xs", S"http://www.w3.org/2001/XMLSchema");
    schema->Write(Console::Out, nsmgr);
}

[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 内)

参照

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

次の方法で共有

XmlSchemaDocumentation クラス

スレッドセーフ

解説

使用例

必要条件

参照

その他のリソース