Suspending Adaptable Objects
Summary
- To Do
Many objects in AdapTable derive from SuspendableObject (which itself derives from the AdaptableObject).
Caution
Not all AdapTable Objects can be suspended as for some it makes no sense, e.g. Layouts or Calculated Columns
The interface exposes just a single, IsSuspended, property:
| Property | Description |
|---|---|
| IsSuspended | Suspends (i.e. turns off) an Adaptable Object |
| IsReadOnly | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
When this property is set to to true, the object becomes inactive but remains in Adaptable State.
Note
Suspendable Objects display a toggle button in the Settings Panel, enabling the object to be easily suspended
Hint
- All API classes that deal with Suspendable Objects have suspend and unSuspend methods
- For instance,
suspendCustomSortandunSuspendCustomSortin Custom Sort API