ignore_text_boxes property

ImportFormatOptions.ignore_text_boxes property

Gets or sets a boolean value that specifies that source formatting of textboxes content ignored if ImportFormatMode.KEEP_SOURCE_FORMATTING mode is used. The default value is True.

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

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

Examples

Shows how to manage text box formatting while appending a document.

# Create a document that will have nodes from another document inserted into it.
dst_doc = aw.Document()
builder = aw.DocumentBuilder(dst_doc)

builder.writeln("Hello world!")

# Create another document with a text box, which we will import into the first document.
src_doc = aw.Document()
builder = aw.DocumentBuilder(src_doc)

text_box = builder.insert_shape(aw.drawing.ShapeType.TEXT_BOX, 300, 100)
builder.move_to(text_box.first_paragraph)
builder.paragraph_format.style.font.name = "Courier New"
builder.paragraph_format.style.font.size = 24
builder.write("Textbox contents")

# Set a flag to specify whether to clear or preserve text box formatting
# while importing them to other documents.
import_format_options = aw.ImportFormatOptions()
import_format_options.ignore_text_boxes = ignore_text_boxes

# Import the text box from the source document into the destination document,
# and then verify whether we have preserved the styling of its text contents.
importer = aw.NodeImporter(src_doc, dst_doc, aw.ImportFormatMode.KEEP_SOURCE_FORMATTING, import_format_options)
imported_text_box = importer.import_node(text_box, True).as_shape()
dst_doc.first_section.body.paragraphs[1].append_child(imported_text_box)

if ignore_text_boxes:
    self.assertEqual(12.0, imported_text_box.first_paragraph.runs[0].font.size)
    self.assertEqual("Times New Roman", imported_text_box.first_paragraph.runs[0].font.name)
else:
    self.assertEqual(24.0, imported_text_box.first_paragraph.runs[0].font.size)
    self.assertEqual("Courier New", imported_text_box.first_paragraph.runs[0].font.name)

dst_doc.save(ARTIFACTS_DIR + "DocumentBuilder.ignore_text_boxes.docx")

ignore_text_boxes property

ImportFormatOptions.ignore_text_boxes property

Examples

See Also