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

#include <NetField.h>

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

公開型

enum class  FIELD_TYPE {
  TYPE_PUSHBUTTON = 1 , TYPE_CHECKBOX = 2 , TYPE_RADIOGROUP = 3 , TYPE_RADIOBUTTON = 4 ,
  TYPE_TEXT = 5 , TYPE_LISTBOX = 6 , TYPE_DROPDOWN = 7 , TYPE_SIGNATURE = 10 ,
  TYPE_UNKNOWN = 100
}

公開メンバ関数

PdfTk::PtlField * getNative ()
 PtlField (FIELD_TYPE type)
 コンストラクタ
 PtlField (PtlField^ obj)
 コピーコンストラクタ alias copy
virtual ~PtlField ()
 デストラクタ
 !PtlField ()
 ファイナライザ。
PtlField operator= (PtlField^ obj)
 コピーオペレータ alias copy
FIELD_TYPE getType ()
 フィールドタイプを取得。
String getFieldName ()
 フィールド名を取得。
void setFieldName (String^ fieldName)
 フィールド名を設定。
bool hasWidget ()
 ウィジット注釈を持つかどうかを取得。
PtlAnnotWidget getWidget ()
 ウィジット注釈を取得。
void setWidget (PtlAnnotWidget^ widget)
 ウィジット注釈のフィールドへの紐づけ。

限定公開変数類

PdfTk::PtlField * m_native

詳解

フォームのフィールドを表現したクラスです。
すべてのフィールドクラスのベースクラスです。

列挙型メンバ詳解

◆ FIELD_TYPE

enum class PdfTkNet::PtlField::FIELD_TYPE
strong

フィールドのタイプ

列挙値
TYPE_PUSHBUTTON 

プッシュボタン

TYPE_CHECKBOX 

チェックボックス

TYPE_RADIOGROUP 

ラジオグループ

TYPE_RADIOBUTTON 

ラジオボタン

TYPE_TEXT 

テキスト

TYPE_LISTBOX 

リストボックス

TYPE_DROPDOWN 

ドロップダウン

TYPE_SIGNATURE 

署名

TYPE_UNKNOWN 

未対応フィールド

構築子と解体子

◆ PtlField() [1/2]

PdfTkNet::PtlField::PtlField ( FIELD_TYPE type)

コンストラクタ

引数
typeタイプ
例外
PtlException

◆ PtlField() [2/2]

PdfTkNet::PtlField::PtlField ( PtlField^ obj)

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

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

◆ ~PtlField()

virtual PdfTkNet::PtlField::~PtlField ( )
virtual

デストラクタ

◆ !PtlField()

PdfTkNet::PtlField::!PtlField ( )

ファイナライザ。

メソッド詳解

◆ getFieldName()

String PdfTkNet::PtlField::getFieldName ( )

フィールド名を取得。

ラジオボタンはフィールド名が存在しないのでラジオグループのフィールド名に連番を振った値で取得される。

戻り値
フィールド名。
例外
PtlException

◆ getNative()

PdfTk::PtlField * PdfTkNet::PtlField::getNative ( )

◆ getType()

FIELD_TYPE PdfTkNet::PtlField::getType ( )

フィールドタイプを取得。

戻り値
フィールドタイプ
例外
PtlException

◆ getWidget()

PtlAnnotWidget PdfTkNet::PtlField::getWidget ( )

ウィジット注釈を取得。

ウィジット注釈を取得します。 存在しない場合、PtlErrorCode::NO_OBJECTが例外として発生します。
この関数の使用前にhasWidget関数で次の兄弟アウトラインの有無を確認してください。

戻り値
ウィジット注釈
例外
PtlException

◆ hasWidget()

bool PdfTkNet::PtlField::hasWidget ( )

ウィジット注釈を持つかどうかを取得。

戻り値
true: ウィジット注釈を持つ。false: ウィジット注釈を持たない。
例外
PtlException

◆ operator=()

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

コピーオペレータ alias copy

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

◆ setFieldName()

void PdfTkNet::PtlField::setFieldName ( String^ fieldName)

フィールド名を設定。

引数
fieldNameフィールド名
例外
PtlException

◆ setWidget()

void PdfTkNet::PtlField::setWidget ( PtlAnnotWidget^ widget)

ウィジット注釈のフィールドへの紐づけ。

引数
widgetウィジット注釈
例外
PtlException

メンバ詳解

◆ m_native

PdfTk::PtlField* PdfTkNet::PtlField::m_native
protected