XObject.RemoveAnnotations Method

Definition

Namespace:

System.Xml.Linq

Assembly:

System.Xml.XDocument.dll

Overloads

RemoveAnnotations(Type)	Removes the annotations of the specified type from this XObject.
RemoveAnnotations<T>()	Removes the annotations of the specified type from this XObject.

RemoveAnnotations(Type)

Source:

XObject.cs

Removes the annotations of the specified type from this XObject.

public:
 void RemoveAnnotations(Type ^ type);

public void RemoveAnnotations (Type type);

member this.RemoveAnnotations : Type -> unit

Public Sub RemoveAnnotations (type As Type)

Parameters

type

Type

The type of annotations to remove.

Examples

The following example creates an element with four annotations on it. It then uses this method to remove two of them.

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

class Program  
{  
    static void Main(string[] args)  
    {     
        XElement root = new XElement("Root", "content");  
        root.AddAnnotation(new MyAnnotation("T1"));  
        root.AddAnnotation(new MyAnnotation("T2"));  
        root.AddAnnotation("abc");  
        root.AddAnnotation("def");  

        Console.WriteLine("Count before removing: {0}", root.Annotations<object>().Count());  
        root.RemoveAnnotations(typeof(MyAnnotation));  
        Console.WriteLine("Count after removing: {0}", root.Annotations<object>().Count());  
    }  
}  

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")  

        Console.WriteLine("Count before removing: {0}", root.Annotations(Of Object)().Count())  
        root.RemoveAnnotations(GetType(MyAnnotation))  
        Console.WriteLine("Count after removing: {0}", root.Annotations(Of Object)().Count())  
    End Sub  
End Module  

This example produces the following output:

Count before removing: 4  
Count after removing: 2  

See also

• LINQ to XML overview

RemoveAnnotations<T>()

Source:

XObject.cs

Removes the annotations of the specified type from this XObject.

public:
generic <typename T>
 where T : class void RemoveAnnotations();

public void RemoveAnnotations<T> () where T : class;

member this.RemoveAnnotations : unit -> unit (requires 'T : null)

Public Sub RemoveAnnotations(Of T As Class) ()

Type Parameters

T

The type of annotations to remove.

Examples

The following example creates an element with four annotations on it. It then uses this method to remove two of them.

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

class Program {  
    static void Main(string[] args) {     
        XElement root = new XElement("Root", "content");  
        root.AddAnnotation(new MyAnnotation("T1"));  
        root.AddAnnotation(new MyAnnotation("T2"));  
        root.AddAnnotation("abc");  
        root.AddAnnotation("def");  

        Console.WriteLine("Count before removing: {0}", root.Annotations<object>().Count());  
        root.RemoveAnnotations<MyAnnotation>();  
        Console.WriteLine("Count after removing: {0}", root.Annotations<object>().Count());  
    }  
}  

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")  

        Console.WriteLine("Count before removing: {0}", root.Annotations(Of Object)().Count())  
        root.RemoveAnnotations(Of MyAnnotation)()  
        Console.WriteLine("Count after removing: {0}", root.Annotations(Of Object)().Count())  
    End Sub  
End Module  

This example produces the following output:

Count before removing: 4  
Count after removing: 2  

See also

• LINQ to XML overview