Export (0) Print
Expand All

XmlSchemaDocumentation Class

Class that specifies information to be read or used by humans within an annotation. Represents the World Wide Web Consortium (W3C) documentation element.

For a list of all members of this type, see XmlSchemaDocumentation Members.

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

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

Thread Safety

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

Remarks

Information supplied within the XmlSchemaDocumentation class is not used in validation. However, it provides a standardized way to supply information that can be retrieved by tools.

Example

[Visual Basic, C#, C++] The following example creates the documentation element.

[Visual Basic] 
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++] 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>

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Namespace: System.Xml.Schema

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

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

See Also

XmlSchemaDocumentation Members | System.Xml.Schema Namespace

Show:
© 2014 Microsoft