Copy of Copy of Copy of GetPageWidth Methods (3)

Returns the horizontal coordinate of the current position.

Syntax:

XFRXDraw::GetXPos()

Returns the vertical coordinate of the current position.

Syntax:

XFRXDraw::GetYPos()

Append next XFF file to opened XFF file.

Syntax:

XFRXDraw::AppendXFF(m.tcName, m.tnAppend)

Parameters:

tcName
   The file name of next XFF file.

tnAppend
   The parameter it's equal to parameter tuAppend of method SetParams().

Opens an existing XFF file.

Syntax:

XFRXDraw::OpenDocument(tcFileName)

Return values

.T. … the file was successfully opened
.F. … file couldn’t have been opened (file doesn’t exist or is locked)

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
-101 … cannot initialize printer driver
-102 … cannot initialize DEVMODE structure
     0 … no errors

Parameters:

tcPrinterName
   Then name of the printer to which the document will be sent

tcJobName
   The printer job name

tnFrom
   If numeric, the first page to be printed.

tnTo
   The last page to be printed.

tcDEVMODE
   DEVMODE structure. 

tnPagesPerSheet
   The number of pages per sheet .

tnAllEvenOdd
   Include all pages, odd or even only.  The allowed values are:

   1 ... all pages (default value)
   2 ... odd pages
   3 ... even pages

 tnCopies
   The number of copies.

tnUnderlineHyperlinksOnPrint
   Print hyperlink... 
   0 - No print hyperlink
   1 - Print hyperlink in blue color
   2 - Print hyperlink in green color 

laFindString (XFRX 15.4)
 A array contains strings for   highlight  (background color yelow).

lcOutput (XFRX 15.5) 
 A output file name for virtual printers such as Microsoft XPS Document Writer, PDFCreator.

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 method saves the report page(s) as a picture.

Syntax:

XFRXDraw::SavePicture(tcFilename, tcType, tnFrom [, 
                      tnTo [, tnBpp [, tnJPEGQuality [, 
                      tnThumbnailWidth [, tnThumbnailHeight [, 
                      tnPagesPerSheet, [ tnAllEvenOdd [, m.tnCopies, [
                      laFindString, [liBackgroundMode] ]]]]]]]]]),

Return values
 0 ... no errors was encountered
-1 ... unknown image format
-2 ... page out of range

Parameters:

tcFilename
   The name of the file to be generated.

tcType
  The format of the picture to be saved. Currently supported options are: BMP, GIF, JPEG (JPG), PNG, TIFF (TIF), EMF.

tnFrom
  The page number to be saved. If TIFF format is being saved, the parameter specifies the first page to be saved.

tnTo
  If TIFF format is being saved, the parameter specifies the last page to be saved. Ignored otherwise.

tnBpp
  Bits per pixel. Currently supported values are 2, 16 or 24.

tnJPEGQuality
  Specifies the JPEG compression quality. The range is from 1 - the lowest quality to 100 - the best quality. The default value is 0 - default quality. Ignored for other output types.

tnThumbnailWidth
  The width of the output picture in pixels.

tnThumbnailHeight
  The height of the output picture in pixels.

tnPagesPerSheet
 The number of pages per sheet .

 tnAllEvenOdd
  Include all pages, odd or even only.  The allowed values are:

  1 ... all pages (default value)
  2 ... odd pages 
  3 ... even pages

tnCopies
 Number of copies. This parameter is ignore.

laFindString (XFRX 15.4)
 A array contains strings for  highlight  (background color yelow).

liBackGroundMode (XFRX 15.5)

   0 ... Opaque (default color is white)
   1 ... Transparent (use 32bppARGB always)

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.

Sets the foreground and background drawing colors.

Syntax:

XFRXDraw::SetColor(tfr, tfg, tfb[, tbr, tbg, tbb])

Parameters:

tfr, tfg, tfb
  Red, green and blue components of the foreground color

tbr, tbg, tbb
  Red, green and blue components of the background color (optional)

Sets font name and attributes for subsequent DrawText() or DrawTextBox() calls.

Syntax:

XFRXDraw::SetFont(tcFontName, tnSize[, tlBold[, 
                  tlItalic[, tlUnderline[, 
                  tlStrikeThrough]]]])

Parameters:

tcFontName
  The font name

tnSize
  The font size in points

tlBold, tlItalics, tlUnderline, tlStrikeThrough
  The font attributes. These parameters are optional, the default value is .F. Parameter tlStrikeThrough is since XFRX 15.7

Sets the position where the text will be drawn by the subsequent DrawText() method call.

Syntax:

XFRXDraw::SetPos(tnXPos, tnYPos)

Parameters:

tnXPos, tnYPos
  The X and Y (horizontal and vertical) coordinates of the position. The unit of the coordinates is defined by SetUnit() method, the default unit is Point (pt).

Sets the drawing units.

Syntax:

XFRXDraw::SetUnit(tcUnit)

Parameters:

tcUnit
  The unit code. The allowed values are: “in” – inches, “cm” – centimeters, “pt” – points and “px” – pixels.