OdbcRowUpdatingEventArgs.xml 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <Type Name="OdbcRowUpdatingEventArgs" FullName="System.Data.Odbc.OdbcRowUpdatingEventArgs">
  3. <TypeSignature Language="C#" Value="public sealed class OdbcRowUpdatingEventArgs : System.Data.Common.RowUpdatingEventArgs" />
  4. <AssemblyInfo>
  5. <AssemblyName>System.Data</AssemblyName>
  6. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  7. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  8. </AssemblyInfo>
  9. <Base>
  10. <BaseTypeName>System.Data.Common.RowUpdatingEventArgs</BaseTypeName>
  11. </Base>
  12. <Interfaces />
  13. <Docs>
  14. <remarks>
  15. <attribution license="cc4" from="Microsoft" modified="false" />
  16. <para>The <see cref="E:System.Data.Odbc.OdbcDataAdapter.RowUpdating" /> event is raised before an update to a row.</para>
  17. <para>When using the Update method, there are two events that occur for each data row updated: <see cref="E:System.Data.Odbc.OdbcDataAdapter.RowUpdating" /> and <see cref="E:System.Data.Odbc.OdbcDataAdapter.RowUpdated" />. The order of execution for an update operation is as follows:</para>
  18. <list type="ordered">
  19. <item>
  20. <para>The values in the <see cref="T:System.Data.DataRow" /> are moved to the parameter values.</para>
  21. </item>
  22. <item>
  23. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdating(System.Data.Common.RowUpdatingEventArgs)" /> event is raised.</para>
  24. </item>
  25. <item>
  26. <para>The command executes.</para>
  27. </item>
  28. <item>
  29. <para>If the command is set to FirstReturnedRecord, then the first returned result is placed in the <see cref="T:System.Data.DataRow" />.</para>
  30. </item>
  31. <item>
  32. <para>If there are output parameters, they are placed in the <see cref="T:System.Data.DataRow" />.</para>
  33. </item>
  34. <item>
  35. <para>The <see cref="M:System.Data.Common.DbDataAdapter.OnRowUpdated(System.Data.Common.RowUpdatedEventArgs)" /> event is raised.</para>
  36. </item>
  37. <item>
  38. <para>
  39. <see cref="M:System.Data.DataRow.AcceptChanges" /> is called.</para>
  40. </item>
  41. </list>
  42. </remarks>
  43. <summary>
  44. <attribution license="cc4" from="Microsoft" modified="false" />
  45. <para>Provides data for the <see cref="E:System.Data.Odbc.OdbcDataAdapter.RowUpdating" /> event.</para>
  46. </summary>
  47. </Docs>
  48. <Members>
  49. <Member MemberName=".ctor">
  50. <MemberSignature Language="C#" Value="public OdbcRowUpdatingEventArgs (System.Data.DataRow row, System.Data.IDbCommand command, System.Data.StatementType statementType, System.Data.Common.DataTableMapping tableMapping);" />
  51. <MemberType>Constructor</MemberType>
  52. <Parameters>
  53. <Parameter Name="row" Type="System.Data.DataRow" />
  54. <Parameter Name="command" Type="System.Data.IDbCommand" />
  55. <Parameter Name="statementType" Type="System.Data.StatementType" />
  56. <Parameter Name="tableMapping" Type="System.Data.Common.DataTableMapping" />
  57. </Parameters>
  58. <Docs>
  59. <remarks>To be added.</remarks>
  60. <summary>
  61. <attribution license="cc4" from="Microsoft" modified="false" />
  62. <para>Initializes a new instance of the <see cref="T:System.Data.Odbc.OdbcRowUpdatingEventArgs" /> class.</para>
  63. </summary>
  64. <param name="row">
  65. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataRow" /> to update. </param>
  66. <param name="command">
  67. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.Odbc.OdbcCommand" /> to execute during the update operation. </param>
  68. <param name="statementType">
  69. <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Data.StatementType" /> values that specifies the type of query executed. </param>
  70. <param name="tableMapping">
  71. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.Common.DataTableMapping" /> sent through <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" />. </param>
  72. </Docs>
  73. <AssemblyInfo>
  74. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  75. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  76. </AssemblyInfo>
  77. </Member>
  78. <Member MemberName="BaseCommand">
  79. <MemberSignature Language="C#" Value="protected override System.Data.IDbCommand BaseCommand { set; get; }" />
  80. <MemberType>Property</MemberType>
  81. <AssemblyInfo>
  82. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  83. </AssemblyInfo>
  84. <ReturnValue>
  85. <ReturnType>System.Data.IDbCommand</ReturnType>
  86. </ReturnValue>
  87. <Docs>
  88. <summary>To be added.</summary>
  89. <value>To be added.</value>
  90. <remarks>To be added.</remarks>
  91. </Docs>
  92. </Member>
  93. <Member MemberName="Command">
  94. <MemberSignature Language="C#" Value="public System.Data.Odbc.OdbcCommand Command { set; get; }" />
  95. <MemberType>Property</MemberType>
  96. <ReturnValue>
  97. <ReturnType>System.Data.Odbc.OdbcCommand</ReturnType>
  98. </ReturnValue>
  99. <Docs>
  100. <value>To be added.</value>
  101. <remarks>To be added.</remarks>
  102. <summary>
  103. <attribution license="cc4" from="Microsoft" modified="false" />
  104. <para>Gets or sets the <see cref="T:System.Data.Odbc.OdbcCommand" /> to execute when <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> is called.</para>
  105. </summary>
  106. </Docs>
  107. <AssemblyInfo>
  108. <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  109. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  110. </AssemblyInfo>
  111. </Member>
  112. </Members>
  113. </Type>