Skip to main content
.NET Framework 4.5.2+

LogoffController.LogoffAction Property

Provides access to the Logoff Action.

Namespace: DevExpress.ExpressApp.SystemModule

Assembly: DevExpress.ExpressApp.v22.1.dll

Declaration

public SimpleAction LogoffAction { get; }

Property Value

Type Description
SimpleAction

A SimpleAction object representing the Log Off Action.

Remarks

The Logoff Action allows end-users to log off from the application.

LogOffAction_Web

LogOffAction_Win

The Logoff Action is activated when the Security System’s IsLogoffEnabled property returns true. This occurs when the Authentication strategy, which is used by the current security system, enables logging off. By default, the Standard Authentication strategy permits logging off, while the Active Directory Authentication strategy prohibits this. The Log Off Action’s Execute event is handled by the LogoffControllerBase‘s Logoff protected method.

To ascertain why the Logoff Action is currently deactivated or disabled, use the DiagnosticInfo Action. If you need to change the Action’s “active” or “enabled” state in code, use its ActionBase.Active or ActionBase.Enabled property, respectively. Information on the Logoff Action is also available in the Application Model‘s ActionDesign node. You can access it, using the Model Editor.Application Model.

The XafApplication class exposes two events related to the Log Off Action. The XafApplication.LoggingOff event is raised after a user has clicked the Log Off button, and allows you to cancel the log off process. The XafApplication.LoggedOff event is raised after a user has logged off, and allows you to perform custom actions.

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

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.

See Also