Table of Contents

Class TabularNamedObject

Inheritance
TabularNamedObject
Implements
Derived
Inherited Members
Namespace
TabularEditor.TOMWrapper
Assembly
TOMWrapper.dll

A TabularObject is a wrapper for the Microsoft.AnalysisServices.Tabular.NamedMetadataObject class. This wrapper is used for all objects that are to be viewable and editable in the Tabular Editor. The same base class is used for all kinds of objects in a Tabular Model. This base class provides method for editing the (localized) name and description.

public abstract class TabularNamedObject : TabularObject, ICustomTypeDescriptor, INotifyPropertyChanging, ITabularNamedObject, INamedObject, ITabularObject, INotifyPropertyChanged, IComparable
Extension Methods

Properties

MetadataIndex

Returns the index of this item in the parent metadata collection

[Browsable(false)]
public int MetadataIndex { get; }

Property Value

Type Description
int

MetadataObject

protected NamedMetadataObject MetadataObject { get; set; }

Property Value

Type Description
NamedMetadataObject

Name

The name of this object. Warning: Changing the name can break formula logic, if Automatic Formula Fix-up is disabled.

public virtual string Name { get; set; }

Property Value

Type Description
string

Methods

AllowDelete(out string)

Derived classes should override this method to prevent an object from being deleted. If left un-overridden, always returns TRUE and sets message to null.

protected virtual bool AllowDelete(out string message)

Parameters

Type Name Description
string message

If an object CANNOT be deleted, this string should provide a reason why. If an object CAN be deleted, this string may optionally provide a suitable warning message that applies if the object is deleted immediately after the call to CanDelete.

Returns

Type Description
bool

True if an object can be deleted. False otherwise.

CanDelete()

Indicates whether an object can be deleted or not.

public bool CanDelete()

Returns

Type Description
bool

True if the object can currently be deleted. False, otherwise.

CanDelete(out string)

Indicates whether an object can be deleted or not.

public bool CanDelete(out string message)

Parameters

Type Name Description
string message

The reason why an object cannot be deleted, or in case the method returns true, a warning message that should be displayed to the user before deletion.

Returns

Type Description
bool

True if the object can currently be deleted. False, otherwise.

CanEditName()

protected virtual bool CanEditName()

Returns

Type Description
bool

CompareTo(object)

public int CompareTo(object obj)

Parameters

Type Name Description
object obj

Returns

Type Description
int

Delete()

Deletes the object.

public void Delete()

Init()

Derived members should override this method to instantiate child objects

protected override void Init()