insert_style_separator method

insert_style_separator()

Inserts style separator into the document.

def insert_style_separator(self):
    ...

Remarks

This method allows to apply different paragraph styles to two different parts of a text line.

Examples

Shows how to work with style separators.

doc = aw.Document()
builder = aw.DocumentBuilder(doc)

# Each paragraph can only have one style.
# The "insert_style_separator" method allows us to work around this limitation.
builder.paragraph_format.style_identifier = aw.StyleIdentifier.HEADING1
builder.write("This text is in a Heading style. ")
builder.insert_style_separator()

para_style = builder.document.styles.add(aw.StyleType.PARAGRAPH, "MyParaStyle")
para_style.font.bold = False
para_style.font.size = 8
para_style.font.name = "Arial"

builder.paragraph_format.style_name = para_style.name
builder.write("This text is in a custom style. ")

# Calling the "insert_style_separator" method creates another paragraph,
# which can have a different style to the previous. There will be no break between paragraphs.
# The text in the output document will look like one paragraph with two styles.
self.assertEqual(2, doc.first_section.body.paragraphs.count)
self.assertEqual("Heading 1", doc.first_section.body.paragraphs[0].paragraph_format.style.name)
self.assertEqual("MyParaStyle", doc.first_section.body.paragraphs[1].paragraph_format.style.name)

doc.save(ARTIFACTS_DIR + "DocumentBuilder.insert_style_separator.docx")

See Also