Export (0) Print
Expand All

XmlSchemaAnnotation Class

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

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

Public Class XmlSchemaAnnotation _
	Inherits XmlSchemaObject
Dim instance As XmlSchemaAnnotation

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.

Option Explicit On
Option Strict On

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"

        ' <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()
        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()
        enumerationWA.Value = "WA" 

        ' <xs:annotation> 
        Dim annWA As New XmlSchemaAnnotation()
        enumerationWA.Annotation = annWA

        ' <xs:documentation>Washington</documentation> 
        Dim docWA As New XmlSchemaDocumentation()
        docWA.Markup = TextToNodeArray("Washington")

        ' <xs:enumeration value='OR'> 
        Dim enumerationOR As New XmlSchemaEnumerationFacet()
        enumerationOR.Value = "OR" 

        ' <xs:annotation> 
        Dim annOR As New XmlSchemaAnnotation()
        enumerationOR.Annotation = annOR

        ' <xs:documentation>Oregon</xs:documentation> 
        Dim docOR As New XmlSchemaDocumentation()
        docOR.Markup = TextToNodeArray("Oregon")

        ' <xs:enumeration value='ID'> 
        Dim enumerationID As New XmlSchemaEnumerationFacet()
        enumerationID.Value = "ID" 

        ' <xs:annotation> 
        Dim annID As New XmlSchemaAnnotation()
        enumerationID.Annotation = annID

        ' <xs:documentation>Idaho</xs:documentation> 
        Dim docID As New XmlSchemaDocumentation()
        docID.Markup = TextToNodeArray("Idaho")

        Dim schemaSet As New XmlSchemaSet()
        AddHandler schemaSet.ValidationEventHandler, AddressOf ValidationCallbackOne


        Dim compiledSchema As XmlSchema = Nothing 

        For Each schema1 As XmlSchema In schemaSet.Schemas()
            compiledSchema = schema1

        Dim nsmgr As New XmlNamespaceManager(New NameTable())
        nsmgr.AddNamespace("xs", "http://www.w3.org/2001/XMLSchema")
        compiledSchema.Write(Console.Out, nsmgr)
    End Sub 'Main

    Public Shared Sub ValidationCallbackOne(ByVal sender As Object, ByVal args As ValidationEventArgs)
    End Sub 'ValidationCallbackOne

    Public Shared Function TextToNodeArray(ByVal text As String) As XmlNode()
        Dim doc As New XmlDocument()
        Return New XmlNode(0) {doc.CreateTextNode(text)}
    End Function 'TextToNodeArray
End Class 'XMLSchemaExamples 

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


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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Community Additions

© 2014 Microsoft