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

#include <NetAnnotLine.h>

PdfTkNet::PtlAnnotLine の継承関係図
PdfTkNet::PtlAnnotLine 連携図

公開型

enum class  LINE_ENDING_STYLE {
  STYLE_NONE = 0 , STYLE_SQUARE = 1 , STYLE_CIRCLE = 2 , STYLE_DIAMOND = 3 ,
  STYLE_OPEN_ARROW = 4 , STYLE_CLOSED_ARROW = 5 , STYLE_BUTT = 6 , STYLE_R_OPEN_ARROW = 7 ,
  STYLE_R_CLOSED_ARROW = 8 , STYLE_SLASH = 9
}
enum class  CAPTION_POSITION { POSITION_INLINE = 0 , POSITION_TOP = 1 }
基底クラス PdfTkNet::PtlAnnot に属する継承公開型
enum class  ANNOT_TYPE {
  TYPE_TEXT = 1 , TYPE_LINK = 2 , TYPE_FREE_TEXT = 3 , TYPE_LINE = 4 ,
  TYPE_SQUARE = 5 , TYPE_CIRCLE = 6 , TYPE_POLYGON = 7 , TYPE_POLYLINE = 8 ,
  TYPE_HIGHLIGHT = 9 , TYPE_UNDERLINE = 10 , TYPE_SQUIGGLY = 11 , TYPE_STRIKEOUT = 12 ,
  TYPE_STAMP = 13 , TYPE_CARET = 14 , TYPE_INK = 15 , TYPE_POPUP = 16 ,
  TYPE_FILE_ATTACHMENT = 17 , TYPE_SOUND = 18 , TYPE_MOVIE = 19 , TYPE_WIDGET = 20 ,
  TYPE_SCREEN = 21 , TYPE_PRINTER_MARK = 22 , TYPE_TRAP_NETWORK = 23 , TYPE_WATERMARK = 24 ,
  TYPE_3D = 25 , TYPE_REDACT = 26 , TYPE_PROJECTION = 27 , TYPE_RICHMEDIA = 28 ,
  TYPE_UNKNOWN = 100
}
enum class  ANNOT_FLAGS {
  FLAG_INVISIBLE = 0x00000001 , FLAG_HIDDEN = 0x00000002 , FLAG_PRINT = 0x00000004 , FLAG_NOZOOM = 0x00000008 ,
  FLAG_NOROTATE = 0x00000010 , FLAG_NOVIEW = 0x00000020 , FLAG_READONLY = 0x00000040 , FLAG_LOCKED = 0x00000080 ,
  FLAG_TOGGLE_NOVIEW = 0x00000100 , FLAG_LOCKED_CONTENTS = 0x00000200
}
enum class  BORDER_STYLE {
  BORDER_SOLID = 1 , BORDER_DASHED = 2 , BORDER_BEVELED = 3 , BORDER_INSET = 4 ,
  BORDER_UNDERLINE = 5
}
enum class  BORDER_LINE_WIDTH { BORDER_WIDTH_NONE = 0 , BORDER_WIDTH_THIN = 1 , BORDER_WIDTH_MIDDLE = 2 , BORDER_WIDTH_THICK = 3 }

公開メンバ関数

 PtlAnnotLine ()
 コンストラクタ
 PtlAnnotLine (PtlAnnotLine^ obj)
 コピーコンストラクタ alias copy
 ~PtlAnnotLine ()
 デストラクタ
 !PtlAnnotLine ()
 ファイナライザ。
PtlAnnotLine operator= (PtlAnnotLine^ obj)
 コピーオペレータ alias copy
void setStartPoint (PtlPoint^ point)
 注釈の開始座標を設定。
PtlPoint getStartPoint ()
 注釈の開始座標を取得。
void setEndPoint (PtlPoint^ point)
 注釈の終了座標を設定。
PtlPoint getEndPoint ()
 注釈の終了座標を取得。
void setLineStartPointStyle (LINE_ENDING_STYLE style)
 開始座標の線端のスタイルを設定する。デフォルトはSTYLE_NONE。
LINE_ENDING_STYLE getLineStartPointStyle ()
 開始座標の線端のスタイルを取得。
void setLineEndPointStyle (LINE_ENDING_STYLE style)
 終了座標の線端のスタイルを設定する。デフォルトはSTYLE_NONE。
LINE_ENDING_STYLE getLineEndPointStyle ()
 終了座標の線端のスタイルを取得。
void setLeaderLinesLength (float length)
 線端から垂直に伸びる引き出し線の長さを設定する。負の値も設定可能。
float getLeaderLinesLength ()
 線端から垂直に伸びる引き出し線の長さを取得。
void setExtensionLeaderLines (float length)
 引き出し線と逆側に伸びる線の長さを設定する。正の値のみ設定可能。
float getExtensionLeaderLines ()
 引き出し線と逆側に伸びる線の長さを取得。
void setLeaderLinesOffset (float value)
 引き出し線オフセットを設定する。正の値のみ設定可能。
float getLeaderLinesOffset ()
 引き出し線オフセットを取得。
void setViewCaption (bool view)
 キャプションを表示するかどうかを設定する。
bool getViewCaption ()
 キャプションを表示するかどうかを取得。
void setHorizontalOffset (float value)
 キャプションの表示位置の水平方向のオフセットを設定します。 正の値は右へのオフセットを示し、負の値は左へのオフセットを示します。 デフォルトは0.0。
float getHorizontalOffset ()
 キャプションの表示位置の水平方向のオフセットを取得。
void setVerticalOffset (float value)
 キャプションの表示位置の垂直方向のオフセットを設定します。 正の値は上へのオフセットを示し、負の値は下へのオフセットを示します。 デフォルトは0.0。
float getVerticalOffset ()
 キャプションの表示位置の垂直方向のオフセットを取得。
void setCaptionPosition (CAPTION_POSITION position)
 キャプションの表示位置を設定します。 デフォルトはPOSITION_INLINE。
CAPTION_POSITION getCaptionPosition ()
 キャプションの表示位置を取得。
基底クラス PdfTkNet::PtlAnnotMarkup に属する継承公開メンバ関数
 PtlAnnotMarkup (ANNOT_TYPE type)
 コンストラクタ
 PtlAnnotMarkup (PtlAnnotMarkup^ obj)
 コピーコンストラクタ alias copy
virtual ~PtlAnnotMarkup ()
 デストラクタ
 !PtlAnnotMarkup ()
 ファイナライザ。
PtlAnnotMarkup operator= (PtlAnnotMarkup^ obj)
 コピーオペレータ alias copy
String getMarkUpTitle ()
 ポップアップウィンドウのタイトル文字列を取得。
void setMarkUpTitle (String^title)
 ポップアップウィンドウのタイトル文字列を設定。
String getMarkUpSubj ()
 サブジェクトの短い説明を取得。
void setMarkUpSubj (String^subj)
 サブジェクトの短い説明を設定。
PtlDate getMarkUpDate ()
 注釈生成日時を取得。
void setMarkUpDate (PtlDate^ date)
 注釈生成日時を設定。
float getMarkUpCA ()
 不透明度を取得。
void setMarkUpCA (float ca)
 不透明度を設定。
bool hasAnnotPopup ()
 ポップアップ注釈を持つか否かを取得。
PtlAnnotPopup getAnnotPopup ()
 ポップアップ注釈を取得。
void setAnnotPopUp (PtlAnnotPopup^ popup)
 ポップアップ注釈を設定。
基底クラス PdfTkNet::PtlAnnot に属する継承公開メンバ関数
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 ()
 注釈名を取得。

その他の継承メンバ

基底クラス PdfTkNet::PtlAnnot に属する継承限定公開変数類
PdfTk::PtlAnnot * m_native

詳解

PDFの線注釈を表現したクラスです。

列挙型メンバ詳解

◆ CAPTION_POSITION

キャプションの表示位置

列挙値
POSITION_INLINE 

線の中

POSITION_TOP 

線の上

◆ LINE_ENDING_STYLE

線端のスタイル

列挙値
STYLE_NONE 

なし

STYLE_SQUARE 

四角

STYLE_CIRCLE 

STYLE_DIAMOND 

ダイヤモンド

STYLE_OPEN_ARROW 

矢印

STYLE_CLOSED_ARROW 

矢印(三角形)

STYLE_BUTT 

線に垂直な短線

STYLE_R_OPEN_ARROW 

矢印(逆向き)

STYLE_R_CLOSED_ARROW 

矢印(逆三角形)

STYLE_SLASH 

線に30度傾いた短線

構築子と解体子

◆ PtlAnnotLine() [1/2]

PdfTkNet::PtlAnnotLine::PtlAnnotLine ( )

コンストラクタ

例外
PtlException

◆ PtlAnnotLine() [2/2]

PdfTkNet::PtlAnnotLine::PtlAnnotLine ( PtlAnnotLine^ obj)

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

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

◆ ~PtlAnnotLine()

PdfTkNet::PtlAnnotLine::~PtlAnnotLine ( )

デストラクタ

◆ !PtlAnnotLine()

PdfTkNet::PtlAnnotLine::!PtlAnnotLine ( )

ファイナライザ。

メソッド詳解

◆ getCaptionPosition()

CAPTION_POSITION PdfTkNet::PtlAnnotLine::getCaptionPosition ( )

キャプションの表示位置を取得。

戻り値
表示位置。
例外
PtlException

◆ getEndPoint()

PtlPoint PdfTkNet::PtlAnnotLine::getEndPoint ( )

注釈の終了座標を取得。

戻り値
注釈の終了座標。
例外
PtlException

◆ getExtensionLeaderLines()

float PdfTkNet::PtlAnnotLine::getExtensionLeaderLines ( )

引き出し線と逆側に伸びる線の長さを取得。

戻り値
引き出し線と逆側に伸びる線の長さ。
例外
PtlException

◆ getHorizontalOffset()

float PdfTkNet::PtlAnnotLine::getHorizontalOffset ( )

キャプションの表示位置の水平方向のオフセットを取得。

戻り値
水平方向オフセット。
例外
PtlException

◆ getLeaderLinesLength()

float PdfTkNet::PtlAnnotLine::getLeaderLinesLength ( )

線端から垂直に伸びる引き出し線の長さを取得。

戻り値
引き出し線の長さ。
例外
PtlException

◆ getLeaderLinesOffset()

float PdfTkNet::PtlAnnotLine::getLeaderLinesOffset ( )

引き出し線オフセットを取得。

戻り値
引き出し線オフセット。
例外
PtlException

◆ getLineEndPointStyle()

LINE_ENDING_STYLE PdfTkNet::PtlAnnotLine::getLineEndPointStyle ( )

終了座標の線端のスタイルを取得。

戻り値
終了座標の線端のスタイル。
例外
PtlException

◆ getLineStartPointStyle()

LINE_ENDING_STYLE PdfTkNet::PtlAnnotLine::getLineStartPointStyle ( )

開始座標の線端のスタイルを取得。

戻り値
開始座標の線端のスタイル。
例外
PtlException

◆ getStartPoint()

PtlPoint PdfTkNet::PtlAnnotLine::getStartPoint ( )

注釈の開始座標を取得。

戻り値
注釈の開始座標。
例外
PtlException

◆ getVerticalOffset()

float PdfTkNet::PtlAnnotLine::getVerticalOffset ( )

キャプションの表示位置の垂直方向のオフセットを取得。

戻り値
垂直方向オフセット。
例外
PtlException

◆ getViewCaption()

bool PdfTkNet::PtlAnnotLine::getViewCaption ( )

キャプションを表示するかどうかを取得。

戻り値
キャプションを表示するかどうか。 true:表示 false:非表示
例外
PtlException

◆ operator=()

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

コピーオペレータ alias copy

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

◆ setCaptionPosition()

void PdfTkNet::PtlAnnotLine::setCaptionPosition ( CAPTION_POSITION position)

キャプションの表示位置を設定します。 デフォルトはPOSITION_INLINE。

引数
position表示位置。
例外
PtlException

◆ setEndPoint()

void PdfTkNet::PtlAnnotLine::setEndPoint ( PtlPoint^ point)

注釈の終了座標を設定。

引数
point終了座標。
例外
PtlException

◆ setExtensionLeaderLines()

void PdfTkNet::PtlAnnotLine::setExtensionLeaderLines ( float length)

引き出し線と逆側に伸びる線の長さを設定する。正の値のみ設定可能。

引数
length引き出し線と逆側に伸びる線の長さ。
例外
PtlException

◆ setHorizontalOffset()

void PdfTkNet::PtlAnnotLine::setHorizontalOffset ( float value)

キャプションの表示位置の水平方向のオフセットを設定します。 正の値は右へのオフセットを示し、負の値は左へのオフセットを示します。 デフォルトは0.0。

引数
value水平方向オフセット。
例外
PtlException

◆ setLeaderLinesLength()

void PdfTkNet::PtlAnnotLine::setLeaderLinesLength ( float length)

線端から垂直に伸びる引き出し線の長さを設定する。負の値も設定可能。

引数
length引き出し線の長さ。
例外
PtlException

◆ setLeaderLinesOffset()

void PdfTkNet::PtlAnnotLine::setLeaderLinesOffset ( float value)

引き出し線オフセットを設定する。正の値のみ設定可能。

引数
value引き出し線オフセット。
例外
PtlException

◆ setLineEndPointStyle()

void PdfTkNet::PtlAnnotLine::setLineEndPointStyle ( LINE_ENDING_STYLE style)

終了座標の線端のスタイルを設定する。デフォルトはSTYLE_NONE。

引数
style線端スタイル。
例外
PtlException

◆ setLineStartPointStyle()

void PdfTkNet::PtlAnnotLine::setLineStartPointStyle ( LINE_ENDING_STYLE style)

開始座標の線端のスタイルを設定する。デフォルトはSTYLE_NONE。

引数
style線端スタイル。
例外
PtlException

◆ setStartPoint()

void PdfTkNet::PtlAnnotLine::setStartPoint ( PtlPoint^ point)

注釈の開始座標を設定。

引数
point開始座標。
例外
PtlException

◆ setVerticalOffset()

void PdfTkNet::PtlAnnotLine::setVerticalOffset ( float value)

キャプションの表示位置の垂直方向のオフセットを設定します。 正の値は上へのオフセットを示し、負の値は下へのオフセットを示します。 デフォルトは0.0。

引数
value垂直方向オフセット。
例外
PtlException

◆ setViewCaption()

void PdfTkNet::PtlAnnotLine::setViewCaption ( bool view)

キャプションを表示するかどうかを設定する。

引数
viewキャプションを表示するかどうか。 true:表示 false:非表示 デフォルトはfalse;
例外
PtlException