PDFTool.NET  6.0
Public Types | Public Member Functions | List of all members
PdfTkNet::PtlAnnotLink Class Reference

PDFのリンク注釈を表現したクラスです。 More...

#include <NetAnnotLink.h>

Inheritance diagram for PdfTkNet::PtlAnnotLink:
Inheritance graph
[legend]
Collaboration diagram for PdfTkNet::PtlAnnotLink:
Collaboration graph
[legend]

Public Types

enum  HIGHLIGHTING_MODE { HIGHLIGHTING_MODE::HIGHLIGHTING_MODE_NONE = 1, HIGHLIGHTING_MODE::HIGHLIGHTING_MODE_INVERT = 2, HIGHLIGHTING_MODE::HIGHLIGHTING_MODE_OUTLINE = 3, HIGHLIGHTING_MODE::HIGHLIGHTING_MODE_PUSH = 4 }
 ハイライトモード
※ ハイライトモードは注釈のアクティブ領域内でマウスボタンが押されるか、押し続けられるときに用いる視覚効果です。 More...
 
- Public Types inherited from PdfTkNet::PtlAnnot
enum  ANNOT_TYPE {
  ANNOT_TYPE::TYPE_TEXT = 1, ANNOT_TYPE::TYPE_LINK = 2, ANNOT_TYPE::TYPE_FREE_TEXT = 3, ANNOT_TYPE::TYPE_LINE = 4,
  ANNOT_TYPE::TYPE_SQUARE = 5, ANNOT_TYPE::TYPE_CIRCLE = 6, ANNOT_TYPE::TYPE_POLYGON = 7, ANNOT_TYPE::TYPE_POLYLINE = 8,
  ANNOT_TYPE::TYPE_HIGHLIGHT = 9, ANNOT_TYPE::TYPE_UNDERLINE = 10, ANNOT_TYPE::TYPE_SQUIGGLY = 11, ANNOT_TYPE::TYPE_STRIKEOUT = 12,
  ANNOT_TYPE::TYPE_STAMP = 13, ANNOT_TYPE::TYPE_CARET = 14, ANNOT_TYPE::TYPE_INK = 15, ANNOT_TYPE::TYPE_POPUP = 16,
  ANNOT_TYPE::TYPE_FILE_ATTACHMENT = 17, ANNOT_TYPE::TYPE_SOUND = 18, ANNOT_TYPE::TYPE_MOVIE = 19, ANNOT_TYPE::TYPE_WIDGET = 20,
  ANNOT_TYPE::TYPE_SCREEN = 21, ANNOT_TYPE::TYPE_PRINTER_MARK = 22, ANNOT_TYPE::TYPE_TRAP_NETWORK = 23, ANNOT_TYPE::TYPE_WATERMARK = 24,
  ANNOT_TYPE::TYPE_3D = 25, ANNOT_TYPE::TYPE_REDACT = 26, ANNOT_TYPE::TYPE_PROJECTION = 27, ANNOT_TYPE::TYPE_RICHMEDIA = 28,
  ANNOT_TYPE::TYPE_UNKNOWN = 100
}
 注釈のタイプ More...
 
enum  ANNOT_FLAGS {
  ANNOT_FLAGS::FLAG_INVISIBLE = 0x00000001, ANNOT_FLAGS::FLAG_HIDDEN = 0x00000002, ANNOT_FLAGS::FLAG_PRINT = 0x00000004, ANNOT_FLAGS::FLAG_NOZOOM = 0x00000008,
  ANNOT_FLAGS::FLAG_NOROTATE = 0x00000010, ANNOT_FLAGS::FLAG_NOVIEW = 0x00000020, ANNOT_FLAGS::FLAG_READONLY = 0x00000040, ANNOT_FLAGS::FLAG_LOCKED = 0x00000080,
  ANNOT_FLAGS::FLAG_TOGGLE_NOVIEW = 0x00000100, ANNOT_FLAGS::FLAG_LOCKED_CONTENTS = 0x00000200
}
 注釈フラグ。 More...
 
enum  BORDER_STYLE {
  BORDER_STYLE::BORDER_SOLID = 1, BORDER_STYLE::BORDER_DASHED = 2, BORDER_STYLE::BORDER_BEVELED = 3, BORDER_STYLE::BORDER_INSET = 4,
  BORDER_STYLE::BORDER_UNDERLINE = 5
}
 境界線スタイル More...
 
enum  BORDER_LINE_WIDTH { BORDER_LINE_WIDTH::BORDER_WIDTH_NONE = 0, BORDER_LINE_WIDTH::BORDER_WIDTH_THIN = 1, BORDER_LINE_WIDTH::BORDER_WIDTH_MIDDLE = 2, BORDER_LINE_WIDTH::BORDER_WIDTH_THICK = 3 }
 境界線幅 More...
 

Public Member Functions

 PtlAnnotLink ()
 コンストラクタ More...
 
 PtlAnnotLink (PtlAnnotLink^ obj)
 コピーコンストラクタ alias copy More...
 
 ‾PtlAnnotLink ()
 デストラクタ
 
 !PtlAnnotLink ()
 ファイナライザ。
 
PtlAnnotLink operator= (PtlAnnotLink^ obj)
 コピーオペレータ alias copy More...
 
HIGHLIGHTING_MODE getHighlightMode ()
 ハイライトモードを取得。 More...
 
void setHighlightMode (HIGHLIGHTING_MODE mode)
 ハイライトモードを設定。 More...
 
PtlAction getAction ()
 アクションを取得。 More...
 
void setAction (PtlAction^ action)
 アクションを設定。 More...
 
void removeAction ()
 アクションを削除。 More...
 
PtlDest getDest ()
 宛先を取得。 More...
 
void setDest (PtlDest^ dest)
 宛先を設定。 More...
 
- Public Member Functions inherited from PdfTkNet::PtlAnnot
PdfTk::PtlAnnot * getNative ()
 
 PtlAnnot (ANNOT_TYPE type)
 コンストラクタ More...
 
 PtlAnnot (PtlAnnot^ obj)
 コピーコンストラクタ alias copy More...
 
virtual ‾PtlAnnot ()
 デストラクタ
 
 !PtlAnnot ()
 ファイナライザ。
 
PtlAnnot operator= (PtlAnnot^ obj)
 コピーオペレータ alias copy More...
 
ANNOT_TYPE getType ()
 注釈タイプを取得。 More...
 
bool isMarkup ()
 マークアップ注釈か否かを取得。 More...
 
PtlRect getRect ()
 矩形座標を取得。 More...
 
void setRect (PtlRect^ rectMM)
 矩形座標を設定。 More...
 
String getTextContents ()
 内容を取得。 More...
 
void setTextContents (String^ contents)
 内容を設定。 More...
 
PtlDate getDate ()
 日時の取得。 More...
 
void setDate (PtlDate^ date)
 日時の設定。 More...
 
ANNOT_FLAGS getAnnotFlags ()
 注釈フラグを取得。 More...
 
void setAnnotFlags (ANNOT_FLAGS flag)
 注釈フラグを設定。 More...
 
PtlColor getColor ()
 色を取得。 More...
 
void setColor (PtlColorDeviceRGB^ color)
 色を設定。 More...
 
PtlColor getInteriorColor ()
 内部色を取得。 More...
 
void setInteriorColor (PtlColorDeviceRGB^ color)
 内部色を設定。 More...
 
BORDER_STYLE getBorderStyle ()
 境界線スタイルを取得。 More...
 
void setBorderStyle (BORDER_STYLE style)
 境界線スタイルを設定。 More...
 
BORDER_LINE_WIDTH getBorderWidth ()
 境界線幅をBORDER_LINE_WIDTHで取得。 More...
 
void setBorderWidth (BORDER_LINE_WIDTH width)
 境界線幅をBORDER_LINE_WIDTHで設定。 More...
 
float getBorderWidthNative ()
 注釈に設定してある境界線幅を直接取得。 More...
 
void setBorderWidthNative (float width)
 注釈の境界線幅を数値で直接設定。 More...
 

Additional Inherited Members

- Protected Attributes inherited from PdfTkNet::PtlAnnot
PdfTk::PtlAnnot * m_native
 

Detailed Description

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

Member Enumeration Documentation

◆ HIGHLIGHTING_MODE

ハイライトモード
※ ハイライトモードは注釈のアクティブ領域内でマウスボタンが押されるか、押し続けられるときに用いる視覚効果です。

Enumerator
HIGHLIGHTING_MODE_NONE 

(None)ハイライトなし

HIGHLIGHTING_MODE_INVERT 

(Invert)注釈矩形を反転

HIGHLIGHTING_MODE_OUTLINE 

Outline)注釈の境界線を反転

HIGHLIGHTING_MODE_PUSH 

(Push)ページの下に押し込まれたかのように注釈を表示

Constructor & Destructor Documentation

◆ PtlAnnotLink() [1/2]

PdfTkNet::PtlAnnotLink::PtlAnnotLink ( )

コンストラクタ

Exceptions
PtlException

◆ PtlAnnotLink() [2/2]

PdfTkNet::PtlAnnotLink::PtlAnnotLink ( PtlAnnotLink obj)

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

Parameters
objコピー元オブジェクト。
Exceptions
PtlException

Member Function Documentation

◆ getAction()

PtlAction PdfTkNet::PtlAnnotLink::getAction ( )

アクションを取得。

PtlActionを取得後、タイプを確認の上使用して下さい。

Returns
アクション
Exceptions
PtlException

◆ getDest()

PtlDest PdfTkNet::PtlAnnotLink::getDest ( )

宛先を取得。

PtlDestを取得後、タイプを確認の上使用して下さい。
GoToRの宛先は取得されません。GoToRの宛先はActionGoToRから取得して下さい。

Returns
宛先
Exceptions
PtlException

◆ getHighlightMode()

HIGHLIGHTING_MODE PdfTkNet::PtlAnnotLink::getHighlightMode ( )

ハイライトモードを取得。

Returns
ハイライトモード。HIGHLIGHTING_MODE_XXXのいずれかの値。
Exceptions
PtlException

◆ operator=()

PtlAnnotLink PdfTkNet::PtlAnnotLink::operator= ( PtlAnnotLink obj)

コピーオペレータ alias copy

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

◆ removeAction()

void PdfTkNet::PtlAnnotLink::removeAction ( )

アクションを削除。

Exceptions
PtlException

◆ setAction()

void PdfTkNet::PtlAnnotLink::setAction ( PtlAction action)

アクションを設定。

同時にsetDestを使用すると後に設定したほうが反映されます。

Parameters
actionアクション
Exceptions
PtlException

◆ setDest()

void PdfTkNet::PtlAnnotLink::setDest ( PtlDest dest)

宛先を設定。

同時にsetActionを使用すると後に設定したほうが反映されます。

Parameters
dest宛先
Exceptions
PtlException

◆ setHighlightMode()

void PdfTkNet::PtlAnnotLink::setHighlightMode ( HIGHLIGHTING_MODE  mode)

ハイライトモードを設定。

Parameters
modeハイライトモード。HIGHLIGHTING_MODE_XXXのいずれかの値。
Exceptions
PtlException