- Created by martinajindrova, last modified on Mar 22, 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 14 Next »
Properties:
PageCount | |
---|---|
The total number of pages in the XFF document (numeric) |
Methods:
AddPage() | |
---|---|
Adds a new page at the end of the document. Syntax: XFRXDraw::AddPage([tcPageSize]) Or XFRXDraw::AddPage(tnPageWidth, tnPageHeight) Parameters: tcPageSize tnPageWidth, tnPageHeight If no page size is specified, the current page size is used. | |
CreateDocument() | |
| Creates a new XFF file. Syntax: XFRXDraw::CreateDocument([tcFileName]) Return values .T. … the file was successfully created
An existing file is overwritten. Parameters: tcFileName |
DrawLine() | |
Draws a line on the current page. Syntax: XFRXDraw::DrawLine(tnXPos, tnYPos, tnXToPos, tnYToPos [, tnLineWidth[, tnPenPattern]]) Parameters: tnXPos, tnYPos tnXToPos, tnYToPos tnLineWidth tnPenPattern Optional, default value = 8. | |
DrawPicture() | |
Draws a picture on the current page into a given bounding rectangle. Syntax: XFRXDraw::DrawPicture(tnXPos, tnYPos, tnWidth, tnHeight, tcFilename[, tnAdjType [, llCentralHorizontaly[, tnRotate[, tnRotationPoint[, tcLinkName[, tcLinkRef]]]]]]) Parameters: tnXPos, tnYPos tnWidth tnHeight tcFileName tnAdjType llCentralHorizontaly tnRotate tnRotationPoint The point within the rectangle around which the text is rotated. The allowed values are 0..8, optional, default value = 0 (left, top). Please see the picture on the right for the point positions (since XFRX 15.7). tcLinkName tcLinkRef | |
DrawGeneralField() | |
Draws a picture on the current page into a given bounding rectangle. (since XFRX 16.1) Syntax: XFRXDraw::DrawGeneralField(tnXPos, tnYPos, tnWidth, tnHeight, tcFieldName[, tnAdjType [, llCentralHorizontaly[, tnRotate [, tnRotationPoint[, tcLinkName [, tcLinkRef]]]]]]) Parameters: tnXPos, tnYPos tnWidth tnHeight tcFieldName tnAdjType llCentralHorizontaly tnRotate tnRotationPoint The point within the rectangle around which the text is rotated. The allowed values are 0..8, optional, default value = 0 (left, top). Please see the picture on the right for the point positions . tcLinkName tcLinkRef | |
DrawRectangle() | |
| Draws a rectangle on the current page. Syntax: XFRXDraw::DrawRectangle(tnXPos, tnYPos, tnWidth, tnHeight [, tnLineWidth [, tnFillPattern [, tnPenPattern[, tnRoundFactor [, tnMode]]]]]) Parameters: tnXPos, tnYPos tnWidth tnHeight tnLineWidth tnFillPattern Optional, default value = 0. tnPenPattern Optional, default value = 8. tnRoundFactor tnMode Optional, default value = 0. The border and fill color needs to be defined via SetColor() method before calling DrawRectangle() method. |
DrawText() | |
Draws a text, using a font defined by SetFont method. Syntax: XFRXDraw::DrawText(tnLeft, tnTop, tcText [, tnRotate[, tcLinkName[, tcLinkRef[, tcBookmark [, tcTooltip[, tnmode[, liCP]]]]]]]) Or XFRXDraw::DrawText(tcText[, tnRotate[, tcLinkName[, tcLinkRef[, tcBookmark[, tcTooltip[, tnmode[, liCP]]]]]]]) Parameters: tnLeft, tnTop tcText tnRotate tcLinkName tcLinkRef tcBookmark tcTooltip tnMode liCP | |
DrawTextBox() | |
Word wraps the give text and print it into a given bounding rectangle. If the height of the rectangle is zero, then the rectangle stretches to accommodate to full text and the height of the rectangle is returned. Syntax: XFRXDraw::DrawTextBox(tnLeft, tnTop, tnWidth, tnHeight, tcText[, tnAlign[, tnVAlign [, tnRotate[,tnRotationPoint[, tcLinkName[, tcLinkRef[, tcBookmark [, tcTooltip[, tnmode[, liCP]]]]]]]]]]) Return value: Parameters: tnLeft, tnTop tnWidth, tnHeight tnAlign 0 … “left” Optional, the default value is 0 (left). tnVAlign 0 … “top” Optional, the default value is 0 (top). tnRotate tnRotationPoint
The point within the rectangle around which the text is rotated. The allowed values are 0..8, optional, default value = 0 (left, top). Please see the picture on the right for the point positions. tcLinkName tcLinkRef tcBookmark tcTooltip tnMode liCP
| |
GetBoundingRectangle() | |
Returns the bounding rectangle coordinates in the rectangle-bound script. Syntax: XFRXDraw::GetBoundingRectangle() Return value: NULL - the bounding rectangle is not available
The unit of the coordinates can be set by SetUnit() method. The default unit is Point (1/72 in). | |
GetPageWidth() | |
|
|
GetPageHeight() | |
|
|
GetXPos() | |
| Returns the horizontal coordinate of the current position. Syntax: XFRXDraw::GetXPos() |
GetYPos() | |
| Returns the vertical coordinate of the current position. Syntax: XFRXDraw::GetYPos() |
OpenDocument() | |
| Opens an existing XFF file. Syntax: XFRXDraw::OpenDocument(tcFileName) Return values .T. … the file was successfully opened
|
PrintDocument() | |
Prints the XFF file to the specified printer. Syntax: XFRXDraw::PrintDocument(tcPrinterName, tcJobname, tnFrom [, tnTo [, tcDEVMODE [, tnPagesPerSheet, [ tnAllEvenOdd, [ tnCopies, [tnUnderlineHyperlinksOnPrint, [laFindString, [lcOutput]]]]]]]]) Return values -100 … cannot initialize printer device
Parameters: tcPrinterName tcJobName tnFrom tnTo tcDEVMODE tnPagesPerSheet tnAllEvenOdd 1 ... all pages (default value) tnCopies tnUnderlineHyperlinksOnPrint
lcOutput (XFRX 15.5)
Alternatively, tnFrom can contain a string value, containing the pages numbers separated by commas and ranges separated by dashes, e.g.: “1,2,5-6,8,20-30”
| |
SavePicture() | |
SavePicture method saves the report page(s) as a picture. Syntax: XFRXDraw::SavePicture(tcFilename, tcType, tnFrom [, tnTo [, tnBpp [, tnJPEGQuality [, tnThumbnailWidth [, tnThumbnailHeight [, tnPagesPerSheet, [ tnAllEvenOdd, [ laFindString, [liBackgroundMode] ]]]]]]]])
Return values
Parameters: tcFilename tcType tnFrom tnTo tnBpp tnJPEGQuality tnThumbnailWidth tnThumbnailHeight tnPagesPerSheet tnAllEvenOdd 1 ... all pages (default value) laFindString (XFRX 15.4) liBackGroundMode (XFRX 15.5) Background mode of output picture for TIFF,EMF and PNG format 0 ... Opaque (default color is white)
If both tnThumbnailWidth and tnThumbnailHeight are omitted, the original page size is used. If only one of the values is sent, the other one is calculated accordingly.
| |
SetColor() | |
Sets the foreground and background drawing colors. Syntax: XFRXDraw::SetColor(tfr, tfg, tfb[, tbr, tbg, tbb]) Parameters: tfr, tfg, tfb tbr, tbg, tbb
| |
SetFont() | |
| Sets font name and attributes for subsequent DrawText() or DrawTextBox() calls. Syntax: XFRXDraw::SetFont(tcFontName, tnSize[, tlBold[, tlItalic[, tlUnderline[, tlStrikeThrough]]]]) Parameters: tcFontName tnSize tlBold, tlItalics, tlUnderline, tlStrikeThrough
|
SetPos() | |
Sets the position where the text will be drawn by the subsequent DrawText() method call. Syntax: XFRXDraw::SetPos(tnXPos, tnYPos) Parameters: tnXPos, tnYPos
| |
SetUnit() | |
Sets the drawing units. Syntax: XFRXDraw::SetUnit(tcUnit) Parameters: tcUnit The default unit is point. |
- No labels