com.aspose.words

Class StyleCollection

java.lang.Object

com.aspose.words.StyleCollection

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Iterable

public class StyleCollection
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Iterable

A collection of Style objects that represent both the built-in and user-defined styles in a document.

Method Summary

Modifier and Type	Method and Description
Style	add(int type, java.lang.String name)
Style	addCopy(Style style) Copies a style into this collection.
void	clearQuickStyleGallery() Removes all styles from the Quick Style Gallery panel.
Style	get(int index) Gets a style by index.
Style	get(java.lang.String name) Retrieves a style from the collection.
Style	getByStyleIdentifier(int sti)
int	getCount() Gets the number of styles in the collection.
Font	getDefaultFont() Gets document default text formatting.
ParagraphFormat	getDefaultParagraphFormat() Gets document default paragraph formatting.
DocumentBase	getDocument() Gets the owner document.
java.util.Iterator	iterator() Gets an enumerator object that will enumerate styles in the alphabetical order of their names.
protected java.lang.Object	memberwiseClone()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

clearQuickStyleGallery

public void clearQuickStyleGallery()

Removes all styles from the Quick Style Gallery panel.

getDocument

public DocumentBase getDocument()

Gets the owner document.

Returns:

The owner document.

getDefaultFont

public Font getDefaultFont()

Gets document default text formatting.

Note that document-wide defaults were introduced in Microsoft Word 2007 and are fully supported in OOXML formats ( LoadFormat.DOCX) only. Earlier document formats have limited support for this feature and only font names can be stored.

Returns:

Document default text formatting.

getDefaultParagraphFormat

public ParagraphFormat getDefaultParagraphFormat()

Gets document default paragraph formatting.

Note that document-wide defaults were introduced in Microsoft Word 2007 and are fully supported in OOXML formats ( LoadFormat.DOCX) only. Earlier document formats have no support for document default paragraph formatting.

Returns:

Document default paragraph formatting.

getCount

public int getCount()

Gets the number of styles in the collection.

Returns:

The number of styles in the collection.

get

public Style get(java.lang.String name)

Retrieves a style from the collection. Gets a style by name or alias.

Case sensitive, returns null if the style with the given name is not found.

If this is an English name of a built in style that does not yet exist, automatically creates it.

Returns:

The corresponding Style value.

getByStyleIdentifier

public Style getByStyleIdentifier(int sti)

get

public Style get(int index)

Gets a style by index.

Returns:

A style by index.

iterator

public java.util.Iterator iterator()

Gets an enumerator object that will enumerate styles in the alphabetical order of their names.

Specified by:

iterator in interface java.lang.Iterable

add

public Style add(int type,
                 java.lang.String name)

addCopy

public Style addCopy(Style style)

Copies a style into this collection.

Parameters:

style - Style to be copied.

Returns:

Copied style ready for usage.

memberwiseClone

protected java.lang.Object memberwiseClone()