AnnotationCollection Class

Applies To: SQL Server (starting with 2016)

Contains a collection of Annotation objects. This class cannot be inherited.

Namespace:   Microsoft.AnalysisServices
Assembly:  Microsoft.AnalysisServices.Core (in Microsoft.AnalysisServices.Core.dll)

Inheritance Hierarchy

System.Object
  Microsoft.AnalysisServices.AnnotationCollection

Syntax

[GuidAttribute("660FA3D1-97B1-4c33-86AF-8F4381D4317E")]
public sealed class AnnotationCollection : IList, ICollection, 
    IEnumerable

[GuidAttribute("660FA3D1-97B1-4c33-86AF-8F4381D4317E")]
public ref class AnnotationCollection sealed : IList, ICollection, 
    IEnumerable

[<Sealed>]
[<GuidAttribute("660FA3D1-97B1-4c33-86AF-8F4381D4317E")>]
type AnnotationCollection = 
    class
        interface IList
        interface ICollection
        interface IEnumerable
    end

<GuidAttribute("660FA3D1-97B1-4c33-86AF-8F4381D4317E")>
Public NotInheritable Class AnnotationCollection
    Implements IList, ICollection, IEnumerable

Constructors

	Name	Description
	AnnotationCollection()	Initializes a new instance of Annotation.

Properties

	Name	Description
	Count	Gets the number of Annotation objects contained in the collection.
	Item[Int32]	Gets the Annotation at the specified index from the collection.
	Item[String]	Gets the Annotation, with the specified name, from the collection.

Methods

	Name	Description
	Add(Annotation)	Adds an Annotation to the end of the collection.
	Add(String, String)	Creates and adds an Annotation, with the specified name and value, to the end of the collection.
	Clear()	Removes all elements from the collection.
	Contains(Annotation)	Indicates whether the collection contains a specified Annotation.
	Contains(String)	Indicates whether the collection contains an Annotation with the specified name.
	CopyTo(AnnotationCollection)	Copies the entire collection to the end of an AnnotationCollection.
	CopyTo(Array, Int32)	Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array.
	Equals(Object)	(Inherited from Object.)
	Find(String)	Gets the Annotation, with the specified name, from the collection.
	GetHashCode()	(Inherited from Object.)
	GetText(String)	Gets the value of the Annotation, with the specified name.
	GetType()	(Inherited from Object.)
	IndexOf(Annotation)	Gets the index of a specified Annotation.
	IndexOf(String)	Gets the index of an Annotation with the specified name.
	Insert(Int32, Annotation)	Inserts an Annotation into the collection at the specified index.
	Insert(Int32, String, String)	Creates and inserts an Annotation, with the specified name and value, into the collection at the specified index.
	Remove(Annotation)	Removes the specified Annotation from the collection.
	Remove(String)	Removes the Annotation, with the specified name, from the collection.
	RemoveAt(Int32)	Removes the Annotation at the specified index from the collection.
	SetText(String, Boolean)	Sets the Annotation, with the specified name, to a specified Boolean value.
	SetText(String, Int32)	Sets the Annotation, with the specified name, to a specified Int32 value.
	SetText(String, String)	Sets the Annotation, with the specified name, to a specified String value.
	SetText(String, String, Boolean)	Sets the Annotation, with the specified name, to a specified String value. Can also be used to remove a named annotation if it is set to a null reference.
	ToString()	(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.
	IList.Add(Object)	Adds an item to the collection.
	IList.Contains(Object)	Determines whether the collection contains a specific value.
	IList.IndexOf(Object)	Determines the index of the specific item in the collection.
	IList.Insert(Int32, Object)	Inserts an item to the collection at the specified index.
	IList.Remove(Object)	Removes the first occurrence of a specific object from the collection.
	ICollection.IsSynchronized
	ICollection.SyncRoot
	IList.IsFixedSize
	IList.IsReadOnly
	IList.Item[Int32]

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.AnalysisServices Namespace

Return to top