Datasnap.DBClient.TCustomClientDataSet.Active

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

property Active;

C++

__property Active = {default=0};

プロパティ

種類 可視性 ソース ユニット
property public
Datasnap.DBClient.pas
Datasnap.DBClient.hpp
Datasnap.DBClient TCustomClientDataSet

説明

データセットが開いているかどうかを示します。

Datasnap.DBClient.TCustomClientDataSet.Active は Data.DB.TDataSet.Active を継承しています。以下の内容はすべて Data.DB.TDataSet.Active を参照しています。

データセットが開いているかどうかを示します。

Active プロパティは,データセットにデータを設定できるかどうかを判定したり設定したりできます。Active が false なら,データセットは閉じられており,データセットはデータベースからデータを読み出したり,データベースにデータを書き込んだりすることはできず,データベース対応コントロールを使ってデータを取り出したり,編集を書き込んだりすることができません。Active が true のときは,データセットにデータを設定できます。データセットはデータベースまたはその他のソース(プロバイダなど)からデータを読み出すことができます。CanModify プロパティの値によって,アクティブデータセットは変更を登録できます。

Active を true に設定すると,以下の処理が実行されます。

  1. BeforeOpen イベントを生成する。
  2. データセットの状態を dsBrowse に設定する。
  3. 通常はカーソルを開くことで,データを取り出せるようにする。
  4. AfterOpen イベントを生成する。

データセットを開くときにエラーが発生した場合,データセットの状態は dsInactive に設定され,データセットは閉じます。

Active プロパティを false に設定すると,以下の処理を行うことができます。

  1. BeforeClose イベントを発生させる。
  2. State プロパティを dsInactive に設定する。
  3. カーソルを閉じる。
  4. AfterClose イベントを発生させる。

アプリケーションは,データベースのステータスに影響を及ぼすほかのプロパティや,アプリケーションでデータを表示するコントロールを変更する前に,Active を false に設定する必要があります。

メモ:  Active は,Open メソッドを呼び出すと true に設定され,Close メソッドを呼び出すと,false に設定されます。

関連項目