SearchWindow

<< 目次を表示 >>

ページ位置:  API・アドイン・スクリプト > API > リファレンス > SearchWindowオブジェクト >

SearchWindow

SearchWindowクラスは、独自の検索結果を検索タブに表示させるために利用します。

(ビルド1500以降で利用可能)

 

 

属性

属性

R/W

説明

FieldChooserVisible

bool

 

「利用可能な表示項目」の機能を有効にするかどうかを指定します。

(検索結果一覧の、ヘッダ部分を右クリックすると表示されます。)

FiltersVisible

bool

 

フィルタバーの機能を有効にするかどうかを指定します。

(検索結果一覧の、ヘッダ部分を右クリックすると表示されます。)

ObjectType

ObjectType

R

オブジェクトの型を区別する場合に利用します。

 

 

操作

操作

戻り値の型

説明

AddColumn

(string ColumnName,

int Width)

int

検索結果の一覧に列を追加します。

追加した列の位置を返します。失敗した場合には-1を返します。

 

引数:

  • ColumnName: string - 列の名前
  • Width: int - 列の幅

AddRow

(ObjectType ot,

string ElementGUID,

int ElementID,

string ClassType,

object Values)

なし

検索結果の一覧に行を追加します。

 

引数:  

  • ot: ObjectType - 追加した項目の種類
  • ElementGUID: string - 項目のGUID
  • ElementID: int - 項目のID (要素ならElementID)
  • ClassType: string - 項目の種類
  • Values: 値の配列

ClearGrouping ()

bool

設定されているグループ化処理を解除します。

処理に失敗した場合にはfalseが返ります。

ClearSorting ()

bool

設定されているソートを解除します。

処理に失敗した場合にはfalseが返ります。

EnsureVisible ()

bool

検索タブを表示します。

処理に失敗した場合にはfalseが返ります。

GetCell

(int Row,

int Column)

string

指定した位置の値を返します。

 

引数:  

  • Row: int - 対象の位置の行
  • Column: int - 対象の位置の列

GroupByColumn

(int Column)

bool

指定した列でグループ化処理を実行します。

 

処理に失敗した場合にはfalseが返ります。

 

引数:

  • Column: int - 対象の位置の列

LoadLayout

(string LayoutGUID)

bool

表示内容を、指定したGUIDに紐付く内容に設定します。

処理に失敗した場合にはfalseが返ります。

 

引数:

  • LayoutGUID: string - レイアウトを示すGUID

NewLayout

(string LayoutGUID)

なし

表示内容を保存します。

 

引数:

  • LayoutGUID: string - レイアウトを示すGUID

SetCellString

(int Row,

int Column,

string Data)

なし

指定した位置に値を設定します。

 

引数:

  • Row: int - 対象の位置の行
  • Column: int - 対象の位置の列
  • Data: string - 設定する値

SetCellVariant

(int Row,

int Column,

object Data)

なし

指定した位置に文字列以外の値を設定します。

 

引数:

  • Row: int - 対象の位置の行
  • Column: int - 対象の位置の列
  • Data: object - 設定する値

SortByColumn

(int Column)

bool

指定した列でソートします。

 

処理に失敗した場合にはfalseが返ります。

 

引数:

  • Column: int - 対象の位置の列