Antenna House PDF Tool API (.NET) 8.0
|
#include <NetAnnot.h>
公開メンバ関数 | |
PdfTk::PtlAnnot * | getNative () |
PtlAnnot (ANNOT_TYPE type) | |
コンストラクタ | |
PtlAnnot (PtlAnnot^ obj) | |
コピーコンストラクタ alias copy | |
virtual | ~PtlAnnot () |
デストラクタ | |
!PtlAnnot () | |
ファイナライザ。 | |
PtlAnnot | operator= (PtlAnnot^ obj) |
コピーオペレータ alias copy | |
ANNOT_TYPE | getType () |
注釈タイプを取得。 | |
bool | isMarkup () |
マークアップ注釈か否かを取得。 | |
PtlRect | getRect () |
矩形座標を取得。 | |
void | setRect (PtlRect^ rectMM) |
矩形座標を設定。 | |
String | getTextContents () |
内容を取得。 | |
void | setTextContents (String^ contents) |
内容を設定。 | |
PtlDate | getDate () |
日時の取得。 | |
void | setDate (PtlDate^ date) |
日時の設定。 | |
ANNOT_FLAGS | getAnnotFlags () |
注釈フラグを取得。 | |
void | setAnnotFlags (ANNOT_FLAGS flag) |
注釈フラグを設定。 | |
PtlColor | getColor () |
色を取得。 | |
void | setColor (PtlColorDeviceRGB^ color) |
色を設定。 | |
PtlColor | getInteriorColor () |
内部色を取得。 | |
void | setInteriorColor (PtlColor^ color) |
内部色を設定。 | |
BORDER_STYLE | getBorderStyle () |
境界線スタイルを取得。 | |
void | setBorderStyle (BORDER_STYLE style) |
境界線スタイルを設定。 | |
BORDER_LINE_WIDTH | getBorderWidth () |
境界線幅をBORDER_LINE_WIDTHで取得。 | |
void | setBorderWidth (BORDER_LINE_WIDTH width) |
境界線幅をBORDER_LINE_WIDTHで設定。 | |
float | getBorderWidthNative () |
注釈に設定してある境界線幅を直接取得。 | |
void | setBorderWidthNative (float width) |
注釈の境界線幅を数値で直接設定。 | |
String | getAnnotationName () |
注釈名を取得。 |
限定公開変数類 | |
PdfTk::PtlAnnot * | m_native |
PDFの注釈を表現したクラスです。
すべての注釈クラスのベースクラスです。
|
strong |
注釈フラグ。
|
strong |
注釈のタイプ
|
strong |
|
strong |
PdfTkNet::PtlAnnot::PtlAnnot | ( | ANNOT_TYPE | type | ) |
PdfTkNet::PtlAnnot::PtlAnnot | ( | PtlAnnot^ | obj | ) |
|
virtual |
デストラクタ
PdfTkNet::PtlAnnot::!PtlAnnot | ( | ) |
ファイナライザ。
String PdfTkNet::PtlAnnot::getAnnotationName | ( | ) |
ANNOT_FLAGS PdfTkNet::PtlAnnot::getAnnotFlags | ( | ) |
BORDER_STYLE PdfTkNet::PtlAnnot::getBorderStyle | ( | ) |
BORDER_LINE_WIDTH PdfTkNet::PtlAnnot::getBorderWidth | ( | ) |
境界線幅をBORDER_LINE_WIDTHで取得。
境界線幅をPDFの設定値そのままで取得したい場合は、getBorderWidthNative()を使ってください。
PtlException |
float PdfTkNet::PtlAnnot::getBorderWidthNative | ( | ) |
PtlColor PdfTkNet::PtlAnnot::getColor | ( | ) |
色を取得。
下記注釈の色を取得します。
・FreeText : 線の色
・Line : 線の色
・Square : 線の色
・Circle : 線の色
・PolyLine : 線の色
・Polygon : 線の色
・Caret : Caretの色
・Ink : 線の色
・Squiggly : 線の色
・Highlight: Highlightの色
・Strikeout: Strikeoutの色
・Underline: Underlineの色
PtlException |
PtlDate PdfTkNet::PtlAnnot::getDate | ( | ) |
PtlColor PdfTkNet::PtlAnnot::getInteriorColor | ( | ) |
内部色を取得。
下記注釈の内部色を取得します。
・FreeText
・Line
・Square
・Circle
・PolyLine
・Polygon
PtlException |
PdfTk::PtlAnnot * PdfTkNet::PtlAnnot::getNative | ( | ) |
PtlRect PdfTkNet::PtlAnnot::getRect | ( | ) |
String PdfTkNet::PtlAnnot::getTextContents | ( | ) |
内容を取得。
テキスト文字列の内容を取得します。
注意:
このテキスト文字列は以下の目的で使用されます。
・注釈用に表示されるテキスト ・可読な形式での注釈コンテンツの代替説明
PtlException |
ANNOT_TYPE PdfTkNet::PtlAnnot::getType | ( | ) |
bool PdfTkNet::PtlAnnot::isMarkup | ( | ) |
void PdfTkNet::PtlAnnot::setAnnotFlags | ( | ANNOT_FLAGS | flag | ) |
注釈フラグを設定。
フラグの定義を論理和で指定します。
設定しない場合は、各注釈により下記の値が設定されたとみなされます。
PtlAnnotText : FLAG_PRINT|FLAG_NOZOOM|FLAG_NOROTATE
PtlAnnotLink : 0
PtlAnnotStamp : FLAG_PRINT
PtlAnnotPopup : FLAG_PRINT|FLAG_NOZOOM|FLAG_NOROTATE
PtlAnnotFileAttachment : FLAG_PRINT|FLAG_NOZOOM|FLAG_NOROTATE
flag | フラグ。FLAG_XXXのフラグ。 |
PtlException |
void PdfTkNet::PtlAnnot::setBorderStyle | ( | BORDER_STYLE | style | ) |
void PdfTkNet::PtlAnnot::setBorderWidth | ( | BORDER_LINE_WIDTH | width | ) |
境界線幅をBORDER_LINE_WIDTHで設定。
境界線幅を指定した数値で直接設定したい場合は、setBorderWidthNative()を使ってください。
width | 境界線幅。BORDER_WIDTH_XXXのいずれかの値。 |
PtlException |
void PdfTkNet::PtlAnnot::setBorderWidthNative | ( | float | width | ) |
void PdfTkNet::PtlAnnot::setColor | ( | PtlColorDeviceRGB^ | color | ) |
色を設定。
下記注釈の色を設定します。
・FreeText : 線の色
・Line : 線の色
・Square : 線の色
・Circle : 線の色
・PolyLine : 線の色
・Polygon : 線の色
・Caret : Caretの色
・Ink : 線の色
・Squiggly : 線の色
・Highlight: Highlightの色
・Strikeout: Strikeoutの色
・Underline: Underlineの色
color | 色 |
PtlException |
void PdfTkNet::PtlAnnot::setDate | ( | PtlDate^ | date | ) |
void PdfTkNet::PtlAnnot::setInteriorColor | ( | PtlColor^ | color | ) |
内部色を設定。
下記注釈の内部色を設定します。
・FreeText
・Line
・Square
・Circle
・PolyLine
・Polygon
指定できる色はPtlColorDeviceRGB,PtlColorNoneです。
color | 色 |
PtlException |
void PdfTkNet::PtlAnnot::setRect | ( | PtlRect^ | rectMM | ) |
矩形座標を設定。
座標の単位はmmで原点(0,0)は左下となりますので注意してください。
※ 注意事項
PtlAnnotTextMarkupはPtlQuadPointsにQuadPointを追加したら自動的に矩形座標は設定されますので
この関数で矩形座標を設定しないでください。
PtlAnnotPolygonはPtlPointsにPointを追加したら自動的に矩形座標は設定されますので
この関数で矩形座標を設定しないでください。
rectMM | 矩形座標 |
PtlException |
void PdfTkNet::PtlAnnot::setTextContents | ( | String^ | contents | ) |
内容を設定。
テキスト文字列の内容を設定します。
注意:
このテキスト文字列は以下の目的で使用されます。
・注釈用に表示されるテキスト ・可読な形式での注釈コンテンツの代替説明
contents | テキスト文字列 |
PtlException |
|
protected |