SpreadJS Documentation
PDF Classes and Enumerations

The following properties can be used when saving to a PDF file when using the Excel assemblies.

Class Description
GrapeCity.Windows.SpreadSheet.Data.PdfExportSettings Represents the settings for the PDF exporter.

 

Method Description
public PdfExportSettings() Represents the settings for the PDF exporter.

 

Property Description Property Value Description
public string Author { get; set; } Gets or sets the author of the PDF file. value The author. The default value is an empty string.
public string Title { get; set; } Gets or sets the title of the PDF file. value The title. The default value is an empty string.
public string Subject { get; set; } Gets or sets the subject of the PDF file. value The subject. The default value is an empty string.
public string Keywords { get; set; } Gets or sets the keywords for the PDF file. value The keywords. The default value is an empty string.
public string Creator { get; set; } Gets or sets the creator of the PDF file. value The creator. The default value is an empty string.
public bool DisplayDocTitle { get; set; } Gets or sets a value that indicates whether the window's title bar  displays the title specified for the PDF file. This property sets a flag that specifies whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary. Set the title by setting the Title property. If the DisplayDocTitle property is false, the title bar displays the name of the PDF file instead. value True if the window's title bar displays the title specified for the PDF file; otherwise, false. The default value is false, which means the window's title bar displays the PDF file name.
public bool HideMenubar { get; set; } Gets or sets a value that indicates whether to hide the viewer application’s  menu bar when the document is active. value True if the viewer application hides its menu bar; otherwise, false. The default value is false.
public bool HideToolbar { get; set; } Gets or sets a value that specifies whether to hide the viewer application’s  toolbars when the document is active. value True if the viewer application hides its toolbars; otherwise, false. The default value is false.
public bool HideWindowUI { get; set; } Gets or sets a value that specifies whether to hide user interface elements for the document. This property specifies whether to hide user interface elements, such as scroll bars and navigation controls, when displaying the document. Only the document’s contents are displayed if this property is true. value True if the document's user interface elements are hidden; otherwise, false. The default value is false.
public bool CenterWindow { get; set; } Gets or sets a value that specifies whether to center the document in the window. value True if the document is to be centered in the display window; otherwise, false. The default value is false.
public bool FitWindow { get; set; } Gets or sets a value that specifies whether to resize the document’s window  to fit the size of the first displayed page. value True if the document's window is resized; otherwise, false.
public OpenType OpenType { get; set; } Gets or sets how to display the document when it is opened. value A value that specifies how to display the document. The default value is OpenType.Auto.
public PageLayoutType PageLayout { get; set; } Gets or sets the page layout to be used when the document is opened. value A value that specifies the page layout for the document. The default value is PageLayoutType.Auto.
public int PageDuration { get; set; } Gets or sets an integer value that indicates the duration in seconds for the current page during a presentation. value The duration of the page.
public PageTransitionType PageTransition { get; set; } Gets or sets the transition style to use when moving to this page from another during a presentation. value The page transition. The default value is PageTransitionType.Default.
public DestinationType DestinationType { get; set; } Gets or sets a value that indicates how to open the document. value A value that indicates how to open the document. The default value is DestinationType.Auto.
public int OpenPageNumber { get; set; } Gets or sets the page number of the page to display when the document is opened. value The page number to display. The default value is 1.
public PrintPreset PrintPreset { get; set; } Gets the print settings for the PDF viewer. value The print settings for the viewer. The default value is never null.
public List<DocumentAttachment> DocumentAttachments { get; set; } Gets the document attachments. value The document attachments. The default value is never null.

This table lists the enumerations for GrapeCity.PDF.Object.OpenType.

Enumeration Description
public enum OpenType Specifies how the document should be displayed when opened.
Auto Sets the type to automatic.
UseNone Specifies that neither the document outline or thumbnail images are visible.
UseOutlines Specifies that the document outline is visible.
UseThumbs Specifies that the thumbnail images are visible.
FullScreen Specifies full-screen mode, with no menu bar, window controls, or any other window visible.
UseOC Specifies that an optional content group panel is visible.
UseAttachments Specifies that the attachments panel is visible.

This table lists the enumerations for GrapeCity.PDF.Object.PageLayoutType.

Enumeration Description
public enum PageLayoutType Specifies the page layout to be used when the document is opened.
Auto Sets the type to automatic.
SinglePage Displays one page at a time.
OneColumn Displays the pages in one column.
TwoColumnLeft Displays the pages in two columns, with odd-numbered pages on the left.
TwoColumnRight Displays the pages in two columns, with odd-numbered pages on the right.
TwoPageLeft Displays the pages two at a time, with odd-numbered pages on the left.
TwoPageRight Displays the pages two at a time, with odd-numbered pages on the right.

This table lists the enumerations for GrapeCity.PDF.Object.PageTransitionType.

Enumeration Description
public enum PageTransitionType Specifies the transition style to use when moving to this page from another during a presentation.
Default Specifies that the new page replaces the old one with no special transition effect.
Split Specifies that two lines sweep across the screen, revealing the new page.
Blinds Specifies that multiple lines, evenly spaced across the screen, synchronously sweep in the same direction to reveal the new page.
Box Specifies that a rectangular box sweeps inward from the edges of the page.
Wipe Specifies that a single line sweeps across the screen from one edge to the other.
Dissolve Specifies that the old page dissolves gradually to reveal the new one.
Glitter Similar to Dissolve, except that the effect sweeps across the page in a wide band moving from one side of the screen to the other.
Fly Specifies that changes are flown out.
Push Specifies the old page slides off the screen while the new page slides in, pushing the old page out.
Cover Specifies the new page slides on to the screen.
Uncover Specifies the old page slides off the screen.
Fade Specifies the new page gradually becomes visible through the old one.

This table lists the enumerations for GrapeCity.PDF.Object.DuplexMode.

Enumeration Description
public enum DuplexMode Specifies the paper handling option to use when printing the file from the print dialog.
Default Specifies the default setting.
Simplex Specifies to print single-sided.
DuplexFlipShortEdge Specifies to print in duplex mode and flip on the short edge of the sheet.
DuplexFlipLongEdge Specifies to print in duplex mode and flip on the long edge of the sheet.

This table lists the enumerations for GrapeCity.PDF.Object.PrintScalingType.

Enumeration Description
public enum PrintScalingType Specifies the page scaling option to be selected when a print dialog is displayed for this document.
AppDefault Indicates that applications should use the current print scaling.
None Indicates that the print dialog should reflect no page scaling.

 

 


Copyright © GrapeCity, inc. All rights reserved.

Send comments on this topic.