TdxDockingManager.SaveLayoutToStream(TStream) Method

Saves the layout of dock controls to the specified stream.

Declaration

delphi

procedure SaveLayoutToStream(AStream: TStream);

Parameters

Name	Type
AStream	TStream

Remarks

Use the SaveLayoutToStream method to save the layout of dock controls to a stream. The target stream is specified by the AStream parameter. If the specified parameter value is nil , an exception is raised. Note also, that if the specified stream is a file stream, the SaveLayoutToStream method call results in creating a file with the same content as if using the SaveLayoutToIniFile method.

Settings saved by the SaveLayoutToStream method call can be restored using the LoadLayoutFromStream method. If storing settings within a stream doesn’t suit your needs, use either the SaveLayoutToIniFile or SaveLayoutToRegistry methods.

Note

the SaveLayoutToStream method saves the settings for dock controls which reside on the same form as the docking manager. To save the dock controls layout for all forms in an application, use the docking controller’s SaveLayoutToStream method instead.