MdxScript Class

An MDX script is a collection of commands, which is usually used to populate a cube with calculations. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.AnalysisServices.ModelComponent
        Microsoft.AnalysisServices.NamedComponent
          Microsoft.AnalysisServices.MajorObject
            Microsoft.AnalysisServices.MdxScript

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

Syntax

'Declaration
Public NotInheritable Class MdxScript _
    Inherits MajorObject _
    Implements IMajorObject, INamedComponent, IModelComponent, IComponent,  _
    IDisposable, ICloneable
'Usage
Dim instance As MdxScript

public sealed class MdxScript : MajorObject, 
    IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
    ICloneable

public ref class MdxScript sealed : public MajorObject, 
    IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
    ICloneable

[<SealedAttribute>]
type MdxScript =  
    class 
        inherit MajorObject 
        interface IMajorObject 
        interface INamedComponent 
        interface IModelComponent 
        interface IComponent 
        interface IDisposable 
        interface ICloneable 
    end

public final class MdxScript extends MajorObject implements IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, ICloneable

The MdxScript type exposes the following members.

Constructors

	Name	Description
	MdxScript()	Initializes a new instance of MdxScript using the default values.
	MdxScript(String, String)	Initializes a new instance of MdxScript using a name and an identifier.

Top

Properties

	Name	Description
	Annotations	Gets the collection object of all annotations to current object. (Inherited from MajorObject.)
	CalculationProperties	Gets a CalculationProperty object, with display attributes for calculated members defined in current script.
	Commands	Gets a CommandCollection object with all calculations defined in current script.
	Container	(Inherited from Component.)
	CreatedTimestamp	Gets or sets the date and time of the creation of the object. (Inherited from MajorObject.)
	DefaultScript	Gets or sets the DefaultScript property that makes the current script the default one among all scripts.
	Description	Gets or sets a description string of current object. (Inherited from MajorObject.)
	FriendlyName	Returns a user-friendly name. (Inherited from NamedComponent.)
	ID	Gets or sets the identifier of the component. (Inherited from NamedComponent.)
	IsLoaded	Infrastructure. Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject.)
	KeyForCollection	Returns the key used in collections. (Inherited from NamedComponent.)
	LastSchemaUpdate	Gets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.)
	Name	Gets or sets the name of the component. (Inherited from NamedComponent.)
	OwningCollection	Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
	Parent	Gets the Cube object that is the parent of the MdxScript object.
	ParentDatabase	Gets the Database object that is the parent of the MdxScript object.
	ParentServer	Gets the Server object that is the parent of the MdxScript object.
	Site	Infrastructure. Gets or sets the site of the component. (Inherited from NamedComponent.)
	SiteID	Infrastructure. Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent.)

Top

Methods

	Name	Description
	AddToContainer	Infrastructure. Adds a ModelComponent object to the specified container. (Inherited from ModelComponent.)
	AfterInsert	Infrastructure. Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent.)
	AfterMove	Infrastructure. Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent.)
	AfterRemove	Infrastructure. Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent.)
	BeforeRemove	Infrastructure. Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent.)
	Clone()	Creates a new, full copy of an object.
	Clone(Boolean)	Infrastructure. Creates a new copy of the MajorObject object. (Inherited from MajorObject.)
	CopyTo(MdxScript)	Copies an MdxScript to the specified object.
	CopyTo(MajorObject, Boolean)	Infrastructure. Copies a MajorObject object to the specified destination. (Inherited from MajorObject.)
	CreateObjRef	Security Critical. (Inherited from MarshalByRefObject.)
	Dispose	(Inherited from Component.)
	Drop()	Removes current object and updates server. (Inherited from MajorObject.)
	Drop(DropOptions)	Removes current object and updates server using specified options. (Inherited from MajorObject.)
	Drop(DropOptions, XmlaWarningCollection)	Removes current object and updates server using specified options. Warnings resulting from drop operation are returned on the specified warnings object. (Inherited from MajorObject.)
	Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection)	Removes current object and updates server using specified options. Warnings resulting from drop operation are returned on the specified warnings variable and results for affected objects in operation are returned on specified impactResult variable. (Inherited from MajorObject.)
	Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection, Boolean)	Removes current object and updates server using specified options. Warnings resulting from drop operation are returned on the specified warnings variable and results for affected objects in operation are returned on specified impactResult variable. (Inherited from MajorObject.)
	Equals	(Inherited from Object.)
	GetCreateReferences	Infrastructure. Gets a Hashtable to create references. (Inherited from MajorObject.)
	GetDependents	Infrastructure. Gets the dependents to the specified Hashtable. (Inherited from MajorObject.)
	GetDropDependents	Infrastructure. Gets the drop dependents. (Inherited from MajorObject.)
	GetHashCode	(Inherited from Object.)
	GetLifetimeService	Security Critical. (Inherited from MarshalByRefObject.)
	GetReferences	Infrastructure. Gets the objects that the MajorObject references. (Inherited from MajorObject.)
	GetType	(Inherited from Object.)
	GetUpdateOverwrites	Infrastructure. Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject.)
	InitializeLifetimeService	Security Critical. (Inherited from MarshalByRefObject.)
	Refresh()	Updates current object from server definitions. (Inherited from MajorObject.)
	Refresh(Boolean)	Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
	Refresh(Boolean, RefreshType)	Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
	RemoveFromContainer	Infrastructure. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.)
	Submit()	Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
	Submit(Boolean)	Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
	ToString	Returns a string containing the name of the component. (Inherited from NamedComponent.)
	Update()	Updates server definition of current object to actual values using the default values to update dependent objects. (Inherited from MajorObject.)
	Update(UpdateOptions)	Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
	Update(UpdateOptions, UpdateMode)	Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
	Update(UpdateOptions, UpdateMode, XmlaWarningCollection)	Updates server definition of current object to actual values using the specified options to update dependent objects and reports any warnings from operation. (Inherited from MajorObject.)
	Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection)	Updates server definition of current object to actual values using specified options to update dependent objects, reports any warnings from operation, and returns affected objects from operation. (Inherited from MajorObject.)
	Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection, Boolean)	Updates server definition of current object to actual values using specified options to update dependent objects, reports any warnings from operation, and returns affected objects from operation. If analyzeImpactOnly is true, an impact analysis operation is performed with no update operation. (Inherited from MajorObject.)
	Validate(ValidationErrorCollection)	Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
	Validate(ValidationResultCollection)	Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
	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.)
	Validate(ValidationResultCollection, ValidationOptions)	Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
	Validate(ValidationErrorCollection, Boolean, ServerEdition)	Determines whether the MdxScript is valid. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)
	Validate(ValidationResultCollection, ValidationOptions, ServerEdition)	Indicates whether the MajorObject is valid. (Inherited from MajorObject.)

Top

Events

	Name	Description
	Disposed	(Inherited from Component.)

Top

Explicit Interface Implementations

	Name	Description
	ICloneable.Clone	Creates a new copy of the object instance.
	IDeserializationCallback.OnDeserialization	Runs when the entire object graph has been deserialized. (Inherited from MajorObject.)
	IFormattable.ToString	Formats the value of the current instance using the specified format. (Inherited from NamedComponent.)
	IDeserializationStartCallback.OnDeserializationBegin	Runs when the entire object graph starts to deserialized. (Inherited from MajorObject.)
	IHostableComponent.Host	Gets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.)
	IMajorObject.BaseType	Gets the base type implementation of the MdxScript.
	IMajorObject.CreateBody	Creates a new body for the MdxScript.
	IMajorObject.DependsOn	Determines whether the MdxScript depends on an object.
	IMajorObject.ObjectReference	Gets the object reference implementation of the MdxScript.
	IMajorObject.Path	Gets the path implementation of the MdxScript.
	IMajorObject.WriteRef	Writes a reference for the MdxScript.
	IModelComponent.FriendlyPath	Gets a friendly path for the ModelComponent. (Inherited from ModelComponent.)
	IModelComponent.OwningCollection	Gets or sets the collection that owns the current object. (Inherited from ModelComponent.)

Top

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

Reference

Microsoft.AnalysisServices Namespace