AggregationInstanceCollection Class

Article
04/26/2013

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

Inheritance Hierarchy

System.Object
  Microsoft.AnalysisServices.ModelComponentCollection
    Microsoft.AnalysisServices.NamedComponentCollection
      Microsoft.AnalysisServices.AggregationInstanceCollection

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

Syntax

'Declaration
<GuidAttribute("3693796F-221D-496f-9A16-79CDE61E9430")> _
Public NotInheritable Class AggregationInstanceCollection _
    Inherits NamedComponentCollection
'Usage
Dim instance As AggregationInstanceCollection

[GuidAttribute("3693796F-221D-496f-9A16-79CDE61E9430")]
public sealed class AggregationInstanceCollection : NamedComponentCollection

[GuidAttribute(L"3693796F-221D-496f-9A16-79CDE61E9430")]
public ref class AggregationInstanceCollection sealed : public NamedComponentCollection

[<SealedAttribute>]
[<GuidAttribute("3693796F-221D-496f-9A16-79CDE61E9430")>]
type AggregationInstanceCollection =  
    class 
        inherit NamedComponentCollection 
    end

public final class AggregationInstanceCollection extends NamedComponentCollection

The AggregationInstanceCollection type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of ModelComponent objects in the ModelComponentCollection. (Inherited from ModelComponentCollection.)
	IsFixedSize	Gets a value indicating whether the ModelComponentCollection has a fixed size. (Inherited from ModelComponentCollection.)
	IsReadOnly	Gets a value indicating whether the ModelComponentCollection is read-only. (Inherited from ModelComponentCollection.)
	IsSynchronized	Gets a value indicating whether access to the ModelComponentCollection is synchronized (thread-safe). (Inherited from ModelComponentCollection.)
	Item[Int32]	Gets the AggregationInstance, at the specified index, from the collection.
	Item[String]	Gets the AggregationInstance, with the specified identifier, from the collection.
	Parent	Gets the IModelComponent that contains the ModelComponentCollection. (Inherited from ModelComponentCollection.)
	SyncRoot	Gets an object that can be used to synchronize access to the ModelComponentCollection. (Inherited from ModelComponentCollection.)

Top

Methods

	Name	Description
	Add()	Creates and adds an AggregationInstance to the end of the collection.
	Add(String)	Creates and adds an AggregationInstance, with the specified identifier, to the end of the collection.
	Add(AggregationInstance)	Adds an AggregationInstance to the end of the collection.
	Add(ModelComponent)	Infrastructure. Adds a ModelComponent object to the NamedComponentCollection. (Inherited from NamedComponentCollection.)
	Add(String, String)	Creates and adds an AggregationInstance, with the specified name and identifier, to the end of the collection.
	Add(ModelComponent, Boolean)	Infrastructure. Adds a ModelComponent object to the ModelComponentCollection. (Inherited from ModelComponentCollection.)
	CanAdd	Infrastructure. Indicates whether the collection can add a ModelComponent. (Inherited from NamedComponentCollection.)
	ChangeKey	Infrastructure. Changes the specified keys to the collection. (Inherited from ModelComponentCollection.)
	Clear	Removes all elements from the ModelComponentCollection. (Inherited from ModelComponentCollection.)
	Contains(String)	Indicates whether the collection contains an AggregationInstance with the specified identifier.
	Contains(AggregationInstance)	Checks whether the collection contains the specified AggregationInstance.
	ContainsName	Indicates whether the component contains its name. (Inherited from NamedComponentCollection.)
	CopyTo	Copies the entire ModelComponentCollection to a one-dimensional Array, starting at the specified index of the target array. (Inherited from ModelComponentCollection.)
	Equals	(Inherited from Object.)
	Find	Gets the AggregationInstance, with the specified identifier, from the collection.
	FindByName	Gets the AggregationInstance, with the specified name, from the collection.
	GetByName	Gets the AggregationInstance, with the specified name, from the collection.
	GetEnumerator	Returns an enumerator that can iterate through the ModelComponentCollection. (Inherited from ModelComponentCollection.)
	GetHashCode	(Inherited from Object.)
	GetNewID()	Gets a new unique ID for the component. (Inherited from NamedComponentCollection.)
	GetNewID(String)	Gets the value for the new unique ID. (Inherited from NamedComponentCollection.)
	GetNewName()	Gets a unique new name for the component. (Inherited from NamedComponentCollection.)
	GetNewName(String)	Gets a unique new name for the component with the specified name prefix. (Inherited from NamedComponentCollection.)
	GetType	(Inherited from Object.)
	IndexOf(String)	Gets the index of an AggregationInstance with the specified identifier.
	IndexOf(AggregationInstance)	Gets the index of a specified AggregationInstance.
	IndexOfName	Gets the index of the NamedComponent, identified by name, in the collection. (Inherited from NamedComponentCollection.)
	Insert(Int32)	Creates and inserts an AggregationInstance into the collection at the specified index.
	Insert(Int32, AggregationInstance)	Inserts an AggregationInstance into the collection at the specified index.
	Insert(Int32, String)	Creates and inserts an AggregationInstance, with the specified identifier, into the collection at the specified index.
	Insert(Int32, ModelComponent)	Infrastructure. Inserts a ModelComponent in the NamedComponentCollection. (Inherited from NamedComponentCollection.)
	Insert(Int32, String, String)	Creates and inserts an AggregationInstance, with the specified name and identifier, into the collection at the specified index.
	IsValidID(String)	Determines whether the named component collection identifier is valid. (Inherited from NamedComponentCollection.)
	IsValidID(String, String%)	Determines whether the named component collection identifier is valid. (Inherited from NamedComponentCollection.)
	IsValidName(String)	Determines whether the named component collection name is valid. (Inherited from NamedComponentCollection.)
	IsValidName(String, String%)	Determines whether the named component collection name is valid. (Inherited from NamedComponentCollection.)
	IsValidName(String, Type, ModelType, Int32, String%)	(Inherited from NamedComponentCollection.)
	Move(Int32, Int32)	Moves an AggregationInstance at the current specified index to a new specified index in the collection.
	Move(String, Int32)	Moves an AggregationInstance, with the specified identifier, to the specified index in the collection.
	Move(AggregationInstance, Int32)	Moves an AggregationInstance to a new index in the collection.
	Remove(String)	Removes the AggregationInstance, with the specified identifier, from the collection.
	Remove(AggregationInstance)	Removes the specified AggregationInstance from the collection.
	Remove(IModelComponent)	Removes the specified IModelComponent from the collection. (Inherited from ModelComponentCollection.)
	Remove(String, Boolean)	Removes the AggregationInstance from the collection and optionally deletes the referencing objects.
	Remove(AggregationInstance, Boolean)	Removes the specified AggregationInstance from the collection and optionally deletes the referencing objects.
	RemoveAt(Int32)	Removes the IModelComponent at the specified index from the ModelComponentCollection. (Inherited from ModelComponentCollection.)
	RemoveAt(Int32, Boolean)	Infrastructure. Removes the IModelComponent at the specified index from the ModelComponentCollection. (Inherited from ModelComponentCollection.)
	ToString	(Inherited from Object.)

Top

Events

	Name	Description
	CollectionChanged	Infrastructure. Occurs when the collection changes. (Inherited from ModelComponentCollection.)
	CollectionChanging	Infrastructure. Occurs when the collection is changing. (Inherited from ModelComponentCollection.)

Top

Explicit Interface Implementations

	Name	Description
	IList.Add	Adds an item to the collection. (Inherited from ModelComponentCollection.)
	IList.Clear	Removes all items from the collection. (Inherited from ModelComponentCollection.)
	IList.Contains	Indicates whether the collection contains a specific value. (Inherited from ModelComponentCollection.)
	IList.IndexOf	Determines the index of a specific item in the collection. (Inherited from ModelComponentCollection.)
	IList.Insert	Inserts an item to the collection at the specified index. (Inherited from ModelComponentCollection.)
	IList.Item	Gets or sets the element at the specified index. (Inherited from ModelComponentCollection.)
	IList.Remove	Removes the first occurrence of a specified object from the collection. (Inherited from ModelComponentCollection.)
	IList.RemoveAt	Removes the item at the specified index. (Inherited from ModelComponentCollection.)
	IModelComponentCollection.Contains	Indicates whether the collection contains a specific value. (Inherited from ModelComponentCollection.)
	IModelComponentCollection.Remove(IModelComponent)	Removes the first occurrence of a specific IModelComponent from the ModelComponentCollection. (Inherited from ModelComponentCollection.)
	IModelComponentCollection.Remove(IModelComponent, Boolean)	Removes the first occurrence of a specific IModelComponent from the ModelComponentCollection. (Inherited from ModelComponentCollection.)
	IOnDemandLoadableCollection.BlockOnDemandLoad	Specifies the blocked demand load. (Inherited from ModelComponentCollection.)
	IOnDemandLoadableCollection.Loaded	Gets or sets a value that indicates whether the collection is loaded. (Inherited from ModelComponentCollection.)