227 lines
14 KiB
XML
227 lines
14 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="DetailsViewDeletedEventArgs" FullName="System.Web.UI.WebControls.DetailsViewDeletedEventArgs">
|
|
<TypeSignature Language="C#" Value="public class DetailsViewDeletedEventArgs : EventArgs" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Web</AssemblyName>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.EventArgs</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>The <see cref="T:System.Web.UI.WebControls.DetailsView" /> control raises the <see cref="E:System.Web.UI.WebControls.DetailsView.ItemDeleted" /> event when a Delete button (a button with its CommandName property set to "Delete") within the control is clicked, but after the <see cref="T:System.Web.UI.WebControls.DetailsView" /> control deletes the record. This allows you to provide an event handler that performs a custom routine, such as checking the results of a delete operation, whenever this event occurs.</para>
|
|
<para>A <see cref="T:System.Web.UI.WebControls.DetailsViewDeletedEventArgs" /> object is passed to the event handler, which allows you to determine the number of records affected and any exceptions that might have occurred. To determine the number of records affected by the delete operation, use the <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.AffectedRows" /> property. Use the <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.Exception" /> property to determine whether any exceptions occurred. You can also indicate whether the exception was handled in the event handler by setting the <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.ExceptionHandled" /> property. If you want to access the name/value pairs of the key fields and non-key fields of the deleted record, use the <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.Keys" /> and <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.Values" /> properties, respectively.</para>
|
|
<para>For more information about handling events, see <format type="text/html"><a href="01e4f1bc-e55e-413f-98c7-6588493e5f67">Consuming Events</a></format>.</para>
|
|
<para>For a list of initial property values for an instance of the <see cref="T:System.Web.UI.WebControls.DetailsViewDeletedEventArgs" /> class, see the <see cref="M:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.#ctor(System.Int32,System.Exception)" /> constructor.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Provides data for the <see cref="E:System.Web.UI.WebControls.DetailsView.ItemDeleted" /> event.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public DetailsViewDeletedEventArgs (int affectedRows, Exception e);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="affectedRows" Type="System.Int32" />
|
|
<Parameter Name="e" Type="System.Exception" />
|
|
</Parameters>
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use this constructor to initialize a new instance of the <see cref="T:System.Web.UI.WebControls.DetailsViewDeletedEventArgs" /> class.</para>
|
|
<para>The following table shows the initial property values for an instance of <see cref="T:System.Web.UI.WebControls.DetailsViewDeletedEventArgs" />.</para>
|
|
<list type="table">
|
|
<listheader>
|
|
<item>
|
|
<term>
|
|
<para>Property </para>
|
|
</term>
|
|
<description>
|
|
<para>Initial value </para>
|
|
</description>
|
|
</item>
|
|
</listheader>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.AffectedRows" />
|
|
</para>
|
|
</term>
|
|
<description>
|
|
<para>The value of the <paramref name="affectedRows" /> parameter.</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.Exception" />
|
|
</para>
|
|
</term>
|
|
<description>
|
|
<para>The <see cref="T:System.Exception" /> contained in the <paramref name="e" /> parameter.</para>
|
|
</description>
|
|
</item>
|
|
<item>
|
|
<term>
|
|
<para>
|
|
<see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.ExceptionHandled" />
|
|
</para>
|
|
</term>
|
|
<description>
|
|
<para>Initialized to false.</para>
|
|
</description>
|
|
</item>
|
|
</list>
|
|
<block subset="none" type="note">
|
|
<para>This constructor is used primarily by control developers when raising events.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.DetailsViewDeletedEventArgs" /> class.</para>
|
|
</summary>
|
|
<param name="affectedRows">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The number of rows affected by the delete operation.</param>
|
|
<param name="e">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Exception" /> that represents the exception raised when the delete operation was performed. If no exception is raised, use null for this parameter.</param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="AffectedRows">
|
|
<MemberSignature Language="C#" Value="public int AffectedRows { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.AffectedRows" /> property to determine the number of rows affected by the delete operation. This value is commonly used to verify that the appropriate number of rows was deleted.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the number of rows affected by the delete operation.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Exception">
|
|
<MemberSignature Language="C#" Value="public Exception Exception { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Exception</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.Exception" /> property to determine the exception (if any) that was raised during the delete operation. If no exceptions were raised, this property returns null.</para>
|
|
<block subset="none" type="note">
|
|
<para>If an exception was raised and you decide to handle the exception in the event handler, be sure to set the <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.ExceptionHandled" /> property to true; otherwise, the exception is passed to the next method on the call stack for handling.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets the exception (if any) that was raised during the delete operation.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="ExceptionHandled">
|
|
<MemberSignature Language="C#" Value="public bool ExceptionHandled { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>When an exception is raised during the delete operation, use the <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.ExceptionHandled" /> property to indicate whether the exception was handled in the event handler. When this property is set to true, the exception is considered handled and is not passed further up the call stack. If this property is set to false, the exception is passed to the next method on the call stack for handling. To determine which exception was raised, use the <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.Exception" /> property.</para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets a value indicating whether an exception that was raised during the delete operation was handled in the event handler.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Keys">
|
|
<MemberSignature Language="C#" Value="public System.Collections.Specialized.IOrderedDictionary Keys { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.Specialized.IOrderedDictionary</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.Keys" /> property to access the values of the key fields for the record to delete. For example, you can use these values to keep a log of deleted records.</para>
|
|
<block subset="none" type="note">
|
|
<para>This property contains only the key fields. To access the non-key fields, use the <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.Values" /> property.</para>
|
|
</block>
|
|
<para>The <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.Keys" /> property returns an object that implements the <see cref="T:System.Collections.Specialized.IOrderedDictionary" /> interface. The object contains <see cref="T:System.Collections.DictionaryEntry" /> objects that represent the key fields of the record to delete.</para>
|
|
<block subset="none" type="note">
|
|
<para>As a shortcut, you can also use the indexer of the <see cref="T:System.Collections.Specialized.IOrderedDictionary" /> object to access the field values directly.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets an ordered dictionary of key field name/value pairs that contains the names and values of the key fields of the deleted items.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Values">
|
|
<MemberSignature Language="C#" Value="public System.Collections.Specialized.IOrderedDictionary Values { get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Collections.Specialized.IOrderedDictionary</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Use the <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.Values" /> property to access the values of the non-key fields for the record to delete. For example, you can use these values to keep a log of deleted records.</para>
|
|
<block subset="none" type="note">
|
|
<para>This property does not contain the key fields for the record. To access the key fields, use the <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.Keys" /> property.</para>
|
|
</block>
|
|
<para>The <see cref="P:System.Web.UI.WebControls.DetailsViewDeletedEventArgs.Values" /> property returns an <see cref="T:System.Collections.Specialized.IOrderedDictionary" /> object that implements the <see cref="T:System.Collections.Specialized.IOrderedDictionary" /> interface. The object contains <see cref="T:System.Collections.DictionaryEntry" /> objects that represent the non-key fields of the record to delete.</para>
|
|
<block subset="none" type="note">
|
|
<para>As a shortcut, you can also use the indexer of the <see cref="T:System.Collections.Specialized.IOrderedDictionary" /> object to access the field values directly.</para>
|
|
</block>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets a dictionary of the non-key field name/value pairs for the item to delete.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
</Members>
|
|
</Type> |