SetVar 要素 (ビュー)
最終更新日: 2015年3月9日
適用対象: SharePoint Foundation 2010
この記事の内容
属性
子要素
親要素
出現回数
ページ レンダリングのコンテキスト内で、XML の現在のレベルに対してローカルに、またはページに対してグローバルに、変数を設定することができます。
<SetVar
ID = "Text"
Name = "Text"
Scope = "Request"
Value = "Text">
</SetVar>
属性
属性 |
説明 |
|---|---|
ID |
オプションの Text。変数の ID を指定します。 |
Name |
必須の Text。変数の名前を指定します。 |
Scope |
Request に設定すると、変数がグローバルになります。 |
Value |
オプションの Text。この要素が空の要素である場合、これを使用して変数に値を割り当てることができます。 |
子要素
なし |
親要素
多数 |
出現回数
最小 : 0 最大 : 制約なし |
コメント
SetVar 要素はスパン形式と非スパン形式の両方で指定できるため、<SetVar Name="MyVar">Announcements</SetVar> と <SetVar Name="MyVar" Value="Announcements/> の結果は同じになります。
SetVar で Scope="Request" を指定した場合、その変数割り当ては現在のページ全体に適用されます。それ以外の場合、割り当ては SetVar 要素の子にのみ適用されます。
SetVar 要素は多くの場合、Method 要素の子として、要求をバッチ処理する記述に使われます。
SetVar 要素は、DisplayMode を次のいずれかの値に設定して表示モードを変更するためによく使用されます。
値 |
説明 |
|---|---|
DISPLAY |
ビューの ViewBody セクションをレンダリングするときに使用されます。 |
EDIT |
アイテム編集フォームをレンダリングするときに使用されます。 |
DISPLAYHEAD |
ビューの ViewHeader セクションをレンダリングするときに使用されます。 |
NEW |
新規アイテム フォームをレンダリングするときに使用されます。 |
PREVIEWDISPLAY |
Microsoft FrontPage を使用して表示フォームを編集するときに使用されます。 |
PREVIEWNEW |
FrontPage を使用して新規アイテム フォームを編集するときに使用されます。 |
PREVIEWEDIT |
FrontPage を使用してアイテム編集フォームを編集するときに使用されます。 |
例
次の例では、SetVar 要素を使用して変数にグローバル スコープを設定する方法を示します。1 行目で設定した値が 2 行目で返されます。
<SetVar Name="GlobalVar" Scope="Request">Value</SetVar>
...
<GetVar Name="GlobalVar">
次の例では、1 つ目の GetVar (英語) 要素が "Value_2" を返し、2 つ目の GetVar 要素が "Value_1" を返します。これは、"Value_2" を含む SetVar 要素が "Sample" 要素の子にのみ適用されるためです。"Sample" タグが閉じた後、"Value_2" はスコープから外れます。
<SetVar Name="myVar">Value_1</SetVar>
<Sample>
<SetVar Name="myVar">Value_2</SetVar>
<GetVar Name="myVar"/>
</Sample>
<GetVar Name="myVar"/>
次の例では、フィールドが必須かどうかを評価し、必須であれば、新規フォームまたは編集フォームの必須フィールドの横に赤いアスタリスク記号 (*) を表示して、HasRequired 変数を TRUE に設定します。
<Switch>
<Expr>
<Property Select="Required"/>
</Expr>
<Case Value="TRUE">
<HTML><![CDATA[<font color=red> *</font>]]></HTML>
<SetVar Scope="Request" Name="HasRequired">TRUE</SetVar>
</Case>
</Switch>