HELP

共通マクロ書式

DocuWorks 書式 (アノテーション関連)

NAME アノテーション取得結果数
FORMAT {%DW_GET(AnnotationSearchResultCount)}

アノテーション取得の結果数を取得します。本マクロはアノテーションの繰り返しの中で使用できます。

例1
アノテーション取得の結果数を取得します。以下の例では、アノテーション取得でアノテーションが3つ見つかった場合に「3」と表示されます。
{%WRITE_LOG({%DW_GET(AnnotationSearchResultCount)})}
結果
3
NAME アノテーションループカウンタ取得
FORMAT {%DW_GET(AnnotationLoopCount)}

処理中アノテーションのカウンタを取得します。本マクロはアノテーションの繰り返しの中で使用できます。

例1
処理中アノテーションのカウンタを取得します。以下の例では、アノテーションの繰り返し処理で、3番目を処理した場合に「3」と表示されます。
{%WRITE_LOG({%DW_GET(AnnotationLoopCount)})}
結果
3
NAME アノテーションキー取得
FORMAT {%DW_GET(AnnotationKey)}

処理中アノテーションのアノテーションキーを取得します。本マクロはアノテーションの繰り返しの中で使用できます。

例1
処理中アノテーションのアノテーションキーを取得します。
{%WRITE_LOG({%DW_GET(AnnotationKey)})}
結果
f
NAME アノテーションキー取得(貼り付け処理)
FORMAT {%DW_GET_ANNOTATION_KEY_FOR_PROCESS(処理名)}

引き数で指定した処理名で貼り付けたアノテーションのアノテーションキーを取得します。

ページの繰り返しの中では、貼り付け処理毎にキーが上書きされます。

例1
テキスト貼り付け1」と「矩形貼り付け1」処理で貼り付けたアノテーションをグループ化する。
{%ADD_USER_DATA(キーリスト,{%DW_GET_ANNOTATION_KEY_FOR_PROCESS(テキスト貼り付け1)})}
{%ADD_USER_DATA(キーリスト,{%DW_GET_ANNOTATION_KEY_FOR_PROCESS(矩形貼り付け1)})}
{%DW_GROUPING_ANNOTATION(#Page,{%DW_GET(OpenName)},1,キーリスト)}
NAME テキストアノテーション属性設定
FORMAT1 {%DW_SET_TEXT_ANNOTATION_ATTRIBUTE(DWアノテーション取得処理名,属性格納用ユーザーデータ名)}
FORMAT2 {%DW_SET_TEXT_ANNOTATION_ATTRIBUTE(#AnnoNo,DWアノテーション取得処理名,アノテーション番号,属性格納用ユーザーデータ名)}
FORMAT3 {%DW_SET_TEXT_ANNOTATION_ATTRIBUTE(#AnnoKey,DWアノテーション取得処理名,アノテーションキー,属性格納用ユーザーデータ名)}

テキストアノテーションの属性を設定します。属性格納用ユーザーデータ名には設定値を格納したユーザーデータ名を指定します。このマクロはDWアノテーション取得で見つかったアノテーションに対して設定されます。

処理中のアノテーションの種類がテキストでない場合はエラーとなります。

書式毎のアノテーションの指定について

アノテーション取得では複数のアノテーションが見つかる可能性があります。FORMAT1の書式はアノテーションの繰り返し処理の中のマクロ実行に記述してください。

属性格納用ユーザーデータの内容はテキストアノテーション貼り付けと同じです。

アノテーション番号

アノテーション番号はFORMAT2の書式で使用し、アノテーション取得の結果のインデックスとして指定します。番号で指定するため、アノテーションの繰り返し処理外でも使用できます。

アノテーションキー

アノテーションキーはFORMAT3の書式で使用し、DocuWorks文書オープンからクローズするまでの間、アノテーションを特定するためのキーとして使用されます。アノテーションが削除・追加されて個数が変化してもアノテーションキーは変わりませんのでアノテーションを特定することができます。

アノテーションキーは文書クローズ後は使用できません。また、再オープンしても前回オープンした際のアノテーションキーは使用できません。文書オープン毎に異なったアノテーションキーが生成されます。

使用例

例1
テキストアノテーションの貼られた文書からアノテーションの属性を取得してテキストの「x」を「X」に置換して更新する。 (アノテーションの繰り返し処理の中でマクロ記述する場合)
{%SET_U(Anno,Text,{%REPLACE({%GET_U(DWアノテーション取得1,{%DW_GET(AnnotationLoopCount)},Text)},x,X)})}
{%DW_SET_TEXT_ANNOTATION_ATTRIBUTE(DWアノテーション取得1,Anno)}
例2
DWアノテーション取得で見つかった1番目のアノテーションの末尾に「_1」を付与する。
{%SET_U(Anno,Text,{%GET_U(DWアノテーション取得1,1,Text)}_1)}
{%DW_SET_TEXT_ANNOTATION_ATTRIBUTE(#AnnoNo,DWアノテーション取得1,1,Anno)}
例3
DWアノテーション取得で見つかった2番目のアノテーションの末尾に「_1」を付与する。(アノテーションキーで指定)
{%SET_U(Anno,Text,{%GET_U(DWアノテーション取得1,2,Text)}_1)}
{%DW_SET_TEXT_ANNOTATION_ATTRIBUTE(#AnnoKey,DWアノテーション取得1,{%GET_U(DWアノテーション取得1,2,AnnotationKey)},Anno)}
NAME ビットマップアノテーション属性設定
FORMAT1 {%DW_SET_BITMAP_ANNOTATION_ATTRIBUTE(DWアノテーション取得処理名,属性格納用ユーザーデータ名)}
FORMAT2 {%DW_SET_BITMAP_ANNOTATION_ATTRIBUTE(#AnnoNo,DWアノテーション取得処理名,アノテーション番号,属性格納用ユーザーデータ名)}
FORMAT3 {%DW_SET_BITMAP_ANNOTATION_ATTRIBUTE(#AnnoKey,DWアノテーション取得処理名,アノテーションキー,属性格納用ユーザーデータ名)}

ビットマップアノテーションの属性を設定します。属性格納用ユーザーデータ名には設定値を格納したユーザーデータ名を指定します。このマクロはDWアノテーション取得で見つかったアノテーションに対して設定されます。

処理中のアノテーションの種類がビットマップでない場合はエラーとなります。

書式毎のアノテーションの指定について

テキストアノテーション属性設定の「 書式毎のアノテーションの指定について 」を参照して下さい。

属性格納用ユーザーデータの内容はビットマップアノテーション貼り付けと同じです。(ImagePathは変更できません。)

使用例

例1
ビットマップアノテーションのX,Y座標を変更する。 (アノテーションの繰り返し処理の中でマクロ記述する場合)
{%SET_U(Anno,HorPos,10)}
{%SET_U(Anno,VerPos,10)}
{%DW_SET_BITMAP_ANNOTATION_ATTRIBUTE(DWアノテーション取得1,Anno)}
NAME 日付印アノテーション属性設定
FORMAT1 {%DW_SET_DATESTAMP_ANNOTATION_ATTRIBUTE(DWアノテーション取得処理名,属性格納用ユーザーデータ名)}
FORMAT2 {%DW_SET_DATESTAMP_ANNOTATION_ATTRIBUTE(#AnnoNo,DWアノテーション取得処理名,アノテーション番号,属性格納用ユーザーデータ名)}
FORMAT3 {%DW_SET_DATESTAMP_ANNOTATION_ATTRIBUTE(#AnnoKey,DWアノテーション取得処理名,アノテーションキー,属性格納用ユーザーデータ名)}

日付印アノテーションの属性を設定します。属性格納用ユーザーデータ名には設定値を格納したユーザーデータ名を指定します。このマクロはDWアノテーション取得で見つかったアノテーションに対して設定されます。

処理中のアノテーションの種類が日付印でない場合はエラーとなります。

書式毎のアノテーションの指定について

テキストアノテーション属性設定の「 書式毎のアノテーションの指定について 」を参照して下さい。

属性格納用ユーザーデータの内容は日付印アノテーション貼り付けと同じです。

使用例

例1
日付印アノテーションのX,Y座標を変更する。 (アノテーションの繰り返し処理の中でマクロ記述する場合)
{%SET_U(Anno,HorPos,10)}
{%SET_U(Anno,VerPos,10)}
{%DW_SET_DATESTAMP_ANNOTATION_ATTRIBUTE(DWアノテーション取得1,Anno)}
NAME 付箋アノテーション属性設定
FORMAT1 {%DW_SET_FUSEN_ANNOTATION_ATTRIBUTE(DWアノテーション取得処理名,属性格納用ユーザーデータ名)}
FORMAT2 {%DW_SET_FUSEN_ANNOTATION_ATTRIBUTE(#AnnoNo,DWアノテーション取得処理名,アノテーション番号,属性格納用ユーザーデータ名)}
FORMAT3 {%DW_SET_FUSEN_ANNOTATION_ATTRIBUTE(#AnnoKey,DWアノテーション取得処理名,アノテーションキー,属性格納用ユーザーデータ名)}

付箋アノテーションの属性を設定します。属性格納用ユーザーデータ名には設定値を格納したユーザーデータ名を指定します。このマクロはDWアノテーション取得で見つかったアノテーションに対して設定されます。

処理中のアノテーションの種類が付箋でない場合はエラーとなります。

書式毎のアノテーションの指定について

テキストアノテーション属性設定の「 書式毎のアノテーションの指定について 」を参照して下さい。

属性格納用ユーザーデータの内容は付箋アノテーション貼り付けと同じです。

使用例

例1
付箋アノテーションの背景色を緑に変更する。 (アノテーションの繰り返し処理の中でマクロ記述する場合)
{%SET_U(Anno,FillColorFusen,緑)}
{%DW_SET_FUSEN_ANNOTATION_ATTRIBUTE(DWアノテーション取得1,Anno)}
NAME 矩形アノテーション属性設定
FORMAT1 {%DW_SET_RECT_ANNOTATION_ATTRIBUTE(DWアノテーション取得処理名,属性格納用ユーザーデータ名)}
FORMAT2 {%DW_SET_RECT_ANNOTATION_ATTRIBUTE(#AnnoNo,DWアノテーション取得処理名,アノテーション番号,属性格納用ユーザーデータ名)}
FORMAT3 {%DW_SET_RECT_ANNOTATION_ATTRIBUTE(#AnnoKey,DWアノテーション取得処理名,アノテーションキー,属性格納用ユーザーデータ名)}

矩形アノテーションの属性を設定します。属性格納用ユーザーデータ名には設定値を格納したユーザーデータ名を指定します。このマクロはDWアノテーション取得で見つかったアノテーションに対して設定されます。

処理中のアノテーションの種類が矩形でない場合はエラーとなります。

書式毎のアノテーションの指定について

テキストアノテーション属性設定の「 書式毎のアノテーションの指定について 」を参照して下さい。

属性格納用ユーザーデータの内容は矩形アノテーション貼り付けと同じです。

使用例

例1
矩形アノテーションの線の色を緑に変更する。 (アノテーションの繰り返し処理の中でマクロ記述する場合)
{%SET_U(Anno,BorderColor,緑)}
{%DW_SET_RECT_ANNOTATION_ATTRIBUTE(DWアノテーション取得1,Anno)}
NAME 楕円アノテーション属性設定
FORMAT1 {%DW_SET_ARC_ANNOTATION_ATTRIBUTE(DWアノテーション取得処理名,属性格納用ユーザーデータ名)}
FORMAT2 {%DW_SET_ARC_ANNOTATION_ATTRIBUTE(#AnnoNo,DWアノテーション取得処理名,アノテーション番号,属性格納用ユーザーデータ名)}
FORMAT3 {%DW_SET_ARC_ANNOTATION_ATTRIBUTE(#AnnoKey,DWアノテーション取得処理名,アノテーションキー,属性格納用ユーザーデータ名)}

楕円アノテーションの属性を設定します。属性格納用ユーザーデータ名には設定値を格納したユーザーデータ名を指定します。このマクロはDWアノテーション取得で見つかったアノテーションに対して設定されます。

処理中のアノテーションの種類が楕円でない場合はエラーとなります。

書式毎のアノテーションの指定について

テキストアノテーション属性設定の「 書式毎のアノテーションの指定について 」を参照して下さい。

属性格納用ユーザーデータの内容は楕円アノテーション貼り付けと同じです。

使用例

例1
楕円アノテーションの線の色を緑に変更する。 (アノテーションの繰り返し処理の中でマクロ記述する場合)
{%SET_U(Anno,BorderColor,緑)}
{%DW_SET_ARC_ANNOTATION_ATTRIBUTE(DWアノテーション取得1,Anno)}
NAME 直線アノテーション属性設定
FORMAT1 {%DW_SET_LINE_ANNOTATION_ATTRIBUTE(DWアノテーション取得処理名,属性格納用ユーザーデータ名)}
FORMAT2 {%DW_SET_LINE_ANNOTATION_ATTRIBUTE(#AnnoNo,DWアノテーション取得処理名,アノテーション番号,属性格納用ユーザーデータ名)}
FORMAT3 {%DW_SET_LINE_ANNOTATION_ATTRIBUTE(#AnnoKey,DWアノテーション取得処理名,アノテーションキー,属性格納用ユーザーデータ名)}

直線アノテーションの属性を設定します。属性格納用ユーザーデータ名には設定値を格納したユーザーデータ名を指定します。このマクロはDWアノテーション取得で見つかったアノテーションに対して設定されます。

処理中のアノテーションの種類が直線でない場合はエラーとなります。

書式毎のアノテーションの指定について

テキストアノテーション属性設定の「 書式毎のアノテーションの指定について 」を参照して下さい。

属性格納用ユーザーデータの内容は直線アノテーション貼り付けと同じです。

使用例

例1
直線アノテーションの線の色を緑に変更する。 (アノテーションの繰り返し処理の中でマクロ記述する場合)
{%SET_U(Anno,BorderColor,緑)}
{%DW_SET_LINE_ANNOTATION_ATTRIBUTE(DWアノテーション取得1,Anno)}
NAME テキストアノテーション貼り付け
FORMAT1 {%DW_PASTE_TEXT_ANNOTATION(XDW文書オープン処理名,属性格納用ユーザーデータ名[,アノテーションキー])}
FORMAT2 {%DW_PASTE_TEXT_ANNOTATION(#Page,XDW文書オープン処理名,ページ,属性格納用ユーザーデータ名[,アノテーションキー])}

テキストアノテーションを指定ページに貼り付けます。属性格納用ユーザーデータ名には属性を指定したユーザーデータ名を指定します。

ページを省略した場合はページの繰り返し処理の現在のページが対象となります。従って、ページの繰り返し処理の中に記述してください。

ページを指定する場合は、第1引数に「#Page」(FORMAT2)を指定します。

アノテーションキーは省略可能です。アノテーションキーを指定した場合は、指定したアノテーションが、アノテーションを上に貼り付け可能な場合(付箋やカスタムアノテーション)にアノテーション上に貼り付けを行います。また、指定したアノテーションが、グループアノテーションの場合はグループに追加します。

戻り値は、貼り付けたアノテーションのアノテーションキーが返却されます。

アノテーションの属性はあらかじめユーザーデータにセットしておきます。セットできる属性は以下の通りです。

属性名
Text 文字列。
HorPos アノテーションの水平方向の位置(X座標)。小数点第2位まで有効。
単位 : mm 範囲 : -2400~2400
VerPos アノテーションの垂直方向の位置(Y座標)。小数点第2位まで有効。
単位 : mm 範囲 : -2400~2400
Width アノテーションの幅。小数点第2位まで有効。
単位 : mm 範囲: 5~50
文字の折り返しを"折り返す"に設定した場合に設定可能。また、DocuWorksの問題で、設定した値に誤差が生じる。DocuWorks7では0.02mm、DocuWorks8では0.15mmほど増加する。DocuWorks8.0.3で修正された。
Height アノテーションの高さ。小数点第2位まで有効。
単位 : mm 範囲: 5~50
文字の折り返しを"折り返す"に設定した場合に設定可能。高さの自動調整を"する"にした場合は、高さの設定を行っても自動調整される。
FontName フォント名。
FontStyle フォントスタイル。以下の何れか。
イタリック
ボールド
下線
打ち消し線
複数のスタイルを設定する場合は、「イタリック|下線」のように|で区切って指定する。
フォントスタイルは以下のように、スタイル毎に個別に指定することも可能。
FontStyleItalic フォントスタイル(イタリック)。以下の何れか。
する
しない
FontStyleBold フォントスタイル(ボールド)。以下の何れか。
する
しない
FontStyleUnderline フォントスタイル(下線)。以下の何れか。
する
しない
FontStyleStrikeOut フォントスタイル(打ち消し線)。以下の何れか。
する
しない
FontSize フォントサイズ。小数点第1位まで有効。
単位 : ポイント
ForeColor 文字の色。
定義済みの場合は以下の何れか。未定義の場合はカラーコード(16進文字列で6文字)。
黒
茶
緑
オリーブ
紺
紫
青緑
灰
銀
赤
黄緑
黄
青
赤紫
水
白
BackColor 背景色。
定義済みの場合は以下の何れか。(透過の場合は"無し"。色コード010101が割り当てられているので、010101はカラーとして使用不可。) 未定義の場合はカラーコード(16進文字列で6文字)。
無し
黒
茶
緑
オリーブ
紺
紫
青緑
灰
銀
赤
黄緑
黄
青
赤紫
水
白
WordWrap 文字の折り返し。以下の何れか。
折り返す
折り返さない
TextDirection 文字の方向。以下の何れか。
横書き
縦書き
TextOrientation 文字列の回転角度。時計回りで0~359。
LineSpace 文字列の行間。小数点第2位まで有効。
単位 : 行  範囲: 1~10
TextSpacing テキストの文字間隔。小数点第1位まで有効。
単位 : ポイント
TextTopMargin 文字の上マージン。0~200の値。小数点第2位まで有効。
単位 : mm
TextLeftMargin 文字の左マージン。0~200の値。小数点第2位まで有効。
単位 : mm
TextBottomMargin 文字の下マージン。0~200の値。小数点第2位まで有効。
単位 : mm
TextRightMargin 文字の右マージン。0~200の値。小数点第2位まで有効。
単位 : mm
TextAutoResizeHeight 高さの自動調整。折り返しを行う場合に有効。以下の何れか。
する
しない
例1
テキストアノテーションを処理中のページに貼り付ける。属性はテキストの内容のみを指定して、他の属性は初期値で貼り付ける。この処理はDWページの繰り返しの中に記述してください。
{%SET_U(Anno,Text,テキスト)}
{%SET_U(Anno,HorPos,10)}
{%SET_U(Anno,VerPos,10)}
{%DW_PASTE_TEXT_ANNOTATION(XDW文書オープン1,Anno)}
例2
テキストアノテーションをページ1に貼り付ける。属性はテキストの内容のみを指定して、他の属性は初期値で貼り付ける。
{%SET_U(Anno,Text,テキスト)}
{%SET_U(Anno,HorPos,10)}
{%SET_U(Anno,VerPos,10)}
{%DW_PASTE_TEXT_ANNOTATION(#Page,XDW文書オープン1,1,Anno)}
例3
テキストアノテーションを属性を指定してページ1に貼り付ける。
{%SET_U(Anno,Text,テキスト)}
{%SET_U(Anno,HorPos,10)}
{%SET_U(Anno,VerPos,10)}
{%SET_U(Anno,FontName,MS 明朝)}
{%SET_U(Anno,FontStyle,無し)}
{%SET_U(Anno,FontSize,12)}
{%SET_U(Anno,ForeColor,黒)}
{%SET_U(Anno,BackColor,無し)}
{%SET_U(Anno,WordWrap,折り返さない)}
{%SET_U(Anno,TextDirection,横書き)}
{%SET_U(Anno,TextOrientation,0)}
{%SET_U(Anno,LineSpace,1)}
{%SET_U(Anno,TextSpacing,0)}
{%SET_U(Anno,TextTopMargin,1.7)}
{%SET_U(Anno,TextLeftMargin,1.7)}
{%SET_U(Anno,TextBottomMargin,1.7)}
{%SET_U(Anno,TextRightMargin,1.7)}
{%SET_U(Anno,TextAutoResizeHeight,しない)}
{%DW_PASTE_TEXT_ANNOTATION(#Page,XDW文書オープン1,1,Anno)}
NAME ビットマップアノテーション貼り付け
FORMAT1 {%DW_PASTE_BITMAP_ANNOTATION(XDW文書オープン処理名,属性格納用ユーザーデータ名[,アノテーションキー])}
FORMAT2 {%DW_PASTE_BITMAP_ANNOTATION(#Page,XDW文書オープン処理名,ページ,属性格納用ユーザーデータ名[,アノテーションキー])}

ビットマップアノテーションを指定ページに貼り付けます。属性格納用ユーザーデータ名には属性を指定したユーザーデータ名を指定します。

ページを省略した場合はページの繰り返し処理の現在のページが対象となります。従って、ページの繰り返し処理の中に記述してください。

ページを指定する場合は、第1引数に「#Page」(FORMAT2)を指定します。

アノテーションキーは省略可能です。アノテーションキーを指定した場合は、指定したアノテーションが、アノテーションを上に貼り付け可能な場合(付箋やカスタムアノテーション)にアノテーション上に貼り付けを行います。また、指定したアノテーションが、グループアノテーションの場合はグループに追加します。

戻り値は、貼り付けたアノテーションのアノテーションキーが返却されます。

アノテーションの属性はあらかじめユーザーデータにセットしておきます。セットできる属性は以下の通りです。

属性名
ImagePath ビットマップファイルのフルパスファイル名。
HorPos アノテーションの水平方向の位置(X座標)。小数点第2位まで有効。
単位 : mm 範囲 : -2400~2400
VerPos アノテーションの垂直方向の位置(Y座標)。小数点第2位まで有効。
単位 : mm 範囲 : -2400~2400

「ImagePath」はDW_PASTE_BITMAP_ANNOTATIONでのみ参照される属性となります。アノテーションの貼り付け時に設定され、それ以後の属性参照、及び変更はできません。

例1
ビットマップ(D:\stamp.bmp)を処理中のページに貼り付ける。この処理はDWページの繰り返しの中に記述してください。
{%SET_U(BitmapAnno,ImagePath,D:\stamp.bmp)}
{%SET_U(BitmapAnno,HorPos,10)}
{%SET_U(BitmapAnno,VerPos,10)}
{%DW_PASTE_BITMAP_ANNOTATION(XDW文書オープン1,BitmapAnno)}
例2
ビットマップ(D:\stamp.bmp)をページ1に貼り付ける。
{%SET_U(BitmapAnno,ImagePath,D:\stamp.bmp)}
{%SET_U(BitmapAnno,HorPos,10)}
{%SET_U(BitmapAnno,VerPos,10)}
{%DW_PASTE_BITMAP_ANNOTATION(#Page,XDW文書オープン1,1,BitmapAnno)}

ビットマップアノテーションはビットマップファイルの解像度と縦横のピクセル数によって幅と高さが決まります。ビットマップファイルに解像度情報がない場合は200dpiとして計算を行います。

ビットマップファイルは非圧縮の形式となりますので、ファイルサイズに気をつけてください。ビットマップファイルの色数を減らすことでファイルサイズを小さくすることができます。

NAME 日付印アノテーション貼り付け
FORMAT1 {%DW_PASTE_DATESTAMP_ANNOTATION(XDW文書オープン処理名,属性格納用ユーザーデータ名[,アノテーションキー])}
FORMAT2 {%DW_PASTE_DATESTAMP_ANNOTATION(#Page,XDW文書オープン処理名,ページ,属性格納用ユーザーデータ名[,アノテーションキー])}

日付印アノテーションを指定ページに貼り付けます。属性格納用ユーザーデータ名には属性を指定したユーザーデータ名を指定します。

ページを省略した場合はページの繰り返し処理の現在のページが対象となります。従って、ページの繰り返し処理の中に記述してください。

ページを指定する場合は、第1引数に「#Page」(FORMAT2)を指定します。

アノテーションキーは省略可能です。アノテーションキーを指定した場合は、指定したアノテーションが、アノテーションを上に貼り付け可能な場合(付箋やカスタムアノテーション)にアノテーション上に貼り付けを行います。また、指定したアノテーションが、グループアノテーションの場合はグループに追加します。

戻り値は、貼り付けたアノテーションのアノテーションキーが返却されます。

アノテーションの属性はあらかじめユーザーデータにセットしておきます。セットできる属性は以下の通りです。

属性名
HorPos アノテーションの水平方向の位置(X座標)。小数点第2位まで有効。
単位 : mm 範囲 : -2400~2400
VerPos アノテーションの垂直方向の位置(Y座標)。小数点第2位まで有効。
単位 : mm 範囲 : -2400~2400
Width アノテーションの幅。小数点第2位まで有効。
単位 : mm 範囲: 5~50
高さは自動で幅と同じ値に設定されます。
BorderColor 線の色。テキストアノテーションのForeColorと同じ。
TopField 上欄のテキスト。1行の長さは12バイトまで。2行まで指定可。
BottomField 下欄のテキスト。1行の長さは12バイトまで。2行まで指定可。
DateStyle 日付設定。以下の何れか。
自動
手動
BasisYearStyle 基準年設定。
する
しない
BasisYear 日付設定の基準年。1~9999。「基準年設定」が「する」の時のみ有効。
DateField_FirstChar 日付欄の先頭1文字。
YearField 日付欄の年。「日付設定」が「手動」の時のみ有効。
MonthField 日付欄の月。「日付設定」が「手動」の時のみ有効。
DayField 日付欄の日。「日付設定」が「手動」の時のみ有効。
DateFormat 日付の書式設定。以下の何れか。「日付設定」が「自動」の時のみ有効。
yy.mm.dd
yy.m.d
dd.mmm.yy
dd.mmm.yyyy
DateOrder 年月日の表示順。以下の何れか。「日付設定」が「手動」の時のみ有効。
年月日
日月年
StampDate 日付印の日付。YearField, MonthField, DayFieldを日付形式(yyyy/MM/dd)にしたもの。
YearField, MonthField, DayField の組み合わせが日付と認識できない時は、DateTime型の初期値(0001/01/01)となる。
例1
日付印(上段:総務課 下段:伊藤)を処理中のページに貼り付ける。この処理はDWページの繰り返しの中に記述してください。
{%SET_U(Anno,TopField,総務課)}
{%SET_U(Anno,BottomField,伊藤)}
{%SET_U(Anno,BorderColor,赤)}
{%SET_U(Anno,HorPos,10)}
{%SET_U(Anno,VerPos,10)}
{%SET_U(Anno,Width,15)}
{%DW_PASTE_DATESTAMP_ANNOTATION(XDW文書オープン1,Anno)}
例2
日付印(上段:総務課 下段:伊藤)をページ1に貼り付ける。
{%SET_U(Anno,TopField,総務課)}
{%SET_U(Anno,BottomField,伊藤)}
{%SET_U(Anno,BorderColor,赤)}
{%SET_U(Anno,HorPos,10)}
{%SET_U(Anno,VerPos,10)}
{%SET_U(Anno,Width,15)}
{%DW_PASTE_DATESTAMP_ANNOTATION(#Page,XDW文書オープン1,1,Anno)}
NAME 付箋アノテーション貼り付け
FORMAT1 {%DW_PASTE_FUSEN_ANNOTATION(XDW文書オープン処理名,属性格納用ユーザーデータ名)}
FORMAT2 {%DW_PASTE_FUSEN_ANNOTATION(#Page,XDW文書オープン処理名,ページ,属性格納用ユーザーデータ名)}

付箋アノテーションを指定ページに貼り付けます。属性格納用ユーザーデータ名には属性を指定したユーザーデータ名を指定します。

ページを省略した場合はページの繰り返し処理の現在のページが対象となります。従って、ページの繰り返し処理の中に記述してください。

ページを指定する場合は、第1引数に「#Page」(FORMAT2)を指定します。

付箋アノテーションはページ上にしか貼り付けできません。付箋の上に他のアノテーションを貼り付けることが可能です。

戻り値は、貼り付けたアノテーションのアノテーションキーが返却されます。そのアノテーションキーを他のアノテーション貼り付けマクロの引数に指定することで、付箋上に貼り付けを行うことができます。

アノテーションの属性はあらかじめユーザーデータにセットしておきます。セットできる属性は以下の通りです。

属性名
HorPos アノテーションの水平方向の位置(X座標)。小数点第2位まで有効。
単位 : mm 範囲 : -2400~2400
VerPos アノテーションの垂直方向の位置(Y座標)。小数点第2位まで有効。
単位 : mm 範囲 : -2400~2400
Width アノテーションの幅。小数点第2位まで有効。
単位 : mm 範囲: 5~50
Height アノテーションの高さ。小数点第2位まで有効。
単位 : mm 範囲: 5~50
FillColorFusen 背景色。以下の何れか。カラーコード(16進文字列で6文字)を指定することもできます。
赤
青
黄
緑
淡赤
淡青
淡黄
淡緑
白
AutoResize 自動サイズ調整。以下のいずれか。
する
しない
例1
付箋を処理中のページに貼り付ける。この処理はDWページの繰り返しの中に記述してください。
{%SET_U(Anno,HorPos,0)}
{%SET_U(Anno,VerPos,0)}
{%SET_U(Anno,Width,50)}
{%SET_U(Anno,Height,20)}
{%SET_U(Anno,FillColorFusen,赤)}
{%SET_U(Anno,AutoResize,しない)}
{%DW_PASTE_FUSEN_ANNOTATION(XDW文書オープン1,Anno)}
例2
付箋をページ1に貼り付ける。
{%SET_U(Anno,HorPos,10)}
{%SET_U(Anno,VerPos,10)}
{%SET_U(Anno,FillColorFusen,淡緑)}
{%DW_PASTE_FUSEN_ANNOTATION(#Page,XDW文書オープン1,1,Anno)}
例3
付箋を処理中のページに貼り付け、付箋の上にテキストを貼り付ける。この処理はDWページの繰り返しの中に記述してください。
{%SET_U(FusenAnnoSet,HorPos,0)}
{%SET_U(FusenAnnoSet,VerPos,0)}
{%SET_U(FusenAnnoSet,Width,50)}
{%SET_U(FusenAnnoSet,Height,20)}
{%SET_U(FusenAnnoSet,FillColorFusen,赤)}
{%SET_U(FusenAnnoSet,AutoResize,しない)}
{%SET_U(wk,AnnoKey,{%DW_PASTE_FUSEN_ANNOTATION(XDW文書オープン1,FusenAnnoSet)})}
{%WRITE_LOG(FUSEN:{%GET_U(wk,AnnoKey)})}

{%SET_U(TextAnnoSet,Text,テキスト)}
{%SET_U(TextAnnoSet,BackColor,無し)}
{%DW_PASTE_TEXT_ANNOTATION(XDW文書オープン1,TextAnnoSet,{%GET_U(wk,AnnoKey)})}
NAME 矩形アノテーション貼り付け
FORMAT1 {%DW_PASTE_RECT_ANNOTATION(XDW文書オープン処理名,属性格納用ユーザーデータ名[,アノテーションキー])}
FORMAT2 {%DW_PASTE_RECT_ANNOTATION(#Page,XDW文書オープン処理名,ページ,属性格納用ユーザーデータ名[,アノテーションキー])}

矩形アノテーションを指定ページに貼り付けます。属性格納用ユーザーデータ名には属性を指定したユーザーデータ名を指定します。

ページを省略した場合はページの繰り返し処理の現在のページが対象となります。従って、ページの繰り返し処理の中に記述してください。

ページを指定する場合は、第1引数に「#Page」(FORMAT2)を指定します。

アノテーションキーは省略可能です。アノテーションキーを指定した場合は、指定したアノテーションが、アノテーションを上に貼り付け可能な場合(付箋やカスタムアノテーション)にアノテーション上に貼り付けを行います。また、指定したアノテーションが、グループアノテーションの場合はグループに追加します。

戻り値は、貼り付けたアノテーションのアノテーションキーが返却されます。

アノテーションの属性はあらかじめユーザーデータにセットしておきます。セットできる属性は以下の通りです。

属性名
HorPos アノテーションの水平方向の位置(X座標)。小数点第2位まで有効。
単位 : mm 範囲 : -2400~2400
VerPos アノテーションの垂直方向の位置(Y座標)。小数点第2位まで有効。
単位 : mm 範囲 : -2400~2400
Width アノテーションの幅。小数点第2位まで有効。
単位 : mm 範囲: 5~50
Height アノテーションの高さ。小数点第2位まで有効。
単位 : mm 範囲: 5~50
BorderStyle 線の表示。以下の何れか。
する
しない
BorderWidth 線の太さ。1~30の整数。
BorderColor 線の色。テキストアノテーションのForeColorと同じ。
FillStyle 塗りつぶし。以下の何れか。
する
しない
FillColor 塗りつぶしの色。テキストアノテーションのBackColorと同じ。
FillTransparent 塗りつぶしの透過。以下の何れか。
する
しない
例1
矩形を処理中のページに貼り付ける。この処理はDWページの繰り返しの中に記述してください。
{%SET_U(Anno,HorPos,10)}
{%SET_U(Anno,VerPos,10)}
{%SET_U(Anno,Width,50)}
{%SET_U(Anno,Height,20)}
{%SET_U(Anno,BorderColor,赤)}
{%SET_U(Anno,FillStyle,する)}
{%SET_U(Anno,FillColor,黄)}
{%DW_PASTE_RECT_ANNOTATION(XDW文書オープン1,Anno)}
例2
矩形をページ1に貼り付ける。
{%SET_U(Anno,HorPos,10)}
{%SET_U(Anno,VerPos,10)}
{%SET_U(Anno,Width,50)}
{%SET_U(Anno,Height,20)}
{%SET_U(Anno,BorderColor,赤)}
{%DW_PASTE_RECT_ANNOTATION(#Page,XDW文書オープン1,1,Anno)}
NAME 楕円アノテーション貼り付け
FORMAT1 {%DW_PASTE_ARC_ANNOTATION(XDW文書オープン処理名,属性格納用ユーザーデータ名[,アノテーションキー])}
FORMAT2 {%DW_PASTE_ARC_ANNOTATION(#Page,XDW文書オープン処理名,ページ,属性格納用ユーザーデータ名[,アノテーションキー])}

楕円アノテーションを指定ページに貼り付けます。属性格納用ユーザーデータ名には属性を指定したユーザーデータ名を指定します。

ページを省略した場合はページの繰り返し処理の現在のページが対象となります。従って、ページの繰り返し処理の中に記述してください。

ページを指定する場合は、第1引数に「#Page」(FORMAT2)を指定します。

アノテーションキーは省略可能です。アノテーションキーを指定した場合は、指定したアノテーションが、アノテーションを上に貼り付け可能な場合(付箋やカスタムアノテーション)にアノテーション上に貼り付けを行います。また、指定したアノテーションが、グループアノテーションの場合はグループに追加します。

戻り値は、貼り付けたアノテーションのアノテーションキーが返却されます。

アノテーションの属性はあらかじめユーザーデータにセットしておきます。セットできる属性は以下の通りです。

属性名
HorPos アノテーションの水平方向の位置(X座標)。小数点第2位まで有効。
単位 : mm 範囲 : -2400~2400
VerPos アノテーションの垂直方向の位置(Y座標)。小数点第2位まで有効。
単位 : mm 範囲 : -2400~2400
Width アノテーションの幅。小数点第2位まで有効。
単位 : mm 範囲: 5~50
Height アノテーションの高さ。小数点第2位まで有効。
単位 : mm 範囲: 5~50
BorderStyle 線の表示。以下の何れか。
する
しない
BorderWidth 線の太さ。1~30の整数。
BorderColor 線の色。テキストアノテーションのForeColorと同じ。
FillStyle 塗りつぶし。以下の何れか。
する
しない
FillColor 塗りつぶしの色。テキストアノテーションのBackColorと同じ。
FillTransparent 塗りつぶしの透過。以下の何れか。
する
しない
例1
楕円を処理中のページに貼り付ける。この処理はDWページの繰り返しの中に記述してください。
{%SET_U(Anno,HorPos,10)}
{%SET_U(Anno,VerPos,10)}
{%SET_U(Anno,Width,50)}
{%SET_U(Anno,Height,20)}
{%SET_U(Anno,BorderColor,赤)}
{%SET_U(Anno,FillStyle,する)}
{%SET_U(Anno,FillColor,黄)}
{%DW_PASTE_ARC_ANNOTATION(XDW文書オープン1,Anno)}
例2
楕円をページ1に貼り付ける。
{%SET_U(Anno,HorPos,10)}
{%SET_U(Anno,VerPos,10)}
{%SET_U(Anno,Width,50)}
{%SET_U(Anno,Height,20)}
{%SET_U(Anno,BorderColor,赤)}
{%DW_PASTE_ARC_ANNOTATION(#Page,XDW文書オープン1,1,Anno)}
NAME 直線アノテーション貼り付け
FORMAT1 {%DW_PASTE_LINE_ANNOTATION(XDW文書オープン処理名,属性格納用ユーザーデータ名[,アノテーションキー])}
FORMAT2 {%DW_PASTE_LINE_ANNOTATION(#Page,XDW文書オープン処理名,ページ,属性格納用ユーザーデータ名[,アノテーションキー])}

直線アノテーションを指定ページに貼り付けます。属性格納用ユーザーデータ名には属性を指定したユーザーデータ名を指定します。

ページを省略した場合はページの繰り返し処理の現在のページが対象となります。従って、ページの繰り返し処理の中に記述してください。

ページを指定する場合は、第1引数に「#Page」(FORMAT2)を指定します。

アノテーションキーは省略可能です。アノテーションキーを指定した場合は、指定したアノテーションが、アノテーションを上に貼り付け可能な場合(付箋やカスタムアノテーション)にアノテーション上に貼り付けを行います。また、指定したアノテーションが、グループアノテーションの場合はグループに追加します。

戻り値は、貼り付けたアノテーションのアノテーションキーが返却されます。

アノテーションの属性はあらかじめユーザーデータにセットしておきます。セットできる属性は以下の通りです。

属性名
HorPos アノテーションの水平方向の位置(X座標)。小数点第2位まで有効。
単位 : mm 範囲 : -2400~2400
VerPos アノテーションの垂直方向の位置(Y座標)。小数点第2位まで有効。
単位 : mm 範囲 : -2400~2400
HorVec 水平移動量。
単位 : mm 範囲 : -2400~2400
VerVec 垂直移動量。
単位 : mm 範囲 : -2400~2400
BorderWidth 線の太さ。1~30の整数。
BorderColor 線の色。テキストアノテーションのForeColorと同じ。
BorderTransparent 線の透過。以下の何れか。
する
しない
ArrowheadType 直線の矢印の種類。以下の何れか。
なし
始点のみ
終点のみ
両方
ArrowheadStyle 直線の矢印のスタイル。
広いかさ
かさ
塗りつぶし
BorderType 線の種類。
実線
点線
破線
一点鎖線
二重線
例1
直線を処理中のページに貼り付ける。この処理はDWページの繰り返しの中に記述してください。
{%SET_U(Anno,HorPos,10)}
{%SET_U(Anno,VerPos,10)}
{%SET_U(Anno,HorVec,50)}
{%SET_U(Anno,VerVec,20)}
{%SET_U(Anno,BorderColor,赤)}
{%DW_PASTE_LINE_ANNOTATION(XDW文書オープン1,Anno)}
例2
直線をページ1に貼り付ける。
{%SET_U(Anno,HorPos,10)}
{%SET_U(Anno,VerPos,10)}
{%SET_U(Anno,HorVec,50)}
{%SET_U(Anno,VerVec,20)}
{%SET_U(Anno,BorderColor,赤)}
{%DW_PASTE_LINE_ANNOTATION(#Page,XDW文書オープン1,1,Anno)}
NAME アノテーションツールファイルの貼り付け
FORMAT1 {%DW_PASTE_ANNOTATION_TOOL_FILE(XDW文書オープン処理名,X座標,Y座標,アノテーションツールファイル名,番号[,アノテーションキー])}
FORMAT2 {%DW_PASTE_ANNOTATION_TOOL_FILE(#Page,XDW文書オープン処理名,ページ,X座標,Y座標,アノテーションツールファイル名,番号[,アノテーションキー])}

処理中のDocuWorks文書の指定ページに、アノテーションツールファイルの指定番号のアノテーションを貼り付けます。

本マクロはDocuWorks8.0以降で使用できます。

ページを省略した場合はページの繰り返し処理の現在のページが対象となります。従って、ページの繰り返し処理の中に記述してください。

ページを指定する場合は、第1引数に「#Page」(FORMAT2)を指定します。

座標には、アノテーションを貼り付ける位置を左上を基準として指定します。(単位はmm)

アノテーションツールファイル名には、アノテーションツールファイル(.ann)のフルパスファイル名を指定します。アノテーションツールファイルは、事前にDocuWorks Viewerで作成しておく必要があります。

アノテーションツールファイルは通常「C:\Users\ユーザー\Documents\Fuji Xerox\DocuWorks\DWFolders\Annotations」または「C:\Users\ユーザー\OneDrive\Documents\Fuji Xerox\DocuWorks\DWFolders\Annotations」に格納されています。このフォルダから拡張子「.ann」のファイルを別フォルダにコピーして参照するようにしてください。

番号には、貼り付けを行うアノテーションツールファイルのアノテーションの番号を指定します。指定した番号が存在しない場合は、「DocuWorksAPIのエラーメッセージ[その他のエラーです。]」とエラーになります。

一部のアノテーション(貼り付け後に操作が必要なものなど)は貼り付けすることができません。エラーとなります。

アノテーションキーは省略可能です。アノテーションキーを指定した場合は、指定したアノテーションが、アノテーションを上に貼り付け可能な場合(付箋やカスタムアノテーション)にアノテーション上に貼り付けを行います。また、指定したアノテーションが、グループアノテーションの場合はグループに追加します。

戻り値は、貼り付けたアノテーションのアノテーションキーが返却されます。

例1
処理中ページに、アノテーションツールファイルの1番目のアノテーションを貼り付ける。 この処理はDWページの繰り返しの中に記述してください。
{%DW_PASTE_ANNOTATION_TOOL_FILE(XDW文書オープン1,10,10,C:\Home\Annotation\カスタム.ann,1)}
NAME アノテーションの削除
FORMAT {%DW_REMOVE_ANNOTATION(DWアノテーション取得処理名,アノテーション番号)}

DWアノテーション取得処理で取得したアノテーションリストからアノテーション番号で指定したアノテーションを削除する。

本マクロはDWアノテーション取得処理後、又は、アノテーションの繰り返しの中で使用できます。アノテーションの繰り返しの中で使用する場合はアノテーション数が動的に変化しますので、アノテーションの繰り返し設定で繰り返し方向を「末尾から」に設定してください。

例1
DWアノテーション取得1で取得したアノテーションを全て削除する。(アノテーションの繰り返し中で使用した場合)
{%DW_REMOVE_ANNOTATION(DWアノテーション取得1,{%DW_GET(AnnotationLoopCount)})}
NAME アノテーションのグループ化
FORMAT1 {%DW_GROUPING_ANNOTATION(XDW文書オープン処理名,アノテーションキー格納用ユーザーデータ名)}
FORMAT2 {%DW_GROUPING_ANNOTATION(#Page,XDW文書オープン処理名,ページ,アノテーションキー格納用ユーザーデータ名)}

オープン中のXDW文書のアノテーションをグループ化します。

本マクロはDocuWorks文書オープン処理後に使用できます。アノテーションの貼り付けや取得処理で取得したアノテーションキーを使用します。

ページを省略した場合はページの繰り返し処理の現在のページが対象となります。従って、ページの繰り返し処理の中に記述してください。

ページを指定する場合は、第1引数に「#Page」(FORMAT2)を指定します。

グループ化したいアノテーションキーをユーザデータにセットして、引き数にユーザーデータ名を指定します。

指定したページ内に指定したアノテーションキーが存在しない場合はエラーになります。

{%ADD_USER_DATA(キーリスト,{%GET_U(属性,アノテーションキー1)})}
{%ADD_USER_DATA(キーリスト,{%GET_U(属性,アノテーションキー2)})}
{%DW_GROUPING_ANNOTATION(#Page,{%DW_GET(OpenName)},1,キーリスト)}
例1
「テキスト貼り付け1」と「矩形貼り付け1」処理で貼り付けたアノテーションをグループ化する。
{%ADD_USER_DATA(キーリスト,{%DW_GET_ANNOTATION_KEY_FOR_PROCESS(テキスト貼り付け1)})}
{%ADD_USER_DATA(キーリスト,{%DW_GET_ANNOTATION_KEY_FOR_PROCESS(矩形貼り付け1)})}
{%DW_GROUPING_ANNOTATION(#Page,{%DW_GET(OpenName)},1,キーリスト)}
NAME アノテーションの表示/非表示の切り替え
FORMAT {%DW_SHOW_OR_HIDE_ANNOTATION(XDW文書オープン処理名,表示モード(Show|Hide))}

オープン中のXDW文書のアノテーションの表示/非表示を切り替えます。引数にShowを指定すると表示状態となります。Hideを指定すると非表示状態となります。文書が複数ページの場合はすべてのページが対象となります。

本マクロはDocuWorks文書オープン処理後に使用できます。

例1
アノテーションを非表示にする。
{%DW_SHOW_OR_HIDE_ANNOTATION(XDW文書オープン1,Hide)}
NAME アノテーションのコピー
FORMAT {%DW_COPY_ANNOTATION(XDW文書オープン処理名,XDW文書ファイル名)}

オープン中のXDW文書に引数で指定したXDW文書からアノテーションをコピーします。

コピー元とコピー先のXDW文書はページ数、用紙サイズを一致させるようにしてください。コピー元のページ数が多い場合は、コピー先にないページ番号以降の全てのアノテーションが、コピー先の最終ページに貼り付きます。また、ページサイズが違う場合はコピー先のページサイズに収まるように位置が調整されます。

カスタムアノテーション以外のアノテーションが対象となります。カスタムアノテーションを含む場合はエラーとなります。エラーとなった場合に出力されるメッセージは、「関数の引数に仕様外の値を渡しました。」となり、エラーの詳細はわかりません。コピー元となるXDW文書は新規で作成して、必要なアノテーションのみを追加したファイルを対象としてください。コピー元となるXDW文書のアノテーションの内容が不定の場合、本マクロを使用するのは推奨できません。このマクロはDocuWorksAPIのXDW_SucceedAttributeを使用していますので、仕様はXDW_SucceedAttributeと同じとなります。

本マクロはDocuWorks文書オープン処理後に使用できます。

例1
オープン中のXDW文書に「D:\Home\temp\moto.xdw」の文書からアノテーションをコピーする。
{%DW_COPY_ANNOTATION(XDW文書オープン1,D:\Home\temp\moto.xdw)}