DataControlBase.SaveLayoutToXml(String) Method

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

Saves a control’s layout to a file in XML format.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v25.2.Core.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public void SaveLayoutToXml(
    string path
)

VB.NET

Public Sub SaveLayoutToXml(
    path As String
)

Parameters

Name	Type	Description
path	String	A String value that specifies the target file name.

Remarks

To restore a control’s layout previously saved by the SaveLayoutToXml method, use the DataControlBase.RestoreLayoutFromXml method.

Note

Detail grids aren’t automatically serialized when saving the master grid’s layout. To learn more, see Master-Detail Mode Limitations.

To learn more, see Saving and Restoring Layout.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SaveLayoutToXml(String) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-prevent-certain-gridcontrols-properties-from-being-serialized-t158989/CS/WpfApplication58/MainWindow.xaml.cs#L23

void OnSaveLayout(object sender, RoutedEventArgs e) {
    grid.SaveLayoutToXml("layout.xml");
}

VB.NET

how-to-prevent-certain-gridcontrols-properties-from-being-serialized-t158989/VB/WpfApplication58/MainWindow.xaml.vb#L27

Private Sub OnSaveLayout(ByVal sender As Object, ByVal e As RoutedEventArgs)
    Me.grid.SaveLayoutToXml("layout.xml")
End Sub