api:set

Version 23.0.8844


api:set

Version 23.0.8844


api:set キーワードはアトリビュートで値を設定します。アトリビュートが、存在しないアイテム内に設定されている場合、アイテムは自動的に生成されます。

api:set を使って値を設定する方法は2種類あります。値のパラメータを設定するか、マルチラインで複雑な大きな値の場合には、キーワード自身のスコープを使って値を設定することもできます。

パラメータ

  • item:アイテムパラメータは、アトリビュートが設定されているアイテムを指定するために使われます。アイテムの指定は必須ではありません。アイテムが指定されない場合には、ディフォルトアイテムが使われます。
  • attr:アトリビュートの名前。ドット表現(例えば item.prefix:attr)アイテムを指定することもできます。完全なアトリビュート名にはname、および接頭辞が両方ありますが、接頭辞は必須ではありません。
  • value:アトリビュートにアサインされる値。このパラメータが与えられていない場合、api:set キーワードの全ボディが値として使われます。これは、長い、もしくは複数の値を設定する際に便利です。
  • copyfrom:このパラメータにて指定されたアイテムからのアトリビュートはアイテムパラメータにより指定されたアイテムにコピーされます。

アトリビュートの制御

None

キーワードのスコープを使って、”input” という名前のアイテムのメッセージアトリビュートの値を設定します:

<api:set item="input" attr="message">
  Dear [name],
  You have won a cruise trip to Hawaii.
  Please confirm your acceptance by [date].
  Thanks, [sales]
</api:set>

関連項目

  • api:unset:アイテムからアトリビュートを削除する:
  • api:setm:一つのキーワードしか持たないマルチプルアトリビュートを設定する。