| Current Path : /var/www/html/mmishra/mm/ada/Doc/ |
| Current File : /var/www/html/mmishra/mm/ada/Doc/interface_page.html |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>VersyPHP Documentation</title>
</head>
<body style="color: rgb(8, 38, 176); font-size: 20px; table-layout: fixed; margin-left: 35px; width: 872px; margin-top: 26px; height: 249px;" text="">
<table style="width: 878px; height: 54px;" align="center" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td align="left" width="30%">
<img src="logo.gif" align="middle" border="0" height="50" width="85">
</td>
<td style="width: 45%;" align="right">
<h1 style="font-size: 10pt;"> VESRYPDF.PHP DOCUMENATION </h1>
</td>
</tr>
</tbody>
</table>
</table>
<h2 style="color: rgb(71, 38, 125); font-family: serif; font-size: 12pt;">VersyPDF Pages' manipulation Interface</h2>
<h3 style="color: rgb(71, 38, 125); font-family: serif; font-size: 11pt;">FUNCTIONS:</h3>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfpage_get_content_count</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>Page Content Streams Count.</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b>[in] PDF Document Handle.
<br><b>$Page -</b>[in] Page Index in PDF Document.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>Page Content Streams Count.</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">$Count = pdfpage_get_content_count( $Doc, $Page );</td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfpage_get_cos_object</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>Get Page Object Handle.</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b>[in] PDF Document Handle.
<br><b>$Page -</b>[in] Page Index in PDF Document.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>Page Object Handle. Cos object must be free after use</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">$CosObject = pdfpage_get_cos_object( $Doc, $Page );</td>
</tr>
<tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfpage_set_rotate_angle</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>Set Rotation Angle of Page.</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b>[in] PDF Document Handle.
<br><b>$Page -</b>[in] Page Index in PDF Document.
<br><b>$Angle -</b>[in] Page Rotation Angle by which the page displayed or printed should be rotated clockwise
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>None.</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">pdfpage_set_rotate_angle( $Doc, $Page, $Angle );</td>
</tr>
<tr>
<td width="15%">See also :</td>
<td>pdfpage_get_rotate_angle, PRA_* constants.</td></tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfpage_get_rotate_angle</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>Get Rotation Angle of Page.</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b>[in] PDF Document Handle.
<br><b>$Page -</b>[in] Page Index in PDF Document.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>Page Rotation Angle by which the page displayed or printed should be rotated clockwise.</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">$Angle = pdfpage_get_rotate_angle( $Doc, $Page );</td>
</tr>
<tr>
<td width="15%">See also :</td>
<td>pdfpage_set_rotate_angle, PRA_* constants.</td></tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfpage_get_box</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>Get Typed Rectangle PageBox.</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b>[in] PDF Document Handle.
<br><b>$Page -</b>[in] Page Index in PDF Document.
<br><b>$Type - </b>[in] PageBox Type for request.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>PageBox Typed Rectangle.</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">$Rect = pdfpage_get_box( $Doc, $Page, $Type );</td>
</tr>
<tr>
<td width="15%">See also :</td>
<td>pdfpage_set_box, PBN_* constants</td></tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfpage_set_box</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>Set Typed Rectangle PageBox.</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b>[in] PDF Document Handle.
<br><b>$Page -</b>[in] Page Index in PDF Document.
<br><b>$Type - </b>[in] PageBox Type for request.
<br><b>$Rect - </b>[in] PageBox Rectangle.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>None.</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">pdfpage_set_box( $Doc, $Page, $Type, $Rect );</td>
</tr>
<tr>
<td width="15%">See also :</td>
<td>pdfpage_get_box, PBN_* constants, ul_rect_get.</td></tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>ul_rect_get</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td> Create PDF Rectangle
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$xl -</b> [ in ] Rectangle left top corner 'x' coordinate
<br><b>$yl -</b> [ in ] Rectangle left top corner 'y' coordinate
<br><b>$xr -</b> [ in ] Rectangle right bottom corner 'x' coordinate
<br><b>$yr -</b> [ in ] Rectangle right bottom corner 'y' coordinate
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>Pointer to PDF Rectangle Handle</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">$Rect = ul_rect_get( $xl, $yl, $xr, $yr ); </td>
</tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfpage_add_content</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>Add void Content to Page Content Streams.</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b>[in] PDF Document Handle.
<br><b>$Page -</b>[in] Page Index in PDF Document.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>Page Content Streams Count..</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">$Count = pdfpag_add_content( $Doc, $Page );</td>
</tr>
<tr>
<td width="15%">See also :</td>
<td>pdfpage_get_content_count</td></tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfpage_insert_content</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td> Insert void Content to Page Content Streams in Indexed Site.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b>[in] PDF Document Handle.
<br><b>$Page -</b>[in] Page Index in PDF Document.
<br><b>$Index -</b> [in] Content Index for inserting.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>Index of void Page Content in Content Streams.</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">$Index = pdfpage_insert_content( $Doc, $Page, $Index );</td>
</tr>
<tr>
<td width="15%">See also :</td>
<td>pdfpage_remove_content</td></tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfpage_remove_content</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td> Remove Content from Page Content Streams according to index.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b>[in] PDF Document Handle.
<br><b>$Page -</b>[in] Page Index in PDF Document.
<br><b>$Index -</b> [in] Content Index for inserting.
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>None.</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">pdfpage_remove_content( $Doc, $Page, $Index );</td>
</tr>
<tr>
<td width="15%">See also :</td>
<td>pdfpage_insert_content</td></tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfpage_create_paint_box</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td> Create Paint Box for Last Page Content with defined resolution.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b>[in] PDF Document Handle.
<br><b>$Page -</b>[in] Page Index in PDF Document.
<br><b>$Resolution -</b> [in] Points per inch (dpi).
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>Paint Box Handle.</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">$PaintBox = pdf_page_create_paint_box( $Doc, $Page, $Resolution );</td>
</tr>
<tr>
<td width="15%">See also :</td>
<td>pdfpage_create_paint_box_from_content</td></tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfpage_create_paint_box_from_content</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td> Create Paint Box for Page Content according to index with defined resolution.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b>[in] PDF Document Handle.
<br><b>$Page -</b>[in] Page Index in PDF Document.
<br><b>$Index -</b>[in] Content's Index in Page Content Streams.
<br><b>$Resolution -</b> [in] Points per inch (dpi).
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>Paint Box Handle.</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">$Paintox = pdfpage_create_paint_box_from_content( $Doc, $Page, $Index, $Resolution );
</td>
</tr>
<tr>
<td width="15%">See also :</td>
<td>pdfpage_create_paint_box</td></tr>
</table><br>
<table style="color : black; font-family : serif; font-size : 10pt; width : 100%;" border="1">
<b>pdfpage_create_paint_box_and_repack_contents</b>
<tr>
<td width="15%"><b>Description :</b></td>
<td>Repack all contents of the page and wrap it with push and pop garaphic state after it create PaintBox.
</td>
</tr>
<tr><td width="15%"><b>Parameters :</b></td>
<td><b>$Doc -</b>[in] PDF Document Handle.
<br><b>$Page -</b>[in] Page Index in PDF Document.
<br><b>$Resolution -</b> [in] Points per inch (dpi).
</td>
</tr>
<tr> <td width="15%"><b>Returns:</b></td>
<td>Paint Box Handle.</td>
</tr>
<tr><td width="15%"><b>Use :</b></td>
<td style="color : brown;">$PaintBox = pdfpage_create_paint_box_and_repack_contents( $Doc, $Page, $Resolution );</td>
</tr>
<tr>
<td width="15%">See also :</td>
<td>pdfpage_create_paint_box_from_content</td></tr>
</table><br>
/* Description
Parameters
Doc : [in] PDF Document Handle.
Page : [in] Page Index in PDF Document.
Resolution : [in] Points per inch (dpi).
Returns
Paint Box Handle..*/
LIB_API PBXHandle ( PDFDocHandle Doc, ppUns32 Page, ppUns32 Resolution);
</body></html>