TdxDockingController.SaveLayoutToStream(TStream,TCustomForm) Method

Saves the layout of dock controls to the specified stream.

Declaration

procedure SaveLayoutToStream(AStream: TStream; AForm: TCustomForm = nil);

Parameters

Name	Type
AStream	TStream
AForm	TCustomForm

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.

The AForm parameter is optional. If omitted or set to nil, the method saves the layout of all dock controls in the application. To save the layout of dock controls residing on a particular form, pass the desired form as this parameter.

The saved dock controls layout can be restored using the LoadLayoutFromStream method.