AuditTrailService.BeginSessionAudit(Session, AuditTrailStrategy, ObjectAuditingMode) Method

Starts auditing changes made to the object within the specified session.

Namespace: DevExpress.Persistent.AuditTrail

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

NuGet Package: DevExpress.Persistent.BaseImpl

Declaration

C#

public ObjectAuditProcessor BeginSessionAudit(
    Session session,
    AuditTrailStrategy strategy,
    ObjectAuditingMode auditingMode
)

VB.NET

Public Function BeginSessionAudit(
    session As Session,
    strategy As AuditTrailStrategy,
    auditingMode As ObjectAuditingMode
) As ObjectAuditProcessor

Parameters

Name	Type	Description
session	Session	The Session to be audited.
strategy	DevExpress.Persistent.AuditTrail.AuditTrailStrategy	The AuditTrailStrategy value.
auditingMode	DevExpress.Persistent.AuditTrail.ObjectAuditingMode	The ObjectAuditingMode value that is the object auditing mode. The default value is Full.

Returns

Type	Description
DevExpress.Persistent.AuditTrail.ObjectAuditProcessor	A processor that the Audit Trail Module uses for the specified auditingMode.

Remarks

Note

If you want to disable and enable the Audit Trail Module for a particular scenario, use solutions from the following help topic: Disable the Audit Trail Module.

The following code demonstrates how to call 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;
        AuditTrailService.Instance.EndSessionAudit(session);
        // ...
        AuditTrailService.Instance.BeginSessionAudit(session, 
            AuditTrailStrategy.OnObjectChanged, ObjectAuditingMode.Lightweight);
    }
    // ...
}

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
        AuditTrailService.Instance.EndSessionAudit(session)
        ' ...
        AuditTrailService.Instance.BeginSessionAudit(session, 
            AuditTrailStrategy.OnObjectChanged, ObjectAuditingMode.Lightweight)
    End Sub
    ' ...
End Class

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the BeginSessionAudit(Session, AuditTrailStrategy, ObjectAuditingMode) method.

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#

XPO_how-to-reuse-xaf-audit-trail-module-functionality-in-a-non-xaf-winforms-application-e2274/CS/WinExample/Form1.cs#L26

    AuditTrailService.Instance.AuditDataStore = new AuditDataStore<AuditDataItemPersistent, AuditedObjectWeakReference>();
    AuditTrailService.Instance.BeginSessionAudit(session1, AuditTrailStrategy.OnObjectChanged, ObjectAuditingMode.Full);
}

VB.NET

XPO_how-to-reuse-xaf-audit-trail-module-functionality-in-a-non-xaf-winforms-application-e2274/VB/WinExample/Form1.vb#L28

    AuditTrailService.Instance.AuditDataStore = New AuditDataStore(Of AuditDataItemPersistent, AuditedObjectWeakReference)()
    AuditTrailService.Instance.BeginSessionAudit(session1, AuditTrailStrategy.OnObjectChanged, ObjectAuditingMode.Full)
End Sub