Save, edit, rename, or delete a Mask
  • 13 Jun 2024
  • 2 Minutes to read
  • Contributors
  • Dark
    Light

Save, edit, rename, or delete a Mask

  • Dark
    Light

Article summary

Once you've populated your Mask with Objects and you've applied all appropriate Selections and graphic customization, make sure to save it before associating it with a Screen.

Save a Mask

To save a Mask, click on the checkmark iconcontents/assets/images/assets/images/save-icon.png in the Top Menu.

If you try to leave the page without saving changes, a warning message will appear: from that popup window, you'll be able to return to the current Screen or to save/discard your changes before moving to another page.

Edit a Mask

To edit an existing Mask, you need to access a Capsule in Design mode.

Once Design mode is active, open a Capsule and, in the left panel, click on the Mask name you want to edit.

The Mask configuration page will open within your Capsule and you'll be able to edit your Mask by adding Objects on the Screen design area or by configuring other Mask properties from the Screen Properties panel.

Another way to edit an existing Mask is the following:

  1. In the left panel, click on the configure icon  contents/assets/images/panel.collapse.png to the right of the "Masks" root folder to access the "Masks" page

  2. Hover over the second column: either the Screen in the "Attached Screens" column or the Mask in the "Mask" column, depending on the table view

  3. Click the pencil icon that appears when hovering over the name of the Screen or Mask in the second column, depending on the table view. 

Again, the Mask configuration page within the Capsule of the chosen Attached Screen will open and you can edit your Mask just like you would with a Screen.

See Add and remove Objects, Configure Screen Objects and Screen Properties for more details.

Rename a Mask

To rename a Mask, you need to activate Design mode.

Once Design mode is active, access your Mask by clicking on it in the left panel under "Masks" in the Resources tab and proceed as follows:

  1. From the right Properties panel, go to "Data"

  2. Write the new name for your Mask in the "Screen name" field. The Mask name will also be immediately replaced in the navigation left panel

    The Mask name can be any number of characters long and can include any Unicode characters except the following:\ / : * " < > |

  3. Click "SAVE" above the Screen to save your Mask to apply changes

Delete a Mask

To delete a Mask, you need to access a Capsule in Design mode.

Once Design mode is active, proceed as follows:

  1. In the left panel, hover over the Mask you want to delete, click on the three-dot icon that appears on the right side of it or right click over the Mask name and click "Delete"

  2. A confirmation popup window will appear. Click "YES"

  3. The deleted Mask disappears from the left panel and simultaneously from any Screen it was associated with

Deleting a Mask deletes all its Objects and configuration settings. This action cannot be undone.


Was this article helpful?