Annotationは、グリッド・オブジェクト内の注釈についてリクエストされた情報を戻します。どの情報を戻すかを定義できます。
構文:
<<Annotation("GridName", Row, Col, Page, Attributes, Reference, Attachments)>>
<<Annotation("GridName", Row, Col, Page)>>
<<Annotation("GridName", Row, Col, Page, Attributes, Reference)>>
<<Annotation("GridName", Row, Col, Page, Attributes, Attachments)>>
<Annotation("GridName", AllRows, AllCols, Page, Attributes, Attachments)>>
ここで:
GridNameは、注釈のあるグリッドの名前です。グリッドのテキスト・セルまたはカスタム見出しに属性が使用されている場合、"current"キーワードの使用がサポートされています。
Rowは、グリッド上の行番号です。グリッドのテキスト・セルまたはカスタム見出しに属性が使用されている場合、"current"キーワードの使用がサポートされています。
注:
すべての行を選択するには、rowをキーワードAllRowsで置き換えます。
Colは、グリッドの列の参照(文字)です。グリッドのテキスト・セルまたはカスタム見出しに属性が使用されている場合、"current"キーワードの使用がサポートされています。
注:
すべての列を選択するには、ColをキーワードAllColsで置き換えます。
Pageは、グリッドのすべてのページ・ディメンションのメンバーの組合せのインデックスを表す数値です。グリッド内の最初のページ・ディメンションにおける組合せのインデックスは1、2番目のページ・ディメンションにおける組合せのインデックスは2、以降、同様に続きます。
Attributesは、注釈から戻す情報を指定します。キーワードAll (デフォルト値)またはキーワードTitle & Description & Author & Date & Categoryのいずれか、またはその組合せを取ります。属性のキーワードの出力順序は自由に設定できます。各属性は、アンパサンド(&)で区切る必要があります。
Referenceは、どの注釈を戻すかを示す次のキーワードです。
All (デフォルト)は、最初の注釈とすべての結果を戻します。
Top <n>は、最初の注釈と最初の<n>個の結果を戻します。
Bottom <n> は、最初の注釈と最後の<n>個の結果を戻します。最初の注釈は常に表示されるので、個数<n>には、最初の注釈は含まれません。
BottomOnly <n>は、最後の<n>個の結果を戻します。最初の注釈は、<n>が4以下の場合に表示されますが、<n>が5以上の場合には表示されません。
Firstは、最初の注釈のみを戻します。
Repliesは、すべての結果を戻します。最初の注釈は表示されません。
Attachmentsは、ブール(true/false)値です。この値は、注釈に関連付けられた添付をレポートとともに印刷するかどうかを次のように示します。
Trueの場合は、レポートの最後に添付を印刷します。
Falseの場合は、添付を印刷しません。
例:
<<Annotation("Grid1", cur, A, cur, All, All, true)>>
<<Annotation("Grid1", cur, A, cur, Title & Description & Author & Date & Category, Top 10, true)>>
<<Annotation("Grid10", 284, AB, cur, Title & Description & Date & Category, Bottom 10, false)>>
<<Annotation("Grid1", cur, A, cur, Title & Description & Author, BottomOnly 4, false)>>
<<Annotation("Grid Name", 1, A, 1, All)>>
<<Annotation("Grid Name","AllRows", "AllCols", 1, All)>>
<<Annotation("Grid Name", 1, A, 1, All, First)>>
<<Annotation("Grid Name", 1, cur, cur, All, Replies)>>
<<Annotation("Grid Name", 1, cur, cur)>>
<<Annotation("Grid Name",1, cur, cur, Desc, Replies)>>
<<Annotation(cur, cur, A, cur, Desc)>>
<<Annotation(cur, 3, ABC, cur, title & Desc, true)>>
<<Annotation("folder1\folder2\Grid2", 3,A,cur, Title & Description, true)>>
<<Annotation(current, 294, AB, cur, Title & Description, Top 19)>>
<<Annotation(current, 39, AB, cur, Title & Description & Author, Bottom 40)>>
テキスト・ボックスでの注釈の動作
"cur"キーワードを使用した場合、注釈の動作はグリッド・テキスト行とテキスト・ボックスで異なります。
テキスト行の場合、"cur"キーワードを使用できます。
たとえば、<<Annotation("Grid1", 1, A, cur, All, All, true)>>です
テキスト・ボックスの場合、"cur"キーワードでは何も戻しません。そのため、<<Annotation("Grid1", 1, A, 1, All, All, true)>>と入力します