> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 名前付きパラメーター

> 名前付きパラメーターは FlexiLayouts のデバッグに役立ちます。FlexiLayout のプロパティタブで作成し、値をバッチやページに渡して、スクリプトから呼び出すことができます。

名前付きパラメーターは、FlexiLayouts のデバッグに役立ちます。名前付きパラメーターの値は、FlexiLayout の適用時にチェックされます。

<div id="create-a-named-parameter">
  ## 名前付きパラメーターの作成
</div>

<Steps>
  <Step title="FlexiLayout のプロパティ ダイアログを開く" />

  <Step title="名前付きパラメーター タブを選択する" />

  <Step title="Add new... をクリックする" />
</Steps>

<Frame>
  <img src="https://mintcdn.com/abbyy/r-nfa7jujx5b9gKX/images/flexi-capture/fls/named_param_layout.png?fit=max&auto=format&n=r-nfa7jujx5b9gKX&q=85&s=1f289ebbecff8c6cf0dd6370b15358ee" alt="FlexiLayout のプロパティ ダイアログにある Input の 名前付きパラメーター タブのスクリーンショット。名前付きパラメーターが Name、Type、Value 列に一覧表示され、Add new、Edit、Reset、Delete の各ボタンがあります。" width="433" height="456" data-path="images/flexi-capture/fls/named_param_layout.png" />
</Frame>

<div id="named-parameter-properties">
  ## 名前付きパラメーターのプロパティ
</div>

各名前付きパラメーターには、次のプロパティがあります。

| プロパティ     | 説明                                                                                |
| --------- | --------------------------------------------------------------------------------- |
| **Name**  | いったん指定すると、変更できません。                                                                |
| **Type**  | **String**、**StringArray**、または **Int** の3つの型のいずれかです。いったん指定すると、変更できません。            |
| **Value** | バッチやページごとに変更できます。FlexiLayoutで値が指定されていない場合は、**Value** 列に **\<Undefined>** と表示されます。 |

<div id="how-named-parameters-are-inherited">
  ## 名前付きパラメーターの継承方法
</div>

FlexiLayout の名前付きパラメーターはそのバッチに継承され、バッチの名前付きパラメーターはそのページに継承されます。バッチまたはページのプロパティ ダイアログにある **名前付きパラメーター** タブの **Inherited from** 列には、各名前付きパラメーターの継承元が表示されます。

<Frame>
  <img src="https://mintcdn.com/abbyy/r-nfa7jujx5b9gKX/images/flexi-capture/fls/named_param_batch.png?fit=max&auto=format&n=r-nfa7jujx5b9gKX&q=85&s=32e298757139cdaa8b3d0b6d3b9a12c0" alt="バッチのプロパティ ダイアログにある Input の 名前付きパラメーター タブのスクリーンショット。Inherited from 列には、各名前付きパラメーターが FlexiLayout と Batch のどちらから継承されたかが表示されています。" width="433" height="456" data-path="images/flexi-capture/fls/named_param_batch.png" />
</Frame>

値が定義されている名前付きパラメーターはコピーできます。コピー先に同じ名前と型の名前付きパラメーターがすでに存在する場合、コピーしたパラメーターの値がコピー先のパラメーターに割り当てられます。

<div id="named-parameter-commands">
  ## 名前付きパラメーターのコマンド
</div>

FlexiLayout のプロパティ ダイアログにある **名前付きパラメーター** タブでは、次のコマンドを使用できます。

| コマンド            | 説明                                                       |
| --------------- | -------------------------------------------------------- |
| **Add new\...** | 名前付きパラメーターを作成します。FlexiLayouts でのみ使用できます。                 |
| **Edit...**     | 名前付きパラメーターを編集します。                                        |
| **Reset**       | 名前付きパラメーターの値をリセットします。                                    |
| **Delete**      | 名前付きパラメーターを削除します。FlexiLayouts でのみ使用できます。                 |
| **Copy**        | 名前付きパラメーターをコピーします。名前付きパラメーターのショートカット メニューでのみ使用できます。      |
| **Paste**       | コピーした名前付きパラメーターを貼り付けます。名前付きパラメーターのショートカット メニューでのみ使用できます。 |

<div id="call-a-named-parameter-from-a-script">
  ## スクリプトから名前付きパラメーターを取得する
</div>

スクリプトから名前付きパラメーターを取得するには、パラメーターの型に応じて、次のいずれかの[メソッド](/ja/flexi-capture/fls/language/named-param-functions)を使用します。

| メソッド                           | 名前付きパラメーターの型    |
| ------------------------------ | --------------- |
| `GetNamedParameterString`      | **String**      |
| `GetNamedParameterStringArray` | **StringArray** |
| `GetNamedParameterInt`         | **Int**         |

<div id="add-named-parameters-to-elements">
  ## 要素への名前付きパラメーターの追加
</div>

Reference layout を使用して、要素に Region を持つ名前付きパラメーターを追加できます。

1 つ以上のページを選択し、それらを右クリックして **Properties...** をクリックすると、プロパティ ダイアログが開きます。**名前付きパラメーター** タブには、利用可能な名前付きパラメーターの List が表示されます。**Edit...** をクリックして編集することも、継承元となる最も近い親の値にリセットすることもできます。

**Prefix to discard** ボックスを使用して、名前付きパラメーターの名前から削除する接頭辞を指定します。たとえば、このボックスを使って、名前付きパラメーター名から代替レイアウトの名前を削除できます。