Article
11/18/2011

XObject.AddAnnotation Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Adds an object to the annotation list of this XObject.

Namespace: System.Xml.Linq
Assembly: System.Xml.Linq (in System.Xml.Linq.dll)

Syntax

'Declaration
Public Sub AddAnnotation ( _
    annotation As Object _
)

public void AddAnnotation(
    Object annotation
)

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 class is used in the example below:

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

public class MyAnnotation
{
    private string tag;
    public string Tag { get { return tag; } set { tag = value; } }
    public MyAnnotation(string tag)
    {
        this.tag = tag;
    }
}

The following example adds an annotation to an XElement.

Dim output As New StringBuilder
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)
output.Append(ma2.Tag)
output.Append(Environment.NewLine)

OutputTextBlock.Text = output.ToString()

StringBuilder output = new StringBuilder();
MyAnnotation ma = new MyAnnotation("T1");
XElement root = new XElement("Root", "content");
root.AddAnnotation(ma);

MyAnnotation ma2 = (MyAnnotation)root.Annotation<MyAnnotation>();
output.Append(ma2.Tag + Environment.NewLine);


OutputTextBlock.Text = output.ToString();

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Share via