PivotGridControl.SaveLayoutToXml(String, OptionsLayoutBase) Method

Saves a Pivot Grid Control's layout to the specified XML file, using the specified settings.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v20.1.dll

Declaration

public void SaveLayoutToXml(
    string xmlFile,
    OptionsLayoutBase options
)
Public Sub SaveLayoutToXml(
    xmlFile As String,
    options As OptionsLayoutBase
)

Parameters

Name Type Description
xmlFile String

A string value specifying the path to the file where the Pivot Grid Control's layout settings should be stored. If an empty string is specified, an exception is raised.

options OptionsLayoutBase

A OptionsLayoutBase descendant that specifies which options should be saved.

Remarks

Use the SaveLayoutToXml method to save specific settings of a Pivot Grid Control to a file in XML format. These settings can then be restored via the PivotGridControl.RestoreLayoutFromXml method.

Note that you should specify unique names for all pivot grid fields to correctly save and restore the layout. You can do this using the PivotGridFieldBase.Name property.

The options parameter determines which options should be saved to the file. For the Pivot Grid Control a OptionsLayoutGrid object can be created, customized as required and then passed as the options parameter. Only the options that are enabled in this object will be saved.

To save all the options you can pass null or the static OptionsLayoutBase.FullLayout property as the options parameter.

The SaveLayoutToXml overload without the options parameter saves only the options which are specified by the PivotGridControl.OptionsLayout property.

NOTE

The expansion states of field values are not saved by the SaveLayoutToXml method.

TIP

You can utilize the Persistence Behavior or Workspace Manager component to save and restore layouts for all supported DevExpress controls at once.

See Also