XmlTypeAttribute Class

Definition

Управляет схемой XML, которая создается при сериализации конечного объекта атрибута классом XmlSerializer.Controls the XML schema that is generated when the attribute target is serialized by the XmlSerializer.

public ref class XmlTypeAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Enum | System.AttributeTargets.Interface | System.AttributeTargets.Struct)]
public class XmlTypeAttribute : Attribute
type XmlTypeAttribute = class
    inherit Attribute
Public Class XmlTypeAttribute
Inherits Attribute
Inheritance
XmlTypeAttribute
Attributes

Examples

В следующем примере показаны два класса, к которым применен XmlTypeAttribute.The following example shows two classes to which the XmlTypeAttribute has been applied.


[XmlType(Namespace="http://www.cpandl.com",
TypeName="GroupMember")]
public ref class Person
{
public:
   String^ Name;
};


[XmlType(Namespace="http://www.cohowinery.com",
TypeName="GroupAddress")]
public ref class Address
{
public:
   String^ Line1;
   String^ Line2;
   String^ City;
   String^ State;
   String^ Zip;
};

public ref class Group
{
public:
   array<Person^>^Staff;
   Person^ Manager;
   Address^ Location;
};

[XmlType(Namespace = "http://www.cpandl.com",
TypeName = "GroupMember")]
public class Person
{
   public string Name;
}

[XmlType(Namespace = "http://www.cohowinery.com",
TypeName = "GroupAddress")]
public class Address
{
   public string Line1;
   public string Line2;
   public string City;
   public string State;
   public string Zip;
}

public class Group
{
   public Person[] Staff;
   public Person Manager;
   public Address Location;
}

<XmlType(Namespace := "http://www.cpandl.com", _
 TypeName := "GroupMember")> _
Public Class Person
    Public Name As String
End Class

<XmlType(Namespace := "http://www.cohowinery.com", _
 TypeName := "GroupAddress")> _ 
Public Class Address
    
    Public Line1 As String
    Public Line2 As String
    Public City As String
    Public State As String
    Public Zip As String
End Class

Public Class Group
    Public Staff() As Person
    Public Manager As Person
    Public Location As Address
End Class

Remarks

XmlTypeAttribute принадлежит семейству атрибутов, который управляет тем, как XmlSerializer сериализует или десериализует объект.The XmlTypeAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. Полный список схожих атрибутов см. в разделе атрибуты, управляющие СЕРИАЛИЗАЦИЕЙ XML.For a complete list of similar attributes, see Attributes That Control XML Serialization.

XmlTypeAttribute можно применить к объявлению класса, структуры, перечисления или интерфейса.You can apply the XmlTypeAttribute to a class, structure, enumeration, or interface declaration.

Примените XmlTypeAttribute к классу, чтобы указать пространство имен типа XML, имя типа XML и указать, следует ли включать тип в документ схемы XML.Apply the XmlTypeAttribute to a class to specify the XML type's namespace, the XML type name, and whether to include the type in the XML schema document. Чтобы просмотреть результаты установки свойств класса XmlTypeAttribute, скомпилируйте приложение как исполняемый файл или библиотеку DLL и передайте полученный файл в средство определения схемы XML (XSD. exe).To see the results of setting the properties of the XmlTypeAttribute class, compile your application as an executable or DLL, and pass the resulting file to the XML Schema Definition Tool (Xsd.exe). Средство записывает схему, включая определение типа.The tool writes the schema, including the type definition.

Note

Если для свойства IncludeInSchema задано значение false, средство определения схемы XML (XSD. exe) не включает этот тип в схему.If you set the IncludeInSchema property to false, the XML Schema Definition Tool (Xsd.exe) does not include the type in the schema. По умолчанию для каждого открытого класса средство XSD создает complexType и элемент этого типа.By default, for each public class, the XSD tool generates a complexType and an element of that type.

Дополнительные сведения об использовании атрибутов см. в разделе атрибуты.For more information about using attributes, see Attributes.

Note

Вместо более длинного XmlTypeAttributeможно использовать слово XmlType в коде.You can use the word XmlType in your code instead of the longer XmlTypeAttribute.

Constructors

XmlTypeAttribute()

Инициализирует новый экземпляр класса XmlTypeAttribute.Initializes a new instance of the XmlTypeAttribute class.

XmlTypeAttribute(String)

Инициализирует новый экземпляр класса XmlTypeAttribute и задает имя типа XML.Initializes a new instance of the XmlTypeAttribute class and specifies the name of the XML type.

Properties

AnonymousType

Возвращает или задает значение, определяющее, является ли результирующий тип схемы анонимным типом XSD.Gets or sets a value that determines whether the resulting schema type is an XSD anonymous type.

IncludeInSchema

Возвращает или задает значение, указывающее, следует ли включать тип в документы схемы XML.Gets or sets a value that indicates whether to include the type in XML schema documents.

Namespace

Возвращает или задает пространство имен типа XML.Gets or sets the namespace of the XML type.

TypeId

В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)
TypeName

Возвращает или задает имя типа XML.Gets or sets the name of the XML type.

Methods

Equals(Object)

Возвращает значение, показывающее, равен ли экземпляр указанному объекту.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode()

Возвращает хэш-код для этого экземпляра.Returns the hash code for this instance.

(Inherited from Attribute)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Возвращает сведения о типе объекта, которые можно использовать для получения сведений о типе интерфейса.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to

See also