public class ViewInfoOptions extends BaseViewOptions implements IMaxSizeOptions
Provides options used for retrieving information about view.
Modifier and Type | Method and Description |
---|---|
static ViewInfoOptions |
forHtmlView()
Initializes new instance of
ViewInfoOptions class to retrieve information about view when rendering into HTML. |
static ViewInfoOptions |
forHtmlView(boolean renderSinglePage)
Initializes new instance of
ViewInfoOptions class to retrieve information about view when rendering into HTML. |
static ViewInfoOptions |
forJpgView()
Initializes new instance of
ViewInfoOptions class to retrieve information about view when rendering into JPG. |
static ViewInfoOptions |
forJpgView(boolean extractText)
Initializes new instance of
ViewInfoOptions class to retrieve information about view when rendering into JPG. |
static ViewInfoOptions |
forPngView()
Initializes new instance of
ViewInfoOptions class to retrieve information about view when rendering into PNG. |
static ViewInfoOptions |
forPngView(boolean extractText)
Initializes new instance of
ViewInfoOptions class to retrieve information about view when rendering into PNG. |
static ViewInfoOptions |
fromHtmlViewOptions(HtmlViewOptions options)
Initializes new instance of
ViewInfoOptions class based on HtmlViewOptions object. |
static ViewInfoOptions |
fromJpgViewOptions(JpgViewOptions options)
Initializes new instance of
ViewInfoOptions class based on JpgViewOptions object. |
static ViewInfoOptions |
fromPngViewOptions(PngViewOptions options)
Initializes new instance of
ViewInfoOptions class based on PngViewOptions object. |
int |
getHeight()
Image height (for rendering to PNG/JPG only)
|
int |
getMaxHeight()
Max height of the output image (for rendering to PNG/JPG only)
|
int |
getMaxWidth()
Max width of the output image (for rendering to PNG/JPG only)
|
int |
getWidth()
Image width (for rendering to PNG/JPG only)
|
boolean |
isExtractText()
Indicates that text extraction is enabled.
|
void |
setExtractText(boolean extractText)
Indicates that text extraction is enabled.
|
void |
setHeight(int height)
Image height (for rendering to PNG/JPG only)
|
void |
setMaxHeight(int maxHeight)
Max height of the output image (for rendering to PNG/JPG only)
|
void |
setMaxWidth(int maxWidth)
Max width of the output image (for rendering to PNG/JPG only)
|
void |
setWidth(int width)
Image width (for rendering to PNG/JPG only)
|
getArchiveOptions, 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, setWordProcessingOptions
public static ViewInfoOptions forHtmlView()
ViewInfoOptions
class to retrieve information about view when rendering into HTML.ViewInfoOptions
class.public static ViewInfoOptions forHtmlView(boolean renderSinglePage)
ViewInfoOptions
class to retrieve information about view when rendering into HTML.renderSinglePage
- Enables HTML content will be rendered to single page.ViewInfoOptions
class.public static ViewInfoOptions forJpgView()
ViewInfoOptions
class to retrieve information about view when rendering into JPG.ViewInfoOptions
class.public static ViewInfoOptions forJpgView(boolean extractText)
ViewInfoOptions
class to retrieve information about view when rendering into JPG.extractText
- Enables text extraction.ViewInfoOptions
class.public static ViewInfoOptions forPngView()
ViewInfoOptions
class to retrieve information about view when rendering into PNG.ViewInfoOptions
class.public static ViewInfoOptions forPngView(boolean extractText)
ViewInfoOptions
class to retrieve information about view when rendering into PNG.extractText
- Enables text extraction.ViewInfoOptions
class.public static ViewInfoOptions fromHtmlViewOptions(HtmlViewOptions options)
Initializes new instance of ViewInfoOptions
class based on HtmlViewOptions
object.
options
- The HTML view options.ViewInfoOptions
class.IllegalArgumentException
- Thrown when options
is null.public static ViewInfoOptions fromJpgViewOptions(JpgViewOptions options)
Initializes new instance of ViewInfoOptions
class based on JpgViewOptions
object.
options
- The JPG view options.ViewInfoOptions
class.IllegalArgumentException
- Thrown when options
is null.public static ViewInfoOptions fromPngViewOptions(PngViewOptions options)
Initializes new instance of ViewInfoOptions
class based on PngViewOptions
object.
options
- The PNG view options.ViewInfoOptions
class.IllegalArgumentException
- Thrown when options
is null.public int getHeight()
public int getMaxHeight()
getMaxHeight
in interface IMaxSizeOptions
public int getMaxWidth()
getMaxWidth
in interface IMaxSizeOptions
public int getWidth()
public boolean isExtractText()
public void setExtractText(boolean extractText)
public void setHeight(int height)
public void setMaxHeight(int maxHeight)
setMaxHeight
in interface IMaxSizeOptions
public void setMaxWidth(int maxWidth)
setMaxWidth
in interface IMaxSizeOptions
public void setWidth(int width)