PivotGridOptionsBehaviorBase.ClipboardCopyCollapsedValuesMode Property
Gets or sets how to copy collapsed field values to the Clipboard.
Namespace: DevExpress.XtraPivotGrid
Assembly: DevExpress.PivotGrid.v18.2.Core.dll
Declaration
[DefaultValue(CopyCollapsedValuesMode.PreserveCollapsedLevels)]
[XtraSerializableProperty]
public CopyCollapsedValuesMode ClipboardCopyCollapsedValuesMode { get; set; }Property Value
| Type | Default | Description |
|---|---|---|
| CopyCollapsedValuesMode | **PreserveCollapsedLevels** | A CopyCollapsedValuesMode enumeration value that specifies how to copy collapsed field values to the Clipboard. |
Available values:
| Name | Description |
|---|---|
| DuplicateCollapsedValues | Collapsed field values are replaced with duplicates of their parent values.
|
| PreserveCollapsedLevels | Collapsed field values are not copied but space is reserved for them.
|
| RemoveCollapsedLevels | Collapsed field values are not copied and space is not reserved for them.
|
Property Paths
You can access this nested property as listed below:
| Library | Object Type | Path to ClipboardCopyCollapsedValuesMode |
|---|---|---|
| WinForms Controls | PivotGridControl |
|
| ASP.NET Controls and MVC Extensions | ASPxPivotGrid |
|
| MVCxPivotGrid |
|
|
| PivotGridSettings |
|
|
| Reporting | XRPivotGrid |
|
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 PivotGridOptionsBehaviorBase.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 PivotGridOptionsBehaviorBase.CopyToClipboardWithFieldValues property.