DbCommandBuilder.xml 51 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <Type Name="DbCommandBuilder" FullName="System.Data.Common.DbCommandBuilder">
  3. <TypeSignature Language="C#" Value="public abstract class DbCommandBuilder : System.ComponentModel.Component" />
  4. <AssemblyInfo>
  5. <AssemblyName>System.Data</AssemblyName>
  6. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>System.ComponentModel.Component</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <since version=".NET 2.0" />
  14. <remarks>
  15. <attribution license="cc4" from="Microsoft" modified="false" />
  16. <para>The <see cref="T:System.Data.Common.DbCommandBuilder" /> class is provided for the convenience of provider writers creating their own command builders. By inheriting from this class, developers can implement provider specific behavior in their own code.</para>
  17. <para>The <see cref="T:System.Data.Common.DbDataAdapter" /> does not automatically generate the SQL statements required to reconcile changes made to a <see cref="T:System.Data.DataSet" /> with the associated data source. However, you can create a <see cref="T:System.Data.Common.DbCommandBuilder" /> object to automatically generate SQL statements for single-table updates if you set the <see cref="P:System.Data.Common.DbDataAdapter.SelectCommand" /> property of the <see cref="T:System.Data.Common.DbDataAdapter" />. Then, any additional SQL statements that you do not set are generated by the <see cref="T:System.Data.Common.DbCommandBuilder" />.</para>
  18. <para>The <see cref="T:System.Data.Common.DbCommandBuilder" /> registers itself as a listener for <see cref="E:System.Data.OleDb.OleDbDataAdapter.RowUpdating" /> events whenever you set the <see cref="P:System.Data.Common.DbCommandBuilder.DataAdapter" /> property. You can only associate one <see cref="T:System.Data.Common.DbDataAdapter" /> or <see cref="T:System.Data.Common.DbCommandBuilder" /> object with each other at one time.</para>
  19. <para>To generate INSERT, UPDATE, or DELETE statements, the <see cref="T:System.Data.Common.DbCommandBuilder" /> uses the <see cref="P:System.Data.Common.DbDataAdapter.SelectCommand" /> property to retrieve a required set of metadata automatically. If you change the <see cref="P:System.Data.Common.DbDataAdapter.SelectCommand" /> after the metadata has been retrieved (for example, after the first update), you should call the <see cref="M:System.Data.Common.DbCommandBuilder.RefreshSchema" /> method to update the metadata.</para>
  20. <para>The SelectCommand must also return at least one primary key or unique column. If none exist, an <see cref="T:System.InvalidOperationException" /> exception is generated, and the commands are not generated.</para>
  21. <para>The <see cref="T:System.Data.Common.DbCommandBuilder" /> also uses the <see cref="P:System.Data.Common.DbCommand.Connection" />, <see cref="P:System.Data.Common.DbCommand.CommandTimeout" />, and <see cref="P:System.Data.Common.DbCommand.Transaction" /> properties referenced by the <see cref="P:System.Data.Common.DbDataAdapter.SelectCommand" />. The user should call <see cref="M:System.Data.Common.DbCommandBuilder.RefreshSchema" /> if any of these properties are modified, or if the <see cref="P:System.Data.Common.DbDataAdapter.SelectCommand" /> itself is replaced. Otherwise the <see cref="P:System.Data.Common.DbDataAdapter.InsertCommand" />, <see cref="P:System.Data.Common.DbDataAdapter.UpdateCommand" />, and <see cref="P:System.Data.Common.DbDataAdapter.DeleteCommand" /> properties retain their previous values.</para>
  22. <para>If you call <see cref="M:System.ComponentModel.Component.Dispose" />, the <see cref="T:System.Data.Common.DbCommandBuilder" /> is disassociated from the <see cref="T:System.Data.Common.DbDataAdapter" />, and the generated commands are no longer used.</para>
  23. </remarks>
  24. <summary>
  25. <attribution license="cc4" from="Microsoft" modified="false" />
  26. <para>Automatically generates single-table commands used to reconcile changes made to a <see cref="T:System.Data.DataSet" /> with the associated database. This is an abstract class that can only be inherited.</para>
  27. </summary>
  28. </Docs>
  29. <Members>
  30. <Member MemberName=".ctor">
  31. <MemberSignature Language="C#" Value="protected DbCommandBuilder ();" />
  32. <MemberType>Constructor</MemberType>
  33. <Parameters />
  34. <Docs>
  35. <remarks>To be added.</remarks>
  36. <since version=".NET 2.0" />
  37. <summary>
  38. <attribution license="cc4" from="Microsoft" modified="false" />
  39. <para>Initializes a new instance of a class that inherits from the <see cref="T:System.Data.Common.DbCommandBuilder" /> class. </para>
  40. </summary>
  41. </Docs>
  42. <AssemblyInfo>
  43. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  44. </AssemblyInfo>
  45. </Member>
  46. <Member MemberName="ApplyParameterInfo">
  47. <MemberSignature Language="C#" Value="protected abstract void ApplyParameterInfo (System.Data.Common.DbParameter parameter, System.Data.DataRow row, System.Data.StatementType statementType, bool whereClause);" />
  48. <MemberType>Method</MemberType>
  49. <ReturnValue>
  50. <ReturnType>System.Void</ReturnType>
  51. </ReturnValue>
  52. <Parameters>
  53. <Parameter Name="parameter" Type="System.Data.Common.DbParameter" />
  54. <Parameter Name="row" Type="System.Data.DataRow" />
  55. <Parameter Name="statementType" Type="System.Data.StatementType" />
  56. <Parameter Name="whereClause" Type="System.Boolean" />
  57. </Parameters>
  58. <Docs>
  59. <since version=".NET 2.0" />
  60. <remarks>
  61. <attribution license="cc4" from="Microsoft" modified="false" />
  62. <para>This method allows an implementation of the <see cref="T:System.Data.Common.DbCommandBuilder" /> class to handle provider-specific parameter properties.</para>
  63. </remarks>
  64. <summary>
  65. <attribution license="cc4" from="Microsoft" modified="false" />
  66. <para>Allows the provider implementation of the <see cref="T:System.Data.Common.DbCommandBuilder" /> class to handle additional parameter properties.</para>
  67. </summary>
  68. <param name="parameter">
  69. <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Data.Common.DbParameter" /> to which the additional modifications are applied. </param>
  70. <param name="row">
  71. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.DataRow" /> from the schema table provided by <see cref="M:System.Data.Common.DbDataReader.GetSchemaTable" />. </param>
  72. <param name="statementType">
  73. <attribution license="cc4" from="Microsoft" modified="false" />The type of command being generated; INSERT, UPDATE or DELETE. </param>
  74. <param name="whereClause">
  75. <attribution license="cc4" from="Microsoft" modified="false" />true if the parameter is part of the update or delete WHERE clause, false if it is part of the insert or update values. </param>
  76. </Docs>
  77. <AssemblyInfo>
  78. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  79. </AssemblyInfo>
  80. </Member>
  81. <Member MemberName="CatalogLocation">
  82. <MemberSignature Language="C#" Value="public virtual System.Data.Common.CatalogLocation CatalogLocation { set; get; }" />
  83. <MemberType>Property</MemberType>
  84. <Attributes>
  85. <Attribute>
  86. <AttributeName>System.ComponentModel.DefaultValue(System.Data.Common.CatalogLocation.Start)</AttributeName>
  87. </Attribute>
  88. </Attributes>
  89. <ReturnValue>
  90. <ReturnType>System.Data.Common.CatalogLocation</ReturnType>
  91. </ReturnValue>
  92. <Docs>
  93. <value>To be added.</value>
  94. <remarks>To be added.</remarks>
  95. <since version=".NET 2.0" />
  96. <summary>
  97. <attribution license="cc4" from="Microsoft" modified="false" />
  98. <para>Sets or gets the <see cref="T:System.Data.Common.CatalogLocation" /> for an instance of the <see cref="T:System.Data.Common.DbCommandBuilder" /> class.</para>
  99. </summary>
  100. </Docs>
  101. <AssemblyInfo>
  102. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  103. </AssemblyInfo>
  104. </Member>
  105. <Member MemberName="CatalogSeparator">
  106. <MemberSignature Language="C#" Value="public virtual string CatalogSeparator { set; get; }" />
  107. <MemberType>Property</MemberType>
  108. <Attributes>
  109. <Attribute>
  110. <AttributeName>System.ComponentModel.DefaultValue(".")</AttributeName>
  111. </Attribute>
  112. </Attributes>
  113. <ReturnValue>
  114. <ReturnType>System.String</ReturnType>
  115. </ReturnValue>
  116. <Docs>
  117. <value>To be added.</value>
  118. <remarks>To be added.</remarks>
  119. <since version=".NET 2.0" />
  120. <summary>
  121. <attribution license="cc4" from="Microsoft" modified="false" />
  122. <para>Sets or gets a string used as the catalog separator for an instance of the <see cref="T:System.Data.Common.DbCommandBuilder" /> class.</para>
  123. </summary>
  124. </Docs>
  125. <AssemblyInfo>
  126. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  127. </AssemblyInfo>
  128. </Member>
  129. <Member MemberName="ConflictOption">
  130. <MemberSignature Language="C#" Value="public virtual System.Data.ConflictOption ConflictOption { set; get; }" />
  131. <MemberType>Property</MemberType>
  132. <Attributes>
  133. <Attribute>
  134. <AttributeName>System.ComponentModel.DefaultValue(System.Data.ConflictOption.CompareAllSearchableValues)</AttributeName>
  135. </Attribute>
  136. </Attributes>
  137. <ReturnValue>
  138. <ReturnType>System.Data.ConflictOption</ReturnType>
  139. </ReturnValue>
  140. <Docs>
  141. <value>To be added.</value>
  142. <remarks>To be added.</remarks>
  143. <since version=".NET 2.0" />
  144. <summary>
  145. <attribution license="cc4" from="Microsoft" modified="false" />
  146. <para>Specifies which <see cref="T:System.Data.ConflictOption" /> is to be used by the <see cref="T:System.Data.Common.DbCommandBuilder" />.</para>
  147. </summary>
  148. </Docs>
  149. <AssemblyInfo>
  150. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  151. </AssemblyInfo>
  152. </Member>
  153. <Member MemberName="DataAdapter">
  154. <MemberSignature Language="C#" Value="public System.Data.Common.DbDataAdapter DataAdapter { set; get; }" />
  155. <MemberType>Property</MemberType>
  156. <Attributes>
  157. <Attribute>
  158. <AttributeName>System.ComponentModel.Browsable(false)</AttributeName>
  159. </Attribute>
  160. <Attribute>
  161. <AttributeName>System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)</AttributeName>
  162. </Attribute>
  163. </Attributes>
  164. <ReturnValue>
  165. <ReturnType>System.Data.Common.DbDataAdapter</ReturnType>
  166. </ReturnValue>
  167. <Docs>
  168. <value>To be added.</value>
  169. <since version=".NET 2.0" />
  170. <remarks>
  171. <attribution license="cc4" from="Microsoft" modified="false" />
  172. <para>The <see cref="T:System.Data.Common.DbCommandBuilder" /> registers itself as a listener for <see cref="E:System.Data.OleDb.OleDbDataAdapter.RowUpdating" /> events that are generated by the <see cref="T:System.Data.Common.DbDataAdapter" /> specified in this property.</para>
  173. <para>When you create a new instance of <see cref="T:System.Data.Common.DbCommandBuilder" />, any existing <see cref="T:System.Data.Common.DbCommandBuilder" /> associated with this <see cref="T:System.Data.Common.DbDataAdapter" /> is released.</para>
  174. </remarks>
  175. <summary>
  176. <attribution license="cc4" from="Microsoft" modified="false" />
  177. <para>Gets or sets a <see cref="T:System.Data.Common.DbDataAdapter" /> object for which Transact-SQL statements are automatically generated.</para>
  178. </summary>
  179. </Docs>
  180. <AssemblyInfo>
  181. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  182. </AssemblyInfo>
  183. </Member>
  184. <Member MemberName="Dispose">
  185. <MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
  186. <MemberType>Method</MemberType>
  187. <ReturnValue>
  188. <ReturnType>System.Void</ReturnType>
  189. </ReturnValue>
  190. <Parameters>
  191. <Parameter Name="disposing" Type="System.Boolean" />
  192. </Parameters>
  193. <Docs>
  194. <since version=".NET 2.0" />
  195. <remarks>
  196. <attribution license="cc4" from="Microsoft" modified="false" />
  197. <para>This method is called by the public <see cref="Overload:System.Data.Common.DbCommandBuilder.Dispose" /> method and the Finalize method. <see cref="Overload:System.Data.Common.DbCommandBuilder.Dispose" /> invokes the protected <see cref="M:System.Data.Common.DbCommandBuilder.Dispose(System.Boolean)" /> method with the disposing parameter set to true. Finalize invokes Dispose with disposing set to false.</para>
  198. <para>When the <paramref name="disposing" /> parameter is true, this method releases all resources held by any managed objects that this <see cref="T:System.Data.Common.DbCommandBuilder" /> references. This method invokes the <see cref="Overload:System.Data.Common.DbCommandBuilder.Dispose" /> method of each referenced object.</para>
  199. </remarks>
  200. <summary>
  201. <attribution license="cc4" from="Microsoft" modified="false" />
  202. <para>Releases the unmanaged resources used by the <see cref="T:System.Data.Common.DbCommandBuilder" /> and optionally releases the managed resources.</para>
  203. </summary>
  204. <param name="disposing">
  205. <attribution license="cc4" from="Microsoft" modified="false" />true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
  206. </Docs>
  207. <AssemblyInfo>
  208. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  209. </AssemblyInfo>
  210. </Member>
  211. <Member MemberName="GetDeleteCommand">
  212. <MemberSignature Language="C#" Value="public System.Data.Common.DbCommand GetDeleteCommand ();" />
  213. <MemberType>Method</MemberType>
  214. <ReturnValue>
  215. <ReturnType>System.Data.Common.DbCommand</ReturnType>
  216. </ReturnValue>
  217. <Parameters />
  218. <Docs>
  219. <since version=".NET 2.0" />
  220. <remarks>
  221. <attribution license="cc4" from="Microsoft" modified="false" />
  222. <para>An application can use the <see cref="M:System.Data.Common.DbCommandBuilder.GetDeleteCommand" /> method for informational or troubleshooting purposes because it returns the <see cref="T:System.Data.Common.DbCommand" /> object to be executed.</para>
  223. <para>You can also use <see cref="M:System.Data.Common.DbCommandBuilder.GetDeleteCommand" /> as the basis of a modified command. For example, you might call <see cref="M:System.Data.Common.DbCommandBuilder.GetDeleteCommand" /> and modify the command text, and then explicitly set that on the <see cref="T:System.Data.Common.DbDataAdapter" />.</para>
  224. <para>After the SQL statement is first generated, the application must explicitly call <see cref="M:System.Data.Common.DbCommandBuilder.RefreshSchema" /> if it changes the statement in any way. Otherwise, the <see cref="M:System.Data.Common.DbCommandBuilder.GetDeleteCommand" /> will still be using information from the previous statement, which might not be correct. The SQL statements are first generated either when the application calls <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> or <see cref="M:System.Data.Common.DbCommandBuilder.GetDeleteCommand" />.</para>
  225. </remarks>
  226. <summary>
  227. <attribution license="cc4" from="Microsoft" modified="false" />
  228. <para>Gets the automatically generated <see cref="T:System.Data.Common.DbCommand" /> object required to perform deletions at the data source.</para>
  229. </summary>
  230. <returns>
  231. <attribution license="cc4" from="Microsoft" modified="false" />
  232. <para>The automatically generated <see cref="T:System.Data.Common.DbCommand" /> object required to perform deletions.</para>
  233. </returns>
  234. </Docs>
  235. <AssemblyInfo>
  236. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  237. </AssemblyInfo>
  238. </Member>
  239. <Member MemberName="GetDeleteCommand">
  240. <MemberSignature Language="C#" Value="public System.Data.Common.DbCommand GetDeleteCommand (bool option);" />
  241. <MemberType>Method</MemberType>
  242. <ReturnValue>
  243. <ReturnType>System.Data.Common.DbCommand</ReturnType>
  244. </ReturnValue>
  245. <Parameters>
  246. <Parameter Name="option" Type="System.Boolean" />
  247. </Parameters>
  248. <Docs>
  249. <param name="option">To be added.</param>
  250. <since version=".NET 2.0" />
  251. <remarks>
  252. <attribution license="cc4" from="Microsoft" modified="false" />
  253. <para>An application can use the <see cref="M:System.Data.Common.DbCommandBuilder.GetDeleteCommand" /> method for informational or troubleshooting purposes because it returns the <see cref="T:System.Data.Common.DbCommand" /> object to be executed.</para>
  254. <para>You can also use <see cref="M:System.Data.Common.DbCommandBuilder.GetDeleteCommand" /> as the basis of a modified command. For example, you might call <see cref="M:System.Data.Common.DbCommandBuilder.GetDeleteCommand" /> and modify the command text, and then explicitly set that on the <see cref="T:System.Data.Common.DbDataAdapter" />. </para>
  255. <para>After the SQL statement is first generated, the application must explicitly call <see cref="M:System.Data.Common.DbCommandBuilder.RefreshSchema" /> if it changes the statement in any way. Otherwise, the <see cref="M:System.Data.Common.DbCommandBuilder.GetDeleteCommand" /> will still be using information from the previous statement, which might not be correct. The SQL statements are first generated either when the application calls <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> or <see cref="M:System.Data.Common.DbCommandBuilder.GetDeleteCommand" />.</para>
  256. <para>The default behavior, when generating parameter names, is to use @p1, @p2, and so on for the various parameters. Passing true for the <paramref name="useColumnsForParameterNames" /> parameter allows you to force the <see cref="T:System.Data.Common.DbCommandBuilder" /> to generate parameters based on the column names instead. This succeeds only if the following conditions are met:</para>
  257. <list type="bullet">
  258. <item>
  259. <para>The <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterNameMaxLength" /> has been specified and its length is equal to or greater than the generated parameter name.</para>
  260. </item>
  261. <item>
  262. <para>The generated parameter name meets the criteria specified in the <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterNamePattern" /> regular expression.</para>
  263. </item>
  264. <item>
  265. <para>A <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterMarkerFormat" /> is specified.</para>
  266. </item>
  267. </list>
  268. </remarks>
  269. <summary>
  270. <attribution license="cc4" from="Microsoft" modified="false" />
  271. <para>Gets the automatically generated <see cref="T:System.Data.Common.DbCommand" /> object required to perform deletions at the data source, optionally using columns for parameter names.</para>
  272. </summary>
  273. <returns>
  274. <attribution license="cc4" from="Microsoft" modified="false" />
  275. <para>The automatically generated <see cref="T:System.Data.Common.DbCommand" /> object required to perform deletions.</para>
  276. </returns>
  277. </Docs>
  278. <AssemblyInfo>
  279. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  280. </AssemblyInfo>
  281. </Member>
  282. <Member MemberName="GetInsertCommand">
  283. <MemberSignature Language="C#" Value="public System.Data.Common.DbCommand GetInsertCommand ();" />
  284. <MemberType>Method</MemberType>
  285. <ReturnValue>
  286. <ReturnType>System.Data.Common.DbCommand</ReturnType>
  287. </ReturnValue>
  288. <Parameters />
  289. <Docs>
  290. <since version=".NET 2.0" />
  291. <remarks>
  292. <attribution license="cc4" from="Microsoft" modified="false" />
  293. <para>An application can use the <see cref="M:System.Data.Common.DbCommandBuilder.GetInsertCommand" /> method for informational or troubleshooting purposes because it returns the text of the <see cref="T:System.Data.Common.DbCommand" /> object to be executed.</para>
  294. <para>You can also use <see cref="M:System.Data.Common.DbCommandBuilder.GetInsertCommand" /> as the basis of a modified command. For example, you might call <see cref="M:System.Data.Common.DbCommandBuilder.GetInsertCommand" /> and modify the command text, and then explicitly set that on the <see cref="T:System.Data.Common.DbDataAdapter" />.</para>
  295. <para>After the SQL statement is first generated, the application must explicitly call <see cref="M:System.Data.Common.DbCommandBuilder.RefreshSchema" /> if it changes the statement in any way. Otherwise, the <see cref="M:System.Data.Common.DbCommandBuilder.GetInsertCommand" /> will still be using information from the previous statement, which might not be correct. The SQL statements are first generated either when the application calls <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> or <see cref="M:System.Data.Common.DbCommandBuilder.GetInsertCommand" />.</para>
  296. </remarks>
  297. <summary>
  298. <attribution license="cc4" from="Microsoft" modified="false" />
  299. <para>Gets the automatically generated <see cref="T:System.Data.Common.DbCommand" /> object required to perform insertions at the data source.</para>
  300. </summary>
  301. <returns>
  302. <attribution license="cc4" from="Microsoft" modified="false" />
  303. <para>The automatically generated <see cref="T:System.Data.Common.DbCommand" /> object required to perform insertions.</para>
  304. </returns>
  305. </Docs>
  306. <AssemblyInfo>
  307. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  308. </AssemblyInfo>
  309. </Member>
  310. <Member MemberName="GetInsertCommand">
  311. <MemberSignature Language="C#" Value="public System.Data.Common.DbCommand GetInsertCommand (bool option);" />
  312. <MemberType>Method</MemberType>
  313. <ReturnValue>
  314. <ReturnType>System.Data.Common.DbCommand</ReturnType>
  315. </ReturnValue>
  316. <Parameters>
  317. <Parameter Name="option" Type="System.Boolean" />
  318. </Parameters>
  319. <Docs>
  320. <param name="option">To be added.</param>
  321. <since version=".NET 2.0" />
  322. <remarks>
  323. <attribution license="cc4" from="Microsoft" modified="false" />
  324. <para>An application can use the <see cref="M:System.Data.Common.DbCommandBuilder.GetInsertCommand" /> method for informational or troubleshooting purposes because it returns the text of the <see cref="T:System.Data.Common.DbCommand" /> object to be executed.</para>
  325. <para>You can also use <see cref="M:System.Data.Common.DbCommandBuilder.GetInsertCommand" /> as the basis of a modified command. For example, you might call <see cref="M:System.Data.Common.DbCommandBuilder.GetInsertCommand" /> and modify the command text, and then explicitly set that on the <see cref="T:System.Data.Common.DbDataAdapter" />.</para>
  326. <para>After the SQL statement is first generated, the application must explicitly call <see cref="M:System.Data.Common.DbCommandBuilder.RefreshSchema" /> if it changes the statement in any way. Otherwise, the <see cref="M:System.Data.Common.DbCommandBuilder.GetInsertCommand" /> will still be using information from the previous statement, which might not be correct. The SQL statements are first generated either when the application calls <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> or <see cref="M:System.Data.Common.DbCommandBuilder.GetInsertCommand" />.</para>
  327. <para>The default behavior, when generating parameter names, is to use @p1, @p2, and so on for the various parameters. Passing true for the <paramref name="useColumnsForParameterNames" /> parameter allows you to force the <see cref="T:System.Data.Common.DbCommandBuilder" /> to generate parameters based on the column names instead. Generation of the parameters based on column names succeeds only if the following conditions are met:</para>
  328. <list type="bullet">
  329. <item>
  330. <para>The <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterNameMaxLength" /> has been specified and its length is equal to or greater than the generated parameter name.</para>
  331. </item>
  332. <item>
  333. <para>The generated parameter name meets the criteria specified in the <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterNamePattern" /> regular expression.</para>
  334. </item>
  335. <item>
  336. <para>A <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterMarkerFormat" /> is specified.</para>
  337. </item>
  338. </list>
  339. </remarks>
  340. <summary>
  341. <attribution license="cc4" from="Microsoft" modified="false" />
  342. <para>Gets the automatically generated <see cref="T:System.Data.Common.DbCommand" /> object required to perform insertions at the data source, optionally using columns for parameter names.</para>
  343. </summary>
  344. <returns>
  345. <attribution license="cc4" from="Microsoft" modified="false" />
  346. <para>The automatically generated <see cref="T:System.Data.Common.DbCommand" /> object required to perform insertions.</para>
  347. </returns>
  348. </Docs>
  349. <AssemblyInfo>
  350. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  351. </AssemblyInfo>
  352. </Member>
  353. <Member MemberName="GetParameterName">
  354. <MemberSignature Language="C#" Value="protected abstract string GetParameterName (int parameterOrdinal);" />
  355. <MemberType>Method</MemberType>
  356. <ReturnValue>
  357. <ReturnType>System.String</ReturnType>
  358. </ReturnValue>
  359. <Parameters>
  360. <Parameter Name="parameterOrdinal" Type="System.Int32" />
  361. </Parameters>
  362. <Docs>
  363. <remarks>To be added.</remarks>
  364. <since version=".NET 2.0" />
  365. <summary>
  366. <attribution license="cc4" from="Microsoft" modified="false" />
  367. <para>Returns the name of the specified parameter in the format of @p#. Use when building a custom command builder.</para>
  368. </summary>
  369. <returns>
  370. <attribution license="cc4" from="Microsoft" modified="false" />
  371. <para>The name of the parameter with the specified number appended as part of the parameter name.</para>
  372. </returns>
  373. <param name="parameterOrdinal">
  374. <attribution license="cc4" from="Microsoft" modified="false" />The number to be included as part of the parameter's name..</param>
  375. </Docs>
  376. <AssemblyInfo>
  377. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  378. </AssemblyInfo>
  379. </Member>
  380. <Member MemberName="GetParameterName">
  381. <MemberSignature Language="C#" Value="protected abstract string GetParameterName (string parameterName);" />
  382. <MemberType>Method</MemberType>
  383. <ReturnValue>
  384. <ReturnType>System.String</ReturnType>
  385. </ReturnValue>
  386. <Parameters>
  387. <Parameter Name="parameterName" Type="System.String" />
  388. </Parameters>
  389. <Docs>
  390. <remarks>To be added.</remarks>
  391. <since version=".NET 2.0" />
  392. <summary>
  393. <attribution license="cc4" from="Microsoft" modified="false" />
  394. <para>Returns the full parameter name, given the partial parameter name.</para>
  395. </summary>
  396. <returns>
  397. <attribution license="cc4" from="Microsoft" modified="false" />
  398. <para>The full parameter name corresponding to the partial parameter name requested.</para>
  399. </returns>
  400. <param name="parameterName">
  401. <attribution license="cc4" from="Microsoft" modified="false" />The partial name of the parameter.</param>
  402. </Docs>
  403. <AssemblyInfo>
  404. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  405. </AssemblyInfo>
  406. </Member>
  407. <Member MemberName="GetParameterPlaceholder">
  408. <MemberSignature Language="C#" Value="protected abstract string GetParameterPlaceholder (int parameterOrdinal);" />
  409. <MemberType>Method</MemberType>
  410. <ReturnValue>
  411. <ReturnType>System.String</ReturnType>
  412. </ReturnValue>
  413. <Parameters>
  414. <Parameter Name="parameterOrdinal" Type="System.Int32" />
  415. </Parameters>
  416. <Docs>
  417. <since version=".NET 2.0" />
  418. <remarks>
  419. <attribution license="cc4" from="Microsoft" modified="false" />
  420. <para>This method is intended for use by provider writers building a custom command builder.</para>
  421. </remarks>
  422. <summary>
  423. <attribution license="cc4" from="Microsoft" modified="false" />
  424. <para>Returns the placeholder for the parameter in the associated SQL statement.</para>
  425. </summary>
  426. <returns>
  427. <attribution license="cc4" from="Microsoft" modified="false" />
  428. <para>The name of the parameter with the specified number appended.</para>
  429. </returns>
  430. <param name="parameterOrdinal">
  431. <attribution license="cc4" from="Microsoft" modified="false" />The number to be included as part of the parameter's name.</param>
  432. </Docs>
  433. <AssemblyInfo>
  434. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  435. </AssemblyInfo>
  436. </Member>
  437. <Member MemberName="GetSchemaTable">
  438. <MemberSignature Language="C#" Value="protected virtual System.Data.DataTable GetSchemaTable (System.Data.Common.DbCommand cmd);" />
  439. <MemberType>Method</MemberType>
  440. <ReturnValue>
  441. <ReturnType>System.Data.DataTable</ReturnType>
  442. </ReturnValue>
  443. <Parameters>
  444. <Parameter Name="cmd" Type="System.Data.Common.DbCommand" />
  445. </Parameters>
  446. <Docs>
  447. <param name="cmd">To be added.</param>
  448. <since version=".NET 2.0" />
  449. <remarks>
  450. <attribution license="cc4" from="Microsoft" modified="false" />
  451. <para>This method is intended for use by provider writers building a custom command builder.</para>
  452. </remarks>
  453. <summary>
  454. <attribution license="cc4" from="Microsoft" modified="false" />
  455. <para>Returns the schema table for the <see cref="T:System.Data.Common.DbCommandBuilder" />.</para>
  456. </summary>
  457. <returns>
  458. <attribution license="cc4" from="Microsoft" modified="false" />
  459. <para>A <see cref="T:System.Data.DataTable" /> that represents the schema for the specific <see cref="T:System.Data.Common.DbCommand" />.</para>
  460. </returns>
  461. </Docs>
  462. <AssemblyInfo>
  463. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  464. </AssemblyInfo>
  465. </Member>
  466. <Member MemberName="GetUpdateCommand">
  467. <MemberSignature Language="C#" Value="public System.Data.Common.DbCommand GetUpdateCommand ();" />
  468. <MemberType>Method</MemberType>
  469. <ReturnValue>
  470. <ReturnType>System.Data.Common.DbCommand</ReturnType>
  471. </ReturnValue>
  472. <Parameters />
  473. <Docs>
  474. <since version=".NET 2.0" />
  475. <remarks>
  476. <attribution license="cc4" from="Microsoft" modified="false" />
  477. <para>An application can use the <see cref="M:System.Data.Common.DbCommandBuilder.GetUpdateCommand" /> method for informational or troubleshooting purposes because it returns the <see cref="T:System.Data.Common.DbCommand" /> object to be executed.</para>
  478. <para>You can also use <see cref="M:System.Data.Common.DbCommandBuilder.GetUpdateCommand" /> as the basis of a modified command. For example, you might call <see cref="M:System.Data.Common.DbCommandBuilder.GetUpdateCommand" /> and modify the command text, and then explicitly set that on the <see cref="T:System.Data.Common.DbDataAdapter" />.</para>
  479. <para>After the SQL statement is first generated, the application must explicitly call <see cref="M:System.Data.Common.DbCommandBuilder.RefreshSchema" /> if it changes the statement in any way. Otherwise, the <see cref="M:System.Data.Common.DbCommandBuilder.GetUpdateCommand" /> will still be using information from the previous statement, which might not be correct. The SQL statements are first generated either when the application calls <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> or <see cref="M:System.Data.Common.DbCommandBuilder.GetUpdateCommand" />.</para>
  480. </remarks>
  481. <summary>
  482. <attribution license="cc4" from="Microsoft" modified="false" />
  483. <para>Gets the automatically generated <see cref="T:System.Data.Common.DbCommand" /> object required to perform updates at the data source.</para>
  484. </summary>
  485. <returns>
  486. <attribution license="cc4" from="Microsoft" modified="false" />
  487. <para>The automatically generated <see cref="T:System.Data.Common.DbCommand" /> object required to perform updates.</para>
  488. </returns>
  489. </Docs>
  490. <AssemblyInfo>
  491. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  492. </AssemblyInfo>
  493. </Member>
  494. <Member MemberName="GetUpdateCommand">
  495. <MemberSignature Language="C#" Value="public System.Data.Common.DbCommand GetUpdateCommand (bool option);" />
  496. <MemberType>Method</MemberType>
  497. <ReturnValue>
  498. <ReturnType>System.Data.Common.DbCommand</ReturnType>
  499. </ReturnValue>
  500. <Parameters>
  501. <Parameter Name="option" Type="System.Boolean" />
  502. </Parameters>
  503. <Docs>
  504. <param name="option">To be added.</param>
  505. <since version=".NET 2.0" />
  506. <remarks>
  507. <attribution license="cc4" from="Microsoft" modified="false" />
  508. <para>An application can use the <see cref="M:System.Data.Common.DbCommandBuilder.GetUpdateCommand" /> method for informational or troubleshooting purposes because it returns the <see cref="T:System.Data.Common.DbCommand" /> object to be executed.</para>
  509. <para>You can also use <see cref="M:System.Data.Common.DbCommandBuilder.GetUpdateCommand" /> as the basis of a modified command. For example, you might call <see cref="M:System.Data.Common.DbCommandBuilder.GetUpdateCommand" /> and modify command text, and then explicitly set that on the <see cref="T:System.Data.Common.DbDataAdapter" />.</para>
  510. <para>After the SQL statement is first generated, the application must explicitly call <see cref="M:System.Data.Common.DbCommandBuilder.RefreshSchema" /> if it changes the statement in any way. Otherwise, the <see cref="M:System.Data.Common.DbCommandBuilder.GetUpdateCommand" /> will still be using information from the previous statement, which might not be correct. The SQL statements are first generated either when the application calls <see cref="M:System.Data.Common.DbDataAdapter.Update(System.Data.DataSet)" /> or <see cref="M:System.Data.Common.DbCommandBuilder.GetUpdateCommand" />.</para>
  511. <para>The default behavior, when generating parameter names, is to use @p1, @p2, and so on for the various parameters. Passing true for the <paramref name="useColumnsForParameterNames" /> parameter allows you to force the <see cref="T:System.Data.Common.DbCommandBuilder" /> to generate parameters based on the column names instead. Generation of the parameters based on column names succeeds only if the following conditions are met:</para>
  512. <list type="bullet">
  513. <item>
  514. <para>The <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterNameMaxLength" /> has been specified and its length is equal to or greater than the generated parameter name.</para>
  515. </item>
  516. <item>
  517. <para>The generated parameter name meets the criteria specified in the <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterNamePattern" /> regular expression.</para>
  518. </item>
  519. <item>
  520. <para>A <see cref="F:System.Data.Common.DbMetaDataColumnNames.ParameterMarkerFormat" /> is specified.</para>
  521. </item>
  522. </list>
  523. </remarks>
  524. <summary>
  525. <attribution license="cc4" from="Microsoft" modified="false" />
  526. <para>Gets the automatically generated <see cref="T:System.Data.Common.DbCommand" /> object required to perform updates at the data source, optionally using columns for parameter names.</para>
  527. </summary>
  528. <returns>
  529. <attribution license="cc4" from="Microsoft" modified="false" />
  530. <para>The automatically generated <see cref="T:System.Data.Common.DbCommand" /> object required to perform updates.</para>
  531. </returns>
  532. </Docs>
  533. <AssemblyInfo>
  534. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  535. </AssemblyInfo>
  536. </Member>
  537. <Member MemberName="InitializeCommand">
  538. <MemberSignature Language="C#" Value="protected virtual System.Data.Common.DbCommand InitializeCommand (System.Data.Common.DbCommand command);" />
  539. <MemberType>Method</MemberType>
  540. <ReturnValue>
  541. <ReturnType>System.Data.Common.DbCommand</ReturnType>
  542. </ReturnValue>
  543. <Parameters>
  544. <Parameter Name="command" Type="System.Data.Common.DbCommand" />
  545. </Parameters>
  546. <Docs>
  547. <since version=".NET 2.0" />
  548. <remarks>
  549. <attribution license="cc4" from="Microsoft" modified="false" />
  550. <para>This method is intended for use by provider writers building a custom command builder.</para>
  551. </remarks>
  552. <summary>
  553. <attribution license="cc4" from="Microsoft" modified="false" />
  554. <para>Resets the <see cref="P:System.Data.Common.DbCommand.CommandTimeout" />, <see cref="P:System.Data.Common.DbCommand.Transaction" />, <see cref="P:System.Data.Common.DbCommand.CommandType" />, and <see cref="T:System.Data.UpdateRowSource" /> properties on the <see cref="T:System.Data.Common.DbCommand" />.</para>
  555. </summary>
  556. <returns>
  557. <attribution license="cc4" from="Microsoft" modified="false" />
  558. <para>A <see cref="T:System.Data.Common.DbCommand" /> instance to use for each insert, update, or delete operation. Passing a null value allows the <see cref="M:System.Data.Common.DbCommandBuilder.InitializeCommand(System.Data.Common.DbCommand)" /> method to create a <see cref="T:System.Data.Common.DbCommand" /> object based on the Select command associated with the <see cref="T:System.Data.Common.DbCommandBuilder" />.</para>
  559. </returns>
  560. <param name="command">
  561. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.Common.DbCommand" /> to be used by the command builder for the corresponding insert, update, or delete command.</param>
  562. </Docs>
  563. <AssemblyInfo>
  564. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  565. </AssemblyInfo>
  566. </Member>
  567. <Member MemberName="QuoteIdentifier">
  568. <MemberSignature Language="C#" Value="public virtual string QuoteIdentifier (string unquotedIdentifier);" />
  569. <MemberType>Method</MemberType>
  570. <ReturnValue>
  571. <ReturnType>System.String</ReturnType>
  572. </ReturnValue>
  573. <Parameters>
  574. <Parameter Name="unquotedIdentifier" Type="System.String" />
  575. </Parameters>
  576. <Docs>
  577. <remarks>To be added.</remarks>
  578. <since version=".NET 2.0" />
  579. <summary>
  580. <attribution license="cc4" from="Microsoft" modified="false" />
  581. <para>Given an unquoted identifier in the correct catalog case, returns the correct quoted form of that identifier, including properly escaping any embedded quotes in the identifier.</para>
  582. </summary>
  583. <returns>
  584. <attribution license="cc4" from="Microsoft" modified="false" />
  585. <para>The quoted version of the identifier. Embedded quotes within the identifier are properly escaped.</para>
  586. </returns>
  587. <param name="unquotedIdentifier">
  588. <attribution license="cc4" from="Microsoft" modified="false" />The original unquoted identifier.</param>
  589. </Docs>
  590. <AssemblyInfo>
  591. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  592. </AssemblyInfo>
  593. </Member>
  594. <Member MemberName="QuotePrefix">
  595. <MemberSignature Language="C#" Value="public virtual string QuotePrefix { set; get; }" />
  596. <MemberType>Property</MemberType>
  597. <Attributes>
  598. <Attribute>
  599. <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
  600. </Attribute>
  601. </Attributes>
  602. <ReturnValue>
  603. <ReturnType>System.String</ReturnType>
  604. </ReturnValue>
  605. <Docs>
  606. <value>To be added.</value>
  607. <since version=".NET 2.0" />
  608. <remarks>
  609. <attribution license="cc4" from="Microsoft" modified="false" />
  610. <para>Some data sources may have objects that can contain characters such as spaces, commas, and semicolons. To accommodate this capability, use the <see cref="P:System.Data.Common.DbCommandBuilder.QuotePrefix" /> and <see cref="P:System.Data.Common.DbCommandBuilder.QuoteSuffix" /> properties to specify delimiters such as a left bracket and a right bracket to encapsulate the object name.</para>
  611. <block subset="none" type="note">
  612. <para>Although you cannot change the <see cref="P:System.Data.Common.DbCommandBuilder.QuotePrefix" /> or <see cref="P:System.Data.Common.DbCommandBuilder.QuoteSuffix" /> properties after an insert, update, or delete command has been generated, you can change their settings after calling the Update method of a <see cref="T:System.Data.Common.DbDataAdapter" />.</para>
  613. </block>
  614. </remarks>
  615. <summary>
  616. <attribution license="cc4" from="Microsoft" modified="false" />
  617. <para>Gets or sets the beginning character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens.</para>
  618. </summary>
  619. </Docs>
  620. <AssemblyInfo>
  621. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  622. </AssemblyInfo>
  623. </Member>
  624. <Member MemberName="QuoteSuffix">
  625. <MemberSignature Language="C#" Value="public virtual string QuoteSuffix { set; get; }" />
  626. <MemberType>Property</MemberType>
  627. <Attributes>
  628. <Attribute>
  629. <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
  630. </Attribute>
  631. </Attributes>
  632. <ReturnValue>
  633. <ReturnType>System.String</ReturnType>
  634. </ReturnValue>
  635. <Docs>
  636. <value>To be added.</value>
  637. <since version=".NET 2.0" />
  638. <remarks>
  639. <attribution license="cc4" from="Microsoft" modified="false" />
  640. <para>Some data sources may have objects that can contain characters such as spaces, commas, and semicolons. To accommodate this capability, use the <see cref="P:System.Data.Common.DbCommandBuilder.QuotePrefix" /> and <see cref="P:System.Data.Common.DbCommandBuilder.QuoteSuffix" /> properties to specify delimiters such as a left bracket and a right bracket to encapsulate the object name.</para>
  641. <block subset="none" type="note">
  642. <para>Although you cannot change the <see cref="P:System.Data.Common.DbCommandBuilder.QuotePrefix" /> or <see cref="P:System.Data.Common.DbCommandBuilder.QuoteSuffix" /> properties after an insert, update, or delete command has been generated, you can change their settings after calling the Update method of a <see cref="T:System.Data.Common.DbDataAdapter" />.</para>
  643. </block>
  644. </remarks>
  645. <summary>
  646. <attribution license="cc4" from="Microsoft" modified="false" />
  647. <para>Gets or sets the ending character or characters to use when specifying database objects (for example, tables or columns) whose names contain characters such as spaces or reserved tokens.</para>
  648. </summary>
  649. </Docs>
  650. <AssemblyInfo>
  651. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  652. </AssemblyInfo>
  653. </Member>
  654. <Member MemberName="RefreshSchema">
  655. <MemberSignature Language="C#" Value="public virtual void RefreshSchema ();" />
  656. <MemberType>Method</MemberType>
  657. <ReturnValue>
  658. <ReturnType>System.Void</ReturnType>
  659. </ReturnValue>
  660. <Parameters />
  661. <Docs>
  662. <since version=".NET 2.0" />
  663. <remarks>
  664. <attribution license="cc4" from="Microsoft" modified="false" />
  665. <para>Calling the <see cref="M:System.Data.Common.DbCommandBuilder.RefreshSchema" /> method effectively removes all the <see cref="T:System.Data.Common.DbCommand" /> objects referred to by the <see cref="P:System.Data.Common.DbDataAdapter.SelectCommand" />,</para>
  666. <para>
  667. <see cref="P:System.Data.Common.DbDataAdapter.UpdateCommand" />,</para>
  668. <para>
  669. <see cref="P:System.Data.Common.DbDataAdapter.DeleteCommand" />, and</para>
  670. <para>
  671. <see cref="P:System.Data.Common.DbDataAdapter.InsertCommand" /> properties.</para>
  672. </remarks>
  673. <summary>
  674. <attribution license="cc4" from="Microsoft" modified="false" />
  675. <para>Clears the commands associated with this <see cref="T:System.Data.Common.DbCommandBuilder" />.</para>
  676. </summary>
  677. </Docs>
  678. <AssemblyInfo>
  679. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  680. </AssemblyInfo>
  681. </Member>
  682. <Member MemberName="RowUpdatingHandler">
  683. <MemberSignature Language="C#" Value="protected void RowUpdatingHandler (System.Data.Common.RowUpdatingEventArgs args);" />
  684. <MemberType>Method</MemberType>
  685. <ReturnValue>
  686. <ReturnType>System.Void</ReturnType>
  687. </ReturnValue>
  688. <Parameters>
  689. <Parameter Name="args" Type="System.Data.Common.RowUpdatingEventArgs" />
  690. </Parameters>
  691. <Docs>
  692. <param name="args">To be added.</param>
  693. <remarks>To be added.</remarks>
  694. <since version=".NET 2.0" />
  695. <summary>
  696. <attribution license="cc4" from="Microsoft" modified="false" />
  697. <para>Adds an event handler for the <see cref="E:System.Data.OleDb.OleDbDataAdapter.RowUpdating" /> event.</para>
  698. </summary>
  699. </Docs>
  700. <AssemblyInfo>
  701. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  702. </AssemblyInfo>
  703. </Member>
  704. <Member MemberName="SchemaSeparator">
  705. <MemberSignature Language="C#" Value="public virtual string SchemaSeparator { set; get; }" />
  706. <MemberType>Property</MemberType>
  707. <Attributes>
  708. <Attribute>
  709. <AttributeName>System.ComponentModel.DefaultValue(".")</AttributeName>
  710. </Attribute>
  711. </Attributes>
  712. <ReturnValue>
  713. <ReturnType>System.String</ReturnType>
  714. </ReturnValue>
  715. <Docs>
  716. <value>To be added.</value>
  717. <since version=".NET 2.0" />
  718. <remarks>
  719. <attribution license="cc4" from="Microsoft" modified="false" />
  720. <para>Generally, database servers indicate the schema for an identifier by separating the schema name from the identifier with some character. For example, SQL Server uses a colon, creating complete identifiers such as Person:CustomerName, where "Person" is the schema name and "CustomerName" is the identifier. Setting this property allows developers to modify this behavior.</para>
  721. </remarks>
  722. <summary>
  723. <attribution license="cc4" from="Microsoft" modified="false" />
  724. <para>Gets or sets the character to be used for the separator between the schema identifier and any other identifiers.</para>
  725. </summary>
  726. </Docs>
  727. <AssemblyInfo>
  728. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  729. </AssemblyInfo>
  730. </Member>
  731. <Member MemberName="SetAllValues">
  732. <MemberSignature Language="C#" Value="public bool SetAllValues { set; get; }" />
  733. <MemberType>Property</MemberType>
  734. <Attributes>
  735. <Attribute>
  736. <AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName>
  737. </Attribute>
  738. </Attributes>
  739. <ReturnValue>
  740. <ReturnType>System.Boolean</ReturnType>
  741. </ReturnValue>
  742. <Docs>
  743. <value>To be added.</value>
  744. <since version=".NET 2.0" />
  745. <remarks>
  746. <attribution license="cc4" from="Microsoft" modified="false" />
  747. <para>The UPDATE statement generated by a <see cref="T:System.Data.Common.DbCommandBuilder" /> can include update information about all the columns, or it can include information only about those columns whose values have changed. Setting the <see cref="P:System.Data.Common.DbCommandBuilder.SetAllValues" /> property to true causes the generated UPDATE statement to include all the columns, whether their values have changed or not.</para>
  748. </remarks>
  749. <summary>
  750. <attribution license="cc4" from="Microsoft" modified="false" />
  751. <para>Specifies whether all column values in an update statement are included or only changed ones.</para>
  752. </summary>
  753. </Docs>
  754. <AssemblyInfo>
  755. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  756. </AssemblyInfo>
  757. </Member>
  758. <Member MemberName="SetRowUpdatingHandler">
  759. <MemberSignature Language="C#" Value="protected abstract void SetRowUpdatingHandler (System.Data.Common.DbDataAdapter adapter);" />
  760. <MemberType>Method</MemberType>
  761. <ReturnValue>
  762. <ReturnType>System.Void</ReturnType>
  763. </ReturnValue>
  764. <Parameters>
  765. <Parameter Name="adapter" Type="System.Data.Common.DbDataAdapter" />
  766. </Parameters>
  767. <Docs>
  768. <since version=".NET 2.0" />
  769. <remarks>
  770. <attribution license="cc4" from="Microsoft" modified="false" />
  771. <para>This method is intended for use by provider writers building a custom command builder. When a new <see cref="T:System.Data.Common.DbDataAdapter" /> is added to the <see cref="T:System.Data.Common.DbCommandBuilder" />, it is registered for the DbDataAdapter's RowUpdating event. If this method is called again with the same <see cref="T:System.Data.Common.DbDataAdapter" />, the <see cref="T:System.Data.Common.DbCommandBuilder" /> is unregistered for that DbDataAdapter's RowUpdating event.</para>
  772. </remarks>
  773. <summary>
  774. <attribution license="cc4" from="Microsoft" modified="false" />
  775. <para>Registers the <see cref="T:System.Data.Common.DbCommandBuilder" /> to handle the <see cref="E:System.Data.OleDb.OleDbDataAdapter.RowUpdating" /> event for a <see cref="T:System.Data.Common.DbDataAdapter" />. </para>
  776. </summary>
  777. <param name="adapter">
  778. <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Data.Common.DbDataAdapter" /> to be used for the update.</param>
  779. </Docs>
  780. <AssemblyInfo>
  781. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  782. </AssemblyInfo>
  783. </Member>
  784. <Member MemberName="UnquoteIdentifier">
  785. <MemberSignature Language="C#" Value="public virtual string UnquoteIdentifier (string quotedIdentifier);" />
  786. <MemberType>Method</MemberType>
  787. <ReturnValue>
  788. <ReturnType>System.String</ReturnType>
  789. </ReturnValue>
  790. <Parameters>
  791. <Parameter Name="quotedIdentifier" Type="System.String" />
  792. </Parameters>
  793. <Docs>
  794. <remarks>To be added.</remarks>
  795. <since version=".NET 2.0" />
  796. <summary>
  797. <attribution license="cc4" from="Microsoft" modified="false" />
  798. <para>Given a quoted identifier, returns the correct unquoted form of that identifier, including properly un-escaping any embedded quotes in the identifier.</para>
  799. </summary>
  800. <returns>
  801. <attribution license="cc4" from="Microsoft" modified="false" />
  802. <para>The unquoted identifier, with embedded quotes properly un-escaped.</para>
  803. </returns>
  804. <param name="quotedIdentifier">
  805. <attribution license="cc4" from="Microsoft" modified="false" />The identifier that will have its embedded quotes removed.</param>
  806. </Docs>
  807. <AssemblyInfo>
  808. <AssemblyVersion>2.0.0.0</AssemblyVersion>
  809. </AssemblyInfo>
  810. </Member>
  811. </Members>
  812. </Type>