9-3-1 DrawString

PDFファイルの指定されたページに、任意の文字列を描画します。
パラメーターは次のとおりです(かっこ内はデフォルト値)。

パラメーター
説明
X=浮動小数点数値(0.0) 水平方向の文字列描画起点を指定します。
Y=浮動小数点数値(0.0) 垂直方向の文字列描画起点を指定します。
String=文字列("" - 空文字列) 描画文字列を指定します。
Font=文字列(MS ゴシック) フォント名を指定します。
Bold=ブーリアン値(False) ボールド体を指定します。
  • True
    ボールド体を指定します。
  • False
    ボールド体を指定しません。
Italic=ブーリアン値(False) イタリック体を指定します。
  • True
    イタリック体を指定します。
  • False
    イタリック体を指定しません。
Outline=ブーリアン値(False) アウトライン化を指定します。
  • True
    アウトライン化します。
  • False
    アウトライン化しません。
Points=浮動小数点数値(60.0) フォントサイズを指定します。単位はポイントです。
HRatio=浮動小数点数値(100.0) フォントサイズに対する水平幅を百分率で指定します。100のとき、正方グリフになります。
Color=浮動小数点数値の配列(0.0,0.0,0.0) フォントの色を表す3つのRGB値を指定します。それぞれの値は1.0のときに最高輝度になります。
LastLayer=ブーリアン値(True) 文字列を最背面に設定するかどうかを指定します。
  • True
    文字列を最背面に指定します。
  • False
    文字列を最背面に指定しません。
Page=カンマ区切りの複数の整数値(0) 文字列を描画するページ番号を指定します。0のとき、すべてのページに描画します。
StrokeWidth=浮動小数点数値(1.0) アウトラインの線幅を指定します。
TilePage=ブーリアン値(False) 文字列をタイル状に並べて表示するかどうかを指定します。隣り合う文字列との間隔調整として、文字列描画位置用のパラメーターX,Yを使用します。詳細は欄外の説明を参照してください。
タイル表示はページ左下隅から文字列が並びます。
  • True
    文字列をタイル状に並べて表示します。
  • False
    座標X、Y位置に文字列を1つだけ描画します。
Transparency=整数値(100) 透明度を、0~100の範囲の整数で設定します。0:完全に透明(非表示)、100:完全に不透明です。
パラメーターの省略時や範囲外の値の場合には100となり、文字列は透明になりません。
最背面のレイヤーに描かない場合(LastLayer=False)、描画文字列が被さる箇所が透明度に応じて、透けて見えます。
RotationAngle=整数値(0) 描画文字列の回転角度を、0~360の範囲の整数で設定します。0と360は、回転無しです。回転は、文字列描画開始位置を中心に反時計回り方向です。
省略時や範囲外の値の場合には0となり、回転しません。
Action=整数値(0) 描画文字列表示のタイミングを指定します。
  • 0
    常に表示します。
  • 1
    モニター画面上で表示し、デバイスに出力しません。
  • 2
    デバイスに出力し、モニター画面上で表示しません。
EmbeddedFont=ブーリアン値(False) フォント埋め込みフラグを指定します。
  • True
    すべてのフォント、すべての文字をPDFに埋め込みます。クライアント環境への依存がなく、完全な可搬性を持ったPDFが生成されます。
  • False
    指定されたフォントでPDFに描画します。
EmbeddedFontURI=文字列("") フォント埋め込みフラグが「True」の場合に、フォントのパスを指定します。パスは次のいずれかです。
  • 絶対ローカルパス
  • 相対ローカルパス
EmbeddedFontNum=整数値(1) 埋め込むフォントの番号を指定します。
TrueTypeコレクション形式は、1つのファイルに複数のフォントを持っています。フォントファイル内の番号を指定してください。
TrueTypeコレクション形式以外の場合は常に「1」です。
注意
  • 埋め込みフォントについて
    • 埋め込みフォントは複数指定できません。
    • IVS文字列を出力するには、IVS対応フォントの埋め込み指定が必要です。
    • フォント埋め込みフラグがTrueの場合は、従来のフォント指定(Font)は無視されてEmbeddedFontURIで指定されたフォントが参照されます。
    • AdobeCMAPは「Identity-H」を使用します。
  • PDFファイルの座標系は、用紙正方向の左下基点、単位はポイントです。使用可能なフォントの一覧はJavaDoc形式のドキュメントを参照してください。

文字列をタイル表示する場合は、左下隅の位置から文字を描画します。各タイルのサイズは、次のとおりです(文字サイズとは「points」パラメーターの入力値です)。

タイル幅  = (全角文字数+1)×文字サイズ + 半角文字数×(文字サイズ÷2) + Xパラメーター値
タイル高さ = 文字サイズ × 2 + Yパラメーター値

タイルは、ページの左下隅から並びます。

DrawStringではプロポーショナルフォントも指定可能です。ただし、フォントがプロポーショナルフォントであるかどうかに関係なく、文字サイズと文字数から横幅を計算するため、使用するフォントや出力文字によっては横方向の間隔が変わる可能性があります。

注意

プロポーショナルフォントの指定時は、幅が広い文字が多い場合に隣と重なったり、また幅が狭い文字の場合は間隔が広くなったりすることがあります(例:MSP明朝の"G"や"i"などを出力した場合)。

タイル表示時には、パラメーターX、Yをタイルのサイズ(幅、および高さ)調整に使用します。
DrawStringのXはタイル幅を、Yはタイルの高さを調整します。負の値を指定した場合は狭く、正の値を指定した場合は広くなります。
タイルのサイズは、文字サイズよりも大きくする必要があります。文字サイズよりタイルのサイズが小さくなった場合は、設定値は無効です。

タイル表示で回転角度を指定した場合は、次のようになります。

プロファイル例

Encoding=UTF-8
Method=DrawString
PluginVersion=1.0.4
X=0.0
Y=0.0
String=SVF for PDF Utility
Font=Courier
Points=40.0
StrokeWidth=1.0
Color=1.0, 0.8, 0.0
LastLayer=True
RotationAngle=45
Transparency=70
Action=0
TilePage=True
EmbeddedFont=False
EmbeddedFontURI=
EmbeddedFontNum=1