Class Perspective

Inheritance

object

DynamicPropertyObject

TabularObject

TabularNamedObject

Perspective

Implements

ICustomTypeDescriptor

INotifyPropertyChanging

IComparable

IDescriptionObject

IExtendedPropertyObject

ITranslatableObject

IAnnotationObject

ITabularNamedObject

ITabularObject

INotifyPropertyChanged

IHandlerObject

INamedObject

IClonableObject

Inherited Members

TabularNamedObject.CompareTo(object)

TabularNamedObject.CanDelete()

TabularNamedObject.CanDelete(out string)

TabularNamedObject.Delete()

TabularNamedObject.MetadataIndex

TabularNamedObject.Name

TabularObject.ObjectTypeName

TabularObject.IsRemoved

TabularObject.Model

TabularObject.ObjectType

TabularObject.PropertyChanging

TabularObject.PropertyChanged

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace

TabularEditor.TOMWrapper

Assembly

TOMWrapper.dll

Defines a logical view over the Model and is a child of a Model object. It allows hiding Tables, Columns, Measures, and Hierarchies so that end users can look at a smaller subset of the large data model.

public sealed class Perspective : TabularNamedObject, ICustomTypeDescriptor, INotifyPropertyChanging, IComparable, IDescriptionObject, IExtendedPropertyObject, ITranslatableObject, IAnnotationObject, ITabularNamedObject, ITabularObject, INotifyPropertyChanged, IHandlerObject, INamedObject, IClonableObject

Extension Methods

ScriptHelper.Output(object)

Properties

Annotations

The collection of Annotations on the current Perspective.

[Browsable(true)]
public AnnotationCollection Annotations { get; }

Property Value

Type	Description
AnnotationCollection

Description

The description of the perspective, visible to developers at design time and to administrators in management tools, such as SQL Server Management Studio.

public string Description { get; set; }

Property Value

Type	Description
string

ExtendedProperties

The collection of Extended Properties on the current Perspective.

public ExtendedPropertyCollection ExtendedProperties { get; }

Property Value

Type	Description
ExtendedPropertyCollection

Parent

The parent Model of the current Perspective.

public Model Parent { get; }

Property Value

Type	Description
Model

TranslatedDescriptions

Collection of localized descriptions for this Perspective.

[Browsable(true)]
public TranslationIndexer TranslatedDescriptions { get; }

Property Value

Type	Description
TranslationIndexer

TranslatedNames

Collection of localized names for this Perspective.

[Browsable(true)]
public TranslationIndexer TranslatedNames { get; }

Property Value

Type	Description
TranslationIndexer

Methods

ClearAnnotations()

Removes all annotations from this object.

public void ClearAnnotations()

ClearExtendedProperties()

Removes all Extended Properties from this object.

public void ClearExtendedProperties()

Clone(string, bool)

Creates an exact copy of this Perspective object.

public Perspective Clone(string newName = null, bool includeTranslations = true)

Parameters

Type	Name	Description
string	newName
bool	includeTranslations

Returns

Type	Description
Perspective

CreateNew(Model, string)

Creates a new Perspective and adds it to the parent Model. Also creates the underlying metadataobject and adds it to the TOM tree.

public static Perspective CreateNew(Model parent, string name = null)

Parameters

Type	Name	Description
Model	parent
string	name

Returns

Type	Description
Perspective

GetAnnotation(int)

Gets the value of the annotation with the given index, assuming it exists.

public string GetAnnotation(int index)

Parameters

Type	Name	Description
int	index

Returns

Type	Description
string

GetAnnotation(string)

Gets the value of the annotation with the given name. Returns null if no such annotation exists.

public string GetAnnotation(string name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
string

GetAnnotations()

Gets a collection of all annotation names on the current Perspective.

public IEnumerable<string> GetAnnotations()

Returns

Type	Description
IEnumerable<string>

GetAnnotationsCount()

Gets the number of annotations on the current Perspective.

public int GetAnnotationsCount()

Returns

Type	Description
int

GetExtendedProperties()

Gets a collection of all ExtendedProperty names on the current object.

public IEnumerable<string> GetExtendedProperties()

Returns

Type	Description
IEnumerable<string>

GetExtendedProperty(int)

Gets the value of the ExtendedProperty with the given index, assuming it exists.

public string GetExtendedProperty(int index)

Parameters

Type	Name	Description
int	index

Returns

Type	Description
string

GetExtendedProperty(string)

Gets the value of the ExtendedProperty with the given name. Returns null if no such ExtendedProperty exists.

public string GetExtendedProperty(string name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
string

GetExtendedPropertyCount()

Gets the number of ExtendedProperties on the current object.

public int GetExtendedPropertyCount()

Returns

Type	Description
int

GetExtendedPropertyType(int)

Gets the type of the ExtendedProperty with the given index, assuming it exists.

public ExtendedPropertyType GetExtendedPropertyType(int index)

Parameters

Type	Name	Description
int	index

Returns

Type	Description
ExtendedPropertyType

GetExtendedPropertyType(string)

Gets the type of the ExtendedProperty with the given name, assuming it exists.

public ExtendedPropertyType GetExtendedPropertyType(string name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
ExtendedPropertyType

GetNewAnnotationName()

Returns a unique name for a new annotation.

public string GetNewAnnotationName()

Returns

Type	Description
string

GetNewExtendedPropertyName()

Returns a unique name for a new ExtendedProperty.

public string GetNewExtendedPropertyName()

Returns

Type	Description
string

HasAnnotation(string)

Returns true if an annotation with the given name exists. Otherwise false.

public bool HasAnnotation(string name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
bool

HasExtendedProperty(string)

Returns true if an ExtendedProperty with the given name exists. Otherwise false.

public bool HasExtendedProperty(string name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
bool

RemoveAnnotation(string)

Remove an annotation by the given name.

public void RemoveAnnotation(string name)

Parameters

Type	Name	Description
string	name

RemoveExtendedProperty(string)

Remove an ExtendedProperty by the given name.

public void RemoveExtendedProperty(string name)

Parameters

Type	Name	Description
string	name

SetAnnotation(int, string)

Sets the value of the annotation with the given index, assuming it exists.

public void SetAnnotation(int index, string value)

Parameters

Type	Name	Description
int	index
string	value

SetAnnotation(string, string)

Sets the value of the annotation having the given name. If no such annotation exists, it will be created. If value is set to null, the annotation will be removed.

public void SetAnnotation(string name, string value)

Parameters

Type	Name	Description
string	name
string	value

SetExtendedProperty(int, string, ExtendedPropertyType)

Sets the value of the ExtendedProperty with the given index, optionally specifiying the type (string or JSON) of the ExtendedProperty.

public void SetExtendedProperty(int index, string value, ExtendedPropertyType type)

Parameters

Type	Name	Description
int	index
string	value
ExtendedPropertyType	type

SetExtendedProperty(string, string, ExtendedPropertyType)

Sets the value of the ExtendedProperty having the given name. If no such ExtendedProperty exists, it will be created. If value is set to null, the ExtendedProperty will be removed.

public void SetExtendedProperty(string name, string value, ExtendedPropertyType type)

Parameters

Type	Name	Description
string	name
string	value
ExtendedPropertyType	type