Style (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.Style

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

TableStyle
```
public class Style
extends java.lang.Object
implements java.lang.Cloneable
```
Represents a single built-in or user-defined style.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Style(int styleType)
Initializes a new instance of this class.

Constructors
Modifier	Constructor and Description
`protected`	`Style(int styleType)` Initializes a new instance of this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearParaAttrs()`
`void`	`clearRunAttrs()`
`boolean`	`equals(Style style)` Compares with the specified style.
`java.lang.Object`	`fetchInheritedParaAttr(int key)`
`java.lang.Object`	`fetchInheritedRunAttr(int key)`
`java.lang.Object`	`fetchParaAttr(int key)`
`java.lang.String[]`	`getAliases()` Gets all aliases of this style.
`java.lang.String`	`getBaseStyleName()` Gets/sets the name of the style this style is based on.
`boolean`	`getBuiltIn()` True if this style is one of the built-in styles in MS Word.
`java.lang.Object`	`getDirectParaAttr(int key)`
`java.lang.Object`	`getDirectParaAttr(int key, int revisionsView)`
`java.lang.Object`	`getDirectRunAttr(int key)`
`DocumentBase`	`getDocument()` Gets the owner document.
`Font`	`getFont()` Gets the character formatting of the style.
`java.lang.String`	`getLinkedStyleName()` Gets the name of the Style linked to this one.
`List`	`getList()` Gets the list that defines formatting of this list style.
`ListFormat`	`getListFormat()` Provides access to the list formatting properties of a paragraph style.
`java.lang.String`	`getName()` Gets the name of the style.
`java.lang.String`	`getNextParagraphStyleName()` Gets/sets the name of the style to be applied automatically to a new paragraph inserted after a paragraph formatted with the specified style.
`ParagraphFormat`	`getParagraphFormat()` Gets the paragraph formatting of the style.
`int`	`getStyleIdentifier()` Gets the locale independent style identifier for a built-in style.
`StyleCollection`	`getStyles()` Gets the collection of styles this style belongs to.
`int`	`getType()` Gets the style type (paragraph or character).
`boolean`	`isHeading()` True when the style is one of the built-in Heading styles.
`boolean`	`isQuickStyle()` Specifies whether this style is shown in the Quick Style gallery inside MS Word UI.
`void`	`isQuickStyle(boolean value)` Specifies whether this style is shown in the Quick Style gallery inside MS Word UI.
`protected java.lang.Object`	`memberwiseClone()`
`void`	`remove()` Removes the specified style from the document.
`void`	`removeParaAttr(int key)`
`void`	`removeRunAttr(int key)`
`void`	`setBaseStyleName(java.lang.String value)` Gets/sets the name of the style this style is based on.
`void`	`setName(java.lang.String value)` Sets the name of the style.
`void`	`setNextParagraphStyleName(java.lang.String value)` Gets/sets the name of the style to be applied automatically to a new paragraph inserted after a paragraph formatted with the specified style.
`void`	`setParaAttr(int key, java.lang.Object value)`
`void`	`setRunAttr(int key, java.lang.Object value)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Style
```
protected Style(int styleType)
```
    Initializes a new instance of this class.
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Gets the name of the style.
    Can not be empty string.
    
    If there already is a style with such name in the collection, then this style will override it. All affected nodes will reference new style.
    
    Returns:
    
    The name of the style.
  - setName
```
public void setName(java.lang.String value)
```
    Sets the name of the style.
    Can not be empty string.
    
    If there already is a style with such name in the collection, then this style will override it. All affected nodes will reference new style.
    
    Parameters:
    
    value - The name of the style.
  - getStyleIdentifier
```
public int getStyleIdentifier()
```
    Gets the locale independent style identifier for a built-in style.
    For user defined (custom) styles, this property returns StyleIdentifier.USER.
    
    Returns:
    
    The locale independent style identifier for a built-in style. The returned value is one of StyleIdentifier constants.
    
    See Also:
    
    getName(), setName(java.lang.String)
  - getAliases
```
public java.lang.String[] getAliases()
```
    Gets all aliases of this style. If style has no aliases then empty array of string is returned.
    
    Returns:
    
    All aliases of this style.
  - isHeading
```
public boolean isHeading()
```
    True when the style is one of the built-in Heading styles.
    
    Returns:
    
    The corresponding boolean value.
  - getType
```
public int getType()
```
    Gets the style type (paragraph or character).
    
    Returns:
    
    The style type (paragraph or character). The returned value is one of StyleType constants.
  - getDocument
```
public DocumentBase getDocument()
```
    Gets the owner document.
    
    Returns:
    
    The owner document.
  - getLinkedStyleName
```
public java.lang.String getLinkedStyleName()
```
    Gets the name of the Style linked to this one. Returns Empty string if no styles are linked.
    
    Returns:
    
    The name of the Style linked to this one.
  - getBaseStyleName
```
public java.lang.String getBaseStyleName()
```
    Gets/sets the name of the style this style is based on. This will be an empty string if the style is not based on any other style and it can be set to an empty string.
    
    Returns:
    
    The corresponding String value.
  - setBaseStyleName
```
public void setBaseStyleName(java.lang.String value)
```
    Gets/sets the name of the style this style is based on. This will be an empty string if the style is not based on any other style and it can be set to an empty string.
    
    Parameters:
    
    value - The corresponding String value.
  - getNextParagraphStyleName
```
public java.lang.String getNextParagraphStyleName()
```
    Gets/sets the name of the style to be applied automatically to a new paragraph inserted after a paragraph formatted with the specified style. This property is not used by Aspose.Words. The next paragraph style will only be applied automatically when you edit the document in MS Word.
    
    Returns:
    
    The corresponding String value.
  - setNextParagraphStyleName
```
public void setNextParagraphStyleName(java.lang.String value)
```
    Gets/sets the name of the style to be applied automatically to a new paragraph inserted after a paragraph formatted with the specified style. This property is not used by Aspose.Words. The next paragraph style will only be applied automatically when you edit the document in MS Word.
    
    Parameters:
    
    value - The corresponding String value.
  - getBuiltIn
```
public boolean getBuiltIn()
```
    True if this style is one of the built-in styles in MS Word.
    
    Returns:
    
    The corresponding boolean value.
  - getFont
```
public Font getFont()
```
    Gets the character formatting of the style.
    For list styles this property returns null.
    
    Returns:
    
    The character formatting of the style.
  - getParagraphFormat
```
public ParagraphFormat getParagraphFormat()
```
    Gets the paragraph formatting of the style.
    For character and list styles this property returns null.
    
    Returns:
    
    The paragraph formatting of the style.
  - getList
```
public List getList()
```
    Gets the list that defines formatting of this list style.
    This property is only valid for list styles. For other style types this property returns null.
    
    Returns:
    
    The list that defines formatting of this list style.
  - getListFormat
```
public ListFormat getListFormat()
```
    Provides access to the list formatting properties of a paragraph style.
    This property is only valid for paragraph styles. For other style types this property returns null.
    
    Returns:
    
    The corresponding ListFormat value.
  - isQuickStyle
```
public boolean isQuickStyle()
```
    Specifies whether this style is shown in the Quick Style gallery inside MS Word UI.
    
    Returns:
    
    The corresponding boolean value.
  - isQuickStyle
```
public void isQuickStyle(boolean value)
```
    Specifies whether this style is shown in the Quick Style gallery inside MS Word UI.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getStyles
```
public StyleCollection getStyles()
```
    Gets the collection of styles this style belongs to.
    
    Returns:
    
    The collection of styles this style belongs to.
  - remove
```
public void remove()
```
    Removes the specified style from the document. Style removal has following effects on the document model:
    - All references to the style are removed from corresponding paragraphs, runs and tables.
    - If base style is removed its formatting is moved to child styles.
    - If style to be deleted has a linked style, then both of these are deleted.
  - equals
```
public boolean equals(Style style)
```
    Compares with the specified style. Styles Istds are compared for built-in styles only. Styles defaults are not included in comparison. Base style, linked style and next paragraph style are recursively compared.
  - getDirectParaAttr
```
public java.lang.Object getDirectParaAttr(int key)
```
  - getDirectParaAttr
```
public java.lang.Object getDirectParaAttr(int key,
                                          int revisionsView)
```
  - fetchParaAttr
```
public java.lang.Object fetchParaAttr(int key)
```
  - fetchInheritedParaAttr
```
public java.lang.Object fetchInheritedParaAttr(int key)
```
  - setParaAttr
```
public void setParaAttr(int key,
                        java.lang.Object value)
```
  - removeParaAttr
```
public void removeParaAttr(int key)
```
  - clearParaAttrs
```
public void clearParaAttrs()
```
  - getDirectRunAttr
```
public java.lang.Object getDirectRunAttr(int key)
```
  - fetchInheritedRunAttr
```
public java.lang.Object fetchInheritedRunAttr(int key)
```
  - setRunAttr
```
public void setRunAttr(int key,
                       java.lang.Object value)
```
  - removeRunAttr
```
public void removeRunAttr(int key)
```
  - clearRunAttrs
```
public void clearRunAttrs()
```
  - memberwiseClone
```
protected java.lang.Object memberwiseClone()
```

Class Style

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Style

Method Detail

getName

setName

getStyleIdentifier

getAliases

isHeading

getType

getDocument

getLinkedStyleName

getBaseStyleName

setBaseStyleName

getNextParagraphStyleName

setNextParagraphStyleName

getBuiltIn

getFont

getParagraphFormat

getList

getListFormat

isQuickStyle

isQuickStyle

getStyles

remove

equals

getDirectParaAttr

getDirectParaAttr

fetchParaAttr

fetchInheritedParaAttr

setParaAttr

removeParaAttr

clearParaAttrs

getDirectRunAttr

fetchInheritedRunAttr

setRunAttr

removeRunAttr

clearRunAttrs

memberwiseClone