Export (0) Print
Expand All

XmlSchemaAttribute Class

Represents the attribute element from the XML Schema as specified by the World Wide Web Consortium (W3C). Attributes provide additional information for other document elements. The attribute tag is nested between the tags of a document's element for the schema. The XML document displays attributes as named items in the opening tag of an element.

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

public class XmlSchemaAttribute : XmlSchemaAnnotated

The XmlSchemaAttribute type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkXmlSchemaAttributeInitializes a new instance of the XmlSchemaAttribute class.
Top

  NameDescription
Public propertySupported by the XNA FrameworkAnnotationGets or sets the annotation property. (Inherited from XmlSchemaAnnotated.)
Public propertySupported by the XNA FrameworkAttributeSchemaTypeGets an XmlSchemaSimpleType object representing the type of the attribute based on the SchemaType or SchemaTypeName of the attribute.
Public propertySupported by the XNA FrameworkAttributeType Obsolete. Gets the common language runtime (CLR) object based on the SchemaType or SchemaTypeName of the attribute that holds the post-compilation value of the AttributeType property.
Public propertySupported by the XNA FrameworkDefaultValueGets or sets the default value for the attribute.
Public propertySupported by the XNA FrameworkFixedValueGets or sets the fixed value for the attribute.
Public propertySupported by the XNA FrameworkFormGets or sets the form for the attribute.
Public propertySupported by the XNA FrameworkIdGets or sets the string id. (Inherited from XmlSchemaAnnotated.)
Public propertySupported by the XNA FrameworkLineNumberGets or sets the line number in the file to which the schema element refers. (Inherited from XmlSchemaObject.)
Public propertySupported by the XNA FrameworkLinePositionGets or sets the line position in the file to which the schema element refers. (Inherited from XmlSchemaObject.)
Public propertySupported by the XNA FrameworkNameGets or sets the name of the attribute.
Public propertySupported by the XNA FrameworkNamespacesGets or sets the XmlSerializerNamespaces to use with this schema object. (Inherited from XmlSchemaObject.)
Public propertySupported by the XNA FrameworkParentGets or sets the parent of this XmlSchemaObject. (Inherited from XmlSchemaObject.)
Public propertySupported by the XNA FrameworkQualifiedNameGets the qualified name for the attribute.
Public propertySupported by the XNA FrameworkRefNameGets or sets the name of an attribute declared in this schema (or another schema indicated by the specified namespace).
Public propertySupported by the XNA FrameworkSchemaTypeGets or sets the attribute type to a simple type.
Public propertySupported by the XNA FrameworkSchemaTypeNameGets or sets the name of the simple type defined in this schema (or another schema indicated by the specified namespace).
Public propertySupported by the XNA FrameworkSourceUriGets or sets the source location for the file that loaded the schema. (Inherited from XmlSchemaObject.)
Public propertySupported by the XNA FrameworkUnhandledAttributesGets or sets the qualified attributes that do not belong to the current schema's target namespace. (Inherited from XmlSchemaAnnotated.)
Public propertySupported by the XNA FrameworkUseGets or sets information about how the attribute is used.
Top

  NameDescription
Public methodSupported by the XNA FrameworkEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by the XNA FrameworkGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Attribute declarations can be present as child elements of the schema element (having global scope) or within complex type definitions. For complex types, attribute declarations can be present as local declarations or references to attributes with global scope. Both global and local attribute declarations have the optional type attribute that refers to an existing simple type. If the optional type attribute is not used, the attribute declaration (global or local) must define a local simple type.

The following example creates the attribute element.

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

class XMLSchemaExamples
{
    public static void Main()
    {

        XmlSchema schema = new XmlSchema();

        // <xs:attribute name="mybaseattribute">
        XmlSchemaAttribute attributeBase = new XmlSchemaAttribute();
        schema.Items.Add(attributeBase);
        attributeBase.Name = "mybaseattribute";

        // <xs:simpleType>
        XmlSchemaSimpleType simpleType = new XmlSchemaSimpleType();
        attributeBase.SchemaType = simpleType;

        // <xs:restriction base="integer">
        XmlSchemaSimpleTypeRestriction restriction = new XmlSchemaSimpleTypeRestriction();
        simpleType.Content = restriction;
        restriction.BaseTypeName = new XmlQualifiedName("integer", "http://www.w3.org/2001/XMLSchema");

        // <xs:maxInclusive value="1000"/>
        XmlSchemaMaxInclusiveFacet maxInclusive = new XmlSchemaMaxInclusiveFacet();
        restriction.Facets.Add(maxInclusive);
        maxInclusive.Value = "1000";

        // <xs:complexType name="myComplexType">
        XmlSchemaComplexType complexType = new XmlSchemaComplexType();
        schema.Items.Add(complexType);
        complexType.Name = "myComplexType";

        // <xs:attribute ref="mybaseattribute"/>
        XmlSchemaAttribute attributeBaseRef = new XmlSchemaAttribute();
        complexType.Attributes.Add(attributeBaseRef);
        attributeBaseRef.RefName = new XmlQualifiedName("mybaseattribute");

        XmlSchemaSet schemaSet = new XmlSchemaSet();
        schemaSet.ValidationEventHandler += new ValidationEventHandler(ValidationCallbackOne);
        schemaSet.Add(schema);
        schemaSet.Compile();

        XmlSchema compiledSchema = null;

        foreach (XmlSchema schema1 in schemaSet.Schemas())
        {
            compiledSchema = schema1;
        }

        XmlNamespaceManager nsmgr = new XmlNamespaceManager(new NameTable());
        nsmgr.AddNamespace("xs", "http://www.w3.org/2001/XMLSchema");
        compiledSchema.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:attribute name="mybaseattribute">
        <xs:simpleType>
            <xs:restriction base="xs:integer">
                <xs:maxInclusive value="1000" />
            </xs:restriction>
        </xs:simpleType>
    </xs:attribute>
    <xs:complexType name="myComplexType">
        <xs:attribute ref="mybaseattribute" />
    </xs:complexType>
</xs:schema>

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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