Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

DynaPDF Manual - Page 675

Previous Page 674   Index   Next Page 676

Function Reference
Page 675 of 750
SetLineAnnotParms
Syntax:
LBOOL pdfSetLineAnnotParms(
const PPDF* IPDF, // Instance pointer
UI32 Handle,
// Handle of a line annotation
SI32 FontHandle,
// Font handle or -1 for Helvetica
double FontSize,
// Font size of the caption or zero
struct TLineAnnotParms* Parms) // Can be NULL to delete all measure
// line specific values
typedef enum
{
cpInline, // The caption is centered inside the line
cpTop
// The caption is drawn on top of the line
}TLineCaptionPos;
struct TLineAnnotParms
{
UI32 StructSize;
// Must be set to sizeof(TLineAnnotParms)
LBOOL Caption;
// See description
float CaptionOffsetX;
// Horizontal offset of the caption
float CaptionOffsetY;
// Vertical offset of the caption
TLineCaptionPos CaptionPos; // See enum TLineCaptionPos
float LeaderLineLen;
// Length of the leader lines
float LeaderLineExtend; // Leader line extend (must be positive or 0)
float LeaderLineOffset; // Amount of space between the endpoints of the
// annotation and the leader lines (must be a
// positive value or zero)
};
The function sets or changes the properties of a line annotation relating to measure lines. The
parameter Parms can be set to NULL to delete all measure line specific values. The parameters
FontHandle and FontSize will be ignored in this case.
The member Caption specifies whether the parameter Content of the function LineAnnot() should be
used as caption of the measure line. Although a measure line can display the string in a PopUp
annotation like ordinary line annotations, this is not recommended and not fully supported in
Adobe's Acrobat or Reader.
If Caption is true (recommended), the caption is drawn horizontally centered either on top or inside
the measure line. The text position can be changed from its normal position with the members
CaptionOffsetX and CaptionOffsetY.
The parameter FontHandle can be used to specify an arbitrary font that should be used to draw the
caption. Although it is possible to use any font or font size greater 0 with DynaPDF, a PDF viewer
will change the font and font size to it's default values when the annotation will be edited since line
annotations support no property to specify the font or font size.
 

Previous topic: SetLicenseKey

Next topic: SetLineCapStyle