RibbonControl.SaveLayoutToXml(String) Method

Saves the current RibbonControl‘s layout to the specific XML file.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public virtual void SaveLayoutToXml(
    string xmlFile
)

VB.NET

Public Overridable Sub SaveLayoutToXml(
    xmlFile As String
)

Parameters

Name	Type	Description
xmlFile	String	A String value that is the path to an XML file where the current RibbonControl‘s layout should be saved.

Remarks

An end-user can customize a RibbonControl at runtime if the RibbonControl.AllowCustomization property is set to true. Customized layouts can also be saved to an XML file or loaded from it. An end-user can do it via the Import/Export button in the Ribbon Customization Window. Use the RibbonControl.RestoreLayoutFromXml and SaveLayoutToXml methods to do it in code.

Failure to save or restore a ribbon layout fires the RibbonControl.InvalidSaveRestoreLayoutException event.

Tip

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