ReconcileDialog
Overview
This class represents the dialog form that is used whenever one or more changes failed to be applied on the server. In case of a failure, the client will receive this dialog, an exception or both alerts, depending on the value of the BaseDataAdapter.FailureBehavior property .
The image below shows an example view of the ReconcileDialog, which is shown on the client when a new field value has not been validated by the business rule:
For more details, see the Introduction to the Reconcile Dialog article.
This Dialog can be shown in two ways:
- By calling the class method ShowDialog(BaseDataAdapter, DataSet,List<DeltaChange>). The Reconcile form will then be created with defined parameters, shown to the user and disposed after closing.
- By calling the inherited (System.Windows.Forms.Form) ShowDialog(), in which case the
Changes,DataAdapterandDataSetproperties have to be manually filled.
Location
- Reference: RemObjects.DataAbstract.dll
- Namespace: RemObjects.DataAbstract
- Ancestry: Form | ReconcileDialog
constructor
Common constructor for System.Windows.Forms.Form. Required for Windows Form Designer support.
constructor
ReconcileDialog()
Sub New()
Changes
Contains the list of changes that failed during applying.
property Changes: List<DeltaChange> read write;
List<DeltaChange> Changes { get; set; }
Property Changes() As List<DeltaChange>
DataAdapter
Points to the BaseDataAdapter that has initiated this dialog due to errors in changing the remote data.
property DataAdapter: BaseDataAdapter read write;
BaseDataAdapter DataAdapter { get; set; }
Property DataAdapter() As BaseDataAdapter
DataSet
Contains a reference to the dataset with errors.
property DataSet: DataSet read write;
DataSet DataSet { get; set; }
Property DataSet() As DataSet
Dispose protected
Releases the resources used by the form.
method Dispose(aDisposing: Boolean)
void Dispose(Boolean aDisposing)
Sub Dispose(aDisposing As Boolean)
Parameters:
- aDisposing: True to release both managed and unmanaged resources; false to release only unmanaged resources.
Setup
Initializes the form interface and fills it with data from Changes.
method Setup
void Setup()
Sub Setup()
ShowDialog
Creates a new instance of the ReconcileDialog, fills its properties with the passed parameters and shows the dialog to the user.
class method ShowDialog(aRemoteDataAdapter: BaseDataAdapter; aDataSet: DataSet; aChanges: List<DeltaChange>)
static void ShowDialog(BaseDataAdapter aRemoteDataAdapter, DataSet aDataSet, List<DeltaChange> aChanges)
Shared Sub ShowDialog(aRemoteDataAdapter As BaseDataAdapter, aDataSet As DataSet, aChanges As List<DeltaChange>)
Parameters:
- aRemoteDataAdapter: Parent data adapter that initiates this dialog.
- aDataSet: Reference to the dataset with errors
- aChanges: List of changes that failed while applying
ShowReconcileRecordInAppUI
Fires before showing a ReconcileDialogDetails with detailed information about the selected error to the user. If handled, ReconcileDialogDetails will not be shown to the user.
event ShowReconcileRecordInAppUI: ShowReconcileRecordInAppUIEventHandler;
delegate: method ShowReconcileRecordInAppUI(sender: Object; e: ShowReconcileRecordInAppUIEventArgs)
delegate ShowReconcileRecordInAppUIEventHandler ShowReconcileRecordInAppUI()
delegate: void ShowReconcileRecordInAppUI(Object sender, ShowReconcileRecordInAppUIEventArgs e)
Event ShowReconcileRecordInAppUI As ShowReconcileRecordInAppUIEventHandler
delegate: Sub ShowReconcileRecordInAppUI(sender As Object, e As ShowReconcileRecordInAppUIEventArgs)
Changes
Contains the list of changes that failed during applying.
property Changes: List<DeltaChange> read write;
List<DeltaChange> Changes { get; set; }
Property Changes() As List<DeltaChange>
DataAdapter
Points to the BaseDataAdapter that has initiated this dialog due to errors in changing the remote data.
property DataAdapter: BaseDataAdapter read write;
BaseDataAdapter DataAdapter { get; set; }
Property DataAdapter() As BaseDataAdapter
DataSet
Contains a reference to the dataset with errors.
property DataSet: DataSet read write;
DataSet DataSet { get; set; }
Property DataSet() As DataSet
ShowDialog
Creates a new instance of the ReconcileDialog, fills its properties with the passed parameters and shows the dialog to the user.
class method ShowDialog(aRemoteDataAdapter: BaseDataAdapter; aDataSet: DataSet; aChanges: List<DeltaChange>)
static void ShowDialog(BaseDataAdapter aRemoteDataAdapter, DataSet aDataSet, List<DeltaChange> aChanges)
Shared Sub ShowDialog(aRemoteDataAdapter As BaseDataAdapter, aDataSet As DataSet, aChanges As List<DeltaChange>)
Parameters:
- aRemoteDataAdapter: Parent data adapter that initiates this dialog.
- aDataSet: Reference to the dataset with errors
- aChanges: List of changes that failed while applying
constructor
Common constructor for System.Windows.Forms.Form. Required for Windows Form Designer support.
constructor
ReconcileDialog()
Sub New()
Dispose protected
Releases the resources used by the form.
method Dispose(aDisposing: Boolean)
void Dispose(Boolean aDisposing)
Sub Dispose(aDisposing As Boolean)
Parameters:
- aDisposing: True to release both managed and unmanaged resources; false to release only unmanaged resources.
Setup
Initializes the form interface and fills it with data from Changes.
method Setup
void Setup()
Sub Setup()
ShowReconcileRecordInAppUI
Fires before showing a ReconcileDialogDetails with detailed information about the selected error to the user. If handled, ReconcileDialogDetails will not be shown to the user.
event ShowReconcileRecordInAppUI: ShowReconcileRecordInAppUIEventHandler;
delegate: method ShowReconcileRecordInAppUI(sender: Object; e: ShowReconcileRecordInAppUIEventArgs)
delegate ShowReconcileRecordInAppUIEventHandler ShowReconcileRecordInAppUI()
delegate: void ShowReconcileRecordInAppUI(Object sender, ShowReconcileRecordInAppUIEventArgs e)
Event ShowReconcileRecordInAppUI As ShowReconcileRecordInAppUIEventHandler
delegate: Sub ShowReconcileRecordInAppUI(sender As Object, e As ShowReconcileRecordInAppUIEventArgs)