AuditTrailService.IsSessionAudited(Session) Method

Indicates whether the Audit Trail Module audits object changes within the specified session.

Namespace: DevExpress.Persistent.AuditTrail

Assembly: DevExpress.Persistent.BaseImpl.v20.2.dll

NuGet Package: DevExpress.Persistent.BaseImpl

Declaration

C#

public bool IsSessionAudited(
    Session session
)

VB.NET

Public Function IsSessionAudited(
    session As Session
) As Boolean

Parameters

Name	Type	Description
session	Session	The Session object this method checks.

Returns

Type	Description
Boolean	true if the Audit Trail Module audits object changes in the specified session; otherwise, false.

Remarks

The following code demonstrates how to use this method:

C#

using DevExpress.ExpressApp;
using DevExpress.Persistent.AuditTrail;
using DevExpress.Xpo;
// ...
public partial class MyController : ViewController {
    protected override void OnActivated() {
        base.OnActivated();
        Session session = ((XPObjectSpace)ObjectSpace).Session;
        if(AuditTrailService.Instance.IsSessionAudited(session)) {
            AuditTrailService.Instance.BeginSessionAudit(session, 
            AuditTrailStrategy.OnObjectChanged, ObjectAuditingMode.Full);  
        }
    }
    // ...
}

VB.NET

Imports DevExpress.ExpressApp
Imports DevExpress.Persistent.AuditTrail
Imports DevExpress.Xpo
' ...
Partial Public Class MyController
    Inherits ViewController
    Protected Overrides Sub OnActivated()
        MyBase.OnActivated()
        Dim session As Session = CType(ObjectSpace, XPObjectSpace).Session
        If AuditTrailService.Instance.IsSessionAudited(session) Then
            AuditTrailService.Instance.BeginSessionAudit(session, 
            AuditTrailStrategy.OnObjectChanged, ObjectAuditingMode.Full)
        End If
    End Sub
    ' ...
End Class