Aspose::Words::Saving::PsSaveOptions class

PsSaveOptions class

Can be used to specify additional options when saving a document into the Ps format. To learn more, visit the Specify Save Options documentation article.

class PsSaveOptions : public FixedPageSaveOptions

Methods

MethodDescription
PsSaveOptions()
get_SaveFormat() overrideSpecifies the format in which the document will be saved if this save options object is used. Can only be Ps.
get_UseBookFoldPrintingSettings() constGets or sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via MultiplePages.
set_SaveFormat(Aspose::Words::SaveFormat) overrideSpecifies the format in which the document will be saved if this save options object is used. Can only be Ps.
set_UseBookFoldPrintingSettings(bool)Sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via MultiplePages.
Equals(System::SharedPtr<System::Object>) overrideDetermines whether the specified object is equal in value to the current object.
get_ColorMode() constGets or sets a value determining how colors are rendered.
get_JpegQuality() constGets or sets a value determining the quality of the JPEG images inside Html document.
get_MetafileRenderingOptions() constAllows to specify metafile rendering options.
get_NumeralFormat() constGets or sets NumeralFormat used for rendering of numerals. European numerals are used by default.
virtual get_OptimizeOutput()Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.
get_PageSavingCallback() constAllows to control how separate pages are saved when a document is exported to fixed page format.
get_PageSet() constGets or sets the pages to render. Default is all the pages in the document.
set_ColorMode(Aspose::Words::Saving::ColorMode)Sets a value determining how colors are rendered.
set_JpegQuality(int32_t)Sets a value determining the quality of the JPEG images inside Html document.
set_MetafileRenderingOptions(const System::SharedPtr<Aspose::Words::Saving::MetafileRenderingOptions> &)Allows to specify metafile rendering options.
set_NumeralFormat(Aspose::Words::Saving::NumeralFormat)Sets NumeralFormat used for rendering of numerals. European numerals are used by default.
virtual set_OptimizeOutput(bool)Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.
set_PageSavingCallback(const System::SharedPtr<Aspose::Words::Saving::IPageSavingCallback> &)Allows to control how separate pages are saved when a document is exported to fixed page format.
set_PageSet(const System::SharedPtr<Aspose::Words::Saving::PageSet> &)Sets the pages to render. Default is all the pages in the document.
static CreateSaveOptions(Aspose::Words::SaveFormat)Creates a save options object of a class suitable for the specified save format.
static CreateSaveOptions(const System::String &)Creates a save options object of a class suitable for the file extension specified in the given file name.
get_AllowEmbeddingPostScriptFonts() constGets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false.
get_CustomTimeZoneInfo() constGets or sets custom local time zone used for date/time fields.
get_DefaultTemplate() constGets or sets path to default template (including filename). Default value for this property is empty string.
get_Dml3DEffectsRenderingMode() constGets or sets a value determining how 3D effects are rendered.
virtual get_DmlEffectsRenderingMode()Gets or sets a value determining how DrawingML effects are rendered.
get_DmlRenderingMode() constGets or sets a value determining how DrawingML shapes are rendered.
get_ExportGeneratorName() constWhen true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.
get_ImlRenderingMode() constGets or sets a value determining how ink (InkML) objects are rendered.
get_MemoryOptimization() constGets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
get_PrettyFormat() constWhen true, pretty formats output where applicable. Default value is false.
get_ProgressCallback() constCalled during saving a document and accepts data about saving progress.
virtual get_SaveFormat()Specifies the format in which the document will be saved if this save options object is used.
get_TempFolder() constSpecifies the folder for temporary files used when saving to a DOC or DOCX file. By default, this property is null and no temporary files are used.
get_UpdateAmbiguousTextFont() constDetermines whether the font attributes will be changed according to the character code being used.
get_UpdateCreatedTimeProperty() constGets or sets a value determining whether the CreatedTime property is updated before saving. Default value is false;
get_UpdateFields() constGets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true.
get_UpdateLastPrintedProperty() constGets or sets a value determining whether the LastPrinted property is updated before saving.
get_UpdateLastSavedTimeProperty() constGets or sets a value determining whether the LastSavedTime property is updated before saving.
get_UpdateOleControlImages() constGets a value determining whether OLE controls presentation image will be updated.
get_UseAntiAliasing() constGets or sets a value determining whether or not to use anti-aliasing for rendering.
get_UseHighQualityRendering() constGets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
set_AllowEmbeddingPostScriptFonts(bool)Sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false.
set_CustomTimeZoneInfo(const System::SharedPtr<System::TimeZoneInfo> &)Sets custom local time zone used for date/time fields.
set_DefaultTemplate(const System::String &)Sets path to default template (including filename). Default value for this property is empty string.
set_Dml3DEffectsRenderingMode(Aspose::Words::Saving::Dml3DEffectsRenderingMode)Sets a value determining how 3D effects are rendered.
virtual set_DmlEffectsRenderingMode(Aspose::Words::Saving::DmlEffectsRenderingMode)Sets a value determining how DrawingML effects are rendered.
set_DmlRenderingMode(Aspose::Words::Saving::DmlRenderingMode)Sets a value determining how DrawingML shapes are rendered.
set_ExportGeneratorName(bool)When true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.
set_ImlRenderingMode(Aspose::Words::Saving::ImlRenderingMode)Sets a value determining how ink (InkML) objects are rendered.
set_MemoryOptimization(bool)Sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
set_PrettyFormat(bool)When true, pretty formats output where applicable. Default value is false.
set_ProgressCallback(const System::SharedPtr<Aspose::Words::Saving::IDocumentSavingCallback> &)Called during saving a document and accepts data about saving progress.
virtual set_SaveFormat(Aspose::Words::SaveFormat)Specifies the format in which the document will be saved if this save options object is used.
set_TempFolder(const System::String &)Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default, this property is null and no temporary files are used.
set_UpdateAmbiguousTextFont(bool)Determines whether the font attributes will be changed according to the character code being used.
set_UpdateCreatedTimeProperty(bool)Sets a value determining whether the CreatedTime property is updated before saving. Default value is false;
set_UpdateFields(bool)Sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true.
set_UpdateLastPrintedProperty(bool)Sets a value determining whether the LastPrinted property is updated before saving.
set_UpdateLastSavedTimeProperty(bool)Sets a value determining whether the LastSavedTime property is updated before saving.
set_UpdateOleControlImages(bool)Sets a value determining whether OLE controls presentation image will be updated.
set_UseAntiAliasing(bool)Sets a value determining whether or not to use anti-aliasing for rendering.
set_UseHighQualityRendering(bool)Sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.

Examples

Shows how to save a document to the Postscript format in the form of a book fold.

auto doc = System::MakeObject<Aspose::Words::Document>(System::String(get_MyDir() + u"Paragraphs.docx"));

// Create a "PsSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to PostScript.
// Set the "UseBookFoldPrintingSettings" property to "true" to arrange the contents
// in the output Postscript document in a way that helps us make a booklet out of it.
// Set the "UseBookFoldPrintingSettings" property to "false" to save the document normally.
auto saveOptions = System::MakeObject<Aspose::Words::Saving::PsSaveOptions>();
saveOptions->set_SaveFormat(SaveFormat::Ps);
saveOptions->set_UseBookFoldPrintingSettings(renderTextAsBookFold);

// If we are rendering the document as a booklet, we must set the "MultiplePages"
// properties of the page setup objects of all sections to "MultiplePagesType.BookFoldPrinting".
for (auto&& s : System::IterateOver<Aspose::Words::Section>(doc->get_Sections()))
{
    s->get_PageSetup()->set_MultiplePages(MultiplePagesType::BookFoldPrinting);
}

// Once we print this document on both sides of the pages, we can fold all the pages down the middle at once,
// and the contents will line up in a way that creates a booklet.
doc->Save(get_ArtifactsDir() + u"PsSaveOptions.UseBookFoldPrintingSettings.ps", saveOptions);

See Also