Top > FPDF > RefMan

FPDF 1.52 Reference Manual

  • AcceptPageBreak - 自動改ページを行うまたは行わない
  • AddFont - 新しいフォントを追加する
  • AddLink - 内部リンクを作成する
  • AddPage - 新しいページを追加する
  • AliasNbPages - 全ページ数のエイリアスを定義する
  • Cell - セルをプリントする
  • Close - ドキュメントを終了する
  • Error - fatal error
  • Footer - ページフッタ
  • FPDF - コンストラクタ
  • GetStringWidth - 文字列の長さを計算する
  • GetX - 現在の x 位置を取得する
  • GetY - 現在の y 位置を取得する
  • Header - ページヘッダ
  • Image - イメージを出力する
  • Line - 線を描く
  • Link - リンクを置く
  • Ln - 改行
  • MultiCell - 改行を伴ったテキストをプリントする
  • Open - ドキュメントを作成する
  • Output - ドキュメントを保存または送信する
  • PageNo - ページ番号
  • Rect - 四角形を描く
  • SetAuthor - ドキュメントの著者を設定する
  • SetAutoPageBreak - 自動改ページモードを設定する
  • SetCompression - 圧縮のオンオフを切り替える
  • SetCreator - ドキュメントの製作者を設定する
  • SetDisplayMode - 表示モードを設定する
  • SetDrawColor - 描写色を設定する
  • SetFillColor - 塗りつぶす色を設定する
  • SetFont - フォントを設定する
  • SetFontSize - フォントのサイズを設定する
  • SetKeywords - ドキュメントとキーワードを関連付ける
  • SetLeftMargin - 左余白を設定する
  • SetLineWidth - 線の幅を設定する
  • SetLink - 内部リンクの行き先を設定する
  • SetMargins - 余白を設定する
  • SetRightMargin - 右余白を設定する
  • SetSubject - ドキュメントの題を設定する
  • SetTextColor - テキストの色を設定する
  • SetTitle - ドキュメントのタイトルを設定する
  • SetTopMargin - 上余白を設定する
  • SetX - 現在の y 位置を設定する
  • SetXY - 現在の x と y 位置を設定する
  • SetY - 現在の y 位置を設定する
  • Text - 文字列をプリントする
  • Write - 次のテキストをプリントする

AcceptPageBreak

boolean AcceptPageBreak()

Version

1.4

Description

Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value. The default implementation returns a value according to the mode selected by SetAutoPageBreak().
This method is called automatically and should not be called directly by the application.

改ページする条件に遭遇したときにはいつでも,このメソッドが呼ばれます。そして,戻り値により改ページが行われ,また,行われません。標準の実行動作では SetAutoPageBreak() で選択したモードに従った値を戻します。
このメソッドは自動的に呼ばれ,アプリケーションから直接呼び出すべきではありません。

Example

The method is overriden in an inherited class in order to obtain a 3 column layout:

このメソッドは 3 段組のために継承したクラスでオーバーライドされます。

class PDF extends FPDF
{
var $col=0;

function SetCol($col)
{
    //Move position to a column
    $this->col=$col;
    $x=10+$col*65;
    $this->SetLeftMargin($x);
    $this->SetX($x);
}

function AcceptPageBreak()
{
    if($this->col<2)
    {
        //Go to next column
        $this->SetCol($this->col+1);
        $this->SetY(10);
        return false;
    }
    else
    {
        //Go back to first column and issue page break
        $this->SetCol(0);
        return true;
    }
}
}

$pdf=new PDF();
$pdf->Open();
$pdf->AddPage();
$pdf->SetFont('Arial','',12);
for($i=1;$i<=300;$i++)
    $pdf->Cell(0,5,"Line $i",0,1);
$pdf->Output();

See also

SetAutoPageBreak().

AddFont

AddFont(string family [, string style [, string file]])

Version

1.5

Description

Imports a TrueType or Type1 font and makes it available. It is necessary to generate a font definition file first with the makefont.php utility.
The definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by FPDF_FONTPATH if the constant is defined. If it could not be found, the error "Could not include font definition file" is generated.

TrueType または Type1 フォントをインポート,利用することが出来るようにします。まず最初に makefont.php ユーティリティーでフォント定義ファイルを生成する必要があります。
定義ファイル (and the font file itself when embedding) は現在のディレクトリと同じ場所または定義されているなら FPDF_FONTPATH で示した場所に存在する必要があります。フォント定義ファイルが見つからなければ,"Could not include font definition file" エラーとなります。

Parameters

family
Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.
family
フォントファミリー。この名前は任意に選択することができます。標準ファミリー名なら,そのフォントがオーバーライドされます。
style
Font style. Possible values are (case insensitive):
  • empty string: regular
  • B: bold
  • I: italic
  • BI or IB: bold italic

The default value is regular.

style
フォントのスタイル。使用可能な値はつぎのものです。大文字,小文字に無関係です。
  • empty string: 標準
  • B: 太字
  • I: 斜体
  • BI or IB: 太字斜体

デフォルト値は標準です。

file
The font definition file. By default, the name is built from the family and style, in lower case with no space.
file
フォントの定義ファイル。デフォルトにはファミリーとスタイルから組み立てた小文字,スペースなしの名前です。

Example

$pdf->AddFont('Comic','I');

is equivalent to:

$pdf->AddFont('Comic','I','comici.php');
$pdf->AddFOnt('Comic','I');

は次と同じです。

$pdf->AddFont('Comic','I','comici.php');

See also

SetFont().

AddLink

int AddLink()

Version

1.5

Description

Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document.
The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().

新しい内部リンクの作成とそのための識別子を戻します。内部リンクはそのドキュメントのほかの場所に導くクリックすることのできる範囲です。
識別子は Cell(), Write(), Image(), Link() に渡すことができます。リンクの先は SetLink() で定めます。

See also

Cell(), Write(), Image(), Link(), SetLink().

AddPage

AddPage([string orientation])

Version

1.0

Description

Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer. Then the page is added, the current position set to the top-left corner according to the left and top margins, and Header() is called to display the header. The font which was set before calling is automatically restored. There is no need to call SetFont() again if you want to continue with the same font. The same is true for colors and line width. The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.

ドキュメントに新しいページを追加します。ページがすでに存在するなら, Footer() メソッドがフッタを出力するためにまず呼び出されます。つぎに,ページが追加され,現在位置が左と上余白にしたがって左上すみに設定され,ヘッダを表示するために Header() が呼び出されます。 このメソッドを呼び出す前に設定したフォントは自動的に元に戻されます。これにより, 同じフォントで続けようとしたときに SetFont() を再び呼ぶ必要がありません。同じことが色と線の幅でもいえます。 座標系の原点は左上すみで下に行くにしたがって増加します。

Parameters

orientation
Page orientation. Possible values are (case insensitive):
  • P or Portrait
  • L or Landscape

The default value is the one passed to the constructor.

orientation
ページの向き。使用することのできる値は次のものです。大文字,小文字に無関係です。
  • P または Portrait
  • L または Landscape

デフォルト値はコンストラクタに渡したものです。

See also

FPDF(), Header(), Footer(), SetMargins().

AliasNbPages

AliasNbPages([string alias])

Version

1.4

Description

Defines an alias for the total number of pages. It will be substituted as the document is closed.

全ページ数のためのエイリアスを定義します。ドキュメントが閉じられるときに置換されます。

Parameters

alias
The alias. Default value: {nb}.
alias
エイリアス。デフォルトは {nb}

Example

class PDF extends FPDF
{
function Footer()
{
    //Go to 1.5 cm from bottom
    $this->SetY(-15);
    //Select Arial italic 8
    $this->SetFont('Arial','I',8);
    //Print current and total page numbers
    $this->Cell(0,10,'Page '.$this->PageNo().'/{nb}',0,0,'C');
}
}

$pdf=new PDF();
$pdf->AliasNbPages();

See also

PageNo(), Footer().

Cell

Cell(float w [, float h [, string txt [, mixed border 
       [, int ln [, string align [, int fill [, mixed link]]]]]]])

Version

1.0

Description

Prints a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.

オプションの枠,背景色,文字列とともにセル (四角形の範囲) をプリントします。セルの左上隅が現在位置に相当します。テキストは揃えるか中央に置くことができます。セルをプリントした後,現在位置を右または次の行に移動します。テキストにリンクを着けることができます。

Parameters

w
Cell width. If 0, the cell extends up to the right margin.
w
セルの幅。0 のときはセルが右余白に広げられます。
h
Cell height. Default value: 0.
h
セルの高さ。デフォルト値は 0 。
txt
String to print. Default value: empty string.
txt
プリントする文字列。デフォルト値は空文字列。
border
Indicates if borders must be drawn around the cell. The value can be either a number:
  • 0: no border
  • 1: frame

or a string containing some or all of the following characters (in any order):

  • L: left
  • T: top
  • R: right
  • B: bottom

Default value: 0.

border
セルの周りに枠線を描く必要のあるときに指定します。値は次のどちらかを指定することができます。
  • 0: 枠線なし
  • 1: フレーム

または,次の文字のどれかまたはすべてを含む文字列。(順不同)

  • L: 左
  • T: 上
  • R: 右
  • B: 下

デフォルト値は 0 。

ln
Indicates where the current position should go after the call. Possible values are:
  • 0: to the right
  • 1: to the beginning of the next line
  • 2: below

Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.

ln
セルのあとで現在の位置をどこへ移動するかを指定します。使用可能な値は次のものです。
  • 0: 右方向へ
  • 1: 次の行の開始位置へ
  • 2: 下へ

1 を指定するのは 0 を指定した後ですぐに Ln() を呼び出すことと同じことです。デフォルト値は 0 。

align
Allows to center or align the text. Possible values are:
  • L or empty string: left align (default value)
  • C: center
  • R: right align
align
テキストを中央または揃えることが出来るようにします。使用可能な値は次のものです。
  • L or empty string: 左ぞろへ (デフォルト値)
  • C: 中央ぞろへ
  • R: 右ぞろへ
fill
Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
fill
セルの背景を塗りつぶす (1) または透過 (0) する必要があるときに指定します。デフォルト値は 0 。
link
URL or identifier returned by AddLink().
link
URL または AddLink() で戻される識別子。

Example

//Set font
$pdf->SetFont('Arial','B',16);
//Move to 8 cm to the right
$pdf->Cell(80);
//Centered text in a framed 20*10 mm cell and line break
$pdf->Cell(20,10,'Title',1,1,'C');

See also

SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), AddLink(), Ln(), MultiCell(), Write(), SetAutoPageBreak().

Close

Close()

Version

1.0

Description

Terminates the PDF document. It is not necessary to call this method explicitly because Output() does it automatically.
If the document contains no page, AddPage() is called to prevent from getting an invalid document.

PDF ドキュメントを終了させます。自動的に Output() が行うためこのメソッドを明示的に呼び出す必要はありません。
ドキュメントがページを持たないとき, 無効なドキュメントを防ぐために AddPage() が呼び出されます。

See also

Open(), Output().

Error

Error(string msg)

Version

1.0

Description

This method is automatically called in case of fatal error; it simply outputs the message and halts the execution. An inherited class may override it to customize the error handling but should always halt the script, or the resulting document would probably be invalid.

Parameters

msg
The error message.

Footer

Footer()

Version

1.0

Description

This method is used to render the page footer. It is automatically called by AddPage() and Close() and should not be called directly by the application. The implementation in FPDF is empty, so you have to subclass it and override the method if you want a specific processing.

このメソッドはページのフッタを描くのに使用します。このメソッドは AddPage() と Close() に自動的に呼ばれ,アプリケーションから直接呼び出すべきではありません。このメソッドの FPDF での実行は空です。そのため,特定の処理を行いたいならサブクラスとこのメソッドをオーバーライドしなければいけません。

Example

class PDF extends FPDF
{
function Footer()
{
    //Go to 1.5 cm from bottom
    $this->SetY(-15);
    //Select Arial italic 8
    $this->SetFont('Arial','I',8);
    //Print centered page number
    $this->Cell(0,10,'Page '.$this->PageNo(),0,0,'C');
}
}

See also

Header().

FPDF

FPDF([string orientation [, string unit [, mixed format]]])

Version

1.0

Description

This is the class constructor. It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).

クラスのコンストラクタ。ページフォーマット,ページの向き,すべてのメソッドで使用される計測単位 (フォントサイズを除く) を設定することができます。

Parameters

orientation
Default page orientation. Possible values are (case insensitive):
  • P or Portrait
  • L or Landscape

Default value is P.

orientation
デフォルトのページの向き。使用可能な値は次のものです。(大文字,小文字に依存しない)
  • P または Portrait
  • L または Landscape

デフォルト値は P 。

unit
User measure unit. Possible values are:
  • pt: point
  • mm: millimeter
  • cm: centimeter
  • in: inch

A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.

Default value is mm.

unit
ユーザーの計測単位。使用することのできる値は次のものです。
  • pt: ポイント。
  • mm: ミリメートル。
  • cm: センチメートル。
  • in: インチ。

ポイントはインチの 1/72 に等しく, 0.35 mm です (インチが 2.54 cm とすると)。これはタイポグラフィーではとても一般的な単位です。フォントサイズはこの単位で表されます。

デフォルト値は mm です。

format
The format used for pages. It can be either one of the following values (case insensitive):
  • A3
  • A4
  • A5
  • Letter
  • Legal

or a custom format in the form of a two-element array containing the width and the height (expressed in the unit given by unit).

format
ページのフォーマット。次の値の一つとすることができます。(大文字,小文字に依存しません)
  • A3
  • A4
  • A5
  • Letter
  • Legal

または高さと幅を含んだ二つの要素の配列形式でのカスタムフォーマット (unit で与えた単位で表す)。

GetStringWidth

float GetStringWidth(string s)

Version

1.2

Description

Returns the length of a string in user unit. A font must be selected.

ユーザーが使用している単位で文字列の長さを戻します。フォントを選択する必要があります。

Parameters

s
The string whose length is to be computed.
s
長さを計算する文字列。

GetX

float GetX()

Version

1.2

Description

Returns the abscissa of the current position.

現在の位置の横座標を戻します。

See also

SetX(), GetY(), SetY().

GetY

float GetY()

Version

1.0

Description

Returns the ordinate of the current position.

現在の位置の縦座標を戻します。

See also

SetY(), GetX(), SetX().

Header

Header()

Version

1.0

Description

This method is used to render the page header. It is automatically called by AddPage() and should not be called directly by the application. The implementation in FPDF is empty, so you have to subclass it and override the method if you want a specific processing.

Example

class PDF extends FPDF
{
function Header()
{
    //Select Arial bold 15
    $this->SetFont('Arial','B',15);
    //Move to the right
    $this->Cell(80);
     //Framed title
    $this->Cell(30,10,'Title',1,0,'C');
    //Line break
    $this->Ln(20);
}
}

See also

Footer().

Image

Image(string file, float x, float y, float w 
   [, float h [, string type [, mixed link]]])

Version

1.1

Description

Prints an image in the page. The upper-left corner and at least one of the dimensions must be specified; the height or the width can be calculated automatically in order to keep the image proportions.

ページにイメージをプリントします。左上端角と範囲の少なくとも一つを指定する必要があります。高さまたは幅は画像の比率を保持するために自動的に計算することができます。

Supported formats are JPEG and PNG.

For JPEG, all flavors are allowed:

  • gray scales
  • true colors (24 bits)
  • CMYK (32 bits)

サポートしている画像フォーマットは JPEG と PNG です。

JPEG ではすべての種類を利用することができます。

  • グレースケール
  • true カラー (24 bits)
  • CMYK (32 bits)

For PNG, are allowed:

  • gray scales on at most 8 bits (256 levels)
  • indexed colors
  • true colors (24 bits)

but are not supported:

  • Interlacing
  • Alpha channel

PNG では次のものを利用することができます。

  • 8 bits (256 levels) 以上のグレースケール
  • indexed colors
  • true カラー (24 bits)

次のものはサポートされていません。

  • インターレース
  • アルファチャンネル

If a transparent color is defined, it will be taken into account (but will be only interpreted by Acrobat 4 and above).
The format can be specified explicitly or inferred from the file extension.
It is possible to put a link on the image.

透過色が定義されているなら,計算に入れられます。 (しかし, Acrobat 4 以上でしか解釈されません)
フォーマットは明示的またはファイルの拡張子から推測させることができます。
画像にリンクを置くことができます。

Remark: if an image is used several times, only one copy will be embedded in the file.

注目: 画像が複数回使用されるとき,一つのコピーのみがファイルに埋め込まれます。

Parameters

file
Name of the file containing the image.
file
画像を含んでいるファイル名
x
Abscissa of the upper-left corner.
x
左上の横座標
y
Ordinate of the upper-left corner.
y
左上の縦座標
w
Width of the image in the page. If equal to zero, it is automatically calculated to keep the original proportions.
w
ページでの画像の幅。ゼロのとき,もとの比率を保つように自動的に計算されます
h
Height of the image in the page. If not specified or equal to zero, it is automatically calculated to keep the original proportions.
h
ページでの画像高さ。指定しないまたはゼロのとき,もとの比率を保つように自動的に計算されます
type
Image format. Possible values are (case insensitive) : JPG, JPEG, PNG. If not specified, the type is inferred from the file extension.
type
画像のフォーマット。使用することができる値は次のものです (大文字小文字依存しない)。JPG, JPEG, PNG。指定しないときはファイルの拡張子から型が推測されます。
link
URL or identifier returned by AddLink().
link
URL または AddLink() で戻される識別子

See also

AddLink().

Line

Line(float x1, float y1, float x2, float y2)

Version

1.0

Description

Draws a line between two points.

二点間に線を描きます。

Parameters

x1
Abscissa of first point.
x1
最初の点の横座標。
y1
Ordinate of first point.
y1
最初の点の縦座標。
x2
Abscissa of second point.
x2
二番めの点の横座標。
y2
Ordinate of second point.
y2
二番めの点の縦座標。

See also

SetLineWidth(), SetDrawColor().

Link

Link(float x, float y, float w, float h, mixed link)

Version

1.5

Description

Puts a link on a rectangular area of the page. Text or image links are generally put via Cell(), Write() or Image(), but this method can be useful for instance to define a clickable area inside an image.

ページの四角形の範囲にリンクをおきます。テキストまたは画像のリンクは普通 Cell(), Write(), Image() でおきます。しかし,このメソッドはたとえば画像の中にクリックすることのできる範囲を定義するのに役に立ちます。

Parameters

x
Abscissa of the upper-left corner of the rectangle.
x
四角形の左上角の横座標。
y
Ordinate of the upper-left corner of the rectangle.
y
四角形の左上角の縦座標。
w
Width of the rectangle.
w
四角形の幅。
h
Height of the rectangle.
h
四角形の高さ。
link
URL or identifier returned by AddLink().
link
URL または AddLink() で戻される識別子。

See also

AddLink(), Cell(), Write(), Image().

Ln

Ln([float h])

Version

1.0

Description

Performs a line break. The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.

改行を実行します。現在の横座標は左余白に戻り,パラメータに渡した量だけ原点を増加します。

Parameters

h
The height of the break.
By default, the value equals the height of the last printed cell.
h
改行高さ。~デフォルトでは最後にプリントしたセルの高さに等しい値。

See also

Cell().

MultiCell

MultiCell(float w, float h, string txt [, mixed border [, string align [, int fill]]])

Version

1.3

Description

This method allows printing text with line breaks. They can be automatic (as soon as the text reaches the right border of the cell) or explicit (via the \n character). As many cells as necessary are output, one below the other.
Text can be aligned, centered or justified. The cell block can be framed and the background painted.

このメソッドは改行を伴ってテキストをプリントすることが出来るようにします。これらは自動的に行うことができ (セルの右枠にテキストが到達するとすぐに),または明示的に (\n で)。As many cells as necessary are output, one below the other.
テキストをそろへ,中央ぞろへ,割付できます。セルブロックは枠をつけ,背景を塗りつぶすことができます。

Parameters

w
Width of cells. If 0, they extend up to the right margin of the page.
w
セルの幅。 0 のとき,ページの右余白まで広げられます。
h
Height of cells.
h
セルの高さ。
txt
String to print.
txt
プリントする文字列。
border
Indicates if borders must be drawn around the cell block. The value can be either a number:
  • 0: no border
  • 1: frame

or a string containing some or all of the following characters (in any order):

  • L: left
  • T: top
  • R: right
  • B: bottom

Default value: 0.

border
セルのブロックの周囲に枠線を描くときに指示します。値は次の数値を使用することができます。
  • 0:枠線なし。
  • 1:フレーム。

または,次の文字のいくつかまたはすべてを含んだ文字列 (順番に関係なく)。

  • L: 左。
  • T: 上。
  • R: 右。
  • B: 下。
align
Sets the text alignment. Possible values are:
  • L: left alignment
  • C: center
  • R: right alignment
  • J: justification (default value)
align
テキストのそろへを設定します。使用することのできる値は次のものです。
  • L: 左ぞろへ。
  • C: 中央。
  • R: 右ぞろへ。
  • J:
fill
Indicates if the cell background must be painted (1) or transparent (0). Default value: 0.
fill
セルの背景を描く (1) または透明にする (0) かを指定します。デフォルト値は 0 です。

See also

SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), Cell(), Write(), SetAutoPageBreak().

Open

Open()

Version

1.0

Description

This method begins the generation of the PDF document; it must be called before any output commands. No page is created by this method, therefore it is necessary to call AddPage().

このメソッドは PDF ドキュメントの生成を開始します。アウトプットコマンドの前に呼び出さなければいけません。このメソッドではページは作成されません。したがって, AddPage() を呼び出す必要があります。

See also

AddPage(), Close().

Output

Output([string file [, boolean download]])

Version

1.0

Description

Saves the PDF document in a local file or sends it to the browser. In the last case, the plug-in may be used (if present) or a download ("Save as" dialog box) may be forced.
The method first calls Close() if necessary to terminate the document.

PDF ドキュメントをローカルファイルとして保存またはブラウザーに送信します。後の場合,プラグインを使用する (存在するとき),またはダウンロード (「名前を付けて保存」ダイアログボックス) させます。
ドキュメントを終了させる必要があるときは,このメソッドは最初に Close() を呼びます。

Parameters

file
The name of the file. If empty or not given, the document will be sent to the browser which will then use the plug-in (if available).
file
ファイル名。空または与えないときは,ドキュメントをプラグインを使用する (利用することができるとき) ブラウザーに送信します。
download
If file was specified, indicates whether it must be saved locally (false) or cause a Save as dialog box by the browser. Default value: false.
download
ファイルが指定されているとき,ローカルに保存するべきかを示し (false) または,ブラウザーに名前を付けて保存ダイアログを表示させます。デフォルト値は false です。

See also

Close().

PageNo

int PageNo()

Version

1.0

Description

Returns the current page number.

現在のページ番号を戻します。

See also

AliasNbPages().

Rect

Rect(float x, float y, float w, float h [, string style])

Version

1.0

Description

Outputs a rectangle. It can be drawn (border only), filled (with no border) or both.

四角形を出力します。描く (枠線のみ),塗る (枠線なし),または両方が可能です。

Parameters

x
Abscissa of upper-left corner.
x
左上角の横座標。
y
Ordinate of upper-left corner.
y
左上角の縦座標。
w
Width.
w
幅。
h
Height.
h
高さ。
style
Style of rendering. Possible values are:
  • D or empty string: draw. This is the default value.
  • F: fill
  • DF or FD: draw and fill
style
描写スタイル。使用可能な値は次のものです。
  • D or または空文字列。これはデフォルト値です。
  • F: 塗り。
  • DF or FD: 枠線と塗り。

See also

SetLineWidth(), SetDrawColor(), SetFillColor().

SetAuthor

SetAuthor(string author)

Version

1.2

Description

Defines the author of the document.

ドキュメントの著者を定めます。

Parameters

author
The name of the author.
author
著者名。

See also

SetCreator(), SetKeywords(), SetSubject(), SetTitle().

SetAutoPageBreak

SetAutoPageBreak(boolean auto [, float margin])

Version

1.0

Description

Enables or disables the automatic page breaking mode. When enabling, the second parameter is the distance from the bottom of the page that defines the triggering limit. By default, the mode is on and the margin is 2 cm.

自動改ページモードを有効または無効にします。有効にしたとき,二番めの引数が改ページの引き金を定義するページの下からの距離です。デフォルトではモードは有効で余白は 2 cm です。

Parameters

auto
Boolean indicating if mode should be on or off.
auto
モードを有効または無効にするとき指定する boolean 型。
margin
Distance from the bottom of the page.
margin
ページの下からの距離。

See also

Cell(), MultiCell(), AcceptPageBreak().

SetCompression

SetCompression(boolean compress)

Version

1.4

Description

Activates or deactivates page compression. When activated, the internal representation of each page is compressed, which leads to a compression ratio of about 2 for the resulting document.
Compression is on by default.

ページの圧縮をアクティブまたは非アクティブにします。アクティブのときそれぞれのページの内部表記が圧縮されます。圧縮の結果得られるドキュメントの圧縮比は約 2 です。
圧縮はデフォルトで行われます。

Note: the Zlib extension is required for this feature. If not present, compression will be turned off.

注意: この機能には Zlib 拡張が必要です。Zlib 拡張が存在しないときには圧縮はオフに切り替えられます。

Parameters

compress
Boolean indicating if compression must be enabled.
compress
圧縮を有効にする必要があるとき指定する boolean 型。

SetCreator

SetCreator(string creator)

Version

1.2

Description

Defines the creator of the document. This is typically the name of the application that generates the PDF.

ドキュメントの作成者を設定します。これは一般的に PDF を生成するアプリケーション名です。

Parameters

creator
The name of the creator.
creator
製作者名。

See also

SetAuthor(), SetKeywords(), SetSubject(), SetTitle().

SetDisplayMode

SetDisplayMode(mixed zoom [, string layout])

Version

1.2

Description

Defines the way the document is to be displayed by the viewer. The zoom level can be set: pages can be displayed entirely on screen, occupy the full width of the window, use real size, be scaled by a specific zooming factor or use viewer default (configured in the Preferences menu of Acrobat). The page layout can be specified too: single at once, continuous display, two columns or viewer default.
By default, documents use the full width mode with continuous display.

ビューワーでドキュメントを表示する方法を決めます。ズームレベルを設定することができます。ページ全体をスクリーンに表示する,ウィンドウの幅全体を占める,実際のサイズを使用する,特定のズームファクターでスケールする,ビューワーのデフォルト値を使用する (Acrobat の Preference メニューで設定する) ことができます。ページのレイアウトも指定することができます。一度に一ページ表示,連続表示,二段表示,ビューワーのデフォルト。
デフォルトではドキュメントは連続表示での全体表示を使用します。

Parameters

zoom
The zoom to use. It can be one of the following string values:
  • fullpage: displays the entire page on screen
  • fullwidth: uses maximum width of window
  • real: uses real size (equivalent to 100% zoom)
  • default: uses viewer default mode

or a number indicating the zooming factor to use.

zoom
使用するズーム値。次の文字列の一つとすることができます。
  • fullpage: スクリーンにページ全体を表示する。
  • fullwidth: ウィンドウの最大幅を使用する。
  • real: 実際のサイズを使用する (100% ズームと同じ)。
  • default: ビューワーのデフォルトモードを使用する。

または,使用するズームファクターを指定する数値。

layout
The page layout. Possible values are:
  • single: displays one page at once
  • continuous: displays pages continuously
  • two: displays two pages on two columns
  • default: uses viewer default mode

Default value is continuous.

layout
ページレイアウト。使用することのできる値は次のものです。
  • single: 一度に一ページを表示する。
  • continuous: ページを連続表示する。
  • two: 二つのカラムで二ページ表示する。
  • default: ビューワーのデフォルトモードを使用する。

デフォルト値は continuous 。

SetDrawColor

SetDrawColor(int r [, int g, int b])

Version

1.3

Description

Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.

すべての描写動作 (線,四角形,セルの枠線) の色を決める。RGB 成分またはグレースケールで表現することができます。このメソッドは最初のページが作成される前に呼び出すことができ,ページからページへ値は保持されます。

Parameters

r
If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255.
r
g および b を与えたとき,赤の成分。g と b を与えないならグレーレベルを示します。値は 0 から 255 。
g
Green component (between 0 and 255).
g
緑の成分 (0 から 255)
b
Blue component (between 0 and 255).
b
青の成分 (0 から 255)

See also

SetFillColor(), SetTextColor(), Line(), Rect(), Cell(), MultiCell().

SetFillColor

SetFillColor(int r [, int g, int b])

Version

1.3

Description

Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.

塗りの動作 (塗られた四角形,セルの背景) に使用される色を決めます。このメソッドは最初のページが作成される前に呼び出すことができ,ページからページへ値は保持されます。

Parameters

r
If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255.
r
g および b を与えたとき,赤の成分。g と b を与えないならグレーレベルを示します。値は 0 から 255 。
g
Green component (between 0 and 255).
g
緑の成分 (0 から 255)
b
Blue component (between 0 and 255).
b
青の成分 (0 から 255)

See also

SetDrawColor(), SetTextColor(), Rect(), Cell(), MultiCell().

SetFont

SetFont(string family [, string style [, float size]])

Version

1.0

Description

Sets the font used to print character strings. It is mandatory to call this method at least once before printing text or the resulting document would not be valid. The font can be either a standard one or a font added via the AddFont() method. Standard fonts use Windows encoding cp1252 (Western Europe). The method can be called before the first page is created and the font is retained from page to page. If you just wish to change the current font size, it is simpler to call SetFontSize().

文字列をプリントするために使用するフォントを設定します。テキストをプリントする前に少なくとも一度はこのメソッドを呼出さなければいけません。そうしなければ結果として得られるドキュメントは有効には成らないでしょう。 フォントは標準のものまたは AddFont() メソッドで追加したフォントのどちらかにすることができます。標準のフォントは Windows エンコード cp1252 (Western Europe) を使用します。 このメソッドは最初のページが作成される前に呼び出すことができ,フォントをページからページへ同じものに保つことができます。 現在のフォントサイズを変更したいときは SetFontSize() を呼び出すのが簡単です。

Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:

  • They are in the current directory (the one where the running script lies)
  • They are in one of the directories defined by the include_path parameter
  • They are in the directory defined by the FPDF_FONTPATH constant

Example for the last case (note the trailing slash):

define('FPDF_FONTPATH','/home/www/font/');
require('fpdf.php');

If the file corresponding to the requested font is not found, the error "Could not include font metric file" is generated.

Parameters

family
Family font. It can be either a name defined by AddFont() or one of the standard families (case insensitive):
  • Courier (fixed-width)
  • Helvetica or Arial (synonymous; sans serif)
  • Times (serif)
  • Symbol (symbolic)
  • ZapfDingbats (symbolic)

It is also possible to pass an empty string. In that case, the current family is retained.

style
Font style. Possible values are (case insensitive):
  • empty string: regular
  • B: bold
  • I: italic
  • U: underline

or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats.

size
Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12.

Example

//Times regular 12
$pdf->SetFont('Times');
//Arial bold 14
$pdf->SetFont('Arial','B',14);
//Removes bold
$pdf->SetFont('');
//Times bold, italic and underlined 14
$pdf->SetFont('Times','BIU');

See also

AddFont(), SetFontSize(), Cell(), MultiCell(), Write().

SetFontSize

SetFontSize(float size)

Version

1.0

Description

Defines the size of the current font.

現在のフォントサイズを指定します。

Parameters

size
The size (in points).

See also

SetFont().

SetKeywords

SetKeywords(string keywords)

Version

1.2

Description

Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.

ドキュメントとキーワードを関連付けます。通常, 'keyword1 keyword2 ...' の形式です。

Parameters

keywords
The list of keywords.
keywords
キーワードのリスト。

See also

SetAuthor(), SetCreator(), SetSubject(), SetTitle().

SetLeftMargin

SetLeftMargin(float margin)

Version

1.4

Description

Defines the left margin. The method can be called before creating the first page.
If the current abscissa gets out of page, it is brought back to the margin.

左余白を決めます。このメソッドは最初のページを作成する前に呼び出すことができます。
現在の横座標がページの外にあるなら,余白を回復させます。

Parameters

margin
The margin.
margin
余白。

See also

SetTopMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins().

SetLineWidth

SetLineWidth(float width)

Version

1.0

Description

Defines the line width. By default, the value equals 0.2 mm. The method can be called before the first page is created and the value is retained from page to page.

線の幅を決めます。デフォルトでは値は 0.2 mm です。このメソッドは最初のページを作成する前に呼び出すことができ,ページからページへ値は保持されます。

Parameters

width
The width.
width
幅。

See also

Line(), Rect(), Cell(), MultiCell().

SetLink

SetLink(int link [, float y [, int page]])

Version

1.5

Description

Defines the page and position a link points to.

ページとリンクを示す位置を決める。

Parameters

link
The link identifier returned by AddLink().
link
AddLink() で戻されたリンク識別子。
y
Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page).
y
ターゲット位置の縦座標。; -1 は現在の位置を示す。デフォルト値は 0 (ページの一番上)
page
Number of target page; -1 indicates the current page. This is the default value.
page
ターゲットのページ。; -1 は現在のページを示す。デフォルト値は 0 。

See also

AddLink().

SetMargins

SetMargins(float left, float top [, float right])

Version

1.0

Description

Defines the left, top and right margins. By default, they equal 1 cm. Call this method to change them.

左,上,右余白を設定します。デフォルトでは,全て 1 cm です。これらの余白を変更するためにこのメソッドを呼び出します。

Parameters

left
Left margin.
left
左余白。
top
Top margin.
top
上余白。
right
Right margin. Default value is the left one.
right
右余白。デフォルト値は左余白と同じ。

See also

SetLeftMargin(), SetTopMargin(), SetRightMargin(), SetAutoPageBreak().

SetRightMargin

SetRightMargin(float margin)

Version

1.5

Description

Defines the right margin. The method can be called before creating the first page.

右余白を決めます。このメソッドは最初のページを作成する前に呼び出すことができます。

Parameters

margin
The margin.
margin
余白。

See also

SetLeftMargin(), SetTopMargin(), SetAutoPageBreak(), SetMargins().

SetSubject

SetSubject(string subject)

Version

1.2

Description

Defines the subject of the document.

ドキュメントのテーマを定めます。

Parameters

subject
The subject.
subject
テーマ。

See also

SetAuthor(), SetCreator(), SetKeywords(), SetTitle().

SetTextColor

SetTextColor(int r [, int g, int b])

Version

1.3

Description

Defines the color used for text. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.

テキストに使用する色を決めます。このメソッドは最初のページが作成される前に呼び出すことができ,ページからページへ値は保持されます。

Parameters

r
If g et b are given, red component; if not, indicates the gray level. Value between 0 and 255.
r
g および b を与えたとき,赤の成分。g と b を与えないならグレーレベルを示します。値は 0 から 255 。
g
Green component (between 0 and 255).
g
緑の成分 (0 から 255)
b
Blue component (between 0 and 255).
b
青の成分 (0 から 255)

See also

SetDrawColor(), SetFillColor(), Text(), Cell(), MultiCell().

SetTitle

SetTitle(string title)

Version

1.2

Description

Defines the title of the document.

ドキュメントのタイトルを定めます。

Parameters

title
The title.
title
タイトル。

See also

SetAuthor(), SetCreator(), SetKeywords(), SetSubject().

SetTopMargin

SetTopMargin(float margin)

Version

1.5

Description

Defines the top margin. The method can be called before creating the first page. 上余白を決めます。このメソッドは最初のページを作成する前に呼び出すことができます。

Parameters

margin
The margin.
margin
余白。

See also

SetLeftMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins().

SetX

SetX(float x)

Version

1.2

Description

Defines the abscissa of the current position. If the passed value is negative, it is relative to the right of the page.

現在の位置の横座標を定義します。渡した値が負の値のときはページの右から相対的になります。

Parameters

x
The value of the abscissa.
x
横座標の値。

See also

GetX(), GetY(), SetY(), SetXY().

SetXY

SetXY(float x, float y)

Version

1.2

Description

Defines the abscissa and ordinate of the current position. If the passed values are negative, they are relative respectively to the right and bottom of the page.

現在の位置の縦横座標を定義します。渡した値が負の値のときはページの右としたから相対的になります。

Parameters

x
The value of the abscissa.
x
横座標の値。
y
The value of the ordinate.
y
縦座標の値。

See also

SetX(), SetY().

SetY

SetY(float y)

Version

1.0

Description

Moves the current abscissa back to the left margin and sets the ordinate. If the passed value is negative, it is relative to the bottom of the page.

現在の横座標を左余白と縦軸の設定に移動します。渡した値が負のときはページの下から相対的になります。

Parameters

y
The value of the ordinate.
y
縦座標の値。

See also

GetX(), GetY(), SetX(), SetXY().

Text

Text(float x, float y, string txt)

Version

1.0

Description

Prints a character string. The origin is on the left of the first charcter, on the baseline. This method allows to place a string precisely on the page, but it is usually easier to use Cell(), MultiCell() or Write() which are the standard methods to print text.

文字列をプリントします。原点はベースライン上の最初の文字の左です。このメソッドはページに文字列を正確に配置することを可能にします。しかし,テキストをプリントする標準のメソッドの Cell(), MultiCell(), Write() を使用すると普通は容易です。

Parameters

x
Abscissa of the origin.
x
原点の横座標。
y
Ordinate of the origin.
y
原点の縦座標。
txt
String to print.
txt
プリントする文字列。

See also

SetFont(), SetTextColor(), Cell(), MultiCell(), Write().

Write

Write(float h, string txt [, mixed link])

Version

1.5

Description

This method prints text from the current position. When the right margin is reached (or the \n character is met) a line break occurs and text continues from the left margin. Upon method exit, the current position is left just at the end of the text.
It is possible to put a link on the text.

このメソッドは現在の位置からテキストをプリントしていきます。右余白に達したとき (または \n 文字に出合ったとき) 改行され左余白からテキストが継続されます。メソッドを出ると,現在の位置はテキスト終わりの左端です。
テキストにリンクを付けることができます。

Parameters

h
Line height.
h
行高さ。
txt
String to print.
txt
プリントする文字列。
link
URL or identifier returned by AddLink().
link
URL または AddLink() で戻される識別子。

Example

//Begin with regular font
$pdf->SetFont('Arial','',14);
$pdf->Write(5,'Visit ');
//Then put a blue underlined link
$pdf->SetTextColor(0,0,255);
$pdf->SetFont('','U');
$pdf->Write(5,'www.fpdf.org','http://www.fpdf.org');

See also

SetFont(), SetTextColor(), AddLink(), MultiCell(), SetAutoPageBreak().


Reload   New Lower page making Edit Freeze Diff Upload Copy Rename   Front page List of pages Search Recent changes Backup   Help   RSS of recent changes