MdxScript Class

Reference

Definition

Namespace:: Microsoft.AnalysisServices

Assembly:: Microsoft.AnalysisServices.dll

Package:: Microsoft.AnalysisServices v19.87.2

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public sealed class MdxScript : Microsoft.AnalysisServices.MajorObject, ICloneable, IDisposable, Microsoft.AnalysisServices.IMajorObject

type MdxScript = class
    inherit MajorObject
    interface IMajorObject
    interface INamedComponent
    interface IModelComponent
    interface IComponent
    interface IDisposable
    interface ICloneable

Public NotInheritable Class MdxScript
Inherits MajorObject
Implements ICloneable, IDisposable, IMajorObject

Inheritance: Component

ModelComponent

NamedComponent

MajorObject
MdxScript

Implements: IMajorObject IModelComponent INamedComponent IComponent ICloneable IDisposable

Constructors

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

Fields

MaxIDLength	Specifies the maximum length of the identifier. (Inherited from NamedComponent)
MaxNameLength	Specifies the maximum length of the name. (Inherited from NamedComponent)

Properties

Annotations	Gets the collection of all annotations associated with the major object. (Inherited from MajorObject)
CalculationProperties	Gets a collection of display attributes for calculated members defined in current script.
Commands	Gets a CommandCollection object with all calculations defined in current script.
CreatedTimestamp	Gets or sets the date and time of the creation of the object. (Inherited from MajorObject)
DefaultScript	Gets or sets an indication if the current script the default one among all scripts.
Description	Gets or sets the description of major object. (Inherited from MajorObject)
FriendlyName	Gets a user-friendly name for the component. (Inherited from NamedComponent)
ID	Gets or sets the identifier of the component. (Inherited from NamedComponent)
IsLoaded	Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject)
KeyForCollection	Gets 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 parent Cube object of the MdxScript object.
ParentDatabase	Gets the parent Database object of the MdxScript object.
ParentServer	Gets the parent Server object of the MdxScript object.
Site	Gets or sets the site associated with the component. (Inherited from NamedComponent)
SiteID	Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent)

Methods

AddToContainer(IContainer)	Adds the ModelComponent object to the specified container. (Inherited from ModelComponent)
AfterInsert(Int32)	Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent)
AfterMove(Int32, Int32)	Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent)
AfterRemove(ModelComponentCollection)	Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent)
BeforeRemove(Boolean)	Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent)
Clone()	Returns a clone of the object.
Clone(Boolean)	Creates a new copy of the MajorObject object. (Inherited from MajorObject)
CopyTo(MajorObject, Boolean)	Copies a MajorObject object to the specified destination. (Inherited from MajorObject)
CopyTo(MdxScript)	Copies the content of this object to another object (the destination).
CopyTo(ModelComponent)	Copies a ModelComponent object to the specified object. (Inherited from ModelComponent)
CopyTo(NamedComponent)	Copies a NamedComponent object to the specified object. (Inherited from NamedComponent)
Drop()	Removes current object and updates server. (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)
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)	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)	Removes current object and updates server using specified options. (Inherited from MajorObject)
GetCreateReferences(Hashtable, Boolean, Boolean)	Gets a Hashtable to create references. (Inherited from MajorObject)
GetDependents(Hashtable)	Gets the dependents to the specified Hashtable. (Inherited from MajorObject)
GetDropDependents(Hashtable, Hashtable)	Gets the drop dependents. (Inherited from MajorObject)
GetReferences(Hashtable, Boolean)	Gets the objects that the MajorObject references. (Inherited from MajorObject)
GetUpdateOverwrites(Boolean)	Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject)
Refresh()	Updates the object from server definitions. (Inherited from MajorObject)
Refresh(Boolean, RefreshType)	Updates the object from server definitions, as well as loaded dependent objects [if specified]. (Inherited from MajorObject)
Refresh(Boolean)	Updates the object from server definitions, as well as loaded dependent objects [if specified]. (Inherited from MajorObject)
RemoveFromContainer(IContainer)	Removes the ModelComponent object from the specified container. (Inherited from ModelComponent)
Reset()	Resets the component to its initial state. (Inherited from NamedComponent)
Submit()	Submits a ModelComponent object. (Inherited from ModelComponent)
Submit(Boolean)	Submits a ModelComponent object. (Inherited from ModelComponent)
ToString()	Returns a string representing the named-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, 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)
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)	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)	Updates server definition of current object to actual values using the specified options 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)
Validate(ValidationErrorCollection, Boolean, ServerEdition)	Determines whether the MdxScript is valid.
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(ValidationErrorCollection)	Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent)
Validate(ValidationResultCollection, ValidationOptions, ServerEdition)	Indicates whether the MajorObject is valid. (Inherited from MajorObject)
Validate(ValidationResultCollection, ValidationOptions)	Indicates whether the MajorObject is valid. (Inherited from MajorObject)
Validate(ValidationResultCollection)	Indicates whether the MajorObject is valid. (Inherited from MajorObject)

Explicit Interface Implementations

ICloneable.Clone()
IDeserializationCallback.OnDeserialization(Object)	(Inherited from MajorObject)
IDeserializationStartCallback.OnDeserializationBegin(Object)	(Inherited from MajorObject)
IFormattable.ToString(String, IFormatProvider)	(Inherited from NamedComponent)
IHostableComponent.Host	(Inherited from ModelComponent)
IMajorObject.BaseType
IMajorObject.CreateBody()
IMajorObject.DependsOn(IMajorObject)
IMajorObject.ObjectReference
IMajorObject.Path
IMajorObject.WriteRef(XmlWriter)
IModelComponent.FriendlyPath	(Inherited from ModelComponent)
IModelComponent.OwningCollection	(Inherited from ModelComponent)

Applies to

Jaa