• Article

AnnotationCollection Class

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
Public method AnnotationCollection Initializes a new instance of Annotation.

Top

Properties

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

Top

Methods

  Name Description
Public method Add(Annotation) Adds an Annotation to the end of the collection.
Public method Add(String, String) Creates and adds an Annotation, with the specified name and value, to the end of the collection.
Public method Clear Removes all elements from the collection.
Public method Contains(String) Indicates whether the collection contains an Annotation with the specified name.
Public method Contains(Annotation) Indicates whether the collection contains a specified Annotation.
Public method CopyTo(AnnotationCollection) Copies the entire collection to the end of an AnnotationCollection.
Public method CopyTo(Array, Int32) Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method Find Gets the Annotation, with the specified name, from the collection.
Public method GetHashCode (Inherited from Object.)
Public method GetText Gets the value of the Annotation, with the specified name.
Public method GetType (Inherited from Object.)
Public method IndexOf(String) Gets the index of an Annotation with the specified name.
Public method IndexOf(Annotation) Gets the index of a specified Annotation.
Public method Insert(Int32, Annotation) Inserts an Annotation into the collection at the specified index.
Public method Insert(Int32, String, String) Creates and inserts an Annotation, with the specified name and value, into the collection at the specified index.
Protected method MemberwiseClone (Inherited from Object.)
Public method Remove(String) Removes the Annotation, with the specified name, from the collection.
Public method Remove(Annotation) Removes the specified Annotation from the collection.
Public method RemoveAt Removes the Annotation at the specified index from the collection.
Public method SetText(String, Boolean) Sets the Annotation, with the specified name, to a specified Boolean value.
Public method SetText(String, Int32) Sets the Annotation, with the specified name, to a specified Int32 value.
Public method SetText(String, String) Sets the Annotation, with the specified name, to a specified String value.
Public method 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.
Public method ToString (Inherited from Object.)

Top

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.