display_doc_title property

PdfSaveOptions.display_doc_title property

A flag specifying whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary.

@property
def display_doc_title(self) -> bool:
    ...

@display_doc_title.setter
def display_doc_title(self, value: bool):
    ...

Remarks

If False, the title bar should instead display the name of the PDF file containing the document.

This flag is required by PDF/UA compliance. True value will be used automatically when saving to PDF/UA.

The default value is False.

Examples

Shows how to display the title of the document as the title bar.

doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
builder.writeln('Hello world!')
doc.built_in_document_properties.title = 'Windows bar pdf title'
# Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
# to modify how that method converts the document to .PDF.
# Set the "DisplayDocTitle" to "true" to get some PDF readers, such as Adobe Acrobat Pro,
# to display the value of the document's "Title" built-in property in the tab that belongs to this document.
# Set the "DisplayDocTitle" to "false" to get such readers to display the document's filename.
pdf_save_options = aw.saving.PdfSaveOptions()
pdf_save_options.display_doc_title = display_doc_title
doc.save(file_name=ARTIFACTS_DIR + 'PdfSaveOptions.DocTitle.pdf', save_options=pdf_save_options)

See Also

• module aspose.words.saving
• class PdfSaveOptions