このダイアログ ボックスでは、カスタム関数の詳細情報やデフォルト値を指定します。[カスタム関数プロパティ]ダイアログ ボックスは、以下の場合に表示されます。
- [式ワークショップ]ツールバーの[プロパティ表示の切り替え]ボタンを選択した状態で既存のカスタム関数を選択したとき。
- [カスタム関数の式からの抽出]ダイアログ ボックスの[詳細情報の入力]をクリックしたとき。
- 式エキスパートの[詳細]をクリックしたとき(この場合、[カスタム関数プロパティ]ダイアログ ボックスの内容は参照専用です)。
- 名前
- 参照専用のフィールドです。カスタム関数の作成時に指定した名前が表示されます。
- 集計
- この領域では、カスタム関数に関する機能や用途などの詳細情報を追加します。
- カテゴリ
- この領域では、カスタム関数のカテゴリを定義します。カテゴリは、特定のカスタム関数をグループ化する手段です。カテゴリは、式ワークショップのツリー ビューの[レポート カスタム関数]フォルダと[式エディタ]ダイアログ ボックスの関数ウィンドウに、サブフォルダとして表示されます。
さらにレベルを細分化するには、カテゴリ定義でスラッシュを使用します。
- リポジトリ
- 参照専用のフィールドです。カスタム関数が現在接続しているリポジトリまたは前回接続したリポジトリの名前が表示されます。このフィールドに情報を表示するには、カスタム関数をリポジトリに接続する必要があります。
- エキスパートで表示
- 式エキスパートの[カスタム関数指定ロジック]ボックスにカスタム関数を表示する場合は、このオプションを選択します。
- 作成者
- このフィールドでは、カスタム関数の作成者の名前を追加します。
- 戻り値の型
- 参照専用のフィールドです。引数のデータ型が表示されます。
- ヘルプ テキスト
- このボタンをクリックすると、[ヘルプ テキスト]ダイアログ ボックスが開きます。このダイアログ ボックスでは、他のユーザー向けに関数を使用するためのヘルプ情報を指定します。ヘルプ テキストを利用できるのは、このダイアログ ボックスだけです。
- 引数
- この領域のフィールドには、カスタム関数の定義が表示されます。
- 名前
- 引数名を示す参照専用のフィールドです。
- タイプ
- 対応するデータベース フィールドのデータ型を示す参照専用のフィールドです。
- 説明
- このフィールドでは、引数の説明(省略可能)を追加できます。この説明は式エキスパートに表示されます。
- デフォルト値
- このフィールドでは引数のデフォルト値を定義します。[デフォルト値]フィールドをクリックすると、デフォルト値ダイアログ ボックスが開きます。ここで作成したデフォルト値は式エキスパートで使用できます。
範囲、配列、または範囲配列の各引数型のデフォルト値は作成できません。
デフォルト値のセットの作成方法については、カスタム関数のデフォルト引数値の定義を参照してください。
参照
カスタム関数 | 式ワークショップ | [ヘルプ テキスト]ダイアログ ボックス | デフォルト値ダイアログ ボックス