ModelComponentCollection Class

 

Applies To: SQL Server (starting with 2016)

Contains a collection of ModelComponent objects.

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

Inheritance Hierarchy

System.Object
  Microsoft.AnalysisServices.ModelComponentCollection
    Microsoft.AnalysisServices.AccountCollection
    Microsoft.AnalysisServices.AggregationAttributeCollection
    Microsoft.AnalysisServices.AggregationDesignAttributeCollection
    Microsoft.AnalysisServices.AggregationDesignDimensionCollection
    Microsoft.AnalysisServices.AggregationDimensionCollection
    Microsoft.AnalysisServices.AggregationInstanceAttributeCollection
    Microsoft.AnalysisServices.AggregationInstanceDimensionCollection
    Microsoft.AnalysisServices.AggregationInstanceMeasureCollection
    Microsoft.AnalysisServices.AttributePermissionCollection
    Microsoft.AnalysisServices.AttributeRelationshipCollection
    Microsoft.AnalysisServices.CalculationPropertyCollection
    Microsoft.AnalysisServices.CellPermissionCollection
    Microsoft.AnalysisServices.CubeAttributeCollection
    Microsoft.AnalysisServices.CubeDimensionPermissionCollection
    Microsoft.AnalysisServices.CubeHierarchyCollection
    Microsoft.AnalysisServices.MeasureGroupAttributeCollection
    Microsoft.AnalysisServices.MeasureGroupDimensionCollection
    Microsoft.AnalysisServices.NamedComponentCollection
    Microsoft.AnalysisServices.PerspectiveActionCollection
    Microsoft.AnalysisServices.PerspectiveAttributeCollection
    Microsoft.AnalysisServices.PerspectiveCalculationCollection
    Microsoft.AnalysisServices.PerspectiveDimensionCollection
    Microsoft.AnalysisServices.PerspectiveHierarchyCollection
    Microsoft.AnalysisServices.PerspectiveKpiCollection
    Microsoft.AnalysisServices.PerspectiveMeasureCollection
    Microsoft.AnalysisServices.PerspectiveMeasureGroupCollection
    Microsoft.AnalysisServices.RelationshipCollection
    Microsoft.AnalysisServices.RelationshipEndAttributeCollection
    Microsoft.AnalysisServices.TranslationCollection

Syntax

[GuidAttribute("74BB3312-550A-4f1f-BECF-80422AC163C6")]
public abstract class ModelComponentCollection : IModelComponentCollection, 
    IList, ICollection, IEnumerable, IOnDemandLoadableCollection
[GuidAttribute("74BB3312-550A-4f1f-BECF-80422AC163C6")]
public ref class ModelComponentCollection abstract : IModelComponentCollection, 
    IList, ICollection, IEnumerable, IOnDemandLoadableCollection
[<AbstractClass>]
[<GuidAttribute("74BB3312-550A-4f1f-BECF-80422AC163C6")>]
type ModelComponentCollection = 
    class
        interface IModelComponentCollection
        interface IList
        interface ICollection
        interface IEnumerable
        interface IOnDemandLoadableCollection
    end
<GuidAttribute("74BB3312-550A-4f1f-BECF-80422AC163C6")>
Public MustInherit Class ModelComponentCollection
    Implements IModelComponentCollection, IList, ICollection, IEnumerable,
    IOnDemandLoadableCollection

Constructors

Name Description
System_CAPS_protmethod ModelComponentCollection(IModelComponent)

Initializes a new instance of the ModelComponentCollection class.

Properties

Name Description
System_CAPS_pubproperty Count

Gets the number of ModelComponent objects in the ModelComponentCollection.

System_CAPS_protproperty DemandLoadingService

Gets the demand loading service for the collection.

System_CAPS_pubproperty IsFixedSize

Gets a value indicating whether the ModelComponentCollection has a fixed size.

System_CAPS_pubproperty IsReadOnly

Gets a value indicating whether the ModelComponentCollection is read-only.

System_CAPS_pubproperty IsSynchronized

Gets a value indicating whether access to the ModelComponentCollection is synchronized (thread-safe).

System_CAPS_protproperty Item[Int32]

Gets the IModelComponent at the specified index.

System_CAPS_protproperty ItemsType

Gets the Type of objects that can be contained by the ModelComponentCollection.

System_CAPS_pubproperty Parent

Gets the IModelComponent that contains the ModelComponentCollection.

System_CAPS_protproperty Preloadable

Gets a value indicating whether the collection can be preloaded.

System_CAPS_pubproperty SyncRoot

Gets an object that can be used to synchronize access to the ModelComponentCollection.

Methods

Name Description
System_CAPS_protmethod Add(ModelComponent)

Adds a ModelComponent object to the ModelComponentCollection.

System_CAPS_protmethod Add(ModelComponent, Boolean)

Adds a ModelComponent object to the ModelComponentCollection.

System_CAPS_protmethod Add(String, IModelComponent)

Adds a IModelComponent object to the ModelComponentCollection.

System_CAPS_protmethod Add(String, IModelComponent, Boolean)

Adds a IModelComponent object to the ModelComponentCollection.

System_CAPS_protmethod AddNew(String, String, Type)

Adds a new IModelComponent to the collection.

System_CAPS_protmethod AddNew(String, Type)

Adds a new IModelComponent to the collection.

System_CAPS_pubmethod CanAdd(ModelComponent, String)

Indicates whether the collection can add a ModelComponent.

System_CAPS_protmethod ChangeKey(String, String)

Changes the specified keys to the collection.

System_CAPS_pubmethod Clear()

Removes all elements from the ModelComponentCollection.

System_CAPS_protmethod Contains(IModelComponent)

Determines whether the specified item is in the collection.

System_CAPS_protmethod Contains(String)

Determines whether an item with the specified key is in the ModelComponentCollection.

System_CAPS_pubmethod CopyTo(Array, Int32)

Copies the entire ModelComponentCollection to a one-dimensional Array, starting at the specified index of the target array.

System_CAPS_protmethod EnsureLoaded()

Ensures the collection is loaded.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetEnumerator()

Returns an enumerator that can iterate through the ModelComponentCollection.

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_protmethod GetItem(String, Boolean, String)

Gets a reference to the specified component.

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod IndexOf(IModelComponent)

Searches for the specified item and returns its zero-based index within the collection.

System_CAPS_protmethod IndexOf(String)

Returns the zero-based index of the first occurrence of an IModelComponent that has the specified key in the ModelComponentCollection.

System_CAPS_protmethod Insert(IModelComponent, String, Int32)

Inserts an IModelComponent in the ModelComponentCollection.

System_CAPS_protmethod Insert(IModelComponent, String, Int32, Boolean)

Inserts an IModelComponent in the ModelComponentCollection.

System_CAPS_protmethod Insert(Int32, ModelComponent)

Inserts an ModelComponent in the ModelComponentCollection.

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethod Remove(IModelComponent)

Removes the specified IModelComponent from the collection.

System_CAPS_pubmethod RemoveAt(Int32)

Removes the IModelComponent at the specified index from the ModelComponentCollection.

System_CAPS_pubmethod RemoveAt(Int32, Boolean)

Removes the IModelComponent at the specified index from the ModelComponentCollection.

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Events

Name Description
System_CAPS_pubevent CollectionChanged

Occurs when the collection changes.

System_CAPS_pubevent CollectionChanging

Occurs when the collection is changing.

Explicit Interface Implementations

Name Description
System_CAPS_pubinterfaceSystem_CAPS_privmethod IOnDemandLoadableCollection.BlockOnDemandLoad(Boolean)

Specifies the blocked demand load.

System_CAPS_pubinterfaceSystem_CAPS_privmethod IModelComponentCollection.Contains(IModelComponent)

Indicates whether the collection contains a specific value.

System_CAPS_pubinterfaceSystem_CAPS_privmethod IModelComponentCollection.Remove(IModelComponent)

Removes the first occurrence of a specific IModelComponent from the ModelComponentCollection.

System_CAPS_pubinterfaceSystem_CAPS_privmethod IModelComponentCollection.Remove(IModelComponent, Boolean)

Removes the first occurrence of a specific IModelComponent from the ModelComponentCollection.

System_CAPS_pubinterfaceSystem_CAPS_privmethod IList.Add(Object)

Adds an item to the collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethod IList.Clear()

Removes all items from the collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethod IList.Contains(Object)

Indicates whether the collection contains a specific value.

System_CAPS_pubinterfaceSystem_CAPS_privmethod IList.IndexOf(Object)

Determines the index of a specific item in the collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethod IList.Insert(Int32, Object)

Inserts an item to the collection at the specified index.

System_CAPS_pubinterfaceSystem_CAPS_privmethod IList.Remove(Object)

Removes the first occurrence of a specified object from the collection.

System_CAPS_pubinterfaceSystem_CAPS_privmethod IList.RemoveAt(Int32)

Removes the item at the specified index.

System_CAPS_pubinterfaceSystem_CAPS_privproperty IOnDemandLoadableCollection.Loaded

System_CAPS_pubinterfaceSystem_CAPS_privproperty 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