System.Xml.Schema.XmlSchemaAny Class

Assembly: System.Xml.dll
Namespace: System.Xml.Schema
Summary
Enables any element from the specified namespace or namespaces to appear in the containing complexType element. Represents the World Wide Web Consortium (W3C) any element.
C# Syntax:
public class XmlSchemaAny : XmlSchemaParticle
Example
The following example creates the any element.
using System;
using System.Xml;  
using System.Xml.Schema;

class XMLSchemaExamples {
    public static void Main() {
 
        XmlSchema schema = new XmlSchema();

        // <element name='htmlText'>
        XmlSchemaElement xeHtmlText = new XmlSchemaElement();
        xeHtmlText.Name = "htmlText";
                
        // <complexType>
        XmlSchemaComplexType ct = new XmlSchemaComplexType();
        
        // <sequence>
        XmlSchemaSequence sequence = new XmlSchemaSequence();
        
        // <any namespace='http://www.w3.org/1999/xhtml'
        //    minOccurs='1' maxOccurs='unbounded'
        //    processContents='lax'/>
        XmlSchemaAny any = new XmlSchemaAny();
        any.MinOccurs = 1;
        any.MaxOccursString = "unbounded";
        any.Namespace = "http://www.w3.org/1999/xhtml";
        any.ProcessContents = XmlSchemaContentProcessing.Lax;
        sequence.Items.Add(any);

        ct.Particle = sequence;
        xeHtmlText.SchemaType = ct;
        
        schema.Items.Add(xeHtmlText);

        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);
    }
}

    

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:element name='htmlText'>
      <xs:complexType>
       <xs:sequence>
         <xs:any namespace='http://www.w3.org/1999/xhtml'
              minOccurs='1' maxOccurs='unbounded'
              processContents='lax'/>
       </xs:sequence>
      </xs:complexType>
    </xs:element>
</xs:schema>

    
See also:
System.Xml.Schema Namespace

System.Xml.Schema.XmlSchemaAny Member List:

Public Constructors
ctor #1 Default constructor. This constructor is called by derived class constructors to initialize state in this type.
Public Properties
Annotation
(inherited from System.Xml.Schema.XmlSchemaAnnotated)
Read-write

See base class member description: System.Xml.Schema.XmlSchemaAnnotated.Annotation


Gets or sets the annotation property.
Id
(inherited from System.Xml.Schema.XmlSchemaAnnotated)
Read-write

See base class member description: System.Xml.Schema.XmlSchemaAnnotated.Id


Gets or sets the string id.
LineNumber
(inherited from System.Xml.Schema.XmlSchemaObject)
Read-write

See base class member description: System.Xml.Schema.XmlSchemaObject.LineNumber


Gets or sets the line number in the file to which the schema element refers.
LinePosition
(inherited from System.Xml.Schema.XmlSchemaObject)
Read-write

See base class member description: System.Xml.Schema.XmlSchemaObject.LinePosition


Gets or sets the line position in the file to which the schema element refers.
MaxOccurs
(inherited from System.Xml.Schema.XmlSchemaParticle)
Read-write

See base class member description: System.Xml.Schema.XmlSchemaParticle.MaxOccurs


Gets or sets the maximum number of times the particle can occur.
MaxOccursString
(inherited from System.Xml.Schema.XmlSchemaParticle)
Read-write

See base class member description: System.Xml.Schema.XmlSchemaParticle.MaxOccursString


Gets or sets the number as a string value. Maximum number of times the particle can occur.
MinOccurs
(inherited from System.Xml.Schema.XmlSchemaParticle)
Read-write

See base class member description: System.Xml.Schema.XmlSchemaParticle.MinOccurs


Gets or sets the minimum number of times the particle can occur.
MinOccursString
(inherited from System.Xml.Schema.XmlSchemaParticle)
Read-write

See base class member description: System.Xml.Schema.XmlSchemaParticle.MinOccursString


Gets or sets the number as a string value. The minimum number of times the particle can occur.
Namespace Read-write

Gets or sets the namespaces containing the elements that can be used.
Namespaces
(inherited from System.Xml.Schema.XmlSchemaObject)
Read-write

See base class member description: System.Xml.Schema.XmlSchemaObject.Namespaces


ProcessContents Read-write

Gets or sets information about how an application or XML processor should handle the validation of XML documents for the elements specified by the any element.
SourceUri
(inherited from System.Xml.Schema.XmlSchemaObject)
Read-write

See base class member description: System.Xml.Schema.XmlSchemaObject.SourceUri


Gets or sets the source location for the file that loaded the schema.
UnhandledAttributes
(inherited from System.Xml.Schema.XmlSchemaAnnotated)
Read-write

See base class member description: System.Xml.Schema.XmlSchemaAnnotated.UnhandledAttributes


Gets or sets the qualified attributes that do not belong to the schema target namespace.
Public Methods
Equals
(inherited from System.Object)
See base class member description: System.Object.Equals

Derived from System.Object, the primary base class for all objects.
GetHashCode
(inherited from System.Object)
See base class member description: System.Object.GetHashCode

Derived from System.Object, the primary base class for all objects.
GetType
(inherited from System.Object)
See base class member description: System.Object.GetType

Derived from System.Object, the primary base class for all objects.
ToString
(inherited from System.Object)
See base class member description: System.Object.ToString

Derived from System.Object, the primary base class for all objects.
Protected Methods
Finalize
(inherited from System.Object)
See base class member description: System.Object.Finalize

Derived from System.Object, the primary base class for all objects.
MemberwiseClone
(inherited from System.Object)
See base class member description: System.Object.MemberwiseClone

Derived from System.Object, the primary base class for all objects.

Hierarchy:


System.Xml.Schema.XmlSchemaAny Member Details

ctor #1
Summary:
Default constructor. This constructor is called by derived class constructors to initialize state in this type.
C# Syntax:
public XmlSchemaAny();

Return to top


Property: Annotation (read-write)
Inherited
See base class member description: System.Xml.Schema.XmlSchemaAnnotated.Annotation

Summary
Gets or sets the annotation property.
C# Syntax:
public XmlSchemaAnnotation Annotation {get; set;}

Return to top


Property: Id (read-write)
Inherited
See base class member description: System.Xml.Schema.XmlSchemaAnnotated.Id

Summary
Gets or sets the string id.
C# Syntax:
public string Id {get; set;}
Remarks
The id value must be of type ID and be unique within the document containing this element.

Optional.

Return to top


Property: LineNumber (read-write)
Inherited
See base class member description: System.Xml.Schema.XmlSchemaObject.LineNumber

Summary
Gets or sets the line number in the file to which the schema element refers.
C# Syntax:
public int LineNumber {get; set;}
Remarks
LineNumber is used to store the line number when a schema is read from a file. This is reported through XmlSchemaException for error handling.

Return to top


Property: LinePosition (read-write)
Inherited
See base class member description: System.Xml.Schema.XmlSchemaObject.LinePosition

Summary
Gets or sets the line position in the file to which the schema element refers.
C# Syntax:
public int LinePosition {get; set;}
Remarks
This is used to store the line position when a schema is read from a file. This is reported through XmlSchemaException for error handling.

Return to top


Property: MaxOccurs (read-write)
Inherited
See base class member description: System.Xml.Schema.XmlSchemaParticle.MaxOccurs

Summary
Gets or sets the maximum number of times the particle can occur.
C# Syntax:
public decimal MaxOccurs {get; set;}
Remarks
The value can be an integer greater than or equal to zero.

Return to top


Property: MaxOccursString (read-write)
Inherited
See base class member description: System.Xml.Schema.XmlSchemaParticle.MaxOccursString

Summary
Gets or sets the number as a string value. Maximum number of times the particle can occur.
C# Syntax:
public string MaxOccursString {get; set;}
Remarks
This property can have a null ("") value or String.Empty.

To set no limit on the maximum number, use the string "unbounded".

Return to top


Property: MinOccurs (read-write)
Inherited
See base class member description: System.Xml.Schema.XmlSchemaParticle.MinOccurs

Summary
Gets or sets the minimum number of times the particle can occur.
C# Syntax:
public decimal MinOccurs {get; set;}
Remarks
The value can be an integer greater than or equal to zero. Set this attribute to zero to indicate that the attribute is optional.

Return to top


Property: MinOccursString (read-write)
Inherited
See base class member description: System.Xml.Schema.XmlSchemaParticle.MinOccursString

Summary
Gets or sets the number as a string value. The minimum number of times the particle can occur.
C# Syntax:
public string MinOccursString {get; set;}
Remarks
This property can have a null ("") value or String.Empty.

Return to top


Property: Namespace (read-write)
Summary
Gets or sets the namespaces containing the elements that can be used.
C# Syntax:
public string Namespace {get; set;}
Remarks
If no namespace is specified, ##any is the default. If the namespace is specified, it must be one of the values shown in the following table.

Namespace value Description
##any Elements from any namespace can be present.
##other Elements from any namespace that is not the targetNamespace of the parent element containing the any element can be present.
##local Elements that are not qualified with a namespace can be present.
##targetNamespace Elements from the targetNamespace of the parent element containing the any element can be present.
List of {URIs, ##targetNamespace, ##local} Elements from a space-delimited list of namespaces can be present. The list can contain the following: URI references of namespaces, ##targetNamespace , and ##local .

Return to top


Property: Namespaces (read-write)
Inherited
See base class member description: System.Xml.Schema.XmlSchemaObject.Namespaces

C# Syntax:
public XmlSerializerNamespaces Namespaces {get; set;}

Return to top


Property: ProcessContents (read-write)
Summary
Gets or sets information about how an application or XML processor should handle the validation of XML documents for the elements specified by the any element.
C# Syntax:
public XmlSchemaContentProcessing ProcessContents {get; set;}

Return to top


Property: SourceUri (read-write)
Inherited
See base class member description: System.Xml.Schema.XmlSchemaObject.SourceUri

Summary
Gets or sets the source location for the file that loaded the schema.
C# Syntax:
public string SourceUri {get; set;}
Remarks
Provides information for exception handling.

Return to top


Property: UnhandledAttributes (read-write)
Inherited
See base class member description: System.Xml.Schema.XmlSchemaAnnotated.UnhandledAttributes

Summary
Gets or sets the qualified attributes that do not belong to the schema target namespace.
C# Syntax:
public XmlAttribute[] UnhandledAttributes {get; set;}

Return to top


Method: Equals(
   object obj
)
Inherited
See base class member description: System.Object.Equals
C# Syntax:
public virtual bool Equals(
   object obj
);

For more information on members inherited from System.Object click on the link above.

Return to top


Method: Finalize()
Inherited
See base class member description: System.Object.Finalize
C# Syntax:
~XmlSchemaAny();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: GetHashCode()
Inherited
See base class member description: System.Object.GetHashCode
C# Syntax:
public virtual int GetHashCode();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: GetType()
Inherited
See base class member description: System.Object.GetType
C# Syntax:
public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: MemberwiseClone()
Inherited
See base class member description: System.Object.MemberwiseClone
C# Syntax:
protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: ToString()
Inherited
See base class member description: System.Object.ToString
C# Syntax:
public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top


Top of page

Copyright (c) 2002 Microsoft Corporation. All rights reserved.