Package com.grapecity.documents.excel

Class PdfSaveOptions

java.lang.Object
com.grapecity.documents.excel.SaveOptionsBase
com.grapecity.documents.excel.PdfSaveOptions
public class PdfSaveOptions extends SaveOptionsBase
Option class for saving PDF file.

  • Constructor Details

    • PdfSaveOptions

      public PdfSaveOptions()
      Constructor.

  • Method Details

    • getPDFRenderEngin

      public IPDFRenderEngine getPDFRenderEngin()

    • setPDFRenderEngin

      public void setPDFRenderEngin(IPDFRenderEngine pdfPrinter)

    • getPrintBackgroundPicture

      public boolean getPrintBackgroundPicture()
      Returns if the sheet's background image is printed on the page.

    • setPrintBackgroundPicture

      public void setPrintBackgroundPicture(boolean value)
      Sets if the sheet's background image is printed on the page.

    • getPrintTransparentCell

      public boolean getPrintTransparentCell()
      Returns if the transparency of the cell's background color is printed on the page.

    • setPrintTransparentCell

      public void setPrintTransparentCell(boolean value)
      Sets if the transparency of the cell's background color is printed on the page.

    • getShrinkToFitSettings

      public IShrinkToFitSettings getShrinkToFitSettings()
      The settings about performing shrink to fit on the wrapped text.

    • getDocumentProperties

      public DocumentProperties getDocumentProperties()
      Gets the document properties of PDF.

    • setDocumentProperties

      public void setDocumentProperties(DocumentProperties value)
      Sets the document properties of PDF.

    • getOpenActionScript

      public String getOpenActionScript()
      Get the JavaScript to be execute when the saved PDF file is opened.
      Returns:
      The JavaScript to be executed when the saved PDF file is opened.

    • setOpenActionScript

      public void setOpenActionScript(String openActionScript)
      Set the JavaScript to be execute when the saved PDF file is opened.
      Parameters:
      openActionScript - The JavaScript to be executed when the saved PDF file is opened.

    • getSecurityOptions

      public PdfSecurityOptions getSecurityOptions()
      Gets the the security settings of PDF.

    • setSecurityOptions

      public void setSecurityOptions(PdfSecurityOptions value)
      Sets the the security settings of PDF.

    • getIncludeAutoMergedCells

      public boolean getIncludeAutoMergedCells()
      Gets whether to include the automatically merged cells. The default value is false.

    • setIncludeAutoMergedCells

      public void setIncludeAutoMergedCells(boolean value)
      Sets whether to include the automatically merged cells. The default value is false.

    • getPagePrintingEvent

      public Event<EventHandler<PagePrintingEventArgs>> getPagePrintingEvent()
      Occurs before printing a page.

    • getPagePrintedEvent

      public Event<EventHandler<PagePrintedEventArgs>> getPagePrintedEvent()
      Occurs when a page was printed.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getFormFields

      public boolean getFormFields()
      Indicates that whether to replace Excel form controls with PDF form fields. Not all controls and properties are supported.
      Returns:
      True if Excel form controls will be exported as PDF form fields.Otherwise, false. The default value is false.

    • setFormFields

      public void setFormFields(boolean value)
      Indicates that whether to replace Excel form controls with PDF form fields. Not all controls and properties are supported.
      Parameters:
      value - True if Excel form controls will be exported as PDF form fields.Otherwise, false. The default value is false.

    • getBorderOptions

      public final HashMap<BorderLineStyle,CustomBorderStyle> getBorderOptions()
      This dictionary stores border options when exporting PDF.