BaseView.ReleaseDeferredLoadControl(BaseDocument) Method

Disposes a specific deferred load Document within the current View.

Namespace : DevExpress.XtraBars.Docking2010.Views

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

public void ReleaseDeferredLoadControl(
    BaseDocument document
)

Public Sub ReleaseDeferredLoadControl(
    document As BaseDocument
)

Parameters

Name	Type	Description
document	BaseDocument

A BaseDocument object, loaded using the Deferred Load feature, which is to be disposed.

Remarks

Deferred load Documents are Documents with no content within. When such a Document needs to be displayed, the BaseView.QueryControl event occurs. Handle this event to set the Document’s content. Otherwise, an exception is thrown as Documents can not be displayed without any content.

After a deferred load Document gets unselected, the BaseView.ControlReleasing event is raised. Unless this event was canceled (set the ControlReleasingEventArgs.Cancel property to true in order to do so), the Document is disposed and will re-load its content next time it will be activated. The BaseView.ReleaseDeferredLoadControls method emulates this process and disposes all deferred load Documents within the current View. Use the ReleaseDeferredLoadControl method instead to dispose a specific Document.

The ReleaseDeferredLoadControl member is a part of the Deferred Load feature.