java.lang.Objectcom.aspose.words.Style
public class Style
Example: Example:
Document doc = new Document();
for (Style style : doc.getStyles())
{
if (style.getFont() != null)
{
style.getFont().clearFormatting();
style.getFont().setSize(20);
style.getFont().setName("Arial");
}
}
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Create a paragraph style and specify some formatting for it.
Style style = doc.getStyles().add(StyleType.PARAGRAPH, "MyStyle1");
style.getFont().setSize(24);
style.getFont().setName("Verdana");
style.getParagraphFormat().setSpaceAfter(12);
// Create a list and make sure the paragraphs that use this style will use this list.
style.getListFormat().setList(doc.getLists().add(ListTemplate.BULLET_DEFAULT));
style.getListFormat().setListLevelNumber(0);
// Apply the paragraph style to the current paragraph in the document and add some text.
builder.getParagraphFormat().setStyle(style);
builder.writeln("Hello World: MyStyle1, bulleted.");
// Change to a paragraph style that has no list formatting.
builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
builder.writeln("Hello World: Normal.");
builder.getDocument().save(getMyDir() + "Lists.ParagraphStyleBulleted Out.doc");
Property Getters/Setters Summary | ||
---|---|---|
java.lang.String | getBaseStyleName() | |
void | setBaseStyleName(java.lang.String value) | |
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. | ||
DocumentBase | getDocument() | |
Gets the owner document. | ||
Font | getFont() | |
Gets the character formatting of the style. | ||
boolean | isHeading() | |
True when the style is one of the built-in Heading styles. | ||
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() | |
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. | ||
ParagraphFormat | getParagraphFormat() | |
Gets the paragraph formatting of the style. | ||
int | getStyleIdentifier() | |
Gets the locale independent style identifier for a built-in style. The value of the property is StyleIdentifier integer constant. | ||
StyleCollection | getStyles() | |
Gets the collection of styles this style belongs to. | ||
int | getType() | |
Gets the style type (paragraph or character). The value of the property is StyleType integer constant. |
Property Getters/Setters Detail |
---|
getBaseStyleName/setBaseStyleName | |
public java.lang.String getBaseStyleName() / public void setBaseStyleName(java.lang.String value) |
getBuiltIn | |
public boolean getBuiltIn() |
Example:
Applies double underline to all runs in a document that are formatted with custom character styles.Document doc = new Document(getMyDir() + "Font.Style.doc"); // Select all run nodes in the document. NodeCollection runs = doc.getChildNodes(NodeType.RUN, true); // Loop through every run node. for (Run run : (Iterable<Run>) runs) { Style charStyle = run.getFont().getStyle(); // If the style of the run is not a built-in character style, apply double underline. if (!charStyle.getBuiltIn()) run.getFont().setUnderline(Underline.DOUBLE); } doc.save(getMyDir() + "Font.Style Out.doc");
getDocument | |
public DocumentBase getDocument() |
getFont | |
public Font getFont() |
For list styles this property returns null.
Example:
Shows how to change the font formatting of all styles in a document.Document doc = new Document(); for (Style style : doc.getStyles()) { if (style.getFont() != null) { style.getFont().clearFormatting(); style.getFont().setSize(20); style.getFont().setName("Arial"); } }
Example:
Shows how to create and use a paragraph style with list formatting.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Create a paragraph style and specify some formatting for it. Style style = doc.getStyles().add(StyleType.PARAGRAPH, "MyStyle1"); style.getFont().setSize(24); style.getFont().setName("Verdana"); style.getParagraphFormat().setSpaceAfter(12); // Create a list and make sure the paragraphs that use this style will use this list. style.getListFormat().setList(doc.getLists().add(ListTemplate.BULLET_DEFAULT)); style.getListFormat().setListLevelNumber(0); // Apply the paragraph style to the current paragraph in the document and add some text. builder.getParagraphFormat().setStyle(style); builder.writeln("Hello World: MyStyle1, bulleted."); // Change to a paragraph style that has no list formatting. builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal")); builder.writeln("Hello World: Normal."); builder.getDocument().save(getMyDir() + "Lists.ParagraphStyleBulleted Out.doc");
isHeading | |
public boolean isHeading() |
getList | |
public List getList() |
This property is only valid for list styles. For other style types this property returns null.
Example:
Shows how to create a list style and use it in a document.Document doc = new Document(); // Create a new list style. // List formatting associated with this list style is default numbered. Style listStyle = doc.getStyles().add(StyleType.LIST, "MyListStyle"); // This list defines the formatting of the list style. // Note this list can not be used directly to apply formatting to paragraphs (see below). List list1 = listStyle.getList(); // Check some basic rules about the list that defines a list style. System.out.println("IsListStyle: " + list1.isListStyleDefinition()); // Will be true System.out.println("IsListStyleReference: " + list1.isListStyleReference()); // Will be false System.out.println("IsMultiLevel: " + list1.isMultiLevel()); // Will be true System.out.println("List style has been set: " + (listStyle == list1.getStyle())); // Are equal // Modify formatting of the list style to our liking. for (int i = 0; i < list1.getListLevels().getCount(); i++) { ListLevel level = list1.getListLevels().get(i); level.getFont().setName("Verdana"); level.getFont().setColor(Color.BLUE); level.getFont().setBold(true); } // Add some text to our document and use the list style. DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Using list style first time:"); // This creates a list based on the list style. List list2 = doc.getLists().add(listStyle); // Check some basic rules about the list that references a list style. System.out.println("IsListStyleDefinition: " + list2.isListStyleDefinition()); // Will be false System.out.println("IsListStyleReference: " + list2.isListStyleReference()); // Will be true System.out.println("List Style has been set: " + (listStyle == list2.getStyle())); // Are equal // Apply the list that references the list style. builder.getListFormat().setList(list2); builder.writeln("Item 1"); builder.writeln("Item 2"); builder.getListFormat().removeNumbers(); builder.writeln("Using list style second time:"); // Create and apply another list based on the list style. List list3 = doc.getLists().add(listStyle); builder.getListFormat().setList(list3); builder.writeln("Item 1"); builder.writeln("Item 2"); builder.getListFormat().removeNumbers(); builder.getDocument().save(getMyDir() + "Lists.CreateAndUseListStyle Out.doc");
getListFormat | |
public ListFormat getListFormat() |
This property is only valid for paragraph styles. For other style types this property returns null.
Example:
Shows how to create and use a paragraph style with list formatting.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Create a paragraph style and specify some formatting for it. Style style = doc.getStyles().add(StyleType.PARAGRAPH, "MyStyle1"); style.getFont().setSize(24); style.getFont().setName("Verdana"); style.getParagraphFormat().setSpaceAfter(12); // Create a list and make sure the paragraphs that use this style will use this list. style.getListFormat().setList(doc.getLists().add(ListTemplate.BULLET_DEFAULT)); style.getListFormat().setListLevelNumber(0); // Apply the paragraph style to the current paragraph in the document and add some text. builder.getParagraphFormat().setStyle(style); builder.writeln("Hello World: MyStyle1, bulleted."); // Change to a paragraph style that has no list formatting. builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal")); builder.writeln("Hello World: Normal."); builder.getDocument().save(getMyDir() + "Lists.ParagraphStyleBulleted Out.doc");
getName | |
public java.lang.String getName() |
Names of built-in styles in documents created in different languages of MS Word can be different.
Example:
Shows how to get access to the collection of styles defined in the document.Document doc = new Document(); StyleCollection styles = doc.getStyles(); for (Style style : styles) System.out.println(style.getName());
getNextParagraphStyleName/setNextParagraphStyleName | |
public java.lang.String getNextParagraphStyleName() / public void setNextParagraphStyleName(java.lang.String value) |
getParagraphFormat | |
public ParagraphFormat getParagraphFormat() |
For character and list styles this property returns null.
Example:
Shows how to create and use a paragraph style with list formatting.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Create a paragraph style and specify some formatting for it. Style style = doc.getStyles().add(StyleType.PARAGRAPH, "MyStyle1"); style.getFont().setSize(24); style.getFont().setName("Verdana"); style.getParagraphFormat().setSpaceAfter(12); // Create a list and make sure the paragraphs that use this style will use this list. style.getListFormat().setList(doc.getLists().add(ListTemplate.BULLET_DEFAULT)); style.getListFormat().setListLevelNumber(0); // Apply the paragraph style to the current paragraph in the document and add some text. builder.getParagraphFormat().setStyle(style); builder.writeln("Hello World: MyStyle1, bulleted."); // Change to a paragraph style that has no list formatting. builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal")); builder.writeln("Hello World: Normal."); builder.getDocument().save(getMyDir() + "Lists.ParagraphStyleBulleted Out.doc");
getStyleIdentifier | |
public int getStyleIdentifier() |
For user defined (custom) styles, this property returns
Example:
Shows how to modify the position of the right tab stop in TOC related paragraphs.Document doc = new Document(getMyDir() + "Document.TableOfContents.doc"); // Iterate through all paragraphs in the document for (Paragraph para : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true)) { // Check if this paragraph is formatted using the TOC result based styles. This is any style between TOC and TOC9. if (para.getParagraphFormat().getStyle().getStyleIdentifier() >= StyleIdentifier.TOC_1 && para.getParagraphFormat().getStyle().getStyleIdentifier() <= StyleIdentifier.TOC_9) { // Get the first tab used in this paragraph, this should be the tab used to align the page numbers. TabStop tab = para.getParagraphFormat().getTabStops().get(0); // Remove the old tab from the collection. para.getParagraphFormat().getTabStops().removeByPosition(tab.getPosition()); // Insert a new tab using the same properties but at a modified position. // We could also change the separators used (dots) by passing a different Leader type para.getParagraphFormat().getTabStops().add(tab.getPosition() - 50, tab.getAlignment(), tab.getLeader()); } } doc.save(getMyDir() + "Document.TableOfContentsTabStops Out.doc");
getStyles | |
public StyleCollection getStyles() |
getType | |
public int getType() |