@DocChildren (式言語)

列式やウィンドウタイトル式で、現在の文書やカテゴリに属する子文書や子カテゴリの数を返します。「子」として数えられるのは、次レベルの文書と次のレベルのカテゴリだけです。例えば、返答文書は主要文書の子文書ですが、返答の返答文書は主要文書の子文書とは見なされません。

構文

@DocChildren @DocChildren( defaultString ) @DocChildren( zero-string ; defaultString ) @DocChildren( zero-string ; one-string ; defaultString )

パラメータ

defaultString

文字列。オプション。返される文字列。文字列内で「%」を使用すると、「%」は子文書または子カテゴリの数で置き換えられます。例: "% Responses"

zero-string

文字列。オプション。"No Responses" のように、文書またはカテゴリに子文書がない場合に返される文字列を指定します。

one-string

文字列。オプション。"One Response" のように、文書またはカテゴリに子文書が 1 つだけある場合に返される文字列を指定します。

戻り値

戻り値は、@DocChildren の呼び出し方に応じて、次のようになります。

numChildren

特殊文字列。パラメータを指定しないで @DocChildren を呼び出すと、現在の文書やカテゴリに属する子文書の数が返されます。特殊文字列は数値には変換できません。

childString

特殊文字列。パラメータを指定して @DocChildren を呼び出すと、現在の文書やカテゴリに属する子文書の数に基づいて該当する文字列が返されます。特殊文字列は数値には変換できません。

使用法

ウィンドウタイトル式や列式での @DocChildren は、ある文書に対する最上位レベルの返答文書の数を表示する場合や、あるカテゴリ内の主要文書の数を表示する場合などに使用します。この関数は、これ以外の式では使用できません。

この @関数は文書を開いたときに計算されます。ビューから印刷するときなどのように、文書が開いてない場合は、返される結果は予測できません。

列式での場合を除いて、この関数は、Web アプリケーションでは使用できません。

例

次の例では、3 が返されます。
```
 @DocChildren
```
次の例では、3 Responses が返されます。% は、該当する数で置換されます。文書に返答文書が 1 つもないときは、0 Responses が返されます。
```
@DocChildren("% Responses")
```
次の例では、3 Responses が返されます。この場合、文書に返答文書が 1 つもないときは、No Responses というメッセージが返されます。
```
@DocChildren("No Responses";"% Responses")
```
次の例では、There are 3 Responses. が返されます。文書に返答文書が 1 つあるとき、返されるメッセージは 1 Response です。文書に返答文書がないときは、No Responses というメッセージが返されます。
```
@DocChildren("No Responses";"1 Response";
"There are % Responses.")
```

クロスリファレンス

LotusScript® NotesViewEntry クラスの ChildCount プロパティ

Java™ ViewEntry クラスの ChildCount プロパティ