public class PreviewOptions extends Object
Represents document preview options.
| Constructor and Description |
|---|
PreviewOptions(com.groupdocs.signature.options.PageDataStreamFactory pageDataStreamFactory,
int... pageNumbers)
Initializes PreviewOptions object.
|
PreviewOptions(PageStreamFactory pageStreamFactory,
int... pageNumbers)
Initializes PreviewOptions object.
|
PreviewOptions(String filePathFormat,
int... pageNumbers)
Initializes PreviewOptions object.
|
| Modifier and Type | Method and Description |
|---|---|
int |
getHeight()
Gets or sets preview images height.
|
boolean |
getHideSignatures()
Gets or sets flag to hide signatures from page preview image.
|
int[] |
getPageNumbers()
Gets or sets preview images page numbers.
|
int |
getPreviewFormat()
Gets or sets preview images format.
|
int |
getResolution()
Gets the resolution of the preview images in DPI (dots per inch).
|
int |
getWidth()
Gets or sets preview images width.
|
void |
setHeight(int value)
Gets or sets preview images height.
|
void |
setHideSignatures(boolean value)
Gets or sets flag to hide signatures from page preview image.
|
void |
setPageNumbers(int[] value)
Gets or sets preview images page numbers.
|
void |
setPreviewFormat(int value)
Gets or sets preview images format.
|
void |
setResolution(int value)
Sets the resolution of the preview images in DPI (dots per inch).
|
void |
setWidth(int value)
Gets or sets preview images width.
|
public PreviewOptions(com.groupdocs.signature.options.PageDataStreamFactory pageDataStreamFactory,
int... pageNumbers)
Initializes PreviewOptions object.
pageDataStreamFactory - Interface which defines method to create output page preview stream.public PreviewOptions(PageStreamFactory pageStreamFactory, int... pageNumbers)
Initializes PreviewOptions object.
pageStreamFactory - Interface which defines method to create output page preview stream.pageNumbers - Desired page numberspublic PreviewOptions(String filePathFormat, int... pageNumbers)
Initializes PreviewOptions object.
filePathFormat - Path to output file.pageNumbers - Desired page numberspublic final int getHeight()
Gets or sets preview images height.
public final boolean getHideSignatures()
Gets or sets flag to hide signatures from page preview image. Only signatures are marked as IsSignature will be hidden from generated document page image.
public final int[] getPageNumbers()
Gets or sets preview images page numbers.
public final int getPreviewFormat()
Gets or sets preview images format.
public final int getResolution()
Gets the resolution of the preview images in DPI (dots per inch).
public final int getWidth()
Gets or sets preview images width.
public final void setHeight(int value)
Gets or sets preview images height.
public final void setHideSignatures(boolean value)
Gets or sets flag to hide signatures from page preview image. Only signatures are marked as IsSignature will be hidden from generated document page image.
public final void setPageNumbers(int[] value)
Gets or sets preview images page numbers.
public final void setPreviewFormat(int value)
Gets or sets preview images format.
public final void setResolution(int value)
Sets the resolution of the preview images in DPI (dots per inch).
public final void setWidth(int value)
Gets or sets preview images width.
Copyright © 2026. All rights reserved.