Class Convert.TiffOutputOptions
A class containing options for ToTiff functions
Inherited Members
Namespace: pdftron.PDF
Assembly: PDFNet.dll
Syntax
public class Convert.TiffOutputOptionsConstructors
TiffOutputOptions()
Creates an TiffOutputOptions object with default settings
Declaration
public TiffOutputOptions()Methods
SetAnnots(bool)
Enables or disables drawing of annotations. This option is enabled by default.
Declaration
public void SetAnnots(bool enable)Parameters
| Type | Name | Description |
|---|---|---|
| bool | enable | if false then annotations will not be drawn |
SetBox(Box)
Specifies the page box/region to rasterize. Possible values are media, crop, trim, bleed, and art. By default, page crop region will be rasterized.
Declaration
public void SetBox(Page.Box type)Parameters
| Type | Name | Description |
|---|---|---|
| Page.Box | type | The type cf box to use |
SetCMYK(bool)
Render and export the image in CMYK mode. By default, the image is rendered and exported in RGB color space.
Declaration
public void SetCMYK(bool enable)Parameters
| Type | Name | Description |
|---|---|---|
| bool | enable | if true then cmyk will be enabled |
SetClip(double, double, double, double)
User definable clip box. By default, the clip region is identical to current page 'box'.
Declaration
public void SetClip(double x1, double y1, double x2, double y2)Parameters
| Type | Name | Description |
|---|---|---|
| double | x1 | The value of the x1 coordinate |
| double | y1 | The value of the y1 coordinate |
| double | x2 | The value of the x2 coordinate |
| double | y2 | The value of the y2 coordinate |
SetDPI(double)
The output resolution, from 1 to 1000, in Dots Per Inch (DPI). The higher the DPI, the larger the image. Resolutions larger than 1000 DPI can be achieved by rendering image in tiles or stripes. The default resolution is 92 DPI.
Declaration
public void SetDPI(double dpi)Parameters
| Type | Name | Description |
|---|---|---|
| double | dpi | specifies the output DPI |
SetDither(bool)
Enables dithering when the image is exported in palletized or monochrome mode. This option is disabled by default.
Declaration
public void SetDither(bool enable)Parameters
| Type | Name | Description |
|---|---|---|
| bool | enable | if true then dithering will be enabled |
SetGamma(double)
Sets the gamma factor used for anti-aliased rendering. Typical values are in the range from 0.1 to 3. Gamma correction can be used to improve the quality of anti-aliased image output and can (to some extent) decrease the appearance common anti-aliasing artifacts (such as pixel width lines between polygons). The default gamma is 0.
Declaration
public void SetGamma(double gamma)Parameters
| Type | Name | Description |
|---|---|---|
| double | gamma | specifies the gamma factor |
SetGray(bool)
Render and export the image in grayscale mode. Sets pixel format to 8 bits per pixel grayscale. By default, the image is rendered and exported in RGB color space.
Declaration
public void SetGray(bool enable)Parameters
| Type | Name | Description |
|---|---|---|
| bool | enable | if true then grayscale will be enabled |
SetHRes(int)
Sets the width of the output image, in pixels.
Declaration
public void SetHRes(int hres)Parameters
| Type | Name | Description |
|---|---|---|
| int | hres | specifies the width |
SetMono(bool)
Export the rendered image as 1 bit per pixel (monochrome) image. The image will be compressed using G4 CCITT compression algorithm. By default, the image is not dithered. To enable dithering use 'SetDither' option. This option is disabled by default.
Declaration
public void SetMono(bool enable)Parameters
| Type | Name | Description |
|---|---|---|
| bool | enable | if true then monochrome will be enabled |
SetOverprint(OverprintPreviewMode)
Enable or disable support for overprint and overprint simulation. Overprint is a device dependent feature and the results will vary depending on the output color space and supported colorants (i.e. CMYK, CMYK+spot, RGB, etc). Default is e_op_pdfx_on.
Declaration
public void SetOverprint(PDFRasterizer.OverprintPreviewMode mode)Parameters
| Type | Name | Description |
|---|---|---|
| PDFRasterizer.OverprintPreviewMode | mode | e_op_on: always enabled; e_op_off: always disabled; e_op_pdfx_on: enabled for PDF/X files only. |
SetPages(string)
Specifies the list of pages to convert. "1" for only the first page. "1-5" for pages 1 to 5. "1, 5, 7" for pages 1, 5, and 7. "odd" for all odd pages. "even" for all even pages. By default, all pages are converted.
Declaration
public void SetPages(string page_desc)Parameters
| Type | Name | Description |
|---|---|---|
| string | page_desc | A description of the pages to be converted. |
SetPalettized(bool)
Enabled the output of palettized TIFFs. This option is disabled by default.
Declaration
public void SetPalettized(bool enable)Parameters
| Type | Name | Description |
|---|---|---|
| bool | enable | if true then the TIFF will be palettized |
SetPrintmode(bool)
Renders annotations in the print mode. This option can be used to render 'Print Only' annotations and to hide 'Screen Only' annotations. This option is disabled by default.
Declaration
public void SetPrintmode(bool enable)Parameters
| Type | Name | Description |
|---|---|---|
| bool | enable | if true then print mode will be enabled |
SetRotate(Rotate)
Rotates all pages by a given number of degrees counterclockwise. The allowed values are 0, 90, 180, and 270. The default value is 0.
Declaration
public void SetRotate(Page.Rotate rotate)Parameters
| Type | Name | Description |
|---|---|---|
| Page.Rotate | rotate | The type cf box to use |
SetSmooth(bool)
Enables or disables image smoothing (default: enabled).
Declaration
public void SetSmooth(bool enable)Parameters
| Type | Name | Description |
|---|---|---|
| bool | enable | if false then images will not be smoothed |
SetTransparentPage(bool)
Sets the page color to transparent. By default, Convert assumes that the page is drawn directly on an opaque white surface. Some applications may need to draw the page on a different backdrop. In this case any pixels that are not covered during rendering will be transparent. This option is disabled by default.
Declaration
public void SetTransparentPage(bool enable)Parameters
| Type | Name | Description |
|---|---|---|
| bool | enable | if true then transparent page will be enabled |
SetVRes(int)
Sets the height of the output image, in pixels.
Declaration
public void SetVRes(int vres)Parameters
| Type | Name | Description |
|---|---|---|
| int | vres | specifies the width |