Antenna House PDF Tool API (.NET) 8.0
PdfTkNet::PtlTextBox クラス

#include <NetTextBox.h>

PdfTkNet::PtlTextBox の継承関係図
Inheritance graph
[凡例]
PdfTkNet::PtlTextBox 連携図
Collaboration graph
[凡例]

公開型

enum class  MODE { MODE_HORIZONTAL = 0 , MODE_VERTICAL = 1 }
enum class  OUTLINE_STYLE { OUTLINE_STYLE_SOLID = 1 , OUTLINE_STYLE_DASHED = 2 }

公開メンバ関数

PdfTk::PtlTextBox * getNative ()
 PtlTextBox ()
 コンストラクタ
 PtlTextBox (PtlTextBox^ obj)
 コピーコンストラクタ alias copy
 ~PtlTextBox ()
 デストラクタ
 !PtlTextBox ()
 ファイナライザ。
PtlTextBox operator= (PtlTextBox^ obj)
 コピーオペレータ alias copy
void setWritingMode (MODE mode)
 横書き/縦書きを設定。
void writeString (String^ str, PtlParamWriteStringTextBox^ paramWriteString)
 文字列を出力。
void writeStringNL (String^ str, PtlParamWriteStringTextBox^ paramWriteString)
 文字列を出力して改行。
void writeNL ()
 改行。
void writeNL (float size)
 改行。
void terminate ()
 テキストボックスを終了。
void setOutlineStyle (OUTLINE_STYLE lineStyle)
 テキストボックスの縁取のスタイルをOUTLINE_STYLEで設定。
void setOutlineColor (PtlColor^ outlineColor)
 テキストボックスの縁取り色を設定。
void setBackColor (PtlColor^ bkColor)
 背景色を設定。
void setOpacity (float opacity)
 不透明度を設定。
void fitToBBox (bool fit)
 TextBoxのサイズをテキストのBBoxに合わせるかどうかの設定。

限定公開変数類

PdfTk::PtlTextBox * m_native

詳解

ページに描画されるテキストボックスを表現するクラスです。
テキストボックスをにテキストを書き、テキストボックスをコンテントに配置します。

列挙型メンバ詳解

◆ MODE

enum class PdfTkNet::PtlTextBox::MODE
strong

横書き/縦書き

列挙値
MODE_HORIZONTAL 

横書き

MODE_VERTICAL 

縦書き

◆ OUTLINE_STYLE

enum class PdfTkNet::PtlTextBox::OUTLINE_STYLE
strong

線スタイル

列挙値
OUTLINE_STYLE_SOLID 

実線

OUTLINE_STYLE_DASHED 

破線

構築子と解体子

◆ PtlTextBox() [1/2]

PdfTkNet::PtlTextBox::PtlTextBox ( )

コンストラクタ

例外
PtlException

◆ PtlTextBox() [2/2]

PdfTkNet::PtlTextBox::PtlTextBox ( PtlTextBox^ obj)

コピーコンストラクタ alias copy

引数
objコピー元オブジェクト。
例外
PtlException

◆ ~PtlTextBox()

PdfTkNet::PtlTextBox::~PtlTextBox ( )

デストラクタ

◆ !PtlTextBox()

PdfTkNet::PtlTextBox::!PtlTextBox ( )

ファイナライザ。

メソッド詳解

◆ fitToBBox()

void PdfTkNet::PtlTextBox::fitToBBox ( bool fit)

TextBoxのサイズをテキストのBBoxに合わせるかどうかの設定。

※ 設定しない場合はデフォルト値としてfalseが使用されます。

引数
fittrueなら合わせる。
例外
PtlException

◆ getNative()

PdfTk::PtlTextBox * PdfTkNet::PtlTextBox::getNative ( )

◆ operator=()

PtlTextBox PdfTkNet::PtlTextBox::operator= ( PtlTextBox^ obj)

コピーオペレータ alias copy

引数
objコピー元オブジェクト。

◆ setBackColor()

void PdfTkNet::PtlTextBox::setBackColor ( PtlColor^ bkColor)

背景色を設定。

※ 設定しない場合は背景色をはありません。

引数
bkColor背景色指定。
例外
PtlException

◆ setOpacity()

void PdfTkNet::PtlTextBox::setOpacity ( float opacity)

不透明度を設定。

※ 設定しない場合はデフォルト値として1.0が設定されます。

引数
opacity0.0 〜 1.0。0.0が透明、1.0が不透明。
例外
PtlException

◆ setOutlineColor()

void PdfTkNet::PtlTextBox::setOutlineColor ( PtlColor^ outlineColor)

テキストボックスの縁取り色を設定。

※ 設定しない場合は無色です。

引数
outlineColor縁取り色指定。
例外
PtlException

◆ setOutlineStyle()

void PdfTkNet::PtlTextBox::setOutlineStyle ( OUTLINE_STYLE lineStyle)

テキストボックスの縁取のスタイルをOUTLINE_STYLEで設定。

※ 設定しない場合はデフォルト値としてOUTLINE_STYLE_SOLIDが設定されます。

引数
lineStyle線スタイルの指定。
例外
PtlException

◆ setWritingMode()

void PdfTkNet::PtlTextBox::setWritingMode ( MODE mode)

横書き/縦書きを設定。

横書き/縦書きを設定します。
途中で変更は出来ません。
※ 設定しない場合はデフォルト値としてMODE_HORIZONTALが使用されます。

引数
mode横書きか縦書き。MODEのいずれか。
例外
PtlException

◆ terminate()

void PdfTkNet::PtlTextBox::terminate ( )

テキストボックスを終了。

テキストボックスを終了しページコンテントに書き出します。
この関数を呼ばないとコンテントに書かれないので必ず呼んでください。

例外
PtlException

◆ writeNL() [1/2]

void PdfTkNet::PtlTextBox::writeNL ( )

改行。

改行します。

例外
PtlException

◆ writeNL() [2/2]

void PdfTkNet::PtlTextBox::writeNL ( float size)

改行。

指定サイズで改行します。通常、フォントサイズを指定します。

引数
size改行サイズ(ポイント)
例外
PtlException

◆ writeString()

void PdfTkNet::PtlTextBox::writeString ( String^ str,
PtlParamWriteStringTextBox^ paramWriteString )

文字列を出力。

文字列を出力します。

引数
str文字列。
paramWriteString文字列出力パラメータ。
例外
PtlException

◆ writeStringNL()

void PdfTkNet::PtlTextBox::writeStringNL ( String^ str,
PtlParamWriteStringTextBox^ paramWriteString )

文字列を出力して改行。

文字列を出力して改行します。

引数
str文字列。
paramWriteString文字列出力パラメータ。
例外
PtlException

メンバ詳解

◆ m_native

PdfTk::PtlTextBox* PdfTkNet::PtlTextBox::m_native
protected