List コネクタのメソッド

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間：5分

    • List コネクタのメソッドは、自動化 Workflow の一部として、リストアイテムに対してさまざまなアクションを実行します。使用する前に、まずメソッドを公開する必要があります。

    追加

    単一のリストアイテムを追加します。

    パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

    表 : 1. Add メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？
    アイテム リストアイテムの名前。 データ入力 オブジェクト なし あり

    AddList

    アイテムのリストを追加します。

    パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

    表 : 2. AddList メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？ メモ
    リスト アイテムのリスト。 データ入力 オブジェクト なし あり 変数または適切なコンポーネントからリストアイテムを渡すことができます。

    包含

    リストアイテムが存在するかどうかを示すブール値を返します。

    パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

    表 : 3. Contains メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？
    アイテム メソッドが検索するリストアイテムの名前。 データ入力 オブジェクト なし あり
    戻る リストアイテムが見つかった場合は True を返し、それ以外の場合は False を返します。 データ出力 ブーリアン 適用外 適用外

    カウント

    追加されたリストアイテムの合計数を返します。

    表 : 4. Count メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？
    戻る 追加されたリストアイテムの合計数を返します。 データ出力 整数 適用外 適用外

    FindByProperty

    指定されたキーと値に基づいて、リストアイテムを検索します。このメソッドを実行する前に、少なくとも 1 つのキーと値のペアのリストアイテムを作成する必要があります。

    パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

    表 : 5. FindByProperty メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？
    Prop キーと値のペアのキー。 データ入力 文字列 なし あり
    値 キーと値のペアの値。 データ入力 文字列 なし あり
    検出 リストアイテムが見つかった場合は True を返し、それ以外の場合は False を返します。 データ出力 ブーリアン 適用外 適用外
    アイテム Found パラメーターが True の場合、メソッドはリストアイテムを返します。 データ出力 オブジェクト 適用外 適用外

    FindText

    指定されたフィルターに基づいてリストアイテム内のテキストまたは正規表現を検索し、そのテキストの合計発生件数とテキスト自体を返します。

    パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

    表 : 6. FindByProperty メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？
    SearchText メソッドがリストアイテム内で検索するテキスト。 データ入力 文字列 なし あり
    FindBy メソッドがテキストを検索するのか、正規表現を検索するのかを示すオプションです。 データ入力 文字列 なし あり
    MatchType 一致のタイプを示すオプションです。
    • 完全一致
    • 大文字と小文字を区別する
    • 指定された文字を含む。
    		 データ入力 文字列 なし あり
    カウント 一致の合計発生件数を返します。 データ出力 整数 適用外 適用外
    Outlist 一致のリストを返します。 データ出力 リスト 適用外 適用外

    GetItem

    インデックス値に基づいて、リストアイテムを返します。

    パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

    表 : 7. GetItem メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？
    インデックス リストアイテムのインデックス値。 データ入力 整数 なし あり
    戻る リストアイテムを返します。 データ出力 オブジェクト 適用外 適用外

    GetItems

    インデックス値に基づいて、リストアイテムを返します。最初にインデックス値を設定する必要があります。

    設定するには、次の手順を実行します。
    1. メソッド設定アイコン (メソッド設定アイコン) をクリックします。
    2. インデックスの追加アイコン (インデックスの追加アイコン) をクリックします 。
    3. インデックス値を入力します。
    4. インデックス値のデータタイプを更新します。
    5. さらにインデックス値を追加するには、手順を繰り返します。
    6. [OK] をクリックします。

      インデックス値ごとに、データ出力ポートが作成されます。データ出力ポートは、インデックス値に対応するリストアイテムを返します。

    GetList

    作成されたすべてのリストアイテムとリストを返します。

    表 : 8. GetList メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？
    戻る リストアイテムとリストを返します。 データ出力 アレイ なし 適用外

    削除

    指定されたリストアイテムを削除します。

    パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

    表 : 9. GetList メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？
    アイテム メソッドが削除するリストアイテム。 データ入力 オブジェクト なし あり

    RemoveAll

    追加されたすべてのリストアイテムを削除します。

    リバース

    リストアイテムのインデックス値の順序を逆転させます。

    SetItems

    リストアイテムの値を更新します。メソッドを使用するには、まずメソッドを設定する必要があります。

    設定するには、次の手順を実行します。
    1. メソッド設定アイコン (メソッド設定アイコン) をクリックします。
    2. インデックスの追加アイコン (インデックスの追加アイコン) をクリックします 。
    3. インデックス値を入力します。
    4. インデックス値のデータタイプを更新します。
    5. さらにインデックス値を追加するには、手順を繰り返します。
    6. [OK] をクリックします。

      インデックス値ごとに、データ入力ポートが作成されます。

    パラメーターに入力を指定するには、「ポートのプロパティを設定する」を参照してください。

    表 : 10. SetItems メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？
    アイテム リストアイテムの値を受け取ります。 データ入力 オブジェクト なし あり

    ソート

    リストアイテムをソートします。

    ToArray

    リストアイテムをアレイ形式で返します。このメソッドを実行する前に、複数のリストアイテムを追加する必要があります。

    表 : 11. ToArray メソッドのパラメーター
    パラメーター 説明 データポートタイプ データタイプ デフォルト値 必須？
    戻る リストアイテムをアレイリスト形式で返します。 データ出力 アレイリスト 適用外 適用外