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.

Properties

NameDescription
countGets the number of styles in the collection.
defaultFontGets document default text formatting.
defaultParagraphFormatGets document default paragraph formatting.
documentGets the owner document.
this[]
this[]
this[]

Methods

NameDescription
add(type, name)Creates a new user defined style and adds it the collection.
addCopy(style)Copies a style into this collection.
clearQuickStyleGallery()Removes all styles from the Quick Style Gallery panel.

Examples

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

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);

// Create a custom paragraph style.
let style = doc.styles.add(aw.StyleType.Paragraph, "MyStyle1");
style.font.size = 24;
style.font.name = "Verdana";
style.paragraphFormat.spaceAfter = 12;

// Create a list and make sure the paragraphs that use this style will use this list.
style.listFormat.list = doc.lists.add(aw.Lists.ListTemplate.BulletDefault);
style.listFormat.listLevelNumber = 0;

// Apply the paragraph style to the document builder's current paragraph, and then add some text.
builder.paragraphFormat.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.paragraphFormat.style = doc.styles.at("Normal");
builder.writeln("Hello World: Normal.");

builder.document.save(base.artifactsDir + "Styles.ParagraphStyleBulletedList.docx");

See Also