XmlIgnoreAttribute Třída
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Dává pokyn Serialize(TextWriter, Object) metodě XmlSerializer, aby ne serializoval veřejné pole nebo hodnotu veřejné vlastnosti pro čtení a zápis.
public ref class XmlIgnoreAttribute : Attribute[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)]
public class XmlIgnoreAttribute : Attribute[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property | System.AttributeTargets.ReturnValue)>]
type XmlIgnoreAttribute = class
inherit AttributePublic Class XmlIgnoreAttribute
Inherits Attribute- Dědičnost
- Atributy
Příklady
Následující příklad ukazuje třídu s názvem Group, která obsahuje pole s názvem Comment. Příklad přiřadí XmlIgnoreAttribute pole, čímž dává pokyn XmlSerializer ignorovat pole při serializaci nebo deserializaci instance třídy.
public class Group
{
// The XmlSerializer ignores this field.
[XmlIgnore]
public string Comment;
// The XmlSerializer serializes this field.
public string GroupName;
}
Public Class Group
' the XmlSerializer ignores this field.
<XmlIgnore()> Public Comment As String
' The XmlSerializer serializes this field.
Public GroupName As String
End Class
Poznámky
Patří XmlIgnoreAttribute do řady atributů, které řídí, jak XmlSerializer serializuje nebo deserializuje objekt. Pokud použijete XmlIgnoreAttribute u libovolného člena třídy, XmlSerializer ignoruje člen při serializaci nebo deserializaci instance třídy. Úplný seznam podobných atributů naleznete v části Atributy, které řídí serializaci XML.
Chování způsobené vytvořením objektu XmlIgnoreAttributeXmlAttributes a nastavením jeho XmlIgnore vlastnosti na false. Objekt je nutné AddXmlAttributes k instanci XmlAttributeOverrides třídy. Nakonec musíte objekt použít XmlAttributeOverrides k vytvoření instance XmlSerializer třídy před voláním Serialize nebo Deserialize metod.
Nástroj pro definici schématu XML (Xsd.exe) občas generuje XmlIgnoreAttribute při vytváření tříd ze souboru schématu (.xsd). K tomuto chování dochází, protože hodnoty nelze nastavit na null, ale všechny datové typy XML mohou být. Nástroj proto vytvoří dvě pole, když narazí na typ XML, který se mapuje na typ hodnoty: jeden pro uložení hodnoty a další speciální pole, které má formu fieldnameSpecified, kde fieldname je nahrazen názvem pole nebo vlastnosti. Všimněte si však, že toto speciální pole je generováno pouze v případě, že schéma určuje, že prvek nemá žádný minimální výskyt (minOccurs = "0") a že prvek nemá výchozí hodnotu. Nastaví XmlSerializer a zkontroluje toto speciální pole a určí, zda byla pro pole nebo vlastnost nastavena hodnota. Protože speciální pole nesmí být serializováno, nástroj na něj použije XmlIgnoreAttribute .
Další informace o používání atributů naleznete v tématu Atributy.
Poznámka:
Místo delšího XmlIgnoreAttributekódu můžete použít slovo XmlIgnore v kódu .
Konstruktory
| Name | Description |
|---|---|
| XmlIgnoreAttribute() |
Inicializuje novou instanci XmlIgnoreAttribute třídy. |
Vlastnosti
| Name | Description |
|---|---|
| TypeId |
Při implementaci v odvozené třídě získá jedinečný identifikátor pro tento Attribute. (Zděděno od Attribute) |
Metody
| Name | Description |
|---|---|
| Equals(Object) |
Vrátí hodnotu, která určuje, zda je tato instance rovna zadanému objektu. (Zděděno od Attribute) |
| GetHashCode() |
Vrátí kód hash pro tuto instanci. (Zděděno od Attribute) |
| GetType() |
Získá Type aktuální instance. (Zděděno od Object) |
| IsDefaultAttribute() |
Při přepsání v odvozené třídě určuje, zda hodnota této instance je výchozí hodnotou pro odvozenou třídu. (Zděděno od Attribute) |
| Match(Object) |
Při přepsání v odvozené třídě vrátí hodnotu, která určuje, zda se tato instance rovná zadanému objektu. (Zděděno od Attribute) |
| MemberwiseClone() |
Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object) |
| ToString() |
Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object) |
Explicitní implementace rozhraní
| Name | Description |
|---|---|
| _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) |
Mapuje sadu názvů na odpovídající sadu identifikátorů pro rozesílání. (Zděděno od Attribute) |
| _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) |
Načte informace o typu objektu, který lze použít k získání informací o typu pro rozhraní. (Zděděno od Attribute) |
| _Attribute.GetTypeInfoCount(UInt32) |
Získá počet rozhraní typu informací, které objekt poskytuje (0 nebo 1). (Zděděno od Attribute) |
| _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) |
Poskytuje přístup k vlastnostem a metodám vystaveným objektem. (Zděděno od Attribute) |
