clear_formatting method

clear_formatting()

Resets to default paragraph formatting.

def clear_formatting(self):
    ...

Remarks

Default paragraph formatting is Normal style, left aligned, no indentation, no spacing, no borders and no shading.

Examples

Shows how to nest a list inside another list.

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

# A list allows us to organize and decorate sets of paragraphs with prefix symbols and indents.
# We can create nested lists by increasing the indent level.
# We can begin and end a list by using a document builder's "list_format" property.
# Each paragraph that we add between a list's start and the end will become an item in the list.
# Create an outline list for the headings.
outline_list = doc.lists.add(aw.lists.ListTemplate.OUTLINE_NUMBERS)
builder.list_format.list = outline_list
builder.paragraph_format.style_identifier = aw.StyleIdentifier.HEADING1
builder.writeln("This is my Chapter 1")

# Create a numbered list.
numbered_list = doc.lists.add(aw.lists.ListTemplate.NUMBER_DEFAULT)
builder.list_format.list = numbered_list
builder.paragraph_format.style_identifier = aw.StyleIdentifier.NORMAL
builder.writeln("Numbered list item 1.")

# Every paragraph that comprises a list will have this flag.
self.assertTrue(builder.current_paragraph.is_list_item)
self.assertTrue(builder.paragraph_format.is_list_item)

# Create a bulleted list.
bulleted_list = doc.lists.add(aw.lists.ListTemplate.BULLET_DEFAULT)
builder.list_format.list = bulleted_list
builder.paragraph_format.left_indent = 72
builder.writeln("Bulleted list item 1.")
builder.writeln("Bulleted list item 2.")
builder.paragraph_format.clear_formatting()

# Revert to the numbered list.
builder.list_format.list = numbered_list
builder.writeln("Numbered list item 2.")
builder.writeln("Numbered list item 3.")

# Revert to the outline list.
builder.list_format.list = outline_list
builder.paragraph_format.style_identifier = aw.StyleIdentifier.HEADING1
builder.writeln("This is my Chapter 2")

builder.paragraph_format.clear_formatting()

builder.document.save(ARTIFACTS_DIR + "Lists.nested_lists.docx")

See Also