XSD annotations?

[SideByEach]

I'm trying to read in a XSD schema with two annotation nodes defined.
The schema seems to load fine but I cannot find the annotations. The
schema is being loaded into a xmlschema object.

When I look at the schema object (element, attribute or etc.) the
annotation of every node is "nothing".

Example schema:

<?xml version="1.0"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<!-- definition of simple elements -->
<xs:element name="orderperson" type="xs:string"/>
<xs:element name="name" type="xs:string"/>
<xs:element name="address" type="xs:string"/>
<xs:element name="city" type="xs:string"/>
<xs:element name="country" type="xs:string"/>
<xs:element name="title" type="xs:string">
<xs:annotation>
<xs:documentation>Element Test</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="note" type="xs:string"/>
<xs:element name="quantity" type="xs:positiveInteger"/>
<xs:element name="price" type="xs:decimal"/>
<!-- definition of attributes -->
<xs:attribute name="orderid" type="xs:string">
<xs:annotation>
<xs:documentation>Attribute Test</xs:documentation>
</xs:annotation>
</xs:attribute>
<!-- definition of complex elements -->
<xs:element name="shipto">
<xs:complexType>
<xs:sequence>
<xs:element ref="name"/>
<xs:element ref="address"/>
<xs:element ref="city"/>
<xs:element ref="country"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="item">
<xs:complexType>
<xs:sequence>
<xs:element ref="title"/>
<xs:element ref="note" minOccurs="0"/>
<xs:element ref="quantity"/>
<xs:element ref="price"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="SaleItems">
<xs:complexType>
<xs:sequence>
<xs:element ref="orderperson"/>
<xs:element ref="shipto"/>
<xs:element ref="item" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute ref="orderid" use="required"/>
</xs:complexType>
</xs:element>
</xs:schema>

[SideByEach]

Anyone? Really need to figure this out.

[Priya Lakshminarayanan [MSFT]]

The following sample code will print the content of the annotation elements:
Text in documentation: Element Test
Text in documentation: Attribute Test

Thanks,
Priya

using System;
using System.Threading;
using System.Xml;
using System.Xml.Schema;

class Annotation{

public static void Main() {
XmlSchema schema = XmlSchema.Read(new XmlTextReader("annot.xsd"), null);
schema.Compile(null);

foreach(XmlSchemaObject schemaObject in schema.Items) {
PrintAnnotation(schemaObject);
}

}

private static void PrintAnnotation(XmlSchemaObject schemaObject) {
XmlSchemaAnnotation annotation;
if (schemaObject is XmlSchemaAnnotated) {
XmlSchemaAnnotated annotated = schemaObject as
XmlSchemaAnnotated;
annotation = annotated.Annotation;
if (annotation != null) {
ProcessAnnotation(annotation);
}
}
}

private static void ProcessAnnotation(XmlSchemaAnnotation
annotation) {
foreach (XmlSchemaObject obj in annotation.Items) {
XmlSchemaDocumentation doc = obj as XmlSchemaDocumentation;
if (doc != null) {
foreach(XmlNode node in doc.Markup) {
switch(node.NodeType) {
case XmlNodeType.Text:
Console.WriteLine("Text in documentation: " +
node.Value);
break;

case XmlNodeType.Element:
Console.WriteLine("Text in documentation: " +
node.InnerText);
break;
}
}
}
}
}
}

"SideByEach" <kn*****@nb.sympatico.ca> wrote in message
news:11**********************@z14g2000cwz.googlegr oups.com...

I'm trying to read in a XSD schema with two annotation nodes defined.
The schema seems to load fine but I cannot find the annotations. The
schema is being loaded into a xmlschema object.

When I look at the schema object (element, attribute or etc.) the
annotation of every node is "nothing".

Example schema:

<?xml version="1.0"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<!-- definition of simple elements -->
<xs:element name="orderperson" type="xs:string"/>
<xs:element name="name" type="xs:string"/>
<xs:element name="address" type="xs:string"/>
<xs:element name="city" type="xs:string"/>
<xs:element name="country" type="xs:string"/>
<xs:element name="title" type="xs:string">
<xs:annotation>
<xs:documentation>Element Test</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="note" type="xs:string"/>
<xs:element name="quantity" type="xs:positiveInteger"/>
<xs:element name="price" type="xs:decimal"/>
<!-- definition of attributes -->
<xs:attribute name="orderid" type="xs:string">
<xs:annotation>
<xs:documentation>Attribute Test</xs:documentation>
</xs:annotation>
</xs:attribute>
<!-- definition of complex elements -->
<xs:element name="shipto">
<xs:complexType>
<xs:sequence>
<xs:element ref="name"/>
<xs:element ref="address"/>
<xs:element ref="city"/>
<xs:element ref="country"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="item">
<xs:complexType>
<xs:sequence>
<xs:element ref="title"/>
<xs:element ref="note" minOccurs="0"/>
<xs:element ref="quantity"/>
<xs:element ref="price"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="SaleItems">
<xs:complexType>
<xs:sequence>
<xs:element ref="orderperson"/>
<xs:element ref="shipto"/>
<xs:element ref="item" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute ref="orderid" use="required"/>
</xs:complexType>
</xs:element>
</xs:schema>

[SideByEach]

Thanks for the sample. I have two follow up questions for you.

1). How do I tell what element/attribute/etc the annotation belongs to?

2). What's the point of elements/attributes/etc objects "annotation"
attribute if it doesn't seem to hold the annotation for that item?

[SideByEach]

Here's an example of why I'm getting frustrated:

If TypeOf sObject Is XmlSchemaAnnotated Then
Dim sAnnotated As XmlSchemaAnnotated = DirectCast(sObject,
XmlSchemaAnnotated)
Dim tempAnno As XmlSchemaAnnotation = sAnnotated.Annotation

If Not tempAnno Is Nothing Then
Dim tempMsg As String = GetMessageFromAnno(tempAnno)
End If 'Not tempAnno Is Nothing
End If 'TypeOf sObject Is

The "TypeOf" check passes but "Annotation" property is always nothing.
But if I create a test function that simply loops through all the
objects in the schema looking annotations, it works. What gives?

[SideByEach]

A little help?

[Zafar Abbas]

Are you looking for information regarding xsd:annotations in general, or do
you have a specific need you want to use them for?
"SideByEach" <kn*****@nb.sympatico.ca> wrote in message
news:11**********************@g44g2000cwa.googlegr oups.com...

A little help?

[SideByEach]

I've figured out a little bit about how to reference annotiation in the
XmlSchema object.
The annotation property can exists in one of four different place in
single XmlElement object. For example if an element is a base type,
then the "annotation" property should contain the annotation. The
element's annotation can exist in the "ElementSchemaType.Annotation"
and "SchemaType.Annotation" properties. There is a forth location but I
have been unable to locate it.
I wish there was a simpler way to get the current
element/attribute/etc. annotation.