XmlSchemaDocumentation Class
.NET Framework 2.0
Represents the documentation element from XML Schema as specified by the World Wide Web Consortium (W3C). This class specifies information to be read or used by humans within an annotation.
Namespace: System.Xml.Schema
Assembly: System.Xml (in system.xml.dll)
Assembly: System.Xml (in system.xml.dll)
The following example creates the documentation element.
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") Dim schemaSet As New XmlSchemaSet() AddHandler schemaSet.ValidationEventHandler, AddressOf ValidationCallbackOne schemaSet.Add(schema) schemaSet.Compile() Dim compiledSchema As XmlSchema = Nothing For Each schema1 As XmlSchema In schemaSet.Schemas() compiledSchema = schema1 Next Dim nsmgr As New XmlNamespaceManager(New NameTable()) nsmgr.AddNamespace("xs", "http://www.w3.org/2001/XMLSchema") compiledSchema.Write(Console.Out, nsmgr) End Sub Public Shared Sub ValidationCallbackOne(ByVal sender As Object, ByVal args As ValidationEventArgs) Console.WriteLine(args.Message) End Sub Public Shared Function TextToNodeArray(ByVal 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
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>
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
Community Additions
ADD
Show: