This documentation is archived and is not being maintained.
XmlSchemaDocumentation Class
Visual Studio 2010
Represents the documentation element from XML Schema as specified by the . This class specifies information to be read or used by humans within an annotation.
Assembly: System.Xml (in System.Xml.dll)
The XmlSchemaDocumentation type exposes the following members.
| Name | Description | |
|---|---|---|
![]() ![]() | XmlSchemaDocumentation | Initializes a new instance of the XmlSchemaDocumentation class. |
| Name | Description | |
|---|---|---|
![]() ![]() | Language | Gets or sets the xml:lang attribute. This serves as an indicator of the language used in the contents. |
![]() ![]() | LineNumber | Gets or sets the line number in the file to which the schema element refers. (Inherited from XmlSchemaObject.) |
![]() ![]() | LinePosition | Gets or sets the line position in the file to which the schema element refers. (Inherited from XmlSchemaObject.) |
![]() ![]() | Markup | Gets or sets an array of XmlNodes that represents the documentation child nodes. |
![]() ![]() | Namespaces | Gets or sets the XmlSerializerNamespaces to use with this schema object. (Inherited from XmlSchemaObject.) |
![]() ![]() | Parent | Gets or sets the parent of this XmlSchemaObject. (Inherited from XmlSchemaObject.) |
![]() ![]() | Source | Gets or sets the Uniform Resource Identifier (URI) source of the information. |
![]() ![]() | SourceUri | Gets or sets the source location for the file that loaded the schema. (Inherited from XmlSchemaObject.) |
| Name | Description | |
|---|---|---|
![]() ![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() ![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() ![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() ![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() ![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() ![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
The following example creates the documentation element.
#using <mscorlib.dll> #using <System.Xml.dll> using namespace System; using namespace System::Xml; using namespace System::Xml::Schema; class XmlSchemaExamples { public: static void Main() { XmlSchema^ schema = gcnew XmlSchema(); // <xs:simpleType name="northwestStates"> XmlSchemaSimpleType^ simpleType = gcnew XmlSchemaSimpleType(); simpleType->Name = "northwestStates"; schema->Items->Add(simpleType); // <xs:annotation> XmlSchemaAnnotation^ annNorthwestStates = gcnew XmlSchemaAnnotation(); simpleType->Annotation = annNorthwestStates; // <xs:documentation>States in the Pacific Northwest of US</xs:documentation> XmlSchemaDocumentation^ docNorthwestStates = gcnew XmlSchemaDocumentation(); annNorthwestStates->Items->Add(docNorthwestStates); docNorthwestStates->Markup = TextToNodeArray("States in the Pacific Northwest of US"); // <xs:restriction base="xs:string"> XmlSchemaSimpleTypeRestriction^ restriction = gcnew XmlSchemaSimpleTypeRestriction(); simpleType->Content = restriction; restriction->BaseTypeName = gcnew XmlQualifiedName("string", "http://www.w3.org/2001/XMLSchema"); // <xs:enumeration value="WA"> XmlSchemaEnumerationFacet^ enumerationWA = gcnew XmlSchemaEnumerationFacet(); restriction->Facets->Add(enumerationWA); enumerationWA->Value = "WA"; // <xs:annotation> XmlSchemaAnnotation^ annWA = gcnew XmlSchemaAnnotation(); enumerationWA->Annotation = annWA; // <xs:documentation>Washington</documentation> XmlSchemaDocumentation^ docWA = gcnew XmlSchemaDocumentation(); annWA->Items->Add(docWA); docWA->Markup = TextToNodeArray("Washington"); // <xs:enumeration value="OR"> XmlSchemaEnumerationFacet^ enumerationOR = gcnew XmlSchemaEnumerationFacet(); restriction->Facets->Add(enumerationOR); enumerationOR->Value = "OR"; // <xs:annotation> XmlSchemaAnnotation^ annOR = gcnew XmlSchemaAnnotation(); enumerationOR->Annotation = annOR; // <xs:documentation>Oregon</xs:documentation> XmlSchemaDocumentation^ docOR = gcnew XmlSchemaDocumentation(); annOR->Items->Add(docOR); docOR->Markup = TextToNodeArray("Oregon"); // <xs:enumeration value="ID"> XmlSchemaEnumerationFacet^ enumerationID = gcnew XmlSchemaEnumerationFacet(); restriction->Facets->Add(enumerationID); enumerationID->Value = "ID"; // <xs:annotation> XmlSchemaAnnotation^ annID = gcnew XmlSchemaAnnotation(); enumerationID->Annotation = annID; // <xs:documentation>Idaho</xs:documentation> XmlSchemaDocumentation^ docID = gcnew XmlSchemaDocumentation(); annID->Items->Add(docID); docID->Markup = TextToNodeArray("Idaho"); XmlSchemaSet^ schemaSet = gcnew XmlSchemaSet(); schemaSet->ValidationEventHandler += gcnew ValidationEventHandler(ValidationCallbackOne); schemaSet->Add(schema); schemaSet->Compile(); XmlSchema^ compiledSchema; for each (XmlSchema^ schema1 in schemaSet->Schemas()) { compiledSchema = schema1; } XmlNamespaceManager^ nsmgr = gcnew XmlNamespaceManager(gcnew NameTable()); nsmgr->AddNamespace("xs", "http://www.w3.org/2001/XMLSchema"); compiledSchema->Write(Console::Out, nsmgr); } static void ValidationCallbackOne(Object^ sender, ValidationEventArgs^ args) { Console::WriteLine(args->Message); } static array<XmlNode^>^ TextToNodeArray(String^ text) { XmlDocument^ doc = gcnew XmlDocument(); array<XmlNode^>^ nodes = gcnew array<XmlNode^> {doc->CreateTextNode(text)}; return nodes; } }; int main() { XmlSchemaExamples::Main(); return 0; };
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 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show:
