BasicDesignerLoader.OnEndLoad(Boolean, ICollection) Method

Reference

Definition

Namespace:: System.ComponentModel.Design.Serialization

Assembly:: System.Design.dll

Assemblies:: System.Design.dll, System.Windows.Forms.Design.dll

Assembly:: System.Windows.Forms.Design.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Notifies the designer loader that loading is complete.

protected:
 virtual void OnEndLoad(bool successful, System::Collections::ICollection ^ errors);

protected virtual void OnEndLoad (bool successful, System.Collections.ICollection errors);

protected virtual void OnEndLoad (bool successful, System.Collections.ICollection? errors);

abstract member OnEndLoad : bool * System.Collections.ICollection -> unit
override this.OnEndLoad : bool * System.Collections.ICollection -> unit

Protected Overridable Sub OnEndLoad (successful As Boolean, errors As ICollection)

Parameters

successful: Boolean

true if the load completed successfully; otherwise, false.

errors: ICollection

An ICollection containing objects (usually exceptions) that were reported as errors.

Exceptions

InvalidOperationException

The IDesignerLoaderHost has not been initialized.

ObjectDisposedException

The IDesignerLoaderHost has been disposed.

Remarks

The OnEndLoad method is invoked when loading is finished. It is always called, even if an exception is thrown during loading. The value of successful will be set to true if the load succeeded, or false if a fatal error occurred. The errors collection will contain objects that were reported as errors. Usually, these objects are exceptions.

If you implement IDesignerLoaderService to provide dependent load support, you should call the OnEndLoad method after the last call to the IDesignerLoaderService.DependentLoadComplete method. By default, BasicDesignerLoader implements IDesignerLoaderService and does this for you. If IDesignerLoaderService is not available when BeginLoad is called, BeginLoad will directly call OnEndLoad after calling PerformLoad.

This method should be called by the designer loader service when all dependent loads have been completed. This stops the loading process that was initiated by the BeginLoad method. If you provide your own loader service, or if you choose not to provide a loader service, you are responsible for calling this method. The BeginLoad method will automatically call this, either indirectly by calling the IDesignerLoaderService.DependentLoadComplete method if IDesignerLoaderService is available, or directly if it is not.

Applies to