PDFTool.NET  7.0
Public Member Functions | List of all members
PdfTkNet::PtlAnnotTextMarkup Class Reference

PDFのテキストマークアップ注釈を表現したクラスです。
すべてのテキストマークアップ注釈クラスのベースクラスです。 More...

#include <NetAnnotTextMarkup.h>

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

Public Member Functions

 PtlAnnotTextMarkup (ANNOT_TYPE type)
 コンストラクタ More...
 
 PtlAnnotTextMarkup (PtlAnnotTextMarkup^ obj)
 コピーコンストラクタ alias copy More...
 
virtual ‾PtlAnnotTextMarkup ()
 デストラクタ
 
 !PtlAnnotTextMarkup ()
 ファイナライザ。
 
PtlAnnotTextMarkup operator= (PtlAnnotTextMarkup^ obj)
 コピーオペレータ alias copy More...
 
PtlQuadPoints getQuadPoints ()
 テキストを囲むQuadPointのコンテナを取得。 More...
 
void setVerticalDirection (bool vert)
 テキストを縦書き方向に囲むかどうかを設定。 More...
 
- Public Member Functions inherited from PdfTkNet::PtlAnnotMarkup
 PtlAnnotMarkup (ANNOT_TYPE type)
 コンストラクタ More...
 
 PtlAnnotMarkup (PtlAnnotMarkup^ obj)
 コピーコンストラクタ alias copy More...
 
virtual ‾PtlAnnotMarkup ()
 デストラクタ
 
 !PtlAnnotMarkup ()
 ファイナライザ。
 
PtlAnnotMarkup operator= (PtlAnnotMarkup^ obj)
 コピーオペレータ alias copy More...
 
String getMarkUpTitle ()
 ポップアップウィンドウのタイトル文字列を取得。 More...
 
void setMarkUpTitle (String^title)
 ポップアップウィンドウのタイトル文字列を設定。 More...
 
String getMarkUpSubj ()
 サブジェクトの短い説明を取得。 More...
 
void setMarkUpSubj (String^subj)
 サブジェクトの短い説明を設定。 More...
 
PtlDate getMarkUpDate ()
 注釈生成日時を取得。 More...
 
void setMarkUpDate (PtlDate^ date)
 注釈生成日時を設定。 More...
 
float getMarkUpCA ()
 不透明度を取得。 More...
 
void setMarkUpCA (float ca)
 不透明度を設定。 More...
 
bool hasAnnotPopup ()
 ポップアップ注釈を持つか否かを取得。 More...
 
PtlAnnotPopup getAnnotPopup ()
 ポップアップ注釈を取得。 More...
 
void setAnnotPopUp (PtlAnnotPopup^ popup)
 ポップアップ注釈を設定。 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

- 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...
 
- Protected Attributes inherited from PdfTkNet::PtlAnnot
PdfTk::PtlAnnot * m_native
 

Detailed Description

PDFのテキストマークアップ注釈を表現したクラスです。
すべてのテキストマークアップ注釈クラスのベースクラスです。

Constructor & Destructor Documentation

◆ PtlAnnotTextMarkup() [1/2]

PdfTkNet::PtlAnnotTextMarkup::PtlAnnotTextMarkup ( ANNOT_TYPE  type)

コンストラクタ

Exceptions
PtlException

◆ PtlAnnotTextMarkup() [2/2]

PdfTkNet::PtlAnnotTextMarkup::PtlAnnotTextMarkup ( PtlAnnotTextMarkup obj)

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

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

Member Function Documentation

◆ getQuadPoints()

PtlQuadPoints PdfTkNet::PtlAnnotTextMarkup::getQuadPoints ( )

テキストを囲むQuadPointのコンテナを取得。

※ 注意事項
PtlAnnotTextMarkupはPtlQuadPointsにQuadPointを追加したら自動的に矩形座標は設定されますので
基底クラスPtlAnnotのsetRect関数で矩形座標を設定しないでください。

Returns
テキストを囲むQuadPointのコンテナ。
Exceptions
PtlException

◆ operator=()

PtlAnnotTextMarkup PdfTkNet::PtlAnnotTextMarkup::operator= ( PtlAnnotTextMarkup obj)

コピーオペレータ alias copy

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

◆ setVerticalDirection()

void PdfTkNet::PtlAnnotTextMarkup::setVerticalDirection ( bool  vert)

テキストを縦書き方向に囲むかどうかを設定。

設定しない場合はデフォルト値としてfalse(横方向に囲む)が使用されます。
この設定はハイライト注釈の場合、外観の膨らみの位置に影響します。

Parameters
vertテキストを縦方向に囲むかどうか。trueなら縦方向に配置。
Exceptions
PtlException