Class ViewerOptimizedOptions

A class containing ViewerOptimizedOptions

Inheritance

object

OptionsBase

ViewerOptimizedOptions

Implements

IDisposable

Inherited Members

OptionsBase.mObjSet

OptionsBase.mDict

OptionsBase.ColorPtToNumber(ColorPt)

OptionsBase.ColorPtFromNumber(double)

OptionsBase.GetArray(string)

OptionsBase.PutNumber(string, double)

OptionsBase.PutBool(string, bool)

OptionsBase.PutText(string, string)

OptionsBase.PutRect(string, Rect)

OptionsBase.PushBackNumber(string, double)

OptionsBase.PushBackBool(string, bool)

OptionsBase.PushBackText(string, string)

OptionsBase.PushBackRect(string, Rect)

OptionsBase.RectFromArray(Obj)

OptionsBase.insertRectCollection(string, RectCollection, int)

OptionsBase.GetInternalObj()

OptionsBase.Dispose()

OptionsBase.Dispose(bool)

OptionsBase.Destroy()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: pdftron.PDF

Assembly: PDFTronDotNet.dll

Syntax

public class ViewerOptimizedOptions : OptionsBase, IDisposable

Constructors

ViewerOptimizedOptions()

Creates an ViewerOptimizedOptions object with default settings

Declaration

public ViewerOptimizedOptions()

Methods

SetMinimumInitialThumbnails(int)

Set the number of pages starting from the first for which to guarantee thumbnails regardless of page complexity. This can help improve the viewing experience on the first few pages without increasing the file size dramatically. If this number is greater than the number of pages in the document all of the pages will have thumbnails.

Declaration

public ViewerOptimizedOptions SetMinimumInitialThumbnails(int initial_thumbs)

Parameters

Type	Name	Description
int	initial_thumbs	The number of pages starting with the first which are guaranteed to have thumbnails. The default value is 1, which means only the first page is guaranteed to have a thumbnail.

Returns

Type	Description
ViewerOptimizedOptions

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 ViewerOptimizedOptions 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.

Returns

Type	Description
ViewerOptimizedOptions

SetThumbnailRenderingThreshold(int)

For any pages that are not forced to include thumbnails this function adjusts whether we should include them depending on the complexity of the page. This can be used to include fewer or more thumbnails as required by the use case. In particular reducing this value will tend to increase the number of page thumbnails included and vice versa.

Declaration

public ViewerOptimizedOptions SetThumbnailRenderingThreshold(int threshold)

Parameters

Type	Name	Description
int	threshold	A number from 0 (include all thumbnails) to 100 (include only the first thumbnail) representing the complexity at which SaveViewerOptimized would include the thumbnail. The default value is 50.

Returns

Type	Description
ViewerOptimizedOptions

SetThumbnailSize(int)

The maximum allowed length for the thumbnail's height/width. The default thumbnail size is 1024.

Declaration

public ViewerOptimizedOptions SetThumbnailSize(int size)

Parameters

Type	Name	Description
int	size	the maximum dimension (width or height) that thumbnails will have.

Returns

Type	Description
ViewerOptimizedOptions

Implements

IDisposable