SPWDAExtensions.MergeChangedData Method
Updates the DataSet with the change data provided by the event.
Namespace: Microsoft.Office.SharePointWorkspace.AddIn.Data
Assembly: Microsoft.Office.SharePointWorkspace.AddIn.Data (in Microsoft.Office.SharePointWorkspace.AddIn.Data.dll)
Syntax
'Declaration
<ExtensionAttribute> _
Public Shared Function MergeChangedData ( _
dataSet As DataSet, _
changeData As SPWDataChangeEventArgs _
) As Boolean
'Usage
Dim dataSet As DataSet
Dim changeData As SPWDataChangeEventArgs
Dim returnValue As Boolean
returnValue = dataSet.MergeChangedData(changeData)
public static bool MergeChangedData(
this DataSet dataSet,
SPWDataChangeEventArgs changeData
)
Parameters
- dataSet
Type: System.Data.DataSet
The DataSet to update with the change data.
- changeData
Type: Microsoft.Office.SharePointWorkspace.AddIn.Data.SPWDataChangeEventArgs
The change data provided by the data event.
Return Value
Type: System.Boolean
true if the method succeeds; otherwise, false.
Usage Note
In Visual Basic and C#, you can call this method as an instance method on any object of type DataSet. When you use instance method syntax to call this method, omit the first parameter. For more information, see https://msdn.microsoft.com/en-us/library/bb384936(v=office.14) or https://msdn.microsoft.com/en-us/library/bb383977(v=office.14).
Remarks
The DataSet contents are not automatically updated when the underlying data changes because the DataSet does not have a live connection to the underlying data. The MergeChangedData method allows you to resynchronize the DataSet with the underlying data based on change data returned by an event. If the underlying data has changed after this event, the DataSet will not be updated with those later changes until after you call this method again with the new event data.
Note
Although this method appears present on all DataSet objects, you can call this method only on DataSet objects that were either created by the Query method or filled by the Fill method or the FillSchema method. Calling this method on any other DataRow is unsupported and the results are undefined.