com.groupdocs.viewer.converter.options

Class RenderOptions

  • Direct Known Subclasses:
    HtmlOptions, ImageOptions


    public abstract class RenderOptions
    extends Object

    Base document rendering options.

    Version:
    17.5.0
    Author:
    GroupDocs.Viewer Team
    • Field Detail

      • RENDER_COMMENTS_DEFAULT

        public static final boolean RENDER_COMMENTS_DEFAULT
        Constant RENDER_COMMENTS_DEFAULT=false
        See Also:
        Constant Field Values
    • Method Detail

      • getRenderComments

        public boolean getRenderComments()

        Indicates whether comments should be rendered. Default value is false

        Returns:
        a boolean.
      • setRenderComments

        public void setRenderComments(boolean value)

        Indicates whether comments should be rendered. Default value is false

        Parameters:
        value - a boolean.
      • getPageNumber

        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.
        Returns:
        a int.
      • setPageNumber

        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.
        Parameters:
        value - a int.
      • getCountPagesToRender

        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.
        Returns:
        a int.
      • setCountPagesToRender

        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.
        Parameters:
        value - a int.
      • getPageNumbersToRender

        public List<Integer> getPageNumbersToRender()

        The List of page numbers to render.

        The following example demonstrates how to render custom page numbers.
        Returns:
        a java$util$List object.
      • setPageNumbersToRender

        public void setPageNumbersToRender(List<Integer> value)

        The List of page numbers to render.

        The following example demonstrates how to render custom page numbers.
        Parameters:
        value - a java$util$List object.
      • getPassword

        public String getPassword()

        The password of the document to render.

        The following example demonstrates how to specify the document password.
        Returns:
        a String object.
      • setPassword

        public void setPassword(String value)

        The password of the document to render.

        The following example demonstrates how to specify the document password.
        Parameters:
        value - a String object.
      • getJpegQuality

        public int getJpegQuality()

        The JPEG image quality. Valid values are between 1 and 100.

        The following example demonstrates how to set JPEG quality.
        Returns:
        a int.
      • setJpegQuality

        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.
        Parameters:
        value - a int.
      • getTransformations

        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.
        Returns:
        a int.
      • setTransformations

        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.
        Parameters:
        value - a int.
      • getWatermark

        public Watermark getWatermark()

        The page watermark.

        The following example demonstrates how add watermark when rendering the document.
        Returns:
        a Watermark object.
      • setWatermark

        public void setWatermark(Watermark value)

        The page watermark.

        The following example demonstrates how add watermark when rendering the document.
        Parameters:
        value - a Watermark object.
      • getCellsOptions

        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.
        Returns:
        a CellsOptions object.
      • setCellsOptions

        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.
        Parameters:
        value - a CellsOptions object.
      • getDiagramOptions

        public DiagramOptions getDiagramOptions()

        The Microsoft Visio documents rendering options.

        The following example demonstrates how to set options for rendering Microsoft Visio document.
        Returns:
        a DiagramOptions object.
      • setDiagramOptions

        public void setDiagramOptions(DiagramOptions value)

        The Microsoft Visio documents rendering options.

        The following example demonstrates how to set options for rendering Microsoft Visio document.
        Parameters:
        value - a DiagramOptions object.
      • getWordsOptions

        public WordsOptions getWordsOptions()

        The Text documents rendering options.

        The following example demonstrates how to set options for rendering Text document.
        Returns:
        a WordsOptions object.
      • setWordsOptions

        public void setWordsOptions(WordsOptions value)

        The Text documents rendering options.

        The following example demonstrates how to set options for rendering Text document.
        Parameters:
        value - a WordsOptions object.
      • getEmailOptions

        public EmailOptions getEmailOptions()

        The Email documents rendering options.

        The following example demonstrates how to set Email document rendering options.
        Returns:
        a EmailOptions object.
      • setEmailOptions

        public void setEmailOptions(EmailOptions value)

        The Email documents rendering options.

        The following example demonstrates how to set Email document rendering options.
        Parameters:
        value - a EmailOptions object.
      • getPdfOptions

        public PdfOptions getPdfOptions()

        The PDF documents rendering options.

        The following example demonstrates how to set options for rendering PDF document.
        Returns:
        a PdfOptions object.
      • setPdfOptions

        public void setPdfOptions(PdfOptions value)

        The PDF documents rendering options.

        The following example demonstrates how to set options for rendering PDF document.
        Parameters:
        value - a PdfOptions object.
      • getCadOptions

        public CadOptions getCadOptions()

        The CAD documents rendering options.

        Returns:
        a CadOptions object.
      • setCadOptions

        public void setCadOptions(CadOptions value)

        The CAD documents rendering options.

        Parameters:
        value - a CadOptions object.