public abstract class RenderOptions extends Object
Base document rendering options.
Modifier and Type | Field and Description |
---|---|
static boolean |
RENDER_COMMENTS_DEFAULT
Constant
RENDER_COMMENTS_DEFAULT=false |
Modifier and Type | Method and Description |
---|---|
CadOptions |
getCadOptions()
The CAD documents rendering options.
|
CellsOptions |
getCellsOptions()
The Spreadsheet documents rendering options.
|
int |
getCountPagesToRender()
The number of pages to render.
|
DiagramOptions |
getDiagramOptions()
The Microsoft Visio documents rendering options.
|
EmailOptions |
getEmailOptions()
The Email documents rendering options.
|
int |
getJpegQuality()
The JPEG image quality.
|
int |
getPageNumber()
The starting page number to render.
|
List<Integer> |
getPageNumbersToRender()
The List of page numbers to render.
|
String |
getPassword()
The password of the document to render.
|
PdfOptions |
getPdfOptions()
The PDF documents rendering options.
|
boolean |
getRenderComments()
Indicates whether comments should be rendered.
|
int |
getTransformations()
Indicates what transformations that are applied to the document should be rendered.
|
Watermark |
getWatermark()
The page watermark.
|
WordsOptions |
getWordsOptions()
The Text documents rendering options.
|
void |
setCadOptions(CadOptions value)
The CAD documents rendering options.
|
void |
setCellsOptions(CellsOptions value)
The Spreadsheet documents rendering options.
|
void |
setCountPagesToRender(int value)
The number of pages to render.
|
void |
setDiagramOptions(DiagramOptions value)
The Microsoft Visio documents rendering options.
|
void |
setEmailOptions(EmailOptions value)
The Email documents rendering options.
|
void |
setJpegQuality(int value)
The JPEG image quality.
|
void |
setPageNumber(int value)
The starting page number to render.
|
void |
setPageNumbersToRender(List<Integer> value)
The List of page numbers to render.
|
void |
setPassword(String value)
The password of the document to render.
|
void |
setPdfOptions(PdfOptions value)
The PDF documents rendering options.
|
void |
setRenderComments(boolean value)
Indicates whether comments should be rendered.
|
void |
setTransformations(int value)
Indicates what transformations that are applied to the document should be rendered.
|
void |
setWatermark(Watermark value)
The page watermark.
|
void |
setWordsOptions(WordsOptions value)
The Text documents rendering options.
|
public static final boolean RENDER_COMMENTS_DEFAULT
RENDER_COMMENTS_DEFAULT=false
public boolean getRenderComments()
Indicates whether comments should be rendered. Default value is false
public void setRenderComments(boolean value)
Indicates whether comments should be rendered. Default value is false
value
- a boolean.public int getPageNumber()
The starting page number to render.
The following example demonstrates how to render the document, starting from the page number two. Will be ignored if page numbers to render are set.public void setPageNumber(int value)
The starting page number to render.
The following example demonstrates how to render the document, starting from the page number two. Will be ignored if page numbers to render are set.value
- a int.public int getCountPagesToRender()
The number of pages to render.
The following example demonstrates how to render three consecutive pages, starting from the page number two. Will be ignored if page numbers to render are set.public void setCountPagesToRender(int value)
The number of pages to render.
The following example demonstrates how to render three consecutive pages, starting from the page number two. Will be ignored if page numbers to render are set.value
- a int.public List<Integer> getPageNumbersToRender()
The List of page numbers to render.
The following example demonstrates how to render custom page numbers.public void setPageNumbersToRender(List<Integer> value)
The List of page numbers to render.
The following example demonstrates how to render custom page numbers.value
- a java$util$List object.public String getPassword()
The password of the document to render.
The following example demonstrates how to specify the document password.String
object.public void setPassword(String value)
The password of the document to render.
The following example demonstrates how to specify the document password.value
- a String
object.public int getJpegQuality()
The JPEG image quality. Valid values are between 1 and 100.
The following example demonstrates how to set JPEG quality.public void setJpegQuality(int value)
The JPEG image quality. Valid values are between 1 and 100.
The following example demonstrates how to set JPEG quality.value
- a int.public int getTransformations()
Indicates what transformations that are applied to the document should be rendered.
The following example demonstrates how to render rotate and reorder transformations. By default transformations are set to Transformation.None. Therefore transformations will not be rendered if not set explicitly.public void setTransformations(int value)
Indicates what transformations that are applied to the document should be rendered.
The following example demonstrates how to render rotate and reorder transformations. By default transformations are set to Transformation.None. Therefore transformations will not be rendered if not set explicitly.value
- a int.public Watermark getWatermark()
The page watermark.
The following example demonstrates how add watermark when rendering the document.Watermark
object.public void setWatermark(Watermark value)
The page watermark.
The following example demonstrates how add watermark when rendering the document.value
- a Watermark
object.public CellsOptions getCellsOptions()
The Spreadsheet documents rendering options.
The following example demonstrates how to set options for rendering Spreadsheet document. Includes options to configure rendering Spreadsheet document.CellsOptions
object.public void setCellsOptions(CellsOptions value)
The Spreadsheet documents rendering options.
The following example demonstrates how to set options for rendering Spreadsheet document. Includes options to configure rendering Spreadsheet document.value
- a CellsOptions
object.public DiagramOptions getDiagramOptions()
The Microsoft Visio documents rendering options.
The following example demonstrates how to set options for rendering Microsoft Visio document.DiagramOptions
object.public void setDiagramOptions(DiagramOptions value)
The Microsoft Visio documents rendering options.
The following example demonstrates how to set options for rendering Microsoft Visio document.value
- a DiagramOptions
object.public WordsOptions getWordsOptions()
The Text documents rendering options.
The following example demonstrates how to set options for rendering Text document.WordsOptions
object.public void setWordsOptions(WordsOptions value)
The Text documents rendering options.
The following example demonstrates how to set options for rendering Text document.value
- a WordsOptions
object.public EmailOptions getEmailOptions()
The Email documents rendering options.
The following example demonstrates how to set Email document rendering options.EmailOptions
object.public void setEmailOptions(EmailOptions value)
The Email documents rendering options.
The following example demonstrates how to set Email document rendering options.value
- a EmailOptions
object.public PdfOptions getPdfOptions()
The PDF documents rendering options.
The following example demonstrates how to set options for rendering PDF document.PdfOptions
object.public void setPdfOptions(PdfOptions value)
The PDF documents rendering options.
The following example demonstrates how to set options for rendering PDF document.value
- a PdfOptions
object.public CadOptions getCadOptions()
The CAD documents rendering options.
CadOptions
object.public void setCadOptions(CadOptions value)
The CAD documents rendering options.
value
- a CadOptions
object.Copyright © 2018. All rights reserved.