PivotGridControl.ClipboardCopyCollapsedValuesMode Property

Gets or sets how to copy collapsed field values to the clipboard. This is a dependency property.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v14.2.dll

Declaration

C#

[XtraSerializableProperty]
[XtraSerializablePropertyId(0)]
public CopyCollapsedValuesMode ClipboardCopyCollapsedValuesMode { get; set; }

VB.NET

<XtraSerializableProperty>
<XtraSerializablePropertyId(0)>
Public Property ClipboardCopyCollapsedValuesMode As CopyCollapsedValuesMode

Property Value

Type	Description
CopyCollapsedValuesMode	A CopyCollapsedValuesMode enumeration value that specifies how to copy collapsed field values to the clipboard.

Remarks

PivotGridControl allows end-users to copy contents of the selected cells to the clipboard by pressing CTRL+C or CTRL+INS. You can optionally copy field values as well by setting the PivotGridControl.CopyToClipboardWithFieldValues property to true.

The ClipboardCopyCollapsedValuesMode property allows you to specify how to copy collapsed field values. They can be replaced with duplicates of their parent values or empty cells. You can also disable copying collapsed field values to the clipboard.

For instance, consider the following pivot grid.

The ClipboardCopyCollapsedValuesMode property allows you to select one of the following modes.

• CopyCollapsedValuesMode.DuplicateCollapsedValues

  Collapsed field values are replaced with duplicates of their parent values.

  

• CopyCollapsedValuesMode.PreserveCollapsedLevels

  Collapsed field values are not copied, but space is reserved for them.

  

• CopyCollapsedValuesMode.RemoveCollapsedLevels

  Collapsed field values are not copied and space is not reserved for them.

  

The ClipboardCopyCollapsedValuesMode property is not in effect if copying field values to the clipboard is disabled via the PivotGridControl.CopyToClipboardWithFieldValues property.