ISupportDocumentActions.OnQueryDocumentActions(IDocumentActionsArgs) Method

Called each time a Document that implements the ISupportDocumentActions interface is activated.

Namespace: DevExpress.XtraBars.Docking2010.Views.WindowsUI

Assembly: DevExpress.XtraBars.v20.1.dll

Declaration

void OnQueryDocumentActions(
    IDocumentActionsArgs args
)
Sub OnQueryDocumentActions(
    args As IDocumentActionsArgs
)

Parameters

Name Type Description
args IDocumentActionsArgs

An IDocumentActionArgs object that contains data for the current method.

Remarks

You can implement the ISupportDocumentActions interface for your User Controls that serve as Document content. In this case, you can override the interface's OnQueryDocumentActions method and add a custom Document Action to the IDocumentActionsArgs.DocumentActions collection. When it's done, these Actions will appear as buttons in every Content Container that activated the related Document. Note that SlideGroup and SplitGroup containers do not have an activated Document, except for the Detail screen (see the WindowsUIView.ZoomLevel property). It is recommended that you use Document Actions within Page and PageGroup containers only.

Another way to add Document Actions is to handle the WindowsUIView.QueryDocumentActions event. See the How To: Create Custom Document Actions topic to learn more.

See Also