XObject.Annotation<T> Method
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Get the first annotation object of the specified type from this XObject.
Namespace: System.Xml.Linq
Assembly: System.Xml.Linq (in System.Xml.Linq.dll)
Syntax
'Declaration
Public Function Annotation(Of T As Class) As T
public T Annotation<T>()
where T : class
Type Parameters
- T
The type of the annotation to retrieve.
Return Value
Type: T
The first annotation object that matches the specified type, or nulla null reference (Nothing in Visual Basic) if no annotation is of the specified type.
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 element, and then retrieves it through this method.
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 = root.Annotation(Of 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 = 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.
See Also