ModelComponent Class

 

Applies To: SQL Server (starting with 2016)

Represents the base class for most of the Analysis Management Objects.

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

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.AnalysisServices.ModelComponent
        Microsoft.AnalysisServices.Account
        Microsoft.AnalysisServices.AggregationAttribute
        Microsoft.AnalysisServices.AggregationDesignAttribute
        Microsoft.AnalysisServices.AggregationDesignDimension
        Microsoft.AnalysisServices.AggregationDimension
        Microsoft.AnalysisServices.AggregationInstanceAttribute
        Microsoft.AnalysisServices.AggregationInstanceDimension
        Microsoft.AnalysisServices.AggregationInstanceMeasure
        Microsoft.AnalysisServices.AttributePermission
        Microsoft.AnalysisServices.AttributeRelationship
        Microsoft.AnalysisServices.CalculationProperty
        Microsoft.AnalysisServices.CellPermission
        Microsoft.AnalysisServices.CubeAttribute
        Microsoft.AnalysisServices.CubeDimensionPermission
        Microsoft.AnalysisServices.CubeHierarchy
        Microsoft.AnalysisServices.MeasureGroupAttribute
        Microsoft.AnalysisServices.MeasureGroupDimension
        Microsoft.AnalysisServices.NamedComponent
        Microsoft.AnalysisServices.PerspectiveAction
        Microsoft.AnalysisServices.PerspectiveAttribute
        Microsoft.AnalysisServices.PerspectiveCalculation
        Microsoft.AnalysisServices.PerspectiveDimension
        Microsoft.AnalysisServices.PerspectiveHierarchy
        Microsoft.AnalysisServices.PerspectiveKpi
        Microsoft.AnalysisServices.PerspectiveMeasure
        Microsoft.AnalysisServices.PerspectiveMeasureGroup
        Microsoft.AnalysisServices.Relationship
        Microsoft.AnalysisServices.RelationshipEnd
        Microsoft.AnalysisServices.RelationshipEndAttribute
        Microsoft.AnalysisServices.Translation

Syntax

[GuidAttribute("FBB03F30-DECD-4a40-9E8F-06ACB99A0A97")]
public abstract class ModelComponent : Component, IModelComponent, 
    IComponent, IDisposable, IHostableComponent
[GuidAttribute("FBB03F30-DECD-4a40-9E8F-06ACB99A0A97")]
public ref class ModelComponent abstract : Component, IModelComponent, 
    IComponent, IDisposable, IHostableComponent
[<AbstractClass>]
[<GuidAttribute("FBB03F30-DECD-4a40-9E8F-06ACB99A0A97")>]
type ModelComponent = 
    class
        inherit Component
        interface IModelComponent
        interface IComponent
        interface IDisposable
        interface IHostableComponent
    end
<GuidAttribute("FBB03F30-DECD-4a40-9E8F-06ACB99A0A97")>
Public MustInherit Class ModelComponent
    Inherits Component
    Implements IModelComponent, IComponent, IDisposable, IHostableComponent

Constructors

Name Description
System_CAPS_protmethod ModelComponent()

Initializes a new instance of the ModelComponent class using the default values.

Properties

Name Description
System_CAPS_pubproperty Annotations

Gets a collection within which you can store custom data.

System_CAPS_protproperty CanRaiseEvents

(Inherited from Component.)

System_CAPS_pubproperty Container

(Inherited from Component.)

System_CAPS_protproperty DesignMode

(Inherited from Component.)

System_CAPS_protproperty Events

(Inherited from Component.)

System_CAPS_protproperty FriendlyName

Gets the friendly name of the ModelComponent.

System_CAPS_protproperty KeyForCollection

Gets the key used in the collection.

System_CAPS_pubproperty OwningCollection

Gets or sets the collection that contains the ModelComponent.

System_CAPS_pubproperty Parent

Gets the IModelComponent object that is the parent of the ModelComponent object.

System_CAPS_pubproperty Site

(Inherited from Component.)

Methods

Name Description
System_CAPS_protmethod AddToContainer(IContainer)

Adds a ModelComponent object to the specified container.

System_CAPS_protmethod AfterInsert(Int32)

Displays a ModelComponent object after added to the specified index.

System_CAPS_protmethod AfterMove(Int32, Int32)

Displays a ModelComponent object after moving to the specified index.

System_CAPS_protmethod AfterRemove(ModelComponentCollection)

Displays a ModelComponentCollection after a ModelComponent object is removed.

System_CAPS_protmethod BeforeRemove(Boolean)

Removes the ModelComponent object before the cleanup.

System_CAPS_protmethod CopyTo(ModelComponent)

Copies a ModelComponent object to the specified object.

System_CAPS_pubmethod CreateObjRef(Type)

(Inherited from MarshalByRefObject.)

System_CAPS_pubmethod Dispose()

(Inherited from Component.)

System_CAPS_protmethod Dispose(Boolean)

(Inherited from Component.)

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Component.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_protmethod GetService(Type)

(Inherited from Component.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod InitializeLifetimeService()

(Inherited from MarshalByRefObject.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone(Boolean)

(Inherited from MarshalByRefObject.)

System_CAPS_protmethod RemoveFromContainer(IContainer)

Removes a ModelComponent object from the specified container.

System_CAPS_protmethod Reset()

Resets the component to an initial state.

System_CAPS_pubmethod Submit()

Submits a ModelComponent object.

System_CAPS_pubmethod Submit(Boolean)

Submits a ModelComponent object.

System_CAPS_pubmethod ToString()

Returns a string that represents the current object.(Overrides Component.ToString().)

System_CAPS_pubmethod Validate(ValidationErrorCollection)

Validates the element to which it is appended; returns any errors encountered in a collection.

System_CAPS_pubmethod Validate(ValidationErrorCollection, Boolean)

Validates the element to which it is appended; returns any errors encountered in a collection. Also contains a parameter to enable return of detailed errors.

System_CAPS_pubmethod Validate(ValidationErrorCollection, Boolean, ServerEdition)

Indicates whether a ModelComponent object is valid.

Events

Name Description
System_CAPS_pubevent Disposed

(Inherited from Component.)

Explicit Interface Implementations

Name Description
System_CAPS_pubinterfaceSystem_CAPS_privproperty IHostableComponent.Host

System_CAPS_pubinterfaceSystem_CAPS_privproperty IModelComponent.FriendlyPath

System_CAPS_pubinterfaceSystem_CAPS_privproperty IModelComponent.OwningCollection

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