PdfViewOptions Leave feedback

Inheritance: java.lang.Object, com.groupdocs.viewer.options.BaseViewOptions, com.groupdocs.viewer.options.ViewOptions

public class PdfViewOptions extends ViewOptions

Provides options for rendering documents into PDF format.

The PdfViewOptions class encapsulates additional settings and parameters that can be used to control the rendering of documents into PDF format in the GroupDocs.Viewer component. For details, see the documentation.

Example usage:

 PdfViewOptions pdfViewOptions = new PdfViewOptions();
 pdfViewOptions.setImageHeight(256);
 pdfViewOptions.setImageWidth(128);
 pdfViewOptions.setDefaultFontName("font-name");

 try (Viewer viewer = new Viewer("document.pdf")) {
     viewer.view(pdfViewOptions);
     // Use the viewer object for further operations
 }
 

public PdfViewOptions(CreateFileStream createFileStream)

Initializes a new instance of the PdfViewOptions class.

For the code example, see the documentation.

Parameters:

public PdfViewOptions(CreateFileStream createFileStream, ReleaseFileStream releaseFileStream)

Initializes a new instance of the PdfViewOptions class.

For the code example, see the documentation.

Parameters:

public PdfViewOptions(FileStreamFactory fileStreamFactory)

Initializes a new instance of the PdfViewOptions class.

For the code example, see the documentation.

Parameters:

public PdfViewOptions()

Initializes a new instance of the PdfViewOptions class with default settings.

This constructor creates a new PdfViewOptions object with “output.pdf” as the file path format for the output file. The output file will be placed into the current working directory of the application. For the code example, see the documentation.

public PdfViewOptions(String outputFilePath)

Initializes a new instance of the PdfViewOptions class.

This constructor creates a new PdfViewOptions object with the specified outputFilePath parameter representing the path for the output PDF file. For the code example, see the documentation.

Parameters:

public PdfViewOptions(Path outputFilePath)

Initializes a new instance of the PdfViewOptions class.

For the code example, see the documentation.

Parameters:

public PdfOptimizationOptions getPdfOptimizationOptions()

Reduce output PDF file size applying optimization techniques with different options.

This option is supported for any input file formats which are supported for conversion to PDF: Supported document formats For details and code samples, see this page and its children.

Returns: PdfOptimizationOptions - PdfOptimizationOptions object or null.

public void setPdfOptimizationOptions(PdfOptimizationOptions pdfOptimizationOptions)

Reduce output PDF file size applying optimization techniques with different options.

This option is supported for any input file formats which are supported for conversion to PDF: Supported document formats For details and code samples, see this page and its children.

Parameters:

public int getImageMaxWidth()

Retrieves the maximum width of an output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the maximum output image width (in pixels). GroupDocs.Viewer applies this property when rendering a single image to PDF. For details, see the documentation. If you set the property, this property is ignored.

Returns: int - the maximum width of the output image in pixels.

public void setImageMaxWidth(int imageMaxWidth)

Sets the maximum width of an output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the maximum output image width (in pixels). GroupDocs.Viewer applies this property when rendering a single image to PDF. For details, see the documentation. If you set the property, this property is ignored.

Parameters:

public int getImageMaxHeight()

Retrieves the maximum height of an output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the maximum output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to PDF. For details, see the documentation. If you set the property, this property is ignored.

Returns: int - the maximum height of the output image in pixels.

public void setImageMaxHeight(int imageMaxHeight)

Sets the maximum height of an output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the maximum output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to HTML only. For details, see the documentation. If you set the property, this property is ignored.

Parameters:

public int getImageWidth()

Retrieves the width of the output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the output image width (in pixels). GroupDocs.Viewer applies this property when rendering a single image to PDF. For details, see the documentation. If you set this property, the property is ignored.

Returns: int - the width of the output image in pixels.

public void setImageWidth(int imageWidth)

Sets the width of the output image in pixels. This parameter applies only when converting a single image PDF.

Parameters:

public int getImageHeight()

Retrieves the height of the output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to HTML only. For details, see the documentation. If you set this property, the property is ignored.

Returns: int - the height of the output image in pixels.

public void setImageHeight(int imageHeight)

Sets the height of the output image in pixels. This parameter applies only when converting a single image to HTML.

Use this property to set the output image height (in pixels). GroupDocs.Viewer applies this property when rendering a single image to HTML only. For details, see the documentation. If you set this property, the property is ignored.

Parameters:

public final Security getSecurity()

Retrieves the security options for the output PDF document.

For details, see the documentation.

Returns: Security - the security options for the output PDF document.

public final void setSecurity(Security value)

Sets the security options for the output PDF document.

For details, see the documentation.

Parameters:

public IDocumentSavingCallback getDocumentSavingCallback()

Retrieves the callback used to estimate the progress of saving a Words or Email document.

Returns: com.groupdocs.viewer.domain.documents.converting.tohtml.utils.IDocumentSavingCallback - the callback to estimate the document saving progress.

public void setDocumentSavingCallback(IDocumentSavingCallback documentSavingCallback)

Sets the callback used to estimate the progress of saving a Words or Email document.

Parameters: