Skip to main content

TdxDockingController.LoadLayoutFromStream(TStream,TCustomForm) Method

Loads the layout of dock controls from the specified stream.

Declaration

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

Parameters

Name Type
AStream TStream
AForm TCustomForm

Remarks

Use the LoadLayoutFromStream method to restore the layout of dock controls previously saved to a stream using the SaveLayoutToStream method call. The source stream is specified by the AStream parameter. If the specified stream is nil, an exception is raised. If the stream’s content is not dock controls layout information, all dock panels become undocked. Please refer to the dock control’s UnDock method description for details on undocking panels.

Note

the LoadLayoutFromStream method reads information starting from the current position within the stream. Thus, you may need to update the Position property of the source stream before calling the LoadLayoutFromStream method.

The method’s AForm parameter is optional. If omitted or set to nil, this method restores the layout of all dock controls whose settings are stored within the specified file. To restore the layout of dock controls that belong to a particular form, pass the desired form as this parameter.

See Also