api:set

Version 25.3.9411


api:set


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

api:set を使って値を設定する方法は2種類あります:

  • 値パラメータを設定する。
  • キーワード自体のスコープを使って値を設定する。これは、大きな複数行の複雑な値に便利です。

パラメータ

  • item:アトリビュートが設定されているアイテムを指定するために使われます。アイテムが指定されていない場合は、デフォルトアイテムが使用されます。
  • attr:アトリビュートの名前。ドット表現(例えばitem.prefix:attr)を使用してアイテムを指定することもできます。

    Note:完全なアトリビュート名には、接頭辞とアトリビュート名がありますが、接頭辞は必須ではありません。

  • value:アトリビュートに割り当てる値。このパラメータが指定されていない場合、api:set キーワードのボディ全体が値として使われます。これは、長い値、もしくは複数行の値を設定する際に便利です。
  • copyfrom:このパラメータで指定されたアイテムからのアトリビュートは、item パラメータにより指定されたアイテムにコピーされます。

アトリビュートの制御

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:1つのキーワードで複数のアトリビュートを設定する。