Skip to main content
All docs
V25.1
  • PivotGridControl.RestoreLayoutFromJson(Stream) Method

    SECURITY NOTE

    Deserializing layout settings from untrusted resources may create security issues. Review the following help topic for additional information: Safe Deserialization.

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

    Namespace: DevExpress.XtraPivotGrid

    Assembly: DevExpress.XtraPivotGrid.v25.1.dll

    NuGet Package: DevExpress.Win.PivotGrid

    Declaration

    public void RestoreLayoutFromJson(
        Stream utf8jsonStream
    )

    Parameters

    Name Type Description
    utf8jsonStream Stream

    The layout in UTF-8 encoded JSON format.

    Remarks

    Use the SaveLayoutToJson method to save the layout to a file in JSON format.

    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);
    }
    

    Tip

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

    See Also