PivotGridControl.SaveLayoutToJson(Stream) Method

Saves the Pivot Grid’s layout settings specified by the OptionsLayout property to a file in JSON format.

Namespace : DevExpress.XtraPivotGrid

Assembly : DevExpress.XtraPivotGrid.v25.2.dll

NuGet Package : DevExpress.Win.PivotGrid

Declaration

C#
VB.NET

csharp

public void SaveLayoutToJson(
    Stream utf8jsonStream
)

Public Sub SaveLayoutToJson(
    utf8jsonStream As Stream
)

Parameters

Name	Type	Description
utf8jsonStream	Stream

The layout in UTF-8 encoded JSON format.

Remarks

Use the RestoreLayoutFromJson method to load the layout to a file in JSON format.

C#
VB.NET

csharp

string filePath = "pivotgrid-layout.json";
void Form1_Load(object sender, EventArgs e) {
    if (File.Exists(filePath)) {
        using (var jsonStream = File.OpenRead(filePath))
            pivotGrid1.RestoreLayoutFromJson(jsonStream);
    }
}

void Form1_FormClosing(object sender, FormClosingEventArgs e) {
    using (var jsonStream = File.OpenWrite(filePath))
        pivotGrid1.SaveLayoutToJson(jsonStream);
}

Private filePath As String = "pivotgrid-layout.json"
Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
    If File.Exists(filePath) Then
        Using jsonStream = File.OpenRead(filePath)
            pivotGrid1.RestoreLayoutFromJson(jsonStream)
        End Using
    End If
End Sub

Private Sub Form1_FormClosing(ByVal sender As Object, ByVal e As FormClosingEventArgs)
    Using jsonStream = File.OpenWrite(filePath)
        pivotGrid1.SaveLayoutToJson(jsonStream)
    End Using
End Sub

Tip

Use the Persistence Behavior or Workspace Manager component to save and restore layouts for all DevExpress UI controls simultaneously.