DocumentAction Class

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

Namespace : DevExpress.XtraBars.Docking2010.Views.WindowsUI

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

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

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

Remarks

DocumentAction 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 DocumentAction s only within PageGroup and Page containers, since only these containers have an activated Document at all times. SlideGroup and SplitGroup containers have an activated Document when in a Detail screen only (see the WindowsUIView.ZoomLevel property).

DocumentAction s act like simple push button. You can also use the DocumentCheckAction objects that act like check buttons with two checked states - checked and unchecked.

To add a DocumentAction for a specific Document, implement the ISupportDocumentActions interface for the User Control that serves as this Document’s content. Then, 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> DocumentAction