FireDAC.Comp.DataSet.TFDDataSet.IndexName

提供:RAD Studio API Documentation

Delphi

property IndexName: String read FIndexName write SetIndexName;

C++

__property System::UnicodeString IndexName = {read=FIndexName, write=SetIndexName};

プロパティ

種類 可視性 ソース ユニット 親
property public
FireDAC.Comp.DataSet.pas
FireDAC.Comp.DataSet.hpp
FireDAC.Comp.DataSet TFDDataSet


説明

データセットの現在のインデックスを、名前で取得または設定します。

IndexName を使用すると、現在のインデックスをデータセットに対して指定することができます。 

IndexName が空の場合、データセットのソート順は IndexFieldNames プロパティ、または、データセットのデフォルトの順番を基にします。 IndexName に、Indexes コレクションからの有効なインデックスの名前が含まれている場合には、レコードのデータ ビュー(ソート順を含む)を決定するのに、そのインデックスが使用されます。 

IndexFieldNames および IndexName は、お互い排他関係にあります。 一方を設定すると、他方がクリアされます。 

例

with FDMemTable1.Indexes.Add do begin
Name := 'by_name';
Fields := 'NAME;DT';
Active := True;
end;
FDMemTable1.IndexName := 'by_name';

関連項目