XmlTypeAttribute XmlTypeAttribute XmlTypeAttribute XmlTypeAttribute Class

Definición

Controla el esquema XML generado cuando XmlSerializer serializa el destino del atributo.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)]
[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct | System.AttributeTargets.Enum | System.AttributeTargets.Interface)]
public class XmlTypeAttribute : Attribute
type XmlTypeAttribute = class
    inherit Attribute
Public Class XmlTypeAttribute
Inherits Attribute
Herencia
XmlTypeAttributeXmlTypeAttributeXmlTypeAttributeXmlTypeAttribute
Atributos

Ejemplos

En el ejemplo siguiente se muestran dos clases a XmlTypeAttribute las que se ha 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

Comentarios

Pertenece a una familia de atributos que controla XmlSerializer cómo serializa o deserializa un objeto. XmlTypeAttributeThe XmlTypeAttribute belongs to a family of attributes that controls how the XmlSerializer serializes or deserializes an object. Para obtener una lista completa de atributos similares, vea atributos que controlan la serialización XML.For a complete list of similar attributes, see Attributes That Control XML Serialization.

Puede aplicar XmlTypeAttribute a una clase, una estructura, una enumeración o una declaración de interfaz.You can apply the XmlTypeAttribute to a class, structure, enumeration, or interface declaration.

XmlTypeAttribute Aplique a una clase para especificar el espacio de nombres del tipo XML, el nombre del tipo XML y si se debe incluir el tipo en el 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 los resultados de la configuración de las propiedades XmlTypeAttribute de la clase, compile la aplicación como archivo ejecutable o dll y pase el archivo resultante a la herramienta de definición de esquemas 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). La herramienta escribe el esquema, incluida la definición de tipo.The tool writes the schema, including the type definition.

Nota

Si establece la IncludeInSchema propiedad en false, la herramienta de definición de esquemas XML (XSD. exe) no incluye el tipo en el esquema.If you set the IncludeInSchema property to false, the XML Schema Definition Tool (Xsd.exe) does not include the type in the schema. De forma predeterminada, para cada clase pública, la herramienta XSD genera complexType y un elemento de ese tipo.By default, for each public class, the XSD tool generates a complexType and an element of that type.

Para obtener más información sobre el uso de atributos, vea atributos.For more information about using attributes, see Attributes.

Nota

Puede usar la palabra XmlType en el código en lugar de la más larga. XmlTypeAttributeYou can use the word XmlType in your code instead of the longer XmlTypeAttribute.

Constructores

XmlTypeAttribute() XmlTypeAttribute() XmlTypeAttribute() XmlTypeAttribute()

Inicializa una nueva instancia de la clase XmlTypeAttribute.Initializes a new instance of the XmlTypeAttribute class.

XmlTypeAttribute(String) XmlTypeAttribute(String) XmlTypeAttribute(String) XmlTypeAttribute(String)

Inicializa una nueva instancia de la clase XmlTypeAttribute y especifica el nombre del tipo XML.Initializes a new instance of the XmlTypeAttribute class and specifies the name of the XML type.

Propiedades

AnonymousType AnonymousType AnonymousType AnonymousType

Obtiene o establece un valor que determina si el tipo de esquema resultante es un tipo anónimo del XSD.Gets or sets a value that determines whether the resulting schema type is an XSD anonymous type.

IncludeInSchema IncludeInSchema IncludeInSchema IncludeInSchema

Obtiene o establece un valor que indica si se debe incluir el tipo en los documentos de esquema XML.Gets or sets a value that indicates whether to include the type in XML schema documents.

Namespace Namespace Namespace Namespace

Obtiene o establece el espacio de nombres del tipo XML.Gets or sets the namespace of the XML type.

TypeId TypeId TypeId TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)
TypeName TypeName TypeName TypeName

Obtiene o establece el nombre del tipo XML.Gets or sets the name of the XML type.

Métodos

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Devuelve un valor que indica si esta instancia es igual que un objeto especificado.Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.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) Match(Object) Match(Object) Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Implementaciones de interfaz explícitas

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

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.Maps a set of names to a corresponding set of dispatch identifiers.

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

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.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) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (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) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Se aplica a

Consulte también: