StyleCollection class

StyleCollection class

A collection of Style objects that represent both the built-in and user-defined styles in a document. To learn more, visit the Working with Styles and Themes documentation article.

Indexers

Name Description
__getitem__(index) Gets a style by index.

Properties

Name Description
count Gets the number of styles in the collection.
default_font Gets document default text formatting.
default_paragraph_format Gets document default paragraph formatting.
document Gets the owner document.

Methods

Name Description
add(type, name) Creates a new user defined style and adds it the collection.
add_copy(style) Copies a style into this collection.
clear_quick_style_gallery() Removes all styles from the Quick Style Gallery panel.
get_by_name(name) Gets a style by name or alias.
get_by_style_identifier(sti) Gets a built-in style by its locale independent identifier.

Examples

Shows how to create and use a paragraph style with list formatting.

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

# Create a custom paragraph style.
style = doc.styles.add(aw.StyleType.PARAGRAPH, "MyStyle1")
style.font.size = 24
style.font.name = "Verdana"
style.paragraph_format.space_after = 12

# Create a list and make sure the paragraphs that use this style will use this list.
style.list_format.list = doc.lists.add(aw.lists.ListTemplate.BULLET_DEFAULT)
style.list_format.list_level_number = 0

# Apply the paragraph style to the document builder's current paragraph, and then add some text.
builder.paragraph_format.style = style
builder.writeln("Hello World: MyStyle1, bulleted list.")

# Change the document builder's style to one that has no list formatting and write another paragraph.
builder.paragraph_format.style = doc.styles.get_by_name("Normal")
builder.writeln("Hello World: Normal.")

builder.document.save(ARTIFACTS_DIR + "Styles.paragraph_style_bulleted_list.docx")

See Also