Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

IEditableObject Interface

Provides functionality to commit or rollback changes to an object that is used as a data source.

Namespace:  System.ComponentModel
Assemblies:   System.ComponentModel (in System.ComponentModel.dll)
  System (in System.dll)

Public Interface IEditableObject

The IEditableObject type exposes the following members.

Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryBeginEditBegins an edit on an object.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryCancelEditDiscards changes since the last BeginEdit call.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryEndEditPushes changes since the last BeginEdit or IBindingList.AddNew call into the underlying object.

This interface is typically used to capture the BeginEdit, EndEdit, and CancelEdit semantics of a DataRowView.

The following sample provides a simple implementation of the IEditableObject interface. The Customer class stores customer information and can be used as a collection for a customer database. This sample assumes that you have used the CustomerList class that can be found in sample in the IBindingList class.

    Public Class Customer
        Implements IEditableObject

        Structure CustomerData
            Friend id As String 
            Friend firstName As String 
            Friend lastName As String 
        End Structure  

        Public parent As CustomersList
        Private custData As CustomerData
        Private backupData As CustomerData
        Private inTxn As Boolean = False 

        ' Implements IEditableObject 
        Sub BeginEdit() Implements IEditableObject.BeginEdit
            Console.WriteLine("Start BeginEdit")
            If Not inTxn Then 
                Me.backupData = custData
                inTxn = True
                Console.WriteLine(("BeginEdit - " + Me.backupData.lastName))
            End If
            Console.WriteLine("End BeginEdit")
        End Sub  

        Sub CancelEdit() Implements IEditableObject.CancelEdit
            Console.WriteLine("Start CancelEdit")
            If inTxn Then 
                Me.custData = backupData
                inTxn = False
                Console.WriteLine(("CancelEdit - " + Me.custData.lastName))
            End If
            Console.WriteLine("End CancelEdit")
        End Sub  

        Sub EndEdit() Implements IEditableObject.EndEdit
            Console.WriteLine(("Start EndEdit" + Me.custData.id + Me.custData.lastName))
            If inTxn Then
                backupData = New CustomerData()
                inTxn = False
                Console.WriteLine(("Done EndEdit - " + Me.custData.id + Me.custData.lastName))
            End If
            Console.WriteLine("End EndEdit")
        End Sub  

        Public Sub New(ByVal ID As String)
            Me.custData = New CustomerData()
            Me.custData.id = ID
            Me.custData.firstName = "" 
            Me.custData.lastName = "" 
        End Sub  

        Public ReadOnly Property ID() As String 
                Return Me.custData.id
            End Get 
        End Property 

        Public Property FirstName() As String 
                Return Me.custData.firstName
            End Get 
            Set(ByVal Value As String)
                Me.custData.firstName = Value
            End Set 
        End Property 

        Public Property LastName() As String 
                Return Me.custData.lastName
            End Get 
            Set(ByVal Value As String)
                Me.custData.lastName = Value
            End Set 
        End Property 

        Friend Property Parents() As CustomersList
                Return Parent
            End Get 
            Set(ByVal Value As CustomersList)
                parent = Value
            End Set 
        End Property 

        Private Sub OnCustomerChanged()
            If Not inTxn And (Parent IsNot Nothing) Then
            End If 
        End Sub  

        Public Overrides Function ToString() As String 
            Dim sb As New StringWriter()
            sb.Write(" ")
            Return sb.ToString()
        End Function  
    End Class

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
© 2015 Microsoft