NamedComponent Class

 

Applies To: SQL Server (starting with 2016)

Represents a named component.

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.NamedComponent
          Microsoft.AnalysisServices.Action
          Microsoft.AnalysisServices.Aggregation
          Microsoft.AnalysisServices.AggregationInstance
          Microsoft.AnalysisServices.CubeDimension
          Microsoft.AnalysisServices.DimensionAttribute
          Microsoft.AnalysisServices.Hierarchy
          Microsoft.AnalysisServices.Kpi
          Microsoft.AnalysisServices.Level
          Microsoft.AnalysisServices.MajorObject
          Microsoft.AnalysisServices.Measure
          Microsoft.AnalysisServices.MiningModelColumn
          Microsoft.AnalysisServices.MiningStructureColumn

Syntax

[GuidAttribute("AA77A7C5-38A3-41ad-BAE8-3101FE6A116D")]
[StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, 
    PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736AD6E5F9586BAC2D531EABC3ACC666C2F8EC879FA94F8F7B0327D2FF2ED523448F83C3D5C5DD2DFC7BC99C5286B2C125117BF5CBE242B9D41750732B2BDFFE649C6EFB8E5526D526FDD130095ECDB7BF210809C6CDAD8824FAA9AC0310AC3CBA2AA0523567B2DFA7FE250B30FACBD62D4EC99B94AC47C7D3B28F1F6E4C8")]
public abstract class NamedComponent : ModelComponent, INamedComponent, 
    IModelComponent, IComponent, IDisposable, IFormattable
[GuidAttribute("AA77A7C5-38A3-41ad-BAE8-3101FE6A116D")]
[StrongNameIdentityPermissionAttribute(SecurityAction::InheritanceDemand, 
    PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736AD6E5F9586BAC2D531EABC3ACC666C2F8EC879FA94F8F7B0327D2FF2ED523448F83C3D5C5DD2DFC7BC99C5286B2C125117BF5CBE242B9D41750732B2BDFFE649C6EFB8E5526D526FDD130095ECDB7BF210809C6CDAD8824FAA9AC0310AC3CBA2AA0523567B2DFA7FE250B30FACBD62D4EC99B94AC47C7D3B28F1F6E4C8")]
public ref class NamedComponent abstract : ModelComponent, INamedComponent, 
    IModelComponent, IComponent, IDisposable, IFormattable
[<AbstractClass>]
[<GuidAttribute("AA77A7C5-38A3-41ad-BAE8-3101FE6A116D")>]
[<StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand,
    PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736AD6E5F9586BAC2D531EABC3ACC666C2F8EC879FA94F8F7B0327D2FF2ED523448F83C3D5C5DD2DFC7BC99C5286B2C125117BF5CBE242B9D41750732B2BDFFE649C6EFB8E5526D526FDD130095ECDB7BF210809C6CDAD8824FAA9AC0310AC3CBA2AA0523567B2DFA7FE250B30FACBD62D4EC99B94AC47C7D3B28F1F6E4C8")>]
type NamedComponent = 
    class
        inherit ModelComponent
        interface INamedComponent
        interface IModelComponent
        interface IComponent
        interface IDisposable
        interface IFormattable
    end
<GuidAttribute("AA77A7C5-38A3-41ad-BAE8-3101FE6A116D")>
<StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand,
    PublicKey := "0024000004800000940000000602000000240000525341310004000001000100272736AD6E5F9586BAC2D531EABC3ACC666C2F8EC879FA94F8F7B0327D2FF2ED523448F83C3D5C5DD2DFC7BC99C5286B2C125117BF5CBE242B9D41750732B2BDFFE649C6EFB8E5526D526FDD130095ECDB7BF210809C6CDAD8824FAA9AC0310AC3CBA2AA0523567B2DFA7FE250B30FACBD62D4EC99B94AC47C7D3B28F1F6E4C8")>
Public MustInherit Class NamedComponent
    Inherits ModelComponent
    Implements INamedComponent, IModelComponent, IComponent, IDisposable,
    IFormattable

Constructors

Name Description
System_CAPS_protmethod NamedComponent()

Initializes a new instance of the NamedComponent class.

System_CAPS_protmethod NamedComponent(String)

Initializes a new instance of the NamedComponent class.

System_CAPS_protmethod NamedComponent(String, String)

Initializes a new instance of the NamedComponent class.

Properties

Name Description
System_CAPS_pubproperty Annotations

Gets a collection within which you can store custom data.(Inherited from ModelComponent.)

System_CAPS_protproperty CanRaiseEvents

(Inherited from Component.)

System_CAPS_pubproperty Container

(Inherited from Component.)

System_CAPS_pubproperty Description

Gets or sets the description of the component.

System_CAPS_protproperty DesignMode

(Inherited from Component.)

System_CAPS_protproperty Events

(Inherited from Component.)

System_CAPS_protproperty FriendlyName

Returns a user-friendly name.(Overrides ModelComponent.FriendlyName.)

System_CAPS_pubproperty ID

Gets or sets the identifier of the component.

System_CAPS_protproperty KeyForCollection

Returns the key used in collections.(Overrides ModelComponent.KeyForCollection.)

System_CAPS_pubproperty Name

Gets or sets the name of the component.

System_CAPS_pubproperty OwningCollection

Gets or sets the collection that contains the ModelComponent.(Inherited from ModelComponent.)

System_CAPS_pubproperty Parent

Gets the IModelComponent object that is the parent of the ModelComponent object.(Inherited from ModelComponent.)

System_CAPS_pubproperty Site

Gets or sets the site of the component.(Overrides Component.Site.)

System_CAPS_pubproperty SiteID

Gets or sets the identifier for the site associated with the component.

Methods

Name Description
System_CAPS_protmethod AddToContainer(IContainer)

Adds a ModelComponent object to the specified container.(Inherited from ModelComponent.)

System_CAPS_protmethod AfterInsert(Int32)

Displays a ModelComponent object after added to the specified index.(Inherited from ModelComponent.)

System_CAPS_protmethod AfterMove(Int32, Int32)

Displays a ModelComponent object after moving to the specified index.(Inherited from ModelComponent.)

System_CAPS_protmethod AfterRemove(ModelComponentCollection)

Displays a ModelComponentCollection after a ModelComponent object is removed.(Inherited from ModelComponent.)

System_CAPS_protmethod BeforeRemove(Boolean)

Removes the ModelComponent object before the cleanup.(Inherited from ModelComponent.)

System_CAPS_protmethod CopyTo(ModelComponent)

Copies a ModelComponent object to the specified object.(Inherited from ModelComponent.)

System_CAPS_protmethod CopyTo(NamedComponent)

Copies a NamedComponent 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.(Inherited from ModelComponent.)

System_CAPS_protmethod Reset()

Resets the component to its initial state.

System_CAPS_pubmethod Submit()

Submits a ModelComponent object.(Inherited from ModelComponent.)

System_CAPS_pubmethod Submit(Boolean)

Submits a ModelComponent object.(Inherited from ModelComponent.)

System_CAPS_pubmethod ToString()

Returns a string containing the name of the component.(Overrides ModelComponent.ToString().)

System_CAPS_pubmethod Validate(ValidationErrorCollection)

Validates the element to which it is appended; returns any errors encountered in a collection.(Inherited from ModelComponent.)

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

System_CAPS_pubmethod Validate(ValidationErrorCollection, Boolean, ServerEdition)

Determines whether the NamedComponent is valid.(Overrides ModelComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)

Fields

Name Description
System_CAPS_pubfieldSystem_CAPS_static MaxIDLength

Specifies the maximum length of the identifier.

System_CAPS_pubfieldSystem_CAPS_static MaxNameLength

Specifies the maximum length of the name.

Events

Name Description
System_CAPS_pubevent Disposed

(Inherited from Component.)

Explicit Interface Implementations

Name Description
System_CAPS_pubinterfaceSystem_CAPS_privmethod IFormattable.ToString(String, IFormatProvider)

Formats the value of the current instance using the specified format.

System_CAPS_pubinterfaceSystem_CAPS_privproperty IHostableComponent.Host

(Inherited from ModelComponent.)

System_CAPS_pubinterfaceSystem_CAPS_privproperty IModelComponent.FriendlyPath

(Inherited from ModelComponent.)

System_CAPS_pubinterfaceSystem_CAPS_privproperty IModelComponent.OwningCollection

(Inherited from ModelComponent.)

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