XPInstantFeedbackView.DismissSession Event

Occurs when the XPInstantFeedbackView no longer needs the Session it used to retrieve objects from the data store.

Namespace: DevExpress.Xpo

Assembly: DevExpress.Xpo.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

NuGet Package: DevExpress.Xpo

Declaration

C#

public event EventHandler<ResolveSessionEventArgs> DismissSession

VB.NET

Public Event DismissSession As EventHandler(Of ResolveSessionEventArgs)

Event Data

The DismissSession event's data class is ResolveSessionEventArgs. The following properties provide information specific to this event:

Property	Description
Session	Specifies the session to be used to load and save persistent objects.

Remarks

Handle this event to dispose of a Session if the session was created manually in the ResolveSession event handler. If you used the ResolveSession event handler to assign an object to the Tag field, you can use the DismissSession event to access the object. If you did not handle the ResolveSession event, in most scenarios you do not need to handle the DismissSession event.

Example

This example demonstrates how to initialize an XPInstantFeedbackView to retrieve data from a “Person.Contact” data table (included in the AdventureWorks database shipped with Microsoft SQL Server). The Person_Contact persistent class is declared and mapped to the “Person.Contact” data table, using the PersistentAttribute attribute. Then, this class is used as a parameter in the XPInstantFeedbackView constructor.

C#

using DevExpress.Xpo;
using DevExpress.Xpo.DB;
using DevExpress.Data.Filtering;

// The persistent class describing the "Person.Contact" table 
// from the AdventureWorks SQL database
[Persistent("Person.Contact")]
public class Person_Contact : XPLiteObject {        
    [Key]
    public System.Int32 ContactID {
        get { return fContactID; }
        set { SetPropertyValue(nameof(ContactID), ref fContactID, value); }
    }
    System.Int32 fContactID;

    public string FirstName {
        get { return fFirstName; }
        set { SetPropertyValue(nameof(FirstName), ref fFirstName, value); }
    }
    string fFirstName;

    public string LastName {
        get { return fLastName; }
        set { SetPropertyValue(nameof(LastName), ref fLastName, value); }
    }
    string fLastName;

    //...
}
public partial class Form1 : Form {
    //...
    public Form1() {
        // ...
        // Create a filter that selects records where last names start with 'A'     
        CriteriaOperator criteria = CriteriaOperator.Parse("[LastName] LIKE ?", "A%");
        // Specify the properties that will be available for binding
        ServerViewProperty[] displayableProperties = new ServerViewProperty[]{
            new ServerViewProperty("FirstName", SortDirection.Ascending, CriteriaOperator.Parse("[FirstName]")),
            new ServerViewProperty("LastName", SortDirection.None, CriteriaOperator.Parse("[LastName]"))
        };
        // Initialize an XPInstantFeedbackView data source 
        // supplying data from the Person.Contact data table     
        XPInstantFeedbackView instantDS = new XPInstantFeedbackView(
            typeof(Person_Contact), displayableProperties, criteria);
        // Handle the ResolveSession event, 
        // to provide a Session to the XPInstantFeedbackView
        instantDS.ResolveSession += instantDS_ResolveSession;
        // Handle the DismissSession event, to dispose of the Session
        instantDS.DismissSession += instantDS_DismissSession;
        //...
    }
    void instantDS_ResolveSession(object sender, ResolveSessionEventArgs e) {
        Session session = new Session();
        session.ConnectionString = @"Integrated Security=SSPI;Pooling=false;
            Data Source=.\SQLEXPRESS;Initial Catalog=MyDatabase";
        session.Connect();
        e.Session = session;
    }
    void instantDS_DismissSession(object sender, ResolveSessionEventArgs e) {
        IDisposable session = e.Session as IDisposable;
        if(session != null) {
            session.Dispose();
        }
    }
}

VB.NET

Imports Microsoft.VisualBasic
Imports DevExpress.Xpo
Imports DevExpress.Xpo.DB
Imports DevExpress.Data.Filtering

' The persistent class describing the "Person.Contact" table 
' from the AdventureWorks SQL database
<Persistent("Person.Contact")>
Public Class Person_Contact
    Inherits XPLiteObject

    <Key>
    Public Property ContactID() As System.Int32
        Get
            Return fContactID
        End Get
        Set(ByVal value as System.Int32)
            SetPropertyValue(NameOf(ContactID), fContactID, value)
        End Set
    End Property
    Private fContactID As System.Int32

    Public Property FirstName() As String
        Get
            Return fFirstName
        End Get
        Set(ByVal value as String)
            SetPropertyValue(NameOf(FirstName), fFirstName, value)
        End Set
    End Property
    Private fFirstName As String

    Public Property LastName() As String
        Get
            Return fLastName
        End Get
        Set(ByVal value as String)
            SetPropertyValue(NameOf(LastName), fLastName, value)
        End Set
    End Property
    Private fLastName As String

    '...
End Class
Partial Public Class Form1
    Inherits Form

    '...
    Public Sub New()
        ' ...
        ' Create a filter that selects records where last names start with 'A'     
        Dim criteria As CriteriaOperator = CriteriaOperator.Parse("[LastName] LIKE ?", "A%")
        ' Specify the properties that will be available for binding
        Dim displayableProperties() As ServerViewProperty = {
            New ServerViewProperty("FirstName", SortDirection.Ascending, CriteriaOperator.Parse("[FirstName]")),
            New ServerViewProperty("LastName", SortDirection.None, CriteriaOperator.Parse("[LastName]"))
        }
        ' Initialize an XPInstantFeedbackView data source 
        ' supplying data from the Person.Contact data table     
        Dim instantDS As New XPInstantFeedbackView(GetType(Person_Contact), displayableProperties, criteria)
        ' Handle the ResolveSession event, 
        ' to provide a Session to the XPInstantFeedbackView
        AddHandler instantDS.ResolveSession, AddressOf instantDS_ResolveSession
        ' Handle the DismissSession event, to dispose of the Session
        AddHandler instantDS.DismissSession, AddressOf instantDS_DismissSession
        '...
    End Sub
    Private Sub instantDS_ResolveSession(ByVal sender As Object, ByVal e As ResolveSessionEventArgs)
        Dim session As New Session()
        session.ConnectionString = "Integrated Security=SSPI;Pooling=false;
            Data Source=.\SQLEXPRESS;Initial Catalog=MyDatabase"
        session.Connect()
        e.Session = session
    End Sub
    Private Sub instantDS_DismissSession(ByVal sender As Object, ByVal e As ResolveSessionEventArgs)
        Dim session As IDisposable = TryCast(e.Session, IDisposable)
        If session IsNot Nothing Then
            session.Dispose()
        End If
    End Sub
End Class