Xojo Conferences

DynaPDF Manual - Page 693

Previous Page 692   Index   Next Page 694

Function Reference
Page 693 of 750
A return value of zero indicates that the alignment must not be changed. Negative return values
break processing immediately. WriteFText() returns then with a warning.
When the callback function is called, the coordinate system is always bottom-up, it can be changed to
top-down coordinates inside the callback function if necessary. The current page is still open, the
page must be closed with EndPage() before a new page can be added or opened with Append() or
EditPage(). To determine the current page number, call GetPageNum().
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
LBOOL pdfSetOpacity(
const PPDF* IPDF, // Instance pointer
double Value)
// 1.0 = opaque, 0.0 = invisible
The function sets the opacity value which is used to render the appearance of a text annotation. The
parameter Value must be in the range 0.0 to 1.0. If Value is zero the annotation is invisible, if Value is
1.0, the annotation is completely opaque.
At time of publication the opacity property is used for text annotations only. Later versions of
DynaPDF use this property may be for other PDF objects too.
Default value = 1.0
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
LBOOL pdfSetOrientation(
const PPDF* IPDF, // Instance pointer
SI32 Value)
// Orientation of the page
The function sets the orientation of a page. The parameter Value must be a multiple of 90 or 0.
Positive values rotate the page clockwise, negative counter counter clockwise.
The page orientation is a property that is applied dynamically at viewing or printing time. It does
not change the page's coordinate system or any object in the page description.
To create a true landscape paper format the page's coordinate system must be rotated into the
opposite direction. This can be done with SetOrientationEx(). Another way to create a landscape
paper format is to change the bounding box of the page, see SetBBox().

Previous topic: SetOnPageBreakProc

Next topic: SetOrientationEx