HaruDoc::addPageHaruDoc::addPageLabel
(PECL haru >= 0.0.1)
HaruDoc::addPageLabel — 指定した範囲のページにおけるページラベルの形式を設定する
説明
bool HaruDoc::addPageLabel
( int $first_page
, int $style
, int $first_num
[, string $prefix
] )
指定した範囲のページにおけるページラベルの形式を設定します。
パラメータ
- first_page
-
ラベル付けの範囲に含む最初のページ。
- style
-
番号の形式。以下のいずれかの値となります。
- HaruPage::NUM_STYLE_DECIMAL - ページラベルを十進数で表示します。
- HaruPage::NUM_STYLE_UPPER_ROMAN - ページラベルを大文字のローマ数字で表示します。
- HaruPage::NUM_STYLE_LOWER_ROMAN - ページラベルを小文字のローマ数字で表示します。
- HaruPage::NUM_STYLE_UPPER_LETTER - ページラベルを大文字 (A から Z まで) で表示します。
- HaruPage::NUM_STYLE_LOWER_LETTERS - ページラベルを小文字 (a から z まで) で表示します。
- first_num
-
この範囲内の最初のページ番号。
- prefix
-
ページラベルの接頭辞。オプションで、デフォルトでは空白。
返り値
成功した場合に TRUE を返します。
エラー / 例外
エラー時に HaruException をスローします。
add a note
User Contributed NotesHaruDoc::addPageLabel
There are no user contributed notes for this page.