DocumentCheckAction Class

A check button displayed within a Content Container header and related to a specific Document.

Namespace: DevExpress.XtraBars.Docking2010.Views.WindowsUI

Assembly: DevExpress.XtraBars.v18.1.dll

Declaration

C#

[ActionGroup("Document", ActionType.Default)]
public sealed class DocumentCheckAction :
    DelegateActionCore<Document>,
    IDocumentCheckAction,
    IDocumentAction,
    IUICheckAction<Document>,
    IUIAction<Document>,
    IUIActionProperties,
    IActionStyle

VB.NET

<ActionGroup("Document", ActionType.Default)>
Public NotInheritable Class DocumentCheckAction
    Inherits DelegateActionCore(Of Document)
    Implements IDocumentCheckAction,
               IDocumentAction,
               IUICheckAction(Of Document),
               IUIAction(Of Document),
               IUIActionProperties,
               IActionStyle

Remarks

DocumentCheckAction objects are commands related to specific Documents within a WindowsUI application. Whenever a Document is activated, a corresponding Content Container displays Document Actions, related to the current Document, within its header.

Note

We recommend using DocumentCheckActions only within PageGroup and Page containers, since only these containers have an activated Document at all times. SlideGroup and SplitGroup container have an activated Document when in the Detail screen only (see the WindowsUIView.ZoomLevel property).

DocumentCheckActions act like check buttons and can execute different commands on check and uncheck. You can also use the DocumentAction objects that act like simple push buttons.

To add a DocumentCheckAction for a specific Document, implement the ISupportDocumentActions interface for the User Control that serves as this Document’s content, override the ISupportDocumentActions.OnQueryDocumentActions method and modify the IDocumentActionsArgs.DocumentActions collection. See the How To: Create Custom Document Actions topic for details.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DocumentCheckAction class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-add-custom-document-actions-e4852/CS/WindowsFormsApplication1/Views/ucModuleB.cs#L15

public void OnQueryDocumentActions(IDocumentActionsArgs args) {
    args.DocumentActions.Add(new DocumentCheckAction(() => viewModel.Flag, OnToggle) { Caption = "Flag" });
    args.DocumentActions.Add(new DocumentCheckAction(() => viewModel.IsSpecificState, OnCheck, OnUncheck) { Caption = "Specific State" });

VB.NET

how-to-add-custom-document-actions-e4852/VB/Views/ucModuleB.vb#L17

Public Sub OnQueryDocumentActions(args As IDocumentActionsArgs) Implements ISupportDocumentActions.OnQueryDocumentActions
    args.DocumentActions.Add(New DocumentCheckAction(Function() viewModel.Flag, Sub() OnToggle(args.Document)) With { _
        .Caption = "Flag" _

Inheritance

Object

UIActionPropertiesCore

DevExpress.XtraBars.Docking2010.Views.WindowsUI.DelegateActionCore<Document>

DocumentCheckAction