Skip to main content
All docs
V25.1
  • DevExpress v25.1 Update — Your Feedback Matters

    Our What's New in v25.1 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

    Take the survey Not interested

    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.1.dll

    NuGet Package: DevExpress.Win.PivotGrid

    #Declaration

    public void SaveLayoutToJson(
        Stream utf8jsonStream
    )

    #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.

    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