public class JpgViewOptions extends ViewOptions implements IMaxSizeOptions
Provides options for rendering documents into JPG format.
| Constructor and Description |
|---|
JpgViewOptions()
Initializes new instance of
JpgViewOptions class. |
JpgViewOptions(CreatePageStream createPageStream)
Initializes new instance of
JpgViewOptions class. |
JpgViewOptions(CreatePageStream createPageStream,
ReleasePageStream releasePageStream)
Initializes new instance of
JpgViewOptions class. |
JpgViewOptions(PageStreamFactory pageStreamFactory)
Initializes new instance of
JpgViewOptions class. |
JpgViewOptions(String filePathFormat)
Initializes new instance of
JpgViewOptions class. |
| Modifier and Type | Method and Description |
|---|---|
int |
getHeight()
The height of an output image in pixels.
|
int |
getMaxHeight()
Max height of an output image in pixels.
|
int |
getMaxWidth()
Max width of an output image in pixels.
|
PageStreamFactory |
getPageStreamFactory() |
byte |
getQuality()
Quality of the output image;
Valid values are between 1 and 100;
Default value is 90.
|
int |
getWidth()
The width of the output image in pixels.
|
boolean |
isExtractText()
Enables text extraction.
|
void |
setExtractText(boolean value)
Enables text extraction.
|
void |
setHeight(int value)
The height of an output image in pixels.
|
void |
setMaxHeight(int maxHeight)
Max height of an output image in pixels.
|
void |
setMaxWidth(int maxWidth)
Max width of an output image in pixels.
|
void |
setQuality(byte value)
Quality of the output image;
Valid values are between 1 and 100;
Default value is 90.
|
void |
setWidth(int value)
The width of the output image in pixels.
|
getPageRotations, getWatermark, rotatePage, setWatermarkgetArchiveOptions, getCadOptions, getDefaultFontName, getEmailOptions, getMailStorageOptions, getOutlookOptions, getPdfOptions, getProjectManagementOptions, getSpreadsheetOptions, getTextOptions, getVisioRenderingOptions, getWordProcessingOptions, isForHtmlView, isForJpgView, isForPngView, isForSinglePage, isRenderComments, isRenderHiddenPages, isRenderNotes, setArchiveOptions, setCadOptions, setDefaultFontName, setEmailOptions, setForHtmlView, setForJpgView, setForPngView, setForSinglePage, setMailStorageOptions, setOutlookOptions, setPdfOptions, setProjectManagementOptions, setRenderComments, setRenderHiddenPages, setRenderNotes, setSpreadsheetOptions, setTextOptions, setVisioRenderingOptions, setWordProcessingOptionspublic JpgViewOptions()
Initializes new instance of JpgViewOptions class.
JpgViewOptions
with "p_{0}.jpg" as file path format for the output files.
The output files will be placed into current working directory of the application.
public JpgViewOptions(CreatePageStream createPageStream)
JpgViewOptions class.createPageStream - The method that instantiates stream used to write output page data.public JpgViewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
JpgViewOptions class.createPageStream - The method that instantiates stream used to write output page data.releasePageStream - The method that releases stream created by method assigned to delegate that passed to createPageStream parameter.public JpgViewOptions(PageStreamFactory pageStreamFactory)
Initializes new instance of JpgViewOptions class.
pageStreamFactory - The factory which implements methods for creating and releasing output page stream.IllegalArgumentException - Thrown when pageStreamFactory is null.public JpgViewOptions(String filePathFormat)
Initializes new instance of JpgViewOptions class.
filePathFormat - The file path format e.g. 'page_{0}.jpg'.IllegalArgumentException - Thrown when filePathFormat is null or empty.public final int getHeight()
The height of an output image in pixels.
public int getMaxHeight()
getMaxHeight in interface IMaxSizeOptionspublic int getMaxWidth()
getMaxWidth in interface IMaxSizeOptionspublic final PageStreamFactory getPageStreamFactory()
public final byte getQuality()
Quality of the output image; Valid values are between 1 and 100; Default value is 90.
public final int getWidth()
The width of the output image in pixels.
public final boolean isExtractText()
Enables text extraction.
public final void setExtractText(boolean value)
Enables text extraction.
public final void setHeight(int value)
The height of an output image in pixels.
public void setMaxHeight(int maxHeight)
setMaxHeight in interface IMaxSizeOptionspublic void setMaxWidth(int maxWidth)
setMaxWidth in interface IMaxSizeOptionspublic final void setQuality(byte value)
Quality of the output image; Valid values are between 1 and 100; Default value is 90.
public final void setWidth(int value)
The width of the output image in pixels.