SavePicture Method

Owned by martinajindrova
Last updated: Jun 17, 2023
2 min read

SavePicture method saves the report page(s) as a picture.

Syntax:

Object.SavePicture(tcFilename, tcType, tnFrom 
                   [, tnTo [, tnBpp [, tnJPEGQuality 
                   [, tnThumbnailWidth [, tnThumbnailHeight 
                   [, tnPagesPerSheet [, tnAllEvenOdd [, m.tnCopies]]]]]]]])
XFRX 15.4
Object.SavePicture(tcFilename, tcType, tnFrom 
                   [, tnTo [, tnBpp [, tnJPEGQuality 
                   [, tnThumbnailWidth [, tnThumbnailHeight 
                   [, tnPagesPerSheet [, tnAllEvenOdd [, m.tnCopies
                   [, laFindString]]]]]]]]])
XFRX 15.5
Object.SavePicture(tcFilename, tcType, tnFrom 
                   [, tnTo [, tnBpp [, tnJPEGQuality 
                   [, tnThumbnailWidth [, tnThumbnailHeight 
                   [, tnPagesPerSheet [, tnAllEvenOdd [, m.tnCopies
                   [, laFindString [, liBackgroundMode] ]]]]]]]]])

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 1,  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)

 Background mode of output picture for TIFF, EMF and PNG format

   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.

Return values

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


Remarks

Applies To: XFRX#DRAW