Back to Devexpress

TileControl.SaveLayoutToRegistry(String) Method

windowsforms-devexpress-dot-xtraeditors-dot-tilecontrol-dot-savelayouttoregistry-x28-system-dot-string-x29.md

latest3.7 KB
Original Source

TileControl.SaveLayoutToRegistry(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 the current TileControl layout to a registry.

Namespace : DevExpress.XtraEditors

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
public virtual bool SaveLayoutToRegistry(
    string path
)
vb
Public Overridable Function SaveLayoutToRegistry(
    path As String
) As Boolean

Parameters

NameTypeDescription
pathString

A String value specifying the registry key in which the layout should be stored. If an empty string is specified, an exception is raised.

|

Returns

TypeDescription
Boolean

true if saving was successful; otherwise, false.

|

Remarks

The SaveLayoutToRegistry method creates an registry key to save the current custom TileControl layout at runtime. Later, this layout can be loaded via the TileControl.RestoreLayoutFromRegistry method. You can also save a custom user layout via the TileControl.SaveLayoutToXml and TileControl.SaveLayoutToStream methods.

Saved and restored layouts keep information only about group and item arrangements. Item content and appearance settings are not kept.

Tip

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

See Also

OptionsLayout

SaveLayoutToStream(Stream)

SaveLayoutToXml(String)

RestoreLayoutFromRegistry(String)

RestoreLayoutFromStream(Stream)

RestoreLayoutFromXml(String)

BeforeLoadLayout

LayoutUpgrade

Save and Restore Layouts of DevExpress controls

TileControl Class

TileControl Members

DevExpress.XtraEditors Namespace