Back to Devexpress

RibbonControl.RestoreLayoutFromXml(String) Method

windowsforms-devexpress-dot-xtrabars-dot-ribbon-dot-ribboncontrol-dot-restorelayoutfromxml-x28-system-dot-string-x29.md

latest3.3 KB
Original Source

RibbonControl.RestoreLayoutFromXml(String) Method

SECURITY-RELATED CONSIDERATIONS

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

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

Namespace : DevExpress.XtraBars.Ribbon

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
public virtual void RestoreLayoutFromXml(
    string xmlFile
)
vb
Public Overridable Sub RestoreLayoutFromXml(
    xmlFile As String
)

Parameters

NameTypeDescription
xmlFileString

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.

See Also

AllowCustomization

SaveLayoutToXml(String)

InvalidSaveRestoreLayoutException

AutoSaveLayoutToXml

AutoSaveLayoutToXmlPath

BeforeLoadLayout

LayoutUpgrade

Save and Restore Layouts of DevExpress controls

RibbonControl Class

RibbonControl Members

DevExpress.XtraBars.Ribbon Namespace