Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IEditableObject Interface

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

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

'Declaration
Public Interface IEditableObject

The IEditableObject type exposes the following members.

  NameDescription
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.
Top

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
            Get
                Return Me.custData.id
            End Get
        End Property


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


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


        Friend Property Parents() As CustomersList
            Get
                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
                Parent.CustomerChanged(Me)
            End If
        End Sub 


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



.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

Show:
© 2017 Microsoft