Class RefreshPolicy

Represents an abstract RefreshPolicy object. It is a child of a Table object.

Inheritance
object
DynamicPropertyObject
TabularObject
RefreshPolicy
BasicRefreshPolicy
Implements
Inherited Members
Namespace: TabularEditor.TOMWrapper
Assembly: TOMWrapper.dll
Syntax
public abstract class RefreshPolicy : TabularObject, ICustomTypeDescriptor, INotifyPropertyChanging, IAnnotationObject, IExtendedPropertyObject, ITabularObject, INotifyPropertyChanged
Remarks

This metadata object is only supported when the compatibility level of the database is at 1450 or above.

Properties

Annotations

The collection of Annotations on the current Refresh Policy.

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

ExtendedProperties

The collection of Extended Properties on the current Refresh Policy.

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

Mode

Defines the mode of a refresh policy applied during incremental refresh.

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

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

PolicyType

Specifies the type of the refresh policy

Declaration
public RefreshPolicyType PolicyType { get; set; }
Property Value
Type Description
RefreshPolicyType

Table

The parent table of the current Refresh Policy.

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

Methods

ClearAnnotations()

Removes all annotations from this object.

Declaration
public void ClearAnnotations()

ClearExtendedProperties()

Removes all Extended Properties from this object.

Declaration
public void ClearExtendedProperties()

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 Refresh Policy.

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

GetAnnotationsCount()

Gets the number of annotations on the current Refresh Policy.

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

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