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

#include <NetOpenMode.h>

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

公開型

enum class  PAGE_MODE {
  PAGE_MODE_USE_NONE = 1 , PAGE_MODE_USE_OUTLINES = 2 , PAGE_MODE_USE_THUMBS = 3 , PAGE_MODE_USE_OC = 5 ,
  PAGE_MODE_USE_ATTACHMENTS = 6
}
enum class  PAGE_LAYOUT {
  PAGE_LAYOUT_SINGLE_PAGE = 1 , PAGE_LAYOUT_ONE_COLUMN = 2 , PAGE_LAYOUT_TWO_COLUMN_LEFT = 3 , PAGE_LAYOUT_TWO_COLUMN_RIGHT = 4 ,
  PAGE_LAYOUT_TWO_PAGE_LEFT = 5 , PAGE_LAYOUT_TWO_PAGE_RIGHT = 6
}
enum class  WINDOWS_OPTION { WINDOWS_OPTION_NONE = 0x00000000 , WINDOWS_OPTION_FIT_WINDOW = 0x00000001 , WINDOWS_OPTION_CENTER_WINDOW = 0x00000002 , WINDOWS_OPTION_FULL_SCREEN = 0x00000004 }
enum class  UI_OPTION { UI_OPTION_NONE = 0x00000000 , UI_OPTION_HIDE_MENUBAR = 0x00000001 , UI_OPTION_HIDE_TOOLBAR = 0x00000002 , UI_OPTION_HIDE_WINDOWUI = 0x00000004 }

公開メンバ関数

PdfTk::PtlOpenMode * getNative ()
 PtlOpenMode ()
 コンストラクタ
 PtlOpenMode (PtlOpenMode^ obj)
 コピーコンストラクタ alias copy
 ~PtlOpenMode ()
 デストラクタ
 !PtlOpenMode ()
 ファイナライザ。
PtlOpenMode operator= (PtlOpenMode^ obj)
 コピーオペレータ alias copy
bool hasPageMode ()
 ページモードを持っているかを取得。
PAGE_MODE getPageMode ()
 ページモードを取得。
void setPageMode (PAGE_MODE pageMode)
 ページモードを設定。
bool hasPageLayout ()
 ページレイアウトを持っているかを取得。
PAGE_LAYOUT getPageLayout ()
 ページレイアウトを取得。
void setPageLayout (PAGE_LAYOUT pageLayout)
 ページレイアウトを設定。
PtlAction getOpenAction ()
 オープンアクションを取得。
void setOpenAction (PtlAction^ action)
 オープンアクションを設定。
PtlDest getOpenDest ()
 オープン時の宛先を取得。
void setOpenDest (PtlDest^ dest)
 オープン時の宛先を設定。
void removeOpenAction ()
 オープンアクションを削除。
WINDOWS_OPTION getWindowOption ()
 ウィンドウオプションを取得。
void setWindowOption (WINDOWS_OPTION option)
 ウィンドウオプションを設定。
bool getDisplayDocTitle ()
 ウィンドウのタイトルバーに文書タイトルを表示するかどうかを取得。
void setDisplayDocTitle (bool docTitle)
 ウィンドウのタイトルバーに文書タイトルを表示するかどうかを設定。
UI_OPTION getUIOption ()
 ユーザーインターフェイスオプションを取得。
void setUIOption (UI_OPTION option)
 ユーザーインターフェイスオプションを設定。

限定公開変数類

PdfTk::PtlOpenMode * m_native

詳解

PDFの文開き方を表現したクラスです。
PtlOpenModeはPtlDocPropertyから取得して使用します。

列挙型メンバ詳解

◆ PAGE_LAYOUT

ページレイアウトタイプ
文書を開いたときに使われるページレイアウトです。

列挙値
PAGE_LAYOUT_SINGLE_PAGE 

単一ページ

PAGE_LAYOUT_ONE_COLUMN 

連続ページ

PAGE_LAYOUT_TWO_COLUMN_LEFT 

奇数ページを左側にして連続見開きページ

PAGE_LAYOUT_TWO_COLUMN_RIGHT 

奇数ページを右側にして連続見開きページ

PAGE_LAYOUT_TWO_PAGE_LEFT 

奇数ページを左側にして見開きページ

PAGE_LAYOUT_TWO_PAGE_RIGHT 

奇数ページを右側にして見開きページ

◆ PAGE_MODE

ページモード
文書を開いたときのページ表示方法です。

列挙値
PAGE_MODE_USE_NONE 

ページのみ表示

PAGE_MODE_USE_OUTLINES 

アウトラインパネルとページ

PAGE_MODE_USE_THUMBS 

サムネイルパネルとページ

PAGE_MODE_USE_OC 

レイヤーパネルとページ

PAGE_MODE_USE_ATTACHMENTS 

添付ファイルパネルとページ

◆ UI_OPTION

ユーザーインターフェイスオプション

列挙値
UI_OPTION_NONE 

なし

UI_OPTION_HIDE_MENUBAR 

メニューバーを非表示

UI_OPTION_HIDE_TOOLBAR 

ツールバーを非表示

UI_OPTION_HIDE_WINDOWUI 

ウィンドウコントロールを非表示

◆ WINDOWS_OPTION

ウィンドウオプション

列挙値
WINDOWS_OPTION_NONE 

なし

WINDOWS_OPTION_FIT_WINDOW 

ページにウィンドウサイズを合あわせる

WINDOWS_OPTION_CENTER_WINDOW 

ウィンドウを画面中央に配置

WINDOWS_OPTION_FULL_SCREEN 

フルスクリーンモードで開く

構築子と解体子

◆ PtlOpenMode() [1/2]

PdfTkNet::PtlOpenMode::PtlOpenMode ( )

コンストラクタ

例外
PtlException

◆ PtlOpenMode() [2/2]

PdfTkNet::PtlOpenMode::PtlOpenMode ( PtlOpenMode^ obj)

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

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

◆ ~PtlOpenMode()

PdfTkNet::PtlOpenMode::~PtlOpenMode ( )

デストラクタ

◆ !PtlOpenMode()

PdfTkNet::PtlOpenMode::!PtlOpenMode ( )

ファイナライザ。

メソッド詳解

◆ getDisplayDocTitle()

bool PdfTkNet::PtlOpenMode::getDisplayDocTitle ( )

ウィンドウのタイトルバーに文書タイトルを表示するかどうかを取得。

戻り値
true: 表示、false: 非表示。

◆ getNative()

PdfTk::PtlOpenMode * PdfTkNet::PtlOpenMode::getNative ( )

◆ getOpenAction()

PtlAction PdfTkNet::PtlOpenMode::getOpenAction ( )

オープンアクションを取得。

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

戻り値
PtlAction。
例外
PtlException

◆ getOpenDest()

PtlDest PdfTkNet::PtlOpenMode::getOpenDest ( )

オープン時の宛先を取得。

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

戻り値
宛先
例外
PtlException

◆ getPageLayout()

PAGE_LAYOUT PdfTkNet::PtlOpenMode::getPageLayout ( )

ページレイアウトを取得。

戻り値
ページレイアウト。PAGE_LAYOUT_XXXのいずれかの値。
例外
PtlException

◆ getPageMode()

PAGE_MODE PdfTkNet::PtlOpenMode::getPageMode ( )

ページモードを取得。

戻り値
ページモード。PAGE_MODE_XXXのいずれかの値。
例外
PtlException

◆ getUIOption()

UI_OPTION PdfTkNet::PtlOpenMode::getUIOption ( )

ユーザーインターフェイスオプションを取得。

ユーザーインターフェイスオプションが論理和で指定されています。

戻り値
ユーザーインターフェイスオプション。UI_OPTION_XXXのユーザーインターフェイスオプション。
例外
PtlException

◆ getWindowOption()

WINDOWS_OPTION PdfTkNet::PtlOpenMode::getWindowOption ( )

ウィンドウオプションを取得。

ウィンドウオプションが論理和で指定されています。

戻り値
ウィンドウオプション。WINDOW_OPTION_XXXのウィンドウオプション。
例外
PtlException

◆ hasPageLayout()

bool PdfTkNet::PtlOpenMode::hasPageLayout ( )

ページレイアウトを持っているかを取得。

戻り値
true: 持っている、false: 持っていない。
例外
PtlException

◆ hasPageMode()

bool PdfTkNet::PtlOpenMode::hasPageMode ( )

ページモードを持っているかを取得。

戻り値
true: 持っている、false: 持っていない。
例外
PtlException

◆ operator=()

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

コピーオペレータ alias copy

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

◆ removeOpenAction()

void PdfTkNet::PtlOpenMode::removeOpenAction ( )

オープンアクションを削除。

例外
PtlException

◆ setDisplayDocTitle()

void PdfTkNet::PtlOpenMode::setDisplayDocTitle ( bool docTitle)

ウィンドウのタイトルバーに文書タイトルを表示するかどうかを設定。

引数
docTitletrue: 表示、false: 非表示。

◆ setOpenAction()

void PdfTkNet::PtlOpenMode::setOpenAction ( PtlAction^ action)

オープンアクションを設定。

同時にsetOpenDestを使用すると後に設定したほうが反映されます。
AcrobatではPtlActionLaunch(PDFを指定したもの)、PtlActionGoToRを設定しても動作しません。

引数
actionアクション。
例外
PtlException

◆ setOpenDest()

void PdfTkNet::PtlOpenMode::setOpenDest ( PtlDest^ dest)

オープン時の宛先を設定。

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

引数
dest宛先
例外
PtlException

◆ setPageLayout()

void PdfTkNet::PtlOpenMode::setPageLayout ( PAGE_LAYOUT pageLayout)

ページレイアウトを設定。

引数
pageLayoutページレイアウト。PAGE_LAYOUT_XXXのいずれかの値。
例外
PtlException

◆ setPageMode()

void PdfTkNet::PtlOpenMode::setPageMode ( PAGE_MODE pageMode)

ページモードを設定。

同時にsetWindowOptionでWINDOWS_OPTION_FULL_SCREENを指定すると後に設定したほうが反映されます。

引数
pageModeページモード。PAGE_MODE_XXXのいずれかの値。
例外
PtlException

◆ setUIOption()

void PdfTkNet::PtlOpenMode::setUIOption ( UI_OPTION option)

ユーザーインターフェイスオプションを設定。

ユーザーインターフェイスオプションを論理和で指定します。

引数
optionユーザーインターフェイスオプション。UI_OPTION_XXXのユーザーインターフェイスオプション。
例外
PtlException

◆ setWindowOption()

void PdfTkNet::PtlOpenMode::setWindowOption ( WINDOWS_OPTION option)

ウィンドウオプションを設定。

ウィンドウオプションを論理和で指定します。
同時にsetPageModeを使用すると後に設定したほうが反映されます。

引数
optionウィンドウオプション。WINDOW_OPTION_XXXのウィンドウオプション。
例外
PtlException

メンバ詳解

◆ m_native

PdfTk::PtlOpenMode* PdfTkNet::PtlOpenMode::m_native
protected