NamedComponentCollection Class

 

Applies To: SQL Server (starting with 2016)

Contains a collection of INamedComponent objects.

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

Inheritance Hierarchy

System.Object
  Microsoft.AnalysisServices.ModelComponentCollection
    Microsoft.AnalysisServices.NamedComponentCollection
      Microsoft.AnalysisServices.ActionCollection
      Microsoft.AnalysisServices.AggregationCollection
      Microsoft.AnalysisServices.AggregationInstanceCollection
      Microsoft.AnalysisServices.CubeDimensionCollection
      Microsoft.AnalysisServices.DimensionAttributeCollection
      Microsoft.AnalysisServices.HierarchyCollection
      Microsoft.AnalysisServices.KpiCollection
      Microsoft.AnalysisServices.LevelCollection
      Microsoft.AnalysisServices.MajorObjectCollection
      Microsoft.AnalysisServices.MeasureCollection
      Microsoft.AnalysisServices.MiningModelColumnCollection
      Microsoft.AnalysisServices.MiningStructureColumnCollection

Syntax

[GuidAttribute("4CF930A2-FED5-48c0-AC50-DD4FBDA3E6A8")]
public abstract class NamedComponentCollection : ModelComponentCollection, 
    INamedComponentCollection, IModelComponentCollection, ICollection, 
    IEnumerable
[GuidAttribute("4CF930A2-FED5-48c0-AC50-DD4FBDA3E6A8")]
public ref class NamedComponentCollection abstract : ModelComponentCollection, 
    INamedComponentCollection, IModelComponentCollection, ICollection, 
    IEnumerable
[<AbstractClass>]
[<GuidAttribute("4CF930A2-FED5-48c0-AC50-DD4FBDA3E6A8")>]
type NamedComponentCollection = 
    class
        inherit ModelComponentCollection
        interface INamedComponentCollection
        interface IModelComponentCollection
        interface ICollection
        interface IEnumerable
    end
<GuidAttribute("4CF930A2-FED5-48c0-AC50-DD4FBDA3E6A8")>
Public MustInherit Class NamedComponentCollection
    Inherits ModelComponentCollection
    Implements INamedComponentCollection, IModelComponentCollection,
    ICollection, IEnumerable

Constructors

Name Description
System_CAPS_protmethod NamedComponentCollection(IModelComponent)

Initializes a new instance of the NamedComponentCollection class.

Properties

Name Description
System_CAPS_pubproperty Count

Gets the number of ModelComponent objects in the ModelComponentCollection.(Inherited from ModelComponentCollection.)

System_CAPS_protproperty DemandLoadingService

Gets the demand loading service for the collection.(Inherited from ModelComponentCollection.)

System_CAPS_pubproperty IsFixedSize

Gets a value indicating whether the ModelComponentCollection has a fixed size.(Inherited from ModelComponentCollection.)

System_CAPS_pubproperty IsReadOnly

Gets a value indicating whether the ModelComponentCollection is read-only.(Inherited from ModelComponentCollection.)

System_CAPS_pubproperty IsSynchronized

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

System_CAPS_protproperty Item[Int32]

Gets the IModelComponent at the specified index.(Inherited from ModelComponentCollection.)

System_CAPS_protproperty ItemsType

Gets the Type of objects that can be contained by the ModelComponentCollection.(Inherited from ModelComponentCollection.)

System_CAPS_pubproperty Parent

Gets the IModelComponent that contains the ModelComponentCollection.(Inherited from ModelComponentCollection.)

System_CAPS_protproperty Preloadable

Gets a value indicating whether the collection can be preloaded.(Inherited from ModelComponentCollection.)

System_CAPS_pubproperty SyncRoot

Gets an object that can be used to synchronize access to the ModelComponentCollection.(Inherited from ModelComponentCollection.)

Methods

Name Description
System_CAPS_protmethod Add(ModelComponent)

Adds a ModelComponent object to the NamedComponentCollection.(Overrides ModelComponentCollection.Add(ModelComponent).)

System_CAPS_protmethod Add(ModelComponent, Boolean)

Adds a ModelComponent object to the ModelComponentCollection.(Inherited from ModelComponentCollection.)

System_CAPS_protmethod Add(String, IModelComponent)

Adds a IModelComponent object to the ModelComponentCollection.(Inherited from ModelComponentCollection.)

System_CAPS_protmethod Add(String, IModelComponent, Boolean)

Adds a IModelComponent object to the ModelComponentCollection.(Inherited from ModelComponentCollection.)

System_CAPS_protmethod AddNew(String, String, Type)

Adds a new IModelComponent to the collection.(Inherited from ModelComponentCollection.)

System_CAPS_protmethod AddNew(String, Type)

Adds a new IModelComponent to the collection.(Inherited from ModelComponentCollection.)

System_CAPS_pubmethod CanAdd(ModelComponent, String)

Indicates whether the collection can add a ModelComponent.(Overrides ModelComponentCollection.CanAdd(ModelComponent, String).)

System_CAPS_protmethod ChangeKey(String, String)

Changes the specified keys to the collection.(Inherited from ModelComponentCollection.)

System_CAPS_pubmethod Clear()

Removes all elements from the ModelComponentCollection.(Inherited from ModelComponentCollection.)

System_CAPS_protmethod Contains(IModelComponent)

Determines whether the specified item is in the collection.(Inherited from ModelComponentCollection.)

System_CAPS_pubmethod Contains(String)

Determines whether an item with the specific key is in the NamedComponentCollection.

System_CAPS_pubmethod ContainsName(String)

Indicates whether the component contains its name.

System_CAPS_pubmethod CopyTo(Array, Int32)

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

System_CAPS_protmethod EnsureLoaded()

Ensures the collection is loaded.(Inherited from ModelComponentCollection.)

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.(Inherited from ModelComponentCollection.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_protmethod GetItem(String, Boolean, String)

Gets a reference to the specified component.(Inherited from ModelComponentCollection.)

System_CAPS_pubmethod GetNewID()

Gets a new unique ID for the component.

System_CAPS_pubmethod GetNewID(String)

Gets the value for the new unique ID.

System_CAPS_pubmethod GetNewName()

Gets a unique new name for the component.

System_CAPS_pubmethod GetNewName(String)

Gets a unique new name for the component with the specified name prefix.

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.(Inherited from ModelComponentCollection.)

System_CAPS_pubmethod IndexOf(String)

Reports the index of the first occurrence of the component.

System_CAPS_pubmethod IndexOfName(String)

Gets the index of the NamedComponent, identified by name, in the collection.

System_CAPS_protmethod Insert(IModelComponent, String, Int32)

Inserts an IModelComponent in the ModelComponentCollection.(Inherited from ModelComponentCollection.)

System_CAPS_protmethod Insert(IModelComponent, String, Int32, Boolean)

Inserts an IModelComponent in the ModelComponentCollection.(Inherited from ModelComponentCollection.)

System_CAPS_protmethod Insert(Int32, ModelComponent)

Inserts a ModelComponent in the NamedComponentCollection.(Overrides ModelComponentCollection.Insert(Int32, ModelComponent).)

System_CAPS_pubmethod IsValidID(String)

Determines whether the named component collection identifier is valid.

System_CAPS_pubmethod IsValidID(String, String)

Determines whether the named component collection identifier is valid.

System_CAPS_protmethod IsValidID(String, Type, String)

Determines whether the named component collection identifier is valid.

System_CAPS_pubmethod IsValidName(String)

Determines whether the named component collection name is valid.

System_CAPS_pubmethod IsValidName(String, String)

Determines whether the named component collection name is valid.

System_CAPS_protmethod IsValidName(String, Type, String)

Determines whether the named component collection name is valid.

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethod Remove(IModelComponent)

Removes the specified IModelComponent from the collection.(Inherited from ModelComponentCollection.)

System_CAPS_pubmethod RemoveAt(Int32)

Removes the IModelComponent at the specified index from the ModelComponentCollection.(Inherited from ModelComponentCollection.)

System_CAPS_pubmethod RemoveAt(Int32, Boolean)

Removes the IModelComponent at the specified index from the ModelComponentCollection.(Inherited from ModelComponentCollection.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Events

Name Description
System_CAPS_pubevent CollectionChanged

Occurs when the collection changes.(Inherited from ModelComponentCollection.)

System_CAPS_pubevent CollectionChanging

Occurs when the collection is changing.(Inherited from ModelComponentCollection.)

Explicit Interface Implementations

Name Description
System_CAPS_pubinterfaceSystem_CAPS_privmethod IOnDemandLoadableCollection.BlockOnDemandLoad(Boolean)

Specifies the blocked demand load.(Inherited from ModelComponentCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IModelComponentCollection.Contains(IModelComponent)

Indicates whether the collection contains a specific value.(Inherited from ModelComponentCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IModelComponentCollection.Remove(IModelComponent)

Removes the first occurrence of a specific IModelComponent from the ModelComponentCollection.(Inherited from ModelComponentCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IModelComponentCollection.Remove(IModelComponent, Boolean)

Removes the first occurrence of a specific IModelComponent from the ModelComponentCollection.(Inherited from ModelComponentCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IList.Add(Object)

Adds an item to the collection.(Inherited from ModelComponentCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IList.Clear()

Removes all items from the collection.(Inherited from ModelComponentCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IList.Contains(Object)

Indicates whether the collection contains a specific value.(Inherited from ModelComponentCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IList.IndexOf(Object)

Determines the index of a specific item in the collection.(Inherited from ModelComponentCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IList.Insert(Int32, Object)

Inserts an item to the collection at the specified index.(Inherited from ModelComponentCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IList.Remove(Object)

Removes the first occurrence of a specified object from the collection.(Inherited from ModelComponentCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IList.RemoveAt(Int32)

Removes the item at the specified index.(Inherited from ModelComponentCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privproperty IOnDemandLoadableCollection.Loaded

(Inherited from ModelComponentCollection.)

System_CAPS_pubinterfaceSystem_CAPS_privproperty IList.Item[Int32]

(Inherited from ModelComponentCollection.)

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