AddDescendantsOnCopy

Type: Boolean

Describes whether copying any part of the element will automatically add all descendants 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. The AddParentOnCopy property can be used to include more elements, but only content within the selection is copied. If the addDescendantsOnCopy property is set to true on one of the copied elements, however, all descendants of that element are included on the clipboard. The result is as if the selection was automatically expanded to include the full element.

This can be used in cases where you want to ensure a given node is always copied as a complete structure, including all descendants. For example, consider a person element where copying any selection of it or its parts should always include the full person structure:

configureProperties(sxModule, 'self::person', {
    addDescendantsOnCopy: true
});

In such cases you may also want to configure the AddParentOnCopy property on any relevant children (and possibly deeper descendants) of such elements. This property indicates that the parent element should also be copied if the selection is completely contained inside it.

Default value is false. This is automatically set to true for tables, as copying and pasting partial tables is not currently supported.

Related links

Was this page helpful?