.NET Framework Class Library
XObject.AddAnnotation Method
Adds an object to the annotation list of this XObject.
Assembly: System.Xml.Linq (in System.Xml.Linq.dll)
Syntax
Visual Basic
Public Sub AddAnnotation ( _ annotation As Object _ )
C#
public void AddAnnotation( Object annotation )
Visual C++
public: void AddAnnotation( Object^ annotation )
F#
member AddAnnotation : annotation:Object -> unit
Parameters
- annotation
- Type: System.Object
An Object that contains the annotation to add.
Remarks
Note that annotations are not part of the infoset; they are not persisted, or displayed by ToString.
Examples
The following example adds an annotation to an XElement.
C#
public class MyAnnotation { private string tag; public string Tag {get{return tag;} set{tag=value;}} public MyAnnotation(string tag) { this.tag = tag; } } public class Program { public static void Main(string[] args) { MyAnnotation ma = new MyAnnotation("T1"); XElement root = new XElement("Root", "content"); root.AddAnnotation(ma); MyAnnotation ma2 = (MyAnnotation)root.Annotation<MyAnnotation>(); Console.WriteLine(ma2.Tag); } }
Visual Basic
Public Class MyAnnotation Private _tag As String Property Tag() As String Get Return Me._tag End Get Set(ByVal Value As String) Me._tag = Value End Set End Property Public Sub New(ByVal tag As String) Me._tag = tag End Sub End Class Module Module1 Sub Main() Dim ma As MyAnnotation = New MyAnnotation("T1") Dim root As XElement = <Root>content</Root> root.AddAnnotation(ma) Dim ma2 As MyAnnotation = DirectCast(root.Annotation(Of MyAnnotation)(), MyAnnotation) Console.WriteLine(ma2.Tag) End Sub End Module
This example produces the following output:
T1
Version Information
.NET Framework
Supported in: 4, 3.5.NET Framework Client Profile
Supported in: 4, 3.5 SP1Platforms
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
See Also