Class TablePermission

Defines the security rules of the Role on the Table. It is a child of a Role object.

Inheritance
object
DynamicPropertyObject
TabularObject
TabularNamedObject
TablePermission
Implements
Inherited Members
Namespace: TabularEditor.TOMWrapper
Assembly: TOMWrapper.dll
Syntax
public sealed class TablePermission : TabularNamedObject, ICustomTypeDescriptor, INotifyPropertyChanging, IComparable, ITomErrorMessageObject, IAnnotationObject, IExtendedPropertyObject, IClonableObject, IDaxDependantObject, IExpressionObject, ITabularNamedObject, ITabularObject, INotifyPropertyChanged, INamedObject

Properties

Annotations

The collection of Annotations on the current Table Permission.

Declaration
[Browsable(true)]
public AnnotationCollection Annotations { get; }
Property Value
Type Description
AnnotationCollection

ColumnPermissions

Declaration
[Browsable(true)]
public RoleColumnOLSIndexer ColumnPermissions { get; }
Property Value
Type Description
RoleColumnOLSIndexer

DependsOn

Gets the list of objects that this table permission depends on.

Declaration
[Browsable(false)]
public DependsOnList DependsOn { get; }
Property Value
Type Description
DependsOnList

ErrorMessage

A string that explains the error state associated with the current object. It is set by the engine only when the state of the object is one of these three values: SemanticError, DependencyError, or EvaluationError. It is applicable only to columns of the type Calculated or CalculatedTableColumn. It will be empty for other column objects.

Declaration
public string ErrorMessage { get; }
Property Value
Type Description
string

ExtendedProperties

The collection of Extended Properties on the current Table Permission.

Declaration
public ExtendedPropertyCollection ExtendedProperties { get; }
Property Value
Type Description
ExtendedPropertyCollection

FilterExpression

The DAX expression that filters the rows in the table when this security role is in effect.

Declaration
public string FilterExpression { get; set; }
Property Value
Type Description
string

MetadataPermission

Defines whether the metadata of this table should be secured from users belonging to this role.

Declaration
public MetadataPermission MetadataPermission { get; set; }
Property Value
Type Description
MetadataPermission
Remarks

This property is only supported when the compatibility level of the database is at 1400 or above.

NoEffect

Declaration
public bool NoEffect { get; }
Property Value
Type Description
bool

Parent

The parent Model Role of the current Table Permission.

Declaration
public ModelRole Parent { get; }
Property Value
Type Description
ModelRole

Role

A reference to a Role object that owns this TablePermission.

Declaration
public ModelRole Role { get; }
Property Value
Type Description
ModelRole

RoleName

Declaration
[Browsable(true)]
public string RoleName { get; }
Property Value
Type Description
string

State

Provides information on the state of the permission. Possible values and their interpretation are as follows. Ready (1) The permission has a valid expression. NoData (3) Not applicable. CalculationNeeded (4) Not applicable. SemanticError (5) The expression of the TablePermission object has a semantic error. EvaluationError (6) Not applicable. DependencyError (7) A dependency associated with this TablePermission object is in an error state (SemanticError, EvaluationError, or DependencyError). Incomplete (8) Not applicable. SyntaxError (9) The TablePermission object is in an error state because of a syntax error in its expression. The TablePermission object is not queryable. This state applies only to TablePermission objects of the type Calculated.

Declaration
public ObjectState State { get; }
Property Value
Type Description
ObjectState

Table

The parent table of the current Table Permission.

Declaration
[Browsable(false)]
public Table Table { get; }
Property Value
Type Description
Table

TableName

Declaration
[Browsable(true)]
public string TableName { get; }
Property Value
Type Description
string

Methods

CanEditName()

Declaration
protected override bool CanEditName()
Returns
Type Description
bool
Overrides

ClearAnnotations()

Removes all annotations from this object.

Declaration
public void ClearAnnotations()

ClearExtendedProperties()

Removes all Extended Properties from this object.

Declaration
public void ClearExtendedProperties()

Clone(string, ModelRole)

Creates an exact copy of this TablePermission object.

Declaration
public TablePermission Clone(string newName = null, ModelRole newParent = null)
Parameters
Type Name Description
string newName
ModelRole newParent
Returns
Type Description
TablePermission

CreateNew(ModelRole, string)

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

Declaration
public static TablePermission CreateNew(ModelRole parent, string name = null)
Parameters
Type Name Description
ModelRole parent
string name
Returns
Type Description
TablePermission

CustomReinit()

Declaration
protected override void CustomReinit()
Overrides

DelayedInit()

Declaration
public void DelayedInit()

GetAnnotation(int)

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

Declaration
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.

Declaration
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 Table Permission.

Declaration
public IEnumerable<string> GetAnnotations()
Returns
Type Description
IEnumerable<string>

GetAnnotationsCount()

Gets the number of annotations on the current Table Permission.

Declaration
public int GetAnnotationsCount()
Returns
Type Description
int

GetExtendedProperties()

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

Declaration
public IEnumerable<string> GetExtendedProperties()
Returns
Type Description
IEnumerable<string>

GetExtendedProperty(int)

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

Declaration
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.

Declaration
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.

Declaration
public int GetExtendedPropertyCount()
Returns
Type Description
int

GetExtendedPropertyType(int)

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

Declaration
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.

Declaration
public ExtendedPropertyType GetExtendedPropertyType(string name)
Parameters
Type Name Description
string name
Returns
Type Description
ExtendedPropertyType

GetNewAnnotationName()

Returns a unique name for a new annotation.

Declaration
public string GetNewAnnotationName()
Returns
Type Description
string

GetNewExtendedPropertyName()

Returns a unique name for a new ExtendedProperty.

Declaration
public string GetNewExtendedPropertyName()
Returns
Type Description
string

HasAnnotation(string)

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

Declaration
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.

Declaration
public bool HasExtendedProperty(string name)
Parameters
Type Name Description
string name
Returns
Type Description
bool

Init()

Derived members should override this method to instantiate child objects

Declaration
protected override void Init()
Overrides

OnPropertyChanged(string, object, object)

Fired after a property is changed

Declaration
protected override void OnPropertyChanged(string propertyName, object oldValue, object newValue)
Parameters
Type Name Description
string propertyName
object oldValue
object newValue
Overrides

RemoveAnnotation(string)

Remove an annotation by the given name.

Declaration
public void RemoveAnnotation(string name)
Parameters
Type Name Description
string name

RemoveExtendedProperty(string)

Remove an ExtendedProperty by the given name.

Declaration
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.

Declaration
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.

Declaration
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.

Declaration
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.

Declaration
public void SetExtendedProperty(string name, string value, ExtendedPropertyType type)
Parameters
Type Name Description
string name
string value
ExtendedPropertyType type

Implements

Extension Methods