変数アクション
デスクトップ フローで変数を手動で作成するには、変数の設定 アクションを展開します。 このアクションでは、新しい変数で使用する名前と値を指定する必要があります。
![[変数を設定する] アクションのスクリーンショット。](media/variables/set-var-action-properties.png)
重要
予約されたキーワードは変数名として使用できません。 予約済みキーワードの完全なリストについては、 デスクトップ フローの予約済みキーワード を参照してください。
変数の数値を増減するには、変数を大きくする または 変数を小さくする アクションをそれぞれ使用します。
![[変数を大きくする] アクションのスクリーンショット。](media/variables/increase-var-action-properties.png)
ほとんどのアクションは、結果を変数に出力します。 たとえば、新しいリストを作成する アクションは空のリストを生成します。
同様に、乱数を生成する アクションはランダムな数値を生成します。 このアクションで複数の数値を生成を有効にすると、複数のランダムな数値を含むリスト変数を作成できます。
![[乱数を生成する] アクションのスクリーンショット。](media/variables/generate-random-num-action-properties.png)
既存のリストに項目を追加する場合は、項目をリストに追加する アクションを展開して、ハードコードした値または変数を入力し、追加する項目を定義します。 同様に、リストから項目を削除する アクションでリストから項目を削除します。
Note
リストのインデックスは 0 から始まります。つまり、リストの最初の項目のインデックスはいつも 0 になります。 %ListName[0]% という表記でリストの最初の項目を参照し、%ListName[1]% で 2 番目の項目を参照します、以降同じように参照します。
データテーブル変数を作成する場合は、新しいデータテーブルを作成する アクションを展開し、ビジュアル ビルダーを使用してその初期項目を定義します。
データテーブル変数を操作する際は、データ テーブル内で検索または置換する や データ テーブル項目を更新する アクションのような、それぞれのアクション サブグループのアクションを使用します。
新しいデータ テーブルを作成する
新しいデータ テーブル変数を作成します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| 新しいテーブル | いいえ | Datatable | 入力データ テーブル |
生成された変数
| 引数 | タイプ | 説明設定 |
|---|---|---|
| DataTable | Datatable | 新しいデータ テーブル |
例外
このアクションには例外は含まれません。
行をデータ テーブルに挿入する
行を末尾または指定されたインデックス値の前に挿入します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| データ テーブル | いいえ | Datatable | 使用するデータ テーブル変数。 この変数は、データ テーブル変数を生成するアクションによって事前に指定されている必要があります | |
| 挿入場所 | 該当なし | データ テーブルの末尾、行インデックスの前 | データ テーブルの末尾 | 新しい行をデータ テーブルの末尾に挿入するか、指定した行インデックスの前に挿入するかを指定します |
| 行インデックス | いいえ | 数値 | 挿入場所パラメーターに [行インデックスの前] が指定されている場合に使用する行インデックス値を挿入します | |
| 新しい値 | いいえ | リスト、Datarow | このパラメーターは、列の数がデータ テーブルの列数と一致するリストまたは Datarow 変数を受け取ります |
生成された変数
このアクションは変数を生成しません。
例外
| 例外 | Description |
|---|---|
| 項目インデックスが範囲外です | 指定された項目のインデックスが範囲外であることを示します |
| 無効な入力引数 | 無効な入力パラメータがあることを示します |
| 互換性のない型のエラー | 互換性のない種類の入力パラメーターが指定されたことを示します |
データ テーブル内で検索または置換する
データ テーブルの値を検索または置換します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| データ テーブル | いいえ | Datatable | 使用するデータ テーブル変数。 この変数は、データ テーブル変数を生成するアクションによって事前に指定されている必要があります | |
| 検索モード | 該当なし | 検索、検索して置換する | 検索 | 検索のモード (検索、検索および置換) |
| すべて一致 | 該当なし | ブール値 | True | 一致するすべてのセルのテキストを検索または置換するか、一致する最初のセルのみのテキストを検索または置換するかを指定します |
| 検索するテキスト | いいえ | テキスト値 | データ テーブル内で検索するテキスト | |
| 正規表現を使用して検索する | 該当なし | ブール値 | False | 正規表現を使用して、セルの内容を検索テキストと照合するかどうかを指定します |
| ケースを一致させる | 該当なし | ブール値 | False | データの大文字と小文字を区別して検索するかどうかを指定します |
| セル全体のコンテンツを一致させる | 該当なし | ブール値 | False | 指定したテキストと完全に一致するセルを検索するかどうかを指定します |
| 置換するテキスト | いいえ | テキスト値 | 一致するセルの置換に使用するテキスト | |
| 検索条件 | 該当なし | すべての場所、列 | すべての場所 | テキストを検索する順序 (すべての場所、列) |
| 列のインデックスまたは名前 | いいえ | Text 値 | 列ヘッダーまたはインデックス値 |
生成された変数
| 引数 | タイプ | 説明設定 |
|---|---|---|
| DataTableMatches | Datatable | 一致する行と列のインデックスを含むデータ テーブル |
例外
| 例外 | 説明 |
|---|---|
| 指定された正規表現が無効です | 指定された正規表現が無効であることを示します |
| 列名が存在しません | 指定された列名が存在しないことを示します |
| 列インデックスが範囲外です | 指定された列インデックスが範囲外であることを示します |
| 互換性のない型のエラー | 互換性のない種類の入力パラメーターが指定されたことを示します |
データ テーブル項目を更新する
定義された列でデータ テーブル行の項目を更新します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| データ テーブル | いいえ | Datatable | 使用するデータ テーブル変数。 この変数は、データ テーブル変数を生成するアクションによって事前に指定されている必要があります | |
| 列 | いいえ | テキスト値 | 更新する項目の列名またはインデックス | |
| 行 | いいえ | 数値 | 更新する項目の行インデックス | |
| 新しい値 | いいえ | テキスト値 | 行インデックスおよび列を指定して更新する新しい値 |
生成された変数
このアクションは変数を生成しません。
例外
| 例外 | Description |
|---|---|
| 項目インデックスが範囲外です | 指定されたデータ テーブル項目が範囲外であることを示します |
| 列名が存在しません | 指定された列名が存在しないことを示します |
| 列インデックスが範囲外です | 指定された列インデックスが範囲外であることを示します |
| 互換性のない型のエラー | 互換性のない型の入力パラメーターが指定されたことを示します |
データ テーブルから行を削除する
定義された列でデータ テーブル行の項目を更新します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| データ テーブル | いいえ | Datatable | 使用するデータ テーブル変数。 この変数は、データ テーブル変数を生成するアクションによって事前に指定されている必要があります | |
| 行インデックス | いいえ | 数値 | データ テーブル内で削除する行のインデックス |
生成された変数
このアクションは変数を生成しません。
例外
| 例外 | Description |
|---|---|
| 項目インデックスが範囲外です | 指定されたデータ テーブル項目が範囲外であることを示します |
数値を切り詰める
数値の整数部分または小数部分を取得するか、指定された小数点以下の桁数に値を切り上げます。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| Number to truncate | いいえ | 数値 | 切り捨て/切り上げを行う数値を保持する数字または変数 | |
| Operation | N/A | 整数部分を取得、小数部分を取得、丸める番号 | 整数部分を取得 | 指定された数値に対して実行する操作を指定します |
| Decimal places | はい | 数値 | 3 | 指定された数値を切り上げる小数点以下の桁数。 結果に整数を返すには、0 を入力します |
生成された変数
| 引数 | タイプ | 説明設定 |
|---|---|---|
| TruncatedValue | 数値 | 切り捨てまたは切り上げられた数値 |
例外
このアクションには例外は含まれません。
乱数の生成
最小値と最大値の間にある単一の乱数や乱数リストを生成します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| Minimum value | はい | 数値 | 0 | 生成する乱数の下限 |
| Maximum value | はい | 数値 | 100 | 生成する乱数の上限 |
| Generate multiple numbers | N/A | ブール値 | 無効 | 単一の乱数または乱数リストのどちらを生成するかを指定します |
| How many numbers | はい | 数値 | 10 | 生成する乱数の数を指定します |
| Allow duplicates | N/A | ブール値 | 無効 | 同じ数値が乱数リストに複数件存在することを許可するかどうかを指定します |
生成された変数
| 引数 | タイプ | 説明設定 |
|---|---|---|
| RandomNumber | 数値 | 新しく生成された乱数 |
| RandomNumbers | 数値の一覧 | 新しく生成された乱数リスト |
例外
| 例外 | 説明 |
|---|---|
| 乱数を生成できませんでした | 乱数の生成中にエラーが発生したことを示します |
リストをクリアする
リストからすべての項目を削除します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| List to clear | いいえ | 全般値の一覧 | 要素を削除するリスト変数 |
生成された変数
このアクションは変数を生成しません。
例外
このアクションには例外は含まれません。
リストから項目を削除する
1 つまたは複数の項目をリストから削除します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| Remove item by | N/A | インデックス、値 | インデックス | 指定されたインデックスの項目と特定の値を持つ項目のどちらを削除するかを指定します |
| At index | いいえ | 数値 | 削除する項目のインデックス番号 | |
| With value | いいえ | 一般の値 | 削除する項目 | |
| Remove all item occurrences | N/A | ブール値 | 無効 | 指定された項目に一致したすべての項目を削除します |
| From list | いいえ | 全般値の一覧 | 削除する項目のあるリスト |
生成された変数
このアクションは変数を生成しません。
例外
| 例外 | Description |
|---|---|
| 項目インデックスが範囲外です | 項目インデックスが範囲外であることを示します |
| 項目が見つかりません | 項目がリストに存在しないことを示します |
一覧の並べ替え
リストの項目を並べ替えます。 同じ種類の項目を使用します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| List to sort | いいえ | 全般値の一覧 | 並べ替えるリストを保持する変数 | |
| Sort by list item's properties | N/A | ブール値 | False | リストの項目がオブジェクト (ファイル、フォルダーなど) の場合、このオプションを有効にすると、特定のプロパティで項目を並べ替えることができます。 このオプションを無効にしたままにしておくと、要素を既定のプロパティでソートします (たとえば、ファイル オブジェクトはフルパスでソートされます) |
| First property to sort by | はい | テキスト値 | リストをソートする項目のプロパティ名。 各オブジェクトのプロパティ名については、ヘルプ ファイルを参照してください | |
| Sort | N/A | 照準、降順 | 昇順 | 最初のプロパティを基準に昇順および降順のどちらで並べ替えるかを指定します |
| Second property to sort by | はい | テキスト値 | リストの並べ替えの基準にする 2 番目のプロパティの名前 | |
| Sort | N/A | 照準、降順 | 昇順 | 2 番目のプロパティを基準に昇順および降順のどちらで並べ替えるかを指定します |
| Third property to sort by | はい | テキスト値 | リストの並べ替えの基準にする 3 番目のプロパティの名前 | |
| Sort | N/A | 照準、降順 | 昇順 | 3 番目のプロパティを基準に昇順および降順のどちらで並べ替えるかを指定します |
生成された変数
このアクションは変数を生成しません。
例外
このアクションには例外は含まれません。
リストのシャッフル
リストのランダム順列を作成します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| List to shuffle | いいえ | 全般値の一覧 | シャッフルするリストを含む変数 |
生成された変数
このアクションは変数を生成しません。
例外
このアクションには例外は含まれません。
リストの統合
2 つのリストを 1 つに統合します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| First list | いいえ | 全般値の一覧 | 結合する項目の最初のリスト | |
| Second list | いいえ | 全般値の一覧 | 結合する項目の 2 番目のリスト |
生成された変数
| 引数 | タイプ | 説明設定 |
|---|---|---|
| OutputList | 全般値の一覧 | 統合されたリスト。 初期リストが変更されていません |
例外
| 例外 | 内容 |
|---|---|
| 指定されたリストの種類に互換性がありません | 指定されたリストに互換性がないことを示します |
リストを逆にする
リストの項目の順序を逆にします。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| List to reverse | いいえ | 全般値の一覧 | 項目の順序を逆にするリスト |
生成された変数
このアクションは変数を生成しません。
例外
このアクションには例外は含まれません。
リストから重複する項目を削除
リスト内の重複する項目を削除し、リスト内の各項目を一意にします。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| List to remove duplicate items from | いいえ | 全般値の一覧 | 重複する項目を削除するリスト変数 | |
| Ignore text case while searching for duplicate items | N/A | ブール値 | 無効 | 重複する項目を検索するときに大文字と小文字を区別せずにテキスト比較を行うかどうかを指定します (テキスト項目で構成されたリストにのみ適用されます) |
生成された変数
このアクションは変数を生成しません。
例外
このアクションには例外は含まれません。
共通リスト項目の検索
2 つのリストを比較して、両方に共通する項目を持つ新しいリストを作成します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| First list | いいえ | 全般値の一覧 | 比較する最初のリストを含む変数 | |
| Second list | いいえ | 全般値の一覧 | 比較する 2 番目のリストを含む変数 |
生成された変数
| 引数 | タイプ | 説明設定 |
|---|---|---|
| IntersectionList | 全般値の一覧 | 共通項目の新しいリスト |
例外
このアクションには例外は含まれません。
リストの内容を減らす
2 つのリストを比較して、最初のリストに含まれていて 2 番目のリストに含まれていない項目を含む新しいリストを作成します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| First list | いいえ | 全般値の一覧 | 比較する最初のリストを保持する変数 | |
| Second list | いいえ | 全般値の一覧 | 比較する 2 番目のリストを保持する変数 |
生成された変数
| 引数 | タイプ | 説明設定 |
|---|---|---|
| ListDifference | 全般値の一覧 | 生成される新しいリスト |
例外
このアクションには例外は含まれません。
データ テーブル列をリストに取得
データ テーブル列の内容をリストに変換します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| Data table | いいえ | Datatable | リストに変換する列を含むデータ テーブル | |
| Column name or index | いいえ | テキスト値 | 列名 (列名が定義されている場合)、または取得する列のインデックス番号 |
生成された変数
| 引数 | タイプ | 説明設定 |
|---|---|---|
| ColumnAsList | 全般値の一覧 | 指定されたデータ テーブルの内容を保持する新しいリスト |
例外
| 例外 | 内容 |
|---|---|
| 列名が存在しません | データ テーブルに列名が含まれていないことを示します |
| 列インデックスが範囲外です | 列インデックスが範囲外であることを示します |
JSON をカスタム オブジェクトに変換
JSON 文字列をカスタム オブジェクトに変換します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| JSON | いいえ | テキスト値 | カスタム オブジェクトに変換する JSON テキスト (または JSON テキストを含む以前に作成された変数) |
生成された変数
| 引数 | タイプ | 説明設定 |
|---|---|---|
| JsonAsCustomObject | 一般の値 | 指定された JSON から変換されたカスタム オブジェクト |
例外
| 例外 | 説明 |
|---|---|
| JSON の解析エラー | 指定された JSON の解析中にエラーが発生したことを示します |
カスタム オブジェクトを JSON に変換
カスタム オブジェクトを JSON 文字列に変換します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| Custom object | いいえ | カスタム オブジェクト | JSON に変換するカスタム オブジェクト |
生成された変数
| 引数 | タイプ | 説明設定 |
|---|---|---|
| CustomObjectAsJson | Text 値 | 指定されたカスタム オブジェクトの変換された JSON |
例外
| 例外 | 説明 |
|---|---|
| カスタム オブジェクトの解析エラー | カスタム オブジェクトの解析中にエラーが発生したことを示します |
項目をリストに追加
新しい項目をリストに追加します。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| Add item | いいえ | 一般の値 | リストに追加する値または変数です。 複数の要素を追加する値のリストを提供します。 リストに特定のタイプの要素がある場合、新しい要素はそのタイプに変換されます | |
| Into list | いいえ | 全般値の一覧 | 新しい要素を追加するリスト変数 |
生成された変数
| 引数 | タイプ | 説明設定 |
|---|---|---|
| NewList | 全般値の一覧 | 新しいリスト |
例外
このアクションには例外は含まれません。
新しいリストの作成
新しい空のリストを作成します。
入力パラメーター
このアクションには入力は必要ありません。
生成された変数
| 引数 | タイプ | 説明設定 |
|---|---|---|
| リスト | 全般値の一覧 | 新しいリスト |
例外
このアクションには例外は含まれません。
変数を大きくする
変数の値を一定量増やします。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| Variable name | いいえ | 数値 | 大きくする数値 | |
| Increase by | いいえ | 数値 | 変数を大きくする数値 (または数値を含む以前に作成された変数) |
生成された変数
このアクションは変数を生成しません。
例外
このアクションには例外は含まれません。
変数を小さくする
変数の値を一定量減らします。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| Variable name | いいえ | 数値 | 変数を小さくする数値 (または数値を含む以前に作成された変数) | |
| Decrease by | いいえ | 数値 | 変数を小さくする数値 (または数値を含む以前に作成された変数) |
生成された変数
このアクションは変数を生成しません。
例外
このアクションには例外は含まれません。
Power Fx 式を実行する
指定された Power Fx 式を実行します。
注意
このアクションは、Power Fx が有効なデスクトップ フロー (プレビュー) でのみ使用できます。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | プロパティ |
|---|---|---|---|---|
| 式 | いいえ | * | 実行する Power Fx 式 |
生成される変数
このアクションは変数を生成しません。
例外
このアクションには例外は含まれません。
変数の設定
新規や既存の変数に値を設定する、新しい変数を作成する、または以前作成した変数を上書きします。
入力パラメーター
| 引数 | オプション | 受入 | Default Value | 説明設定 |
|---|---|---|---|---|
| 受信先 | いいえ | * | 変数に割り当てる値です |
生成された変数
| 引数 | タイプ | Description |
|---|---|---|
| NewVar | * | 設定する変数名 |
注意
変数名の先頭にはアルファベットまたはアンダースコア (_) を必ず使用します。 変数名の先頭の文字の後には、アルファベット、アンダースコア、数字 (0-9) を使用できます。 名前の大文字と小文字は区別されません。つまり、myVar、myvar、MYVAR は同じ変数とみなされます。 次に示す予約キーワードは変数名として使用できません: if、then、else、switch、case、default、loop、from、to、step、foreach、in、while、next、exit、label、goto、call、output、function、block、end、error、wait、for、set、main、and、or、xor、not、true、false、yes、no、disable、on、repeat、times、throw、action、mod、global、input、import
例外
このアクションには例外は含まれません。