AnnotationCollection Class

Article
04/26/2013

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

Inheritance Hierarchy

System.Object
Microsoft.AnalysisServices.AnnotationCollection

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

Syntax

'Declaration
<GuidAttribute("660FA3D1-97B1-4c33-86AF-8F4381D4317E")> _
Public NotInheritable Class AnnotationCollection _
    Implements IList, ICollection, IEnumerable
'Usage
Dim instance As AnnotationCollection

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

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

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

public final class AnnotationCollection implements IList, ICollection, IEnumerable

The AnnotationCollection type exposes the following members.

Constructors

	Name	Description
	AnnotationCollection	Initializes a new instance of Annotation.

Top

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.

Top

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(String)	Indicates whether the collection contains an Annotation with the specified name.
	Contains(Annotation)	Indicates whether the collection contains a specified Annotation.
	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	(Inherited from Object.)
	Find	Gets the Annotation, with the specified name, from the collection.
	GetHashCode	(Inherited from Object.)
	GetText	Gets the value of the Annotation, with the specified name.
	GetType	(Inherited from Object.)
	IndexOf(String)	Gets the index of an Annotation with the specified name.
	IndexOf(Annotation)	Gets the index of a specified Annotation.
	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(String)	Removes the Annotation, with the specified name, from the collection.
	Remove(Annotation)	Removes the specified Annotation from the collection.
	RemoveAt	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.)

Top

Explicit Interface Implementations

	Name	Description
	IList.Add	Adds an item to the collection.
	IList.Contains	Determines whether the collection contains a specific value.
	IEnumerable.GetEnumerator	Returns an enumerator that iterates through a collection.
	IList.IndexOf	Determines the index of the specific item in the collection.
	IList.Insert	Inserts an item to the collection at the specified index.
	IList.IsFixedSize	Gets a value that indicates whether the collection is of fixed size.
	IList.IsReadOnly	Gets a value that indicates whether the AnnotationCollection is read-only.
	ICollection.IsSynchronized	Gets a value that indicates whether access to the collection is synchronized (thread safe).
	IList.Item	Gets the element at the specified index.
	IList.Remove	Removes the first occurrence of a specific object from the collection.
	ICollection.SyncRoot	Gets an object that can be used to synchronize access to the collection.