asposewordscloud/dist/model/pdfSaveOptionsData.d.ts

Aspose.Words Cloud SDK for Node.js

import { AttributeInfo } from '../internal/attributeInfo';
import { DownsampleOptionsData } from './downsampleOptionsData';
import { FixedPageSaveOptionsData } from './fixedPageSaveOptionsData';
import { OutlineOptionsData } from './outlineOptionsData';
import { PdfDigitalSignatureDetailsData } from './pdfDigitalSignatureDetailsData';
import { PdfEncryptionDetailsData } from './pdfEncryptionDetailsData';
export declare const importsMapPdfSaveOptionsData: {
    DownsampleOptionsData: typeof DownsampleOptionsData;
    FixedPageSaveOptionsData: typeof FixedPageSaveOptionsData;
    OutlineOptionsData: typeof OutlineOptionsData;
    PdfDigitalSignatureDetailsData: typeof PdfDigitalSignatureDetailsData;
    PdfEncryptionDetailsData: typeof PdfEncryptionDetailsData;
};
/**
 * Container class for pdf save options.
 */
export declare class PdfSaveOptionsData extends FixedPageSaveOptionsData {
    /**
     * Attribute type map
     */
    static attributeTypeMap: Array<AttributeInfo>;
    /**
     * Returns attribute type map
     */
    static getAttributeTypeMap(): AttributeInfo[];
    /**
     * Gets or sets a value determining whether or not to cache graphics placed in document's background.
     * Default value is true and background graphics are written to the PDF document as an xObject. When the value is false background graphics are not cached. Some shapes are not supported for caching(shapes with fields, bookmarks, HRefs). Document background graphic is various shapes, charts, images placed in the footer or header,
     * well as background and border of a page.
     */
    cacheBackgroundGraphics: boolean;
    /**
     * Gets or sets the PDF standards compliance level for output documents.
     */
    compliance: PdfSaveOptionsData.ComplianceEnum;
    /**
     * Gets or sets a value indicating whether to convert footnote/endnote references in main text story into active hyperlinks.
     * When clicked the hyperlink will lead to the corresponding footnote/endnote.
     * The default value is false.
     */
    createNoteHyperlinks: boolean;
    /**
     * Gets or sets the option that controls the way CustomDocumentProperties are exported to PDF file.
     * The default value is None.
     */
    customPropertiesExport: PdfSaveOptionsData.CustomPropertiesExportEnum;
    /**
     * Gets or sets the details for signing the output PDF document.
     */
    digitalSignatureDetails: PdfDigitalSignatureDetailsData;
    /**
     * Gets or sets a value indicating whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary.
     * If false, the title bar should instead display the name of the PDF file containing the document.
     * The default value is false.
     */
    displayDocTitle: boolean;
    /**
     * Gets or sets the downsample options.
     */
    downsampleOptions: DownsampleOptionsData;
    /**
     * Gets or sets a value determining whether or not to embed attachments to the PDF document.
     * Default value is false and attachments are not embedded.
     * When the value is true attachments are embedded to the PDF document.
     * Embedding attachments is not supported when saving to PDF/A and PDF/UA compliance.
     * false value will be used automatically.
     * Embedding attachments is not supported when encryption is enabled. false value will be used automatically.
     */
    embedAttachments: boolean;
    /**
     * Gets or sets a value indicating whether fonts are embedded into the resulting PDF documents.
     */
    embedFullFonts: boolean;
    /**
     * Gets or sets the details for encrypting the output PDF document.
     */
    encryptionDetails: PdfEncryptionDetailsData;
    /**
     * Gets or sets a value indicating whether to export document structure.
     */
    exportDocumentStructure: boolean;
    /**
     * Gets or sets a value determining whether or not to create a "Span" tag in the document structure to export the text language.
     * Default value is false and "Lang" attribute is attached to a marked-content sequence in a page content stream.
     * When the value is true "Span" tag is created for the text with non-default language and "Lang" attribute is attached to this tag.
     * This value is ignored when Aspose.Words.Saving.PdfSaveOptions.ExportDocumentStructure is false.
     */
    exportLanguageToSpanTag: boolean;
    /**
     * Gets or sets the font embedding mode.
     */
    fontEmbeddingMode: PdfSaveOptionsData.FontEmbeddingModeEnum;
    /**
     * Gets or sets the option that controls how bookmarks in headers/footers are exported.
     * The default value is Aspose.Words.Saving.HeaderFooterBookmarksExportMode.All.
     */
    headerFooterBookmarksExportMode: PdfSaveOptionsData.HeaderFooterBookmarksExportModeEnum;
    /**
     * Gets or sets the option that controls how the color space will be selected for the images in PDF document.
     * The default value is "Auto". If "SimpleCmyk" value is specified, ImageCompression option is ignored and Flate compression is used for all images in the document.
     */
    imageColorSpaceExportMode: PdfSaveOptionsData.ImageColorSpaceExportModeEnum;
    /**
     * Gets or sets the compression type to be used for all images in the document.
     */
    imageCompression: string;
    /**
     * Gets or sets a value indicating whether image interpolation shall be performed by a conforming reader. When false is specified, the flag is not written to the output document and the default behavior of reader is used instead.
     * When the resolution of a source image is significantly lower than that of the output device, each source sample covers many device pixels. As a result, images can appear jaggy or blocky. These visual artifacts can be reduced by applying an image interpolation algorithm during rendering. Instead of painting all pixels covered by a source sample with the same color, image interpolation attempts to produce a smooth transition between adjacent sample values. A conforming Reader may choose to not implement this feature of PDF, or may use any specific implementation of interpolation that it wishes. The default value is false.
     */
    interpolateImages: boolean;
    /**
     * Gets or sets a value indicating whether hyperlinks in the output Pdf document are forced to be opened in a new window (or tab) of a browser.
     */
    openHyperlinksInNewWindow: boolean;
    /**
     * Gets or sets the outline options.
     */
    outlineOptions: OutlineOptionsData;
    /**
     * Gets or sets the option that controls how the PDF document should be displayed when opened in the PDF reader.
     */
    pageMode: PdfSaveOptionsData.PageModeEnum;
    /**
     * Gets or sets a value indicating whether to preblend transparent images with black background color.
     * Preblending images may improve PDF document visual appearance in Adobe Reader and remove anti-aliasing artifacts.In order to properly display preblended images, PDF viewer application must support /Matte entry in soft-mask image dictionary.
     * Also preblending images may decrease PDF rendering performance.The default value is false.
     */
    preblendImages: boolean;
    /**
     * Gets or sets a value indicating whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text.
     */
    preserveFormFields: boolean;
    /**
     * Gets or sets a value indicating whether to render PDF choice form field border.
     * PDF choice form fields are used for export of SDT Combo Box Content Control, SDT Drop-Down List Content
     * Control and legacy Drop-Down Form Field when PreserveFormFields option is enabled.The default value is true.
     */
    renderChoiceFormFieldBorder: boolean;
    /**
     * Gets or sets the compression type to be used for all textual content in the document.
     */
    textCompression: PdfSaveOptionsData.TextCompressionEnum;
    /**
     * Gets or sets a value indicating whether the document should be saved using a booklet printing layout.
     */
    useBookFoldPrintingSettings: boolean;
    /**
     * Gets or sets a value indicating whether to substitute TrueType fonts Arial, Times New Roman, Courier New and Symbol with core PDF Type 1 fonts.
     */
    useCoreFonts: boolean;
    /**
     * Gets or sets a value indicating whether to use SDT control Tag or Id property as a name of form field in PDF.
     * The default value is false.When set to false, SDT control Id property is used as a name of form field in PDF.When set to true, SDT control Tag property is used as a name of form field in PDF.If set to true and Tag is empty, Id property will be used as a form field name.If set to true and Tag values are not unique, duplicate Tag values will be altered to build
     * unique PDF form field names.
     */
    useSdtTagAsFormFieldName: boolean;
    /**
     * Gets or sets the option that controls what type of zoom should be applied when a document is opened with a PDF viewer.
     */
    zoomBehavior: PdfSaveOptionsData.ZoomBehaviorEnum;
    /**
     * Gets or sets the zoom factor (in percentages) for a document.
     */
    zoomFactor: number;
    constructor(init?: Partial<PdfSaveOptionsData>);
    collectFilesContent(_resultFilesContent: Array<any>): void;
    validate(): void;
}
/**
 * Enums for PdfSaveOptionsData
 */
export declare namespace PdfSaveOptionsData {
    enum ComplianceEnum {
        Pdf17,
        Pdf20,
        PdfA1a,
        PdfA1b,
        PdfA2a,
        PdfA2u,
        PdfA3a,
        PdfA3u,
        PdfA4,
        PdfA4f,
        PdfA4Ua2,
        PdfUa1,
        PdfUa2
    }
    enum CustomPropertiesExportEnum {
        None,
        Standard,
        Metadata
    }
    enum FontEmbeddingModeEnum {
        EmbedAll,
        EmbedNonstandard,
        EmbedNone
    }
    enum HeaderFooterBookmarksExportModeEnum {
        None,
        First,
        All
    }
    enum ImageColorSpaceExportModeEnum {
        Auto,
        SimpleCmyk
    }
    enum PageModeEnum {
        UseNone,
        UseOutlines,
        UseThumbs,
        FullScreen,
        UseOC,
        UseAttachments
    }
    enum TextCompressionEnum {
        None,
        Flate
    }
    enum ZoomBehaviorEnum {
        None,
        ZoomFactor,
        FitPage,
        FitWidth,
        FitHeight,
        FitBox
    }
}