XObject.Annotations(Of T) Method

Gets a collection of annotations of the specified type for this XObject.

Namespace:  System.Xml.Linq
Assemblies:   System.Xml.Linq (in System.Xml.Linq.dll)
  System.Xml.XDocument (in System.Xml.XDocument.dll)

'Declaration
Public Function Annotations(Of T As Class) As IEnumerable(Of T)

Type Parameters

T

The type of the annotations to retrieve.

Return Value

Type: System.Collections.Generic.IEnumerable(Of T)
An IEnumerable(Of T) that contains the annotations for this XObject.

The following example uses this method to retrieve annotations on an element.

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 root As XElement = <Root>content</Root>
        root.AddAnnotation(New MyAnnotation("T1"))
        root.AddAnnotation(New MyAnnotation("T2"))
        root.AddAnnotation("abc")
        root.AddAnnotation("def")

        Dim annotationList As IEnumerable(Of MyAnnotation)
        annotationList = root.Annotations(Of MyAnnotation)()
        For Each ma As MyAnnotation In annotationList
            Console.WriteLine(ma.Tag)
        Next
        Console.WriteLine("----")

        Dim stringAnnotationList As IEnumerable(Of String)
        stringAnnotationList = root.Annotations(Of String)()
        For Each str As String In stringAnnotationList
            Console.WriteLine(str)
        Next
    End Sub
End Module

This example produces the following output:

T1
T2
----
abc
def

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft