AddParentOnCopy

Type: Boolean

Describes whether copying the element will automatically add the parent element to the clipboard as well. Normally, copying a selection only includes elements up to (but not including) either the first element that fully contains the selection or the closest block, whichever is outermost.

In some cases, you may want to copy a more complete structure. For example, when copying an image in a schema that distinguishes inline and block-level images by their surrounding element, you can use this property to ensure that element is included on the clipboard:

configureProperties(sxModule, 'self::image[parent::fig]', {
    addParentOnCopy: true
});

Note that, by default, only content inside of the selection is copied to the clipboard. Use the AddDescendantsOnCopy property to include all descendants of a given element when part of that element is copied.

Default value is false. This is automatically set to true for table parts and list items.

Related links

Was this page helpful?