RibbonControl.RestoreLayoutFromXml(String) Method

Loads the current RibbonControl‘s layout from the specific XML file.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v19.2.dll

Declaration

C#

public virtual void RestoreLayoutFromXml(
    string xmlFile
)

VB.NET

Public Overridable Sub RestoreLayoutFromXml(
    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 restored from.

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.SaveLayoutToXml and RestoreLayoutFromXml methods to do it in code.

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the RestoreLayoutFromXml(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-make-items-fixed-in-ribboncontrol-e4408/CS/WindowsFormsApplication1/Form1.cs#L46

{
    Ribbon.RestoreLayoutFromXml("ribbon.xml");
}

VB.NET

how-to-make-items-fixed-in-ribboncontrol-e4408/VB/WindowsFormsApplication1/Form1.vb#L39

If System.IO.File.Exists("ribbon.xml") Then
    Ribbon.RestoreLayoutFromXml("ribbon.xml")
End If