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.2.dll

Declaration

C#

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

VB.NET

<ActionGroup("Document", ActionType.Default)>
Public NotInheritable Class DocumentCheckAction
    Inherits DelegateActionCore(Of Document)
    Implements IDocumentCheckAction,
               IDocumentAction,
               IUIAction(Of Document),
               IUIActionProperties,
               IUICheckAction(Of Document),
               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.

Inheritance

Object

UIActionPropertiesCore

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

DocumentCheckAction