BaseView.ReleaseDeferredLoadControl(BaseDocument, Boolean, Boolean) Method

Fires the BaseView.ControlReleasing event with the specified parameters for the specified document.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v20.1.dll

Declaration

public void ReleaseDeferredLoadControl(
    BaseDocument document,
    bool keepControl,
    bool disposeControl
)
Public Sub ReleaseDeferredLoadControl(
    document As BaseDocument,
    keepControl As Boolean,
    disposeControl As Boolean
)

Parameters

Name Type Description
document BaseDocument

A BaseDocument object for which the event should be fired.

keepControl Boolean

true, to cancel releasing and keep the document content; otherwise, false.

disposeControl Boolean

true, to dispose the document content; otherwise, false.

Remarks

The ReleaseDeferredLoadControl method is in effect if the document content is loaded using the Deferred Load mechanism.

By default, when the BaseView.ControlReleasing event is fired on changing the selected document, the ControlReleasingEventArgs.KeepControl and ControlReleasingEventArgs.DisposeControl properties are set to true.

The ReleaseDeferredLoadControl method allows you to fire the BaseView.ControlReleasing event for the specified document with the specified ControlReleasingEventArgs.KeepControl and ControlReleasingEventArgs.DisposeControl properties. The keepControls parameter specifies the ControlReleasingEventArgs.KeepControl property value. The disposeControls parameter specifies the ControlReleasingEventArgs.DisposeControl property value. You can override these property values in the event handler. The document for which the event is raised can be selected via the DocumentCancelEventArgs.Document property of the ControlReleasingEventArgs object passed to an event handler.

The BaseView.ControlReleasing event does not fire if the content of the specified document is already released.

See Also