Class PaginatedSaveOptions

PaginatedSaveOptions class

Represents the options for pagination.

public abstract class PaginatedSaveOptions : SaveOptions

Properties

NameDescription
AllColumnsInOnePagePerSheet { get; set; }If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be ignored, and the other settings of pagesetup will still take effect.
CachedFileFolder { get; set; }The cached file folder is used to store some large data.(Inherited from SaveOptions.)
CheckFontCompatibility { get; set; }Indicates whether to check font compatibility for every character in text.
CheckWorkbookDefaultFont { get; set; }When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set this to true to try to use workbook’s default font to show these characters first.
ClearData { get; set; }Make the workbook empty after saving the file.(Inherited from SaveOptions.)
CreateDirectory { get; set; }If true and the directory does not exist, the directory will be automatically created before saving the file.(Inherited from SaveOptions.)
DefaultEditLanguage { get; set; }Gets or sets default edit language.
DefaultFont { get; set; }When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters.
DrawObjectEventHandler { get; set; }Implements this interface to get DrawObject and Bound when rendering.
EmfRenderSetting { get; set; }Setting for rendering Emf metafile.
EncryptDocumentProperties { get; set; }Indicates whether encrypt document properties when saving as .xls file. The default value is true.(Inherited from SaveOptions.)
GridlineType { get; set; }Gets or sets gridline type.
IgnoreError { get; set; }Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc.
IsFontSubstitutionCharGranularity { get; set; }Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
MergeAreas { get; set; }Indicates whether merge the areas of conditional formatting and validation before saving the file.(Inherited from SaveOptions.)
OnePagePerSheet { get; set; }If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.
OutputBlankPageWhenNothingToPrint { get; set; }Indicates whether to output a blank page when there is nothing to print.
PageCount { get; set; }Gets or sets the number of pages to save.
PageIndex { get; set; }Gets or sets the 0-based index of the first page to save.
PageSavingCallback { get; set; }Control/Indicate progress of page saving process.
PrintingPageType { get; set; }Indicates which pages will not be printed.
RefreshChartCache { get; set; }Indicates whether refreshing chart cache data(Inherited from SaveOptions.)
SaveFormat { get; }Gets the save file format.(Inherited from SaveOptions.)
SheetSet { get; set; }Gets or sets the sheets to render. Default is all visible sheets in the workbook: Visible.
SortExternalNames { get; set; }Indicates whether sorting external defined names before saving file.(Inherited from SaveOptions.)
SortNames { get; set; }Indicates whether sorting defined names before saving file.(Inherited from SaveOptions.)
TextCrossType { get; set; }Gets or sets displaying text type when the text width is larger than cell width.
UpdateSmartArt { get; set; }Indicates whether updating smart art setting. The default value is false.(Inherited from SaveOptions.)
ValidateMergedAreas { get; set; }Indicates whether validate merged cells before saving the file.(Inherited from SaveOptions.)
WarningCallback { get; set; }Gets or sets warning callback.(Inherited from SaveOptions.)

Examples

[C#]

namespace Demos
{
    using Aspose.Cells;
    using Aspose.Cells.Rendering;
    using System;

    public class PaginatedSaveOptionsDemo
    {
        public static void PaginatedSaveOptionsExample()
        {
            // Open an Excel file
            Workbook workbook = new Workbook("PaginatedSaveOptionsExample_original.xlsx");

            // Create an instance of PaginatedSaveOptions
            PdfSaveOptions options = new PdfSaveOptions();

            // Setting properties
            options.DefaultFont = "Arial";
            options.CheckWorkbookDefaultFont = true;
            options.CheckFontCompatibility = true;
            options.IsFontSubstitutionCharGranularity = true;
            options.OnePagePerSheet = false;
            options.AllColumnsInOnePagePerSheet = false;
            options.IgnoreError = true;
            options.OutputBlankPageWhenNothingToPrint = false;
            options.PageIndex = 3; // Starting page index (0-based index)
            options.PageCount = 2; // Number of pages to be printed
            options.PrintingPageType = PrintingPageType.IgnoreBlank;
            options.GridlineType = GridlineType.Dotted;
            options.TextCrossType = TextCrossType.CrossKeep;
            options.DefaultEditLanguage = DefaultEditLanguage.English;
            options.SheetSet = new SheetSet(new int[] { workbook.Worksheets.ActiveSheetIndex });
            options.ClearData = false;
            options.CachedFileFolder = "C:\\Temp";
            options.ValidateMergedAreas = true;
            options.MergeAreas = true;
            options.SortNames = true;
            options.SortExternalNames = true;
            options.RefreshChartCache = true;
            options.UpdateSmartArt = false;

            // Save the PDF file
            workbook.Save("PaginatedSaveOptionsExample.pdf", options);

            return;
        }
    }
}

See Also