XmlTypeAttribute Classe

Definição

Controla o esquema XML que é gerado quando o atributo de destino é serializado pelo 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
Herança
XmlTypeAttribute
Atributos

Exemplos

O exemplo a seguir mostra duas classes às quais XmlTypeAttribute o foi aplicado.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

Comentários

O XmlTypeAttribute pertence a uma família de atributos que controla como o XmlSerializer serializa ou desserializa um objeto.The XmlTypeAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. Para obter uma lista completa de atributos semelhantes, consulte atributos que controlam a serialização de XML.For a complete list of similar attributes, see Attributes That Control XML Serialization.

Você pode aplicar o XmlTypeAttribute a uma declaração de classe, estrutura, enumeração ou interface.You can apply the XmlTypeAttribute to a class, structure, enumeration, or interface declaration.

Aplique o XmlTypeAttribute a uma classe para especificar o namespace do tipo XML, o nome do tipo XML e se deseja incluir o tipo no documento de esquema 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. Para ver os resultados da definição das propriedades da XmlTypeAttribute classe, compile seu aplicativo como um executável ou dll e passe o arquivo resultante para a ferramenta de definição de esquema 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). A ferramenta grava o esquema, incluindo a definição de tipo.The tool writes the schema, including the type definition.

Observação

Se você definir a IncludeInSchema Propriedade como false, a ferramenta de definição de esquema XML (XSD. exe) não incluirá o tipo no esquema.If you set the IncludeInSchema property to false, the XML Schema Definition Tool (Xsd.exe) does not include the type in the schema. Por padrão, para cada classe pública, a ferramenta xsd gera um complexType elemento e desse tipo.By default, for each public class, the XSD tool generates a complexType and an element of that type.

Para obter mais informações sobre como usar atributos, consulte atributos.For more information about using attributes, see Attributes.

Observação

Você pode usar a palavra XmlType em seu código em vez de mais XmlTypeAttributelonga.You can use the word XmlType in your code instead of the longer XmlTypeAttribute.

Construtores

XmlTypeAttribute()

Inicializa uma nova instância da classe XmlTypeAttribute.Initializes a new instance of the XmlTypeAttribute class.

XmlTypeAttribute(String)

Inicializa uma nova instância da classe XmlTypeAttribute e especifica o nome do tipo XML.Initializes a new instance of the XmlTypeAttribute class and specifies the name of the XML type.

Propriedades

AnonymousType

Obtém ou define um valor que determina se o tipo de esquema resultante é um tipo anônimo XSD.Gets or sets a value that determines whether the resulting schema type is an XSD anonymous type.

IncludeInSchema

Obtém ou define um valor que indica se deve incluir o tipo nos XML Schema Documents.Gets or sets a value that indicates whether to include the type in XML schema documents.

Namespace

Obtém ou define o namespace do tipo XML.Gets or sets the namespace of the XML type.

TypeId

Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Herdado de Attribute)
TypeName

Obtém ou define o nome do tipo XML.Gets or sets the name of the XML type.

Métodos

Equals(Object)

Retorna um valor que indica se essa instância é igual a um objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Herdado de Attribute)
GetHashCode()

Retorna o código hash para essa instância.Returns the hash code for this instance.

(Herdado de Attribute)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
IsDefaultAttribute()

Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Herdado de Attribute)
Match(Object)

Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Herdado de Attribute)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)

Implantações explícitas de interface

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

Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de expedição.Maps a set of names to a corresponding set of dispatch identifiers.

(Herdado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Recupera as informações de tipo para um objeto, que pode ser usado para obter as informações de tipo para uma interface.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Herdado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Retorna o número de interfaces de informações do tipo que um objeto fornece (0 ou 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Herdado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fornece acesso a propriedades e métodos expostos por um objeto.Provides access to properties and methods exposed by an object.

(Herdado de Attribute)

Aplica-se a

Veja também