ObjectDataSource.Delete メソッド

.NET Framework クラス ライブラリ リファレンス

ObjectDataSource.Delete メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

DeleteParameters コレクション内のパラメータを持つ DeleteMethod プロパティで識別されるメソッドを呼び出して削除操作を実行します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Function Delete As
 Integer

Visual Basic (使用法)

Dim instance As ObjectDataSource
Dim returnValue As Integer

returnValue = instance.Delete

C#

public int Delete ()

C++

public:
int Delete ()

J#

public int Delete ()

JScript

public function Delete () : int

戻り値
Deleted イベントで ObjectDataSourceStatusEventArgs の AffectedRows プロパティを設定する場合は、基になるデータ ストレージから削除する行数を表す値。それ以外の場合は -1。

解説

Delete 操作を実行する前に、OnDeleting メソッドが呼び出されて Deleting イベントが発生します。Deleting イベントを処理してパラメータの値を調べ、Delete 操作の前にプリプロセスを実行できます。削除操作を実行するために、ObjectDataSourceView オブジェクトは、リフレクションを使用して TypeName プロパティで識別されるオブジェクトのインスタンスを作成します。次に、関連付けられた DeleteParameters プロパティを使用して、DeleteMethod プロパティで識別されるメソッドを呼び出します。削除パラメータが、関連付けられたデータ バインド コントロールのものである場合、OldValuesParameterFormatString プロパティに従ってパラメータの名前が作成されます。Delete 操作の完了後、OnDeleted メソッドが呼び出されて Deleted イベントが発生します。Deleted イベントを処理して、戻り値、出力パラメータ、および例外を調べ、後処理を実行できます。

Delete メソッドは、ObjectDataSource コントロールに関連付けられた ObjectDataSourceView の Delete メソッドに処理を代行させます。

データ バインド コントロール

ObjectDataSource コントロールが GridView コントロールなどのデータ バインド コントロールに関連付けられている場合、ページ コードから Delete メソッドを呼び出す必要はありません。Delete メソッドは、データ バインド コントロールによって直接呼び出されます。

パラメータのマージ、オブジェクトの有効期間、およびメソッド解決の詳細については、DeleteMethod のトピックを参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ObjectDataSource クラス
ObjectDataSource メンバ
System.Web.UI.WebControls 名前空間
DeleteMethod
DeleteParameters