join_runs_with_same_formatting method

join_runs_with_same_formatting()

Joins runs with same formatting in all paragraphs of the document.

def join_runs_with_same_formatting(self):
    ...

Remarks

This is an optimization method. Some documents contain adjacent runs with same formatting. Usually this occurs if a document was intensively edited manually. You can reduce the document size and speed up further processing by joining these runs.

The operation checks every Paragraph node in the document for adjacent Run nodes having identical properties. It ignores unique identifiers used to track editing sessions of run creation and modification. First run in every joining sequence accumulates all text. Remaining runs are deleted from the document.

Returns

Number of joins performed. When N adjacent runs are being joined they count as N - 1 joins.

Examples

Shows how to join runs in a document to reduce unneeded runs.

# Open a document that contains adjacent runs of text with identical formatting,
# which commonly occurs if we edit the same paragraph multiple times in Microsoft Word.
doc = aw.Document(file_name=MY_DIR + 'Rendering.docx')
# If any number of these runs are adjacent with identical formatting,
# then the document may be simplified.
self.assertEqual(317, doc.get_child_nodes(aw.NodeType.RUN, True).count)
# Combine such runs with this method and verify the number of run joins that will take place.
self.assertEqual(121, doc.join_runs_with_same_formatting())
# The number of joins and the number of runs we have after the join
# should add up the number of runs we had initially.
self.assertEqual(196, doc.get_child_nodes(aw.NodeType.RUN, True).count)

join_runs_with_same_formatting method