CustomElement.changeState (Method)
Change the state of a custom element to one of the following: 'Active', 'Deleted', and 'Inactive'.
Returns:
Void
Arguments:
Name | Type | Required | Description |
---|---|---|---|
elementID | CustomElementID | Required | A custom element's ID. |
state | GeneralState | Required | The target state of the element, as follows: 'Active', 'Deleted', or 'Inactive'. |
Context:
License Requirements | None |
Permission Requirements | customElement:Admin |
Deny Context | None |
Require Context | AuthoringEnabled |
Author Lock | (not required) |
Transaction Logging | If transaction logging is enabled at the site level, calls to this method will be logged |
Customization | This method may be customized at the site level |
Error Codes:
None
Notes:
None