Specify Save Options

When saving a document, you can set some advanced properties. Aspose.Words provides you with the SaveOptions class, which allows more precise control of the save process. There are overloads of the Save method that accept a SaveOptions object – it should be an object of a class derived from the SaveOptions class. Each save format has a corresponding class that holds save options for this save format, for example, there is PdfSaveOptions for saving to PDF format, MarkdownSaveOptions for saving to Markdown format, or ImageSaveOptions for saving to an image. This article provides examples of working with some options classes derived from SaveOptions.

The following code example shows how to set the save options before saving the document into HTML:

The article describes a few properties you can control when saving a document.

Encrypt a Document With a Password

Use the Password property to get or set a password for an encrypted document. Use the Password property of the corresponding class to work with the selected document format.

For example, when saving a document to DOC or DOT format, use the get_Password() property of the DocSaveOptions class.

The following code example shows how to set a password to encrypt a document using the RC4 encryption method:

When saving a document to ODT format, use the get_Password() property of the OdtSaveOptions class.

The following code example shows how to load and save OpenDocument encrypted with a password:

Not all formats support encryption and the use of Password property.

Show Document Saving Progress Notifications

Aspose.Words provides the ability to use the get_ProgressCallback() property to get notifications about the progress of document saving.

It is now available when saving to DOCX, FlatOpc, DOCM, DOTM, DOTX, HTML, MHTML, EPUB, XamlFlow, XamlFlowPack, or TXT formats.

Update the Document Creation Time

Aspose.Words provides an ability to use the get_CreatedTime() property to get or set the document creation date in UTC. You can also update this value before saving using the get_UpdateCreatedTimeProperty() option.

The following code example shows how to update the document creation time:

Update Last Saved Property

Aspose.Words provides an ability to use the set_UpdateLastSavedTimeProperty() property to get or set a value determining whether the get_LastSavedTime() property is updated before saving.

The following code example shows how to set this property and save the document:

Control External Resources When Saving a Document into HTML or SVG

To convert HTML or SVG into PDF, simply invoke the Save method and specify a file name with the “.PDF” extension. If you want to load images, CSS, etc. from external sources, you can use IResourceSavingCallback.

Save Black and White Image with One Bit Per Pixel Format

To control image saving options, the ImageSaveOptions class is used. For example, you can use the set_PixelFormat() property to set the pixel format for the generated images. Please note that the pixel format of the output image may differ from the set value because of the work of GDI+.

The following code example shows how to save a black and white image with one bit per pixel format:

FAQ

  1. Q: How can I set a password when saving a document to PDF in C++?
    A: Create a PdfEncryptionDetails object with the password and assign it to the get_EncryptionDetails() property of PdfSaveOptions. Then pass the PdfSaveOptions instance to Document::Save. Example:

    auto saveOptions = System::MakeObject<Aspose::Words::Saving::PdfSaveOptions>();
    saveOptions->set_EncryptionDetails(
        System::MakeObject<Aspose::Words::Saving::PdfEncryptionDetails>(u"Secret123", u""));
    doc->Save(u"Encrypted.pdf", saveOptions);
    
  2. Q: Which property lets me receive progress notifications while a document is being saved?
    A: Assign an implementation of IDocumentSavingCallback to the get_ProgressCallback() property of the appropriate SaveOptions class (e.g., OoxmlSaveOptions). The callback’s Notify method is called periodically, and DocumentSavingArgs::get_EstimatedProgress() returns the percentage completed. Progress is reported when saving to DOCX, FlatOpc, DOCM, DOTM, DOTX, DOC, DOT, HTML, MHTML, EPUB, XamlFlow, or XamlFlowPack.

  3. Q: How do I update the document’s creation time before saving?
    A: Set the set_CreatedTime() property of the document’s built‑in properties, then enable get_UpdateCreatedTimeProperty() on the SaveOptions you use.

    doc->get_BuiltInDocumentProperties()->set_CreatedTime(System::DateTime::get_Now());
    auto saveOptions = Aspose::Words::Saving::SaveOptions::CreateSaveOptions(Aspose::Words::SaveFormat::Docx);
    saveOptions->set_UpdateCreatedTimeProperty(true);
    doc->Save(u"output.docx", saveOptions);
    
  4. Q: Can I force the last‑saved timestamp to be refreshed when saving?
    A: Yes. Set set_UpdateLastSavedTimeProperty() to true on the SaveOptions object you pass to Document::Save. This makes Aspose.Words write the current UTC time to the set_LastSavedTime() property.

  5. Q: How can I save an image generated from a document as a 1‑bit black‑and‑white PNG?
    A: Use ImageSaveOptions, set its set_PixelFormat() to ImagePixelFormat::Format1bppIndexed, and then save the document page as an image.

    auto imgOptions = System::MakeObject<Aspose::Words::Saving::ImageSaveOptions>(Aspose::Words::SaveFormat::Png);
    imgOptions->set_PixelFormat(Aspose::Words::Saving::ImagePixelFormat::Format1bppIndexed);
    doc->Save(u"page.png", imgOptions);