com.aspose.words

Property Getters/Setters Detail

• getAliases

  public java.lang.String[] getAliases()
  

  Gets all aliases of this style. If style has no aliases then empty array of string is returned.

  Example:

  Shows how to use style aliases.

  Document doc = new Document(getMyDir() + "Style with alias.docx");
  
  // This document contains a style named "MyStyle,MyStyle Alias 1,MyStyle Alias 2".
  // If a style's name has multiple values separated by commas, each clause is a separate alias.
  Style style = doc.getStyles().get("MyStyle");
  Assert.assertEquals(new String[]{"MyStyle Alias 1", "MyStyle Alias 2"}, style.getAliases());
  Assert.assertEquals("Title", style.getBaseStyleName());
  Assert.assertEquals("MyStyle Char", style.getLinkedStyleName());
  
  // We can reference a style using its alias, as well as its name.
  Assert.assertEquals(doc.getStyles().get("MyStyle Alias 1"), doc.getStyles().get("MyStyle Alias 2"));
  
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.moveToDocumentEnd();
  builder.getParagraphFormat().setStyle(doc.getStyles().get("MyStyle Alias 1"));
  builder.writeln("Hello world!");
  builder.getParagraphFormat().setStyle(doc.getStyles().get("MyStyle Alias 2"));
  builder.write("Hello again!");
  
  Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().get(0).getParagraphFormat().getStyle(),
          doc.getFirstSection().getBody().getParagraphs().get(1).getParagraphFormat().getStyle());

• getAlignment/setAlignment

  public int getAlignment() / public void setAlignment(int value)
  

  Specifies the alignment for the table style. The value of the property is TableAlignment integer constant.

  The default value is TableAlignment.LEFT.

  Example:

  Shows how to set the position of a table.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Below are two ways of aligning a table horizontally.
  // 1 -  Use the "Alignment" property to align it to a location on the page, such as the center:
  TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  tableStyle.setAlignment(TableAlignment.CENTER);
  tableStyle.getBorders().setColor(Color.BLUE);
  tableStyle.getBorders().setLineStyle(LineStyle.SINGLE);
  
  // Insert a table and apply the style we created to it.
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Aligned to the center of the page");
  builder.endTable();
  table.setPreferredWidth(PreferredWidth.fromPoints(300.0));
  
  table.setStyle(tableStyle);
  
  // 2 -  Use the "LeftIndent" to specify an indent from the left margin of the page:
  tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle2");
  tableStyle.setLeftIndent(55.0);
  tableStyle.getBorders().setColor(Color.GREEN);
  tableStyle.getBorders().setLineStyle(LineStyle.SINGLE);
  
  table = builder.startTable();
  builder.insertCell();
  builder.write("Aligned according to left indent");
  builder.endTable();
  table.setPreferredWidth(PreferredWidth.fromPoints(300.0));
  
  table.setStyle(tableStyle);
  
  doc.save(getArtifactsDir() + "Table.SetTableAlignment.docx");

• getAllowBreakAcrossPages/setAllowBreakAcrossPages

  public boolean getAllowBreakAcrossPages() / public void setAllowBreakAcrossPages(boolean value)
  

  Gets or sets a flag indicating whether text in a table row is allowed to split across a page break.

  The default value is true.

  Example:

  Shows how to create custom style settings for the table.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Name");
  builder.insertCell();
  builder.write("مرحبًا");
  builder.endRow();
  builder.insertCell();
  builder.insertCell();
  builder.endTable();
  
  TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  tableStyle.setAllowBreakAcrossPages(true);
  tableStyle.setBidi(true);
  tableStyle.setCellSpacing(5.0);
  tableStyle.setBottomPadding(20.0);
  tableStyle.setLeftPadding(5.0);
  tableStyle.setRightPadding(10.0);
  tableStyle.setTopPadding(20.0);
  tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
  tableStyle.getBorders().setColor(Color.BLACK);
  tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
  tableStyle.setVerticalAlignment(CellVerticalAlignment.CENTER);
  
  table.setStyle(tableStyle);
  
  // Setting the style properties of a table may affect the properties of the table itself.
  Assert.assertTrue(table.getBidi());
  Assert.assertEquals(5.0d, table.getCellSpacing());
  Assert.assertEquals("MyTableStyle1", table.getStyleName());
  
  doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");

• getBaseStyleName/setBaseStyleName

  public java.lang.String getBaseStyleName() / 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.

  Example:

  Shows how to use style aliases.

  Document doc = new Document(getMyDir() + "Style with alias.docx");
  
  // This document contains a style named "MyStyle,MyStyle Alias 1,MyStyle Alias 2".
  // If a style's name has multiple values separated by commas, each clause is a separate alias.
  Style style = doc.getStyles().get("MyStyle");
  Assert.assertEquals(new String[]{"MyStyle Alias 1", "MyStyle Alias 2"}, style.getAliases());
  Assert.assertEquals("Title", style.getBaseStyleName());
  Assert.assertEquals("MyStyle Char", style.getLinkedStyleName());
  
  // We can reference a style using its alias, as well as its name.
  Assert.assertEquals(doc.getStyles().get("MyStyle Alias 1"), doc.getStyles().get("MyStyle Alias 2"));
  
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.moveToDocumentEnd();
  builder.getParagraphFormat().setStyle(doc.getStyles().get("MyStyle Alias 1"));
  builder.writeln("Hello world!");
  builder.getParagraphFormat().setStyle(doc.getStyles().get("MyStyle Alias 2"));
  builder.write("Hello again!");
  
  Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().get(0).getParagraphFormat().getStyle(),
          doc.getFirstSection().getBody().getParagraphs().get(1).getParagraphFormat().getStyle());

• getBidi/setBidi

  public boolean getBidi() / public void setBidi(boolean value)
  

  Gets or sets whether this is a style for a right-to-left table.

  When true, the cells in rows are laid out right to left.

  The default value is false.

  Example:

  Shows how to create custom style settings for the table.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Name");
  builder.insertCell();
  builder.write("مرحبًا");
  builder.endRow();
  builder.insertCell();
  builder.insertCell();
  builder.endTable();
  
  TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  tableStyle.setAllowBreakAcrossPages(true);
  tableStyle.setBidi(true);
  tableStyle.setCellSpacing(5.0);
  tableStyle.setBottomPadding(20.0);
  tableStyle.setLeftPadding(5.0);
  tableStyle.setRightPadding(10.0);
  tableStyle.setTopPadding(20.0);
  tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
  tableStyle.getBorders().setColor(Color.BLACK);
  tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
  tableStyle.setVerticalAlignment(CellVerticalAlignment.CENTER);
  
  table.setStyle(tableStyle);
  
  // Setting the style properties of a table may affect the properties of the table itself.
  Assert.assertTrue(table.getBidi());
  Assert.assertEquals(5.0d, table.getCellSpacing());
  Assert.assertEquals("MyTableStyle1", table.getStyleName());
  
  doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");

• getBorders

  public BorderCollection getBorders()
  

  Gets the collection of default cell borders for the style.

  Example:

  Shows how to create custom style settings for the table.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Name");
  builder.insertCell();
  builder.write("مرحبًا");
  builder.endRow();
  builder.insertCell();
  builder.insertCell();
  builder.endTable();
  
  TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  tableStyle.setAllowBreakAcrossPages(true);
  tableStyle.setBidi(true);
  tableStyle.setCellSpacing(5.0);
  tableStyle.setBottomPadding(20.0);
  tableStyle.setLeftPadding(5.0);
  tableStyle.setRightPadding(10.0);
  tableStyle.setTopPadding(20.0);
  tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
  tableStyle.getBorders().setColor(Color.BLACK);
  tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
  tableStyle.setVerticalAlignment(CellVerticalAlignment.CENTER);
  
  table.setStyle(tableStyle);
  
  // Setting the style properties of a table may affect the properties of the table itself.
  Assert.assertTrue(table.getBidi());
  Assert.assertEquals(5.0d, table.getCellSpacing());
  Assert.assertEquals("MyTableStyle1", table.getStyleName());
  
  doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");

• getBottomPadding/setBottomPadding

  public double getBottomPadding() / public void setBottomPadding(double value)
  

  Gets or sets the amount of space (in points) to add below the contents of table cells.

  Example:

  Shows how to create custom style settings for the table.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Name");
  builder.insertCell();
  builder.write("مرحبًا");
  builder.endRow();
  builder.insertCell();
  builder.insertCell();
  builder.endTable();
  
  TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  tableStyle.setAllowBreakAcrossPages(true);
  tableStyle.setBidi(true);
  tableStyle.setCellSpacing(5.0);
  tableStyle.setBottomPadding(20.0);
  tableStyle.setLeftPadding(5.0);
  tableStyle.setRightPadding(10.0);
  tableStyle.setTopPadding(20.0);
  tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
  tableStyle.getBorders().setColor(Color.BLACK);
  tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
  tableStyle.setVerticalAlignment(CellVerticalAlignment.CENTER);
  
  table.setStyle(tableStyle);
  
  // Setting the style properties of a table may affect the properties of the table itself.
  Assert.assertTrue(table.getBidi());
  Assert.assertEquals(5.0d, table.getCellSpacing());
  Assert.assertEquals("MyTableStyle1", table.getStyleName());
  
  doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");

• getBuiltIn

  public boolean getBuiltIn()
  

  True if this style is one of the built-in styles in MS Word.

  Example:

  Shows how to differentiate custom styles from built-in styles.

  Document doc = new Document();
  
  // When we create a document using Microsoft Word, or programmatically using Aspose.Words,
  // the document will come with a collection of styles to apply to its text to modify its appearance.
  // We can access these built-in styles via the document's "Styles" collection.
  // These styles will all have the "BuiltIn" flag set to "true".
  Style style = doc.getStyles().get("Emphasis");
  
  Assert.assertTrue(style.getBuiltIn());
  
  // Create a custom style and add it to the collection.
  // Custom styles such as this will have the "BuiltIn" flag set to "false". 
  style = doc.getStyles().add(StyleType.CHARACTER, "MyStyle");
  style.getFont().setColor(Color.RED);
  style.getFont().setName("Courier New");
  
  Assert.assertFalse(style.getBuiltIn());

• getCellSpacing/setCellSpacing

  public double getCellSpacing() / public void setCellSpacing(double value)
  

  Gets or sets the amount of space (in points) between the cells.

  Example:

  Shows how to create custom style settings for the table.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Name");
  builder.insertCell();
  builder.write("مرحبًا");
  builder.endRow();
  builder.insertCell();
  builder.insertCell();
  builder.endTable();
  
  TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  tableStyle.setAllowBreakAcrossPages(true);
  tableStyle.setBidi(true);
  tableStyle.setCellSpacing(5.0);
  tableStyle.setBottomPadding(20.0);
  tableStyle.setLeftPadding(5.0);
  tableStyle.setRightPadding(10.0);
  tableStyle.setTopPadding(20.0);
  tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
  tableStyle.getBorders().setColor(Color.BLACK);
  tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
  tableStyle.setVerticalAlignment(CellVerticalAlignment.CENTER);
  
  table.setStyle(tableStyle);
  
  // Setting the style properties of a table may affect the properties of the table itself.
  Assert.assertTrue(table.getBidi());
  Assert.assertEquals(5.0d, table.getCellSpacing());
  Assert.assertEquals("MyTableStyle1", table.getStyleName());
  
  doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");

• getColumnStripe/setColumnStripe

  public int getColumnStripe() / public void setColumnStripe(int value)
  

  Gets or sets a number of columns to include in the banding when the style specifies odd/even columns banding.

  Example:

  Shows how to create conditional table styles that alternate between rows.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // We can configure a conditional style of a table to apply a different color to the row/column,
  // based on whether the row/column is even or odd, creating an alternating color pattern.
  // We can also apply a number n to the row/column banding,
  // meaning that the color alternates after every n rows/columns instead of one.
  // Create a table where single columns and rows will band the columns will banded in threes.
  Table table = builder.startTable();
  
  for (int i = 0; i < 15; i++) {
      for (int j = 0; j < 4; j++) {
          builder.insertCell();
          builder.writeln(MessageFormat.format("{0} column.", (j % 2 == 0 ? "Even" : "Odd")));
          builder.write(MessageFormat.format("Row banding {0}.", (i % 3 == 0 ? "start" : "continuation")));
      }
      builder.endRow();
  }
  
  builder.endTable();
  
  // Apply a line style to all the borders of the table.
  TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  tableStyle.getBorders().setColor(Color.BLACK);
  tableStyle.getBorders().setLineStyle(LineStyle.DOUBLE);
  
  // Set the two colors, which will alternate over every 3 rows.
  tableStyle.setRowStripe(3);
  tableStyle.getConditionalStyles().getByConditionalStyleType(ConditionalStyleType.ODD_ROW_BANDING).getShading().setBackgroundPatternColor(Color.BLUE);
  tableStyle.getConditionalStyles().getByConditionalStyleType(ConditionalStyleType.EVEN_ROW_BANDING).getShading().setBackgroundPatternColor(Color.CYAN);
  
  // Set a color to apply to every even column, which will override any custom row coloring.
  tableStyle.setColumnStripe(1);
  tableStyle.getConditionalStyles().getByConditionalStyleType(ConditionalStyleType.EVEN_COLUMN_BANDING).getShading().setBackgroundPatternColor(Color.RED);
  
  table.setStyle(tableStyle);
  
  // The "StyleOptions" property enables row banding by default.
  Assert.assertEquals(TableStyleOptions.FIRST_ROW | TableStyleOptions.FIRST_COLUMN | TableStyleOptions.ROW_BANDS,
          table.getStyleOptions());
  
  // Use the "StyleOptions" property also to enable column banding.
  table.setStyleOptions(table.getStyleOptions() | TableStyleOptions.COLUMN_BANDS);
  
  doc.save(getArtifactsDir() + "Table.AlternatingRowStyles.docx");

• getConditionalStyles

  public ConditionalStyleCollection getConditionalStyles()
  

  Collection of conditional styles that may be defined for this table style.

  Example:

  Shows how to work with certain area styles of a table.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Cell 1");
  builder.insertCell();
  builder.write("Cell 2");
  builder.endRow();
  builder.insertCell();
  builder.write("Cell 3");
  builder.insertCell();
  builder.write("Cell 4");
  builder.endTable();
  
  // Create a custom table style.
  TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  
  // Conditional styles are formatting changes that affect only some of the table's cells
  // based on a predicate, such as the cells being in the last row.
  // Below are three ways of accessing a table style's conditional styles from the "ConditionalStyles" collection.
  // 1 -  By style type:
  tableStyle.getConditionalStyles().getByConditionalStyleType(ConditionalStyleType.FIRST_ROW).getShading().setBackgroundPatternColor(Color.BLUE);
  
  // 2 -  By index:
  tableStyle.getConditionalStyles().get(0).getBorders().setColor(Color.BLACK);
  tableStyle.getConditionalStyles().get(0).getBorders().setLineStyle(LineStyle.DOT_DASH);
  Assert.assertEquals(ConditionalStyleType.FIRST_ROW, tableStyle.getConditionalStyles().get(0).getType());
  
  // 3 -  As a property:
  tableStyle.getConditionalStyles().getFirstRow().getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
  
  // Apply padding and text formatting to conditional styles.
  tableStyle.getConditionalStyles().getLastRow().setBottomPadding(10.0);
  tableStyle.getConditionalStyles().getLastRow().setLeftPadding(10.0);
  tableStyle.getConditionalStyles().getLastRow().setRightPadding(10.0);
  tableStyle.getConditionalStyles().getLastRow().setTopPadding(10.0);
  tableStyle.getConditionalStyles().getLastColumn().getFont().setBold(true);
  
  // List all possible style conditions.
  Iterator<ConditionalStyle> enumerator = tableStyle.getConditionalStyles().iterator();
  while (enumerator.hasNext()) {
      ConditionalStyle currentStyle = enumerator.next();
      if (currentStyle != null) System.out.println(currentStyle.getType());
  }
  
  // Apply the custom style, which contains all conditional styles, to the table.
  table.setStyle(tableStyle);
  
  // Our style applies some conditional styles by default.
  Assert.assertEquals(TableStyleOptions.FIRST_ROW | TableStyleOptions.FIRST_COLUMN | TableStyleOptions.ROW_BANDS,
          table.getStyleOptions());
  
  // We will need to enable all other styles ourselves via the "StyleOptions" property.
  table.setStyleOptions(table.getStyleOptions() | TableStyleOptions.LAST_ROW | TableStyleOptions.LAST_COLUMN);
  
  doc.save(getArtifactsDir() + "Table.ConditionalStyles.docx");

• getDocument

  public DocumentBase getDocument()
  

  Gets the owner document.

  Example:

  Shows how to access a document's style collection.

  Document doc = new Document();
  
  Assert.assertEquals(4, doc.getStyles().getCount());
  
  // Enumerate and list all the styles that a document created using Aspose.Words contains by default.
  Iterator<Style> stylesEnum = doc.getStyles().iterator();
  while (stylesEnum.hasNext()) {
      Style curStyle = stylesEnum.next();
      System.out.println(MessageFormat.format("Style name:\t\"{0}\", of type \"{1}\"", curStyle.getName(), curStyle.getType()));
      System.out.println(MessageFormat.format("\tSubsequent style:\t{0}", curStyle.getNextParagraphStyleName()));
      System.out.println(MessageFormat.format("\tIs heading:\t\t\t{0}", curStyle.isHeading()));
      System.out.println(MessageFormat.format("\tIs QuickStyle:\t\t{0}", curStyle.isQuickStyle()));
  
      Assert.assertEquals(curStyle.getDocument(), doc);
  }

• getFont

  public Font getFont()
  

  Gets the character formatting of the style.

  For 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 custom paragraph style.
  Style style = doc.getStyles().add(StyleType.PARAGRAPH, "MyStyle1");
  style.getFont().setSize(24.0);
  style.getFont().setName("Verdana");
  style.getParagraphFormat().setSpaceAfter(12.0);
  
  // 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 document builder's current paragraph, and then add some text.
  builder.getParagraphFormat().setStyle(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.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
  builder.writeln("Hello World: Normal.");
  
  builder.getDocument().save(getArtifactsDir() + "Styles.ParagraphStyleBulletedList.docx");

  Example:

  Shows how to create and apply a custom style.

  Document doc = new Document();
  
  Style style = doc.getStyles().add(StyleType.PARAGRAPH, "MyStyle");
  style.getFont().setName("Times New Roman");
  style.getFont().setSize(16.0);
  style.getFont().setColor(Color.magenta);
  
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Apply one of the styles from the document to the paragraph that the document builder is creating.
  builder.getParagraphFormat().setStyle(doc.getStyles().get("MyStyle"));
  builder.writeln("Hello world!");
  
  Style firstParagraphStyle = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getStyle();
  
  Assert.assertEquals(style, firstParagraphStyle);
  
  // Remove our custom style from the document's styles collection.
  doc.getStyles().get("MyStyle").remove();
  
  firstParagraphStyle = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getStyle();
  
  // Any text that used a removed style reverts to the default formatting.
  Assert.assertFalse(IterableUtils.matchesAny(doc.getStyles(), s -> s.getName() == "MyStyle"));
  Assert.assertEquals("Times New Roman", firstParagraphStyle.getFont().getName());
  Assert.assertEquals(12.0d, firstParagraphStyle.getFont().getSize());
  Assert.assertEquals(0, firstParagraphStyle.getFont().getColor().getRGB());

• isHeading

  public boolean isHeading()
  

  True when the style is one of the built-in Heading styles.

  Example:

  Shows how to access a document's style collection.

  Document doc = new Document();
  
  Assert.assertEquals(4, doc.getStyles().getCount());
  
  // Enumerate and list all the styles that a document created using Aspose.Words contains by default.
  Iterator<Style> stylesEnum = doc.getStyles().iterator();
  while (stylesEnum.hasNext()) {
      Style curStyle = stylesEnum.next();
      System.out.println(MessageFormat.format("Style name:\t\"{0}\", of type \"{1}\"", curStyle.getName(), curStyle.getType()));
      System.out.println(MessageFormat.format("\tSubsequent style:\t{0}", curStyle.getNextParagraphStyleName()));
      System.out.println(MessageFormat.format("\tIs heading:\t\t\t{0}", curStyle.isHeading()));
      System.out.println(MessageFormat.format("\tIs QuickStyle:\t\t{0}", curStyle.isQuickStyle()));
  
      Assert.assertEquals(curStyle.getDocument(), doc);
  }

• isQuickStyle/isQuickStyle

  public boolean isQuickStyle() / public void isQuickStyle(boolean value)
  

  Specifies whether this style is shown in the Quick Style gallery inside MS Word UI.

  Example:

  Shows how to access a document's style collection.

  Document doc = new Document();
  
  Assert.assertEquals(4, doc.getStyles().getCount());
  
  // Enumerate and list all the styles that a document created using Aspose.Words contains by default.
  Iterator<Style> stylesEnum = doc.getStyles().iterator();
  while (stylesEnum.hasNext()) {
      Style curStyle = stylesEnum.next();
      System.out.println(MessageFormat.format("Style name:\t\"{0}\", of type \"{1}\"", curStyle.getName(), curStyle.getType()));
      System.out.println(MessageFormat.format("\tSubsequent style:\t{0}", curStyle.getNextParagraphStyleName()));
      System.out.println(MessageFormat.format("\tIs heading:\t\t\t{0}", curStyle.isHeading()));
      System.out.println(MessageFormat.format("\tIs QuickStyle:\t\t{0}", curStyle.isQuickStyle()));
  
      Assert.assertEquals(curStyle.getDocument(), doc);
  }

• getLeftIndent/setLeftIndent

  public double getLeftIndent() / public void setLeftIndent(double value)
  

  Gets or sets the value that represents the left indent of a table.

  Example:

  Shows how to set the position of a table.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Below are two ways of aligning a table horizontally.
  // 1 -  Use the "Alignment" property to align it to a location on the page, such as the center:
  TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  tableStyle.setAlignment(TableAlignment.CENTER);
  tableStyle.getBorders().setColor(Color.BLUE);
  tableStyle.getBorders().setLineStyle(LineStyle.SINGLE);
  
  // Insert a table and apply the style we created to it.
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Aligned to the center of the page");
  builder.endTable();
  table.setPreferredWidth(PreferredWidth.fromPoints(300.0));
  
  table.setStyle(tableStyle);
  
  // 2 -  Use the "LeftIndent" to specify an indent from the left margin of the page:
  tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle2");
  tableStyle.setLeftIndent(55.0);
  tableStyle.getBorders().setColor(Color.GREEN);
  tableStyle.getBorders().setLineStyle(LineStyle.SINGLE);
  
  table = builder.startTable();
  builder.insertCell();
  builder.write("Aligned according to left indent");
  builder.endTable();
  table.setPreferredWidth(PreferredWidth.fromPoints(300.0));
  
  table.setStyle(tableStyle);
  
  doc.save(getArtifactsDir() + "Table.SetTableAlignment.docx");

• getLeftPadding/setLeftPadding

  public double getLeftPadding() / public void setLeftPadding(double value)
  

  Gets or sets the amount of space (in points) to add to the left of the contents of table cells.

  Example:

  Shows how to create custom style settings for the table.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Name");
  builder.insertCell();
  builder.write("مرحبًا");
  builder.endRow();
  builder.insertCell();
  builder.insertCell();
  builder.endTable();
  
  TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  tableStyle.setAllowBreakAcrossPages(true);
  tableStyle.setBidi(true);
  tableStyle.setCellSpacing(5.0);
  tableStyle.setBottomPadding(20.0);
  tableStyle.setLeftPadding(5.0);
  tableStyle.setRightPadding(10.0);
  tableStyle.setTopPadding(20.0);
  tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
  tableStyle.getBorders().setColor(Color.BLACK);
  tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
  tableStyle.setVerticalAlignment(CellVerticalAlignment.CENTER);
  
  table.setStyle(tableStyle);
  
  // Setting the style properties of a table may affect the properties of the table itself.
  Assert.assertTrue(table.getBidi());
  Assert.assertEquals(5.0d, table.getCellSpacing());
  Assert.assertEquals("MyTableStyle1", table.getStyleName());
  
  doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");

• getLinkedStyleName

  public java.lang.String getLinkedStyleName()
  

  Gets the name of the Style linked to this one. Returns Empty string if no styles are linked.

  Example:

  Shows how to use style aliases.

  Document doc = new Document(getMyDir() + "Style with alias.docx");
  
  // This document contains a style named "MyStyle,MyStyle Alias 1,MyStyle Alias 2".
  // If a style's name has multiple values separated by commas, each clause is a separate alias.
  Style style = doc.getStyles().get("MyStyle");
  Assert.assertEquals(new String[]{"MyStyle Alias 1", "MyStyle Alias 2"}, style.getAliases());
  Assert.assertEquals("Title", style.getBaseStyleName());
  Assert.assertEquals("MyStyle Char", style.getLinkedStyleName());
  
  // We can reference a style using its alias, as well as its name.
  Assert.assertEquals(doc.getStyles().get("MyStyle Alias 1"), doc.getStyles().get("MyStyle Alias 2"));
  
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.moveToDocumentEnd();
  builder.getParagraphFormat().setStyle(doc.getStyles().get("MyStyle Alias 1"));
  builder.writeln("Hello world!");
  builder.getParagraphFormat().setStyle(doc.getStyles().get("MyStyle Alias 2"));
  builder.write("Hello again!");
  
  Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().get(0).getParagraphFormat().getStyle(),
          doc.getFirstSection().getBody().getParagraphs().get(1).getParagraphFormat().getStyle());

• 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.

  Example:

  Shows how to create a list style and use it in a document.

  Document doc = new Document();
  
  // A list allows us to organize and decorate sets of paragraphs with prefix symbols and indents.
  // We can create nested lists by increasing the indent level. 
  // We can begin and end a list by using a document builder's "ListFormat" property. 
  // Each paragraph that we add between a list's start and the end will become an item in the list.
  // We can contain an entire List object within a style.
  Style listStyle = doc.getStyles().add(StyleType.LIST, "MyListStyle");
  
  List list1 = listStyle.getList();
  
  Assert.assertTrue(list1.isListStyleDefinition());
  Assert.assertFalse(list1.isListStyleReference());
  Assert.assertTrue(list1.isMultiLevel());
  Assert.assertEquals(listStyle, list1.getStyle());
  
  // Change the appearance of all list levels in our list.
  for (ListLevel level : list1.getListLevels()) {
      level.getFont().setName("Verdana");
      level.getFont().setColor(Color.BLUE);
      level.getFont().setBold(true);
  }
  
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.writeln("Using list style first time:");
  
  // Create another list from a list within a style.
  List list2 = doc.getLists().add(listStyle);
  
  Assert.assertFalse(list2.isListStyleDefinition());
  Assert.assertTrue(list2.isListStyleReference());
  Assert.assertEquals(listStyle, list2.getStyle());
  
  // Add some list items that our list will format.
  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(getArtifactsDir() + "Lists.CreateAndUseListStyle.docx");

• 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.

  Example:

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

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Create a custom paragraph style.
  Style style = doc.getStyles().add(StyleType.PARAGRAPH, "MyStyle1");
  style.getFont().setSize(24.0);
  style.getFont().setName("Verdana");
  style.getParagraphFormat().setSpaceAfter(12.0);
  
  // 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 document builder's current paragraph, and then add some text.
  builder.getParagraphFormat().setStyle(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.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
  builder.writeln("Hello World: Normal.");
  
  builder.getDocument().save(getArtifactsDir() + "Styles.ParagraphStyleBulletedList.docx");

• getName/setName

  public java.lang.String getName() / public void setName(java.lang.String value)
  

  Gets or 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.

  Example:

  Shows how to access a document's style collection.

  Document doc = new Document();
  
  Assert.assertEquals(4, doc.getStyles().getCount());
  
  // Enumerate and list all the styles that a document created using Aspose.Words contains by default.
  Iterator<Style> stylesEnum = doc.getStyles().iterator();
  while (stylesEnum.hasNext()) {
      Style curStyle = stylesEnum.next();
      System.out.println(MessageFormat.format("Style name:\t\"{0}\", of type \"{1}\"", curStyle.getName(), curStyle.getType()));
      System.out.println(MessageFormat.format("\tSubsequent style:\t{0}", curStyle.getNextParagraphStyleName()));
      System.out.println(MessageFormat.format("\tIs heading:\t\t\t{0}", curStyle.isHeading()));
      System.out.println(MessageFormat.format("\tIs QuickStyle:\t\t{0}", curStyle.isQuickStyle()));
  
      Assert.assertEquals(curStyle.getDocument(), doc);
  }

  Example:

  Shows how to clone a document's style.

  Document doc = new Document();
  
  // The AddCopy method creates a copy of the specified style and
  // automatically generates a new name for the style, such as "Heading 1_0".
  Style newStyle = doc.getStyles().addCopy(doc.getStyles().get("Heading 1"));
  
  // Use the style's "Name" property to change the style's identifying name.
  newStyle.setName("My Heading 1");
  
  // Our document now has two identical looking styles with different names.
  // Changing settings of one of the styles do not affect the other.
  newStyle.getFont().setColor(Color.RED);
  
  Assert.assertEquals("My Heading 1", newStyle.getName());
  Assert.assertEquals("Heading 1", doc.getStyles().get("Heading 1").getName());
  
  Assert.assertEquals(doc.getStyles().get("Heading 1").getType(), newStyle.getType());
  Assert.assertEquals(doc.getStyles().get("Heading 1").getFont().getName(), newStyle.getFont().getName());
  Assert.assertEquals(doc.getStyles().get("Heading 1").getFont().getSize(), newStyle.getFont().getSize());
  Assert.assertNotEquals(doc.getStyles().get("Heading 1").getFont().getColor(), newStyle.getFont().getColor());

• getNextParagraphStyleName/setNextParagraphStyleName

  public java.lang.String getNextParagraphStyleName() / 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.

  Example:

  Shows how to access a document's style collection.

  Document doc = new Document();
  
  Assert.assertEquals(4, doc.getStyles().getCount());
  
  // Enumerate and list all the styles that a document created using Aspose.Words contains by default.
  Iterator<Style> stylesEnum = doc.getStyles().iterator();
  while (stylesEnum.hasNext()) {
      Style curStyle = stylesEnum.next();
      System.out.println(MessageFormat.format("Style name:\t\"{0}\", of type \"{1}\"", curStyle.getName(), curStyle.getType()));
      System.out.println(MessageFormat.format("\tSubsequent style:\t{0}", curStyle.getNextParagraphStyleName()));
      System.out.println(MessageFormat.format("\tIs heading:\t\t\t{0}", curStyle.isHeading()));
      System.out.println(MessageFormat.format("\tIs QuickStyle:\t\t{0}", curStyle.isQuickStyle()));
  
      Assert.assertEquals(curStyle.getDocument(), doc);
  }

• getParagraphFormat

  public ParagraphFormat getParagraphFormat()
  

  Gets the paragraph formatting of the style.

  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 custom paragraph style.
  Style style = doc.getStyles().add(StyleType.PARAGRAPH, "MyStyle1");
  style.getFont().setSize(24.0);
  style.getFont().setName("Verdana");
  style.getParagraphFormat().setSpaceAfter(12.0);
  
  // 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 document builder's current paragraph, and then add some text.
  builder.getParagraphFormat().setStyle(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.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
  builder.writeln("Hello World: Normal.");
  
  builder.getDocument().save(getArtifactsDir() + "Styles.ParagraphStyleBulletedList.docx");

• getRightPadding/setRightPadding

  public double getRightPadding() / public void setRightPadding(double value)
  

  Gets or sets the amount of space (in points) to add to the right of the contents of table cells.

  Example:

  Shows how to create custom style settings for the table.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Name");
  builder.insertCell();
  builder.write("مرحبًا");
  builder.endRow();
  builder.insertCell();
  builder.insertCell();
  builder.endTable();
  
  TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  tableStyle.setAllowBreakAcrossPages(true);
  tableStyle.setBidi(true);
  tableStyle.setCellSpacing(5.0);
  tableStyle.setBottomPadding(20.0);
  tableStyle.setLeftPadding(5.0);
  tableStyle.setRightPadding(10.0);
  tableStyle.setTopPadding(20.0);
  tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
  tableStyle.getBorders().setColor(Color.BLACK);
  tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
  tableStyle.setVerticalAlignment(CellVerticalAlignment.CENTER);
  
  table.setStyle(tableStyle);
  
  // Setting the style properties of a table may affect the properties of the table itself.
  Assert.assertTrue(table.getBidi());
  Assert.assertEquals(5.0d, table.getCellSpacing());
  Assert.assertEquals("MyTableStyle1", table.getStyleName());
  
  doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");

• getRowStripe/setRowStripe

  public int getRowStripe() / public void setRowStripe(int value)
  

  Gets or sets a number of rows to include in the banding when the style specifies odd/even row banding.

  Example:

  Shows how to create conditional table styles that alternate between rows.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // We can configure a conditional style of a table to apply a different color to the row/column,
  // based on whether the row/column is even or odd, creating an alternating color pattern.
  // We can also apply a number n to the row/column banding,
  // meaning that the color alternates after every n rows/columns instead of one.
  // Create a table where single columns and rows will band the columns will banded in threes.
  Table table = builder.startTable();
  
  for (int i = 0; i < 15; i++) {
      for (int j = 0; j < 4; j++) {
          builder.insertCell();
          builder.writeln(MessageFormat.format("{0} column.", (j % 2 == 0 ? "Even" : "Odd")));
          builder.write(MessageFormat.format("Row banding {0}.", (i % 3 == 0 ? "start" : "continuation")));
      }
      builder.endRow();
  }
  
  builder.endTable();
  
  // Apply a line style to all the borders of the table.
  TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  tableStyle.getBorders().setColor(Color.BLACK);
  tableStyle.getBorders().setLineStyle(LineStyle.DOUBLE);
  
  // Set the two colors, which will alternate over every 3 rows.
  tableStyle.setRowStripe(3);
  tableStyle.getConditionalStyles().getByConditionalStyleType(ConditionalStyleType.ODD_ROW_BANDING).getShading().setBackgroundPatternColor(Color.BLUE);
  tableStyle.getConditionalStyles().getByConditionalStyleType(ConditionalStyleType.EVEN_ROW_BANDING).getShading().setBackgroundPatternColor(Color.CYAN);
  
  // Set a color to apply to every even column, which will override any custom row coloring.
  tableStyle.setColumnStripe(1);
  tableStyle.getConditionalStyles().getByConditionalStyleType(ConditionalStyleType.EVEN_COLUMN_BANDING).getShading().setBackgroundPatternColor(Color.RED);
  
  table.setStyle(tableStyle);
  
  // The "StyleOptions" property enables row banding by default.
  Assert.assertEquals(TableStyleOptions.FIRST_ROW | TableStyleOptions.FIRST_COLUMN | TableStyleOptions.ROW_BANDS,
          table.getStyleOptions());
  
  // Use the "StyleOptions" property also to enable column banding.
  table.setStyleOptions(table.getStyleOptions() | TableStyleOptions.COLUMN_BANDS);
  
  doc.save(getArtifactsDir() + "Table.AlternatingRowStyles.docx");

• getShading

  public Shading getShading()
  

  Gets a Shading object that refers to the shading formatting for table cells.

  Example:

  Shows how to create custom style settings for the table.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Name");
  builder.insertCell();
  builder.write("مرحبًا");
  builder.endRow();
  builder.insertCell();
  builder.insertCell();
  builder.endTable();
  
  TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  tableStyle.setAllowBreakAcrossPages(true);
  tableStyle.setBidi(true);
  tableStyle.setCellSpacing(5.0);
  tableStyle.setBottomPadding(20.0);
  tableStyle.setLeftPadding(5.0);
  tableStyle.setRightPadding(10.0);
  tableStyle.setTopPadding(20.0);
  tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
  tableStyle.getBorders().setColor(Color.BLACK);
  tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
  tableStyle.setVerticalAlignment(CellVerticalAlignment.CENTER);
  
  table.setStyle(tableStyle);
  
  // Setting the style properties of a table may affect the properties of the table itself.
  Assert.assertTrue(table.getBidi());
  Assert.assertEquals(5.0d, table.getCellSpacing());
  Assert.assertEquals("MyTableStyle1", table.getStyleName());
  
  doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");

• getStyleIdentifier

  public int getStyleIdentifier()
  

  Gets the locale independent style identifier for a built-in style. The value of the property is StyleIdentifier integer constant.

  For user defined (custom) styles, this property returns StyleIdentifier.USER.

  Example:

  Shows how to modify the position of the right tab stop in TOC related paragraphs.

  Document doc = new Document(getMyDir() + "Table of contents.docx");
  
  // Iterate through all paragraphs with TOC result-based styles; this is any style between TOC and TOC9.
  for (Paragraph para : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true)) {
      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);
  
          // Replace the first default tab, stop with a custom tab stop.
          para.getParagraphFormat().getTabStops().removeByPosition(tab.getPosition());
          para.getParagraphFormat().getTabStops().add(tab.getPosition() - 50.0, tab.getAlignment(), tab.getLeader());
      }
  }
  
  doc.save(getArtifactsDir() + "Styles.ChangeTocsTabStops.docx");

  See Also:

  Name

• getStyles

  public StyleCollection getStyles()
  

  Gets the collection of styles this style belongs to.

  Example:

  Shows how to access a document's style collection.

  Document doc = new Document();
  
  Assert.assertEquals(4, doc.getStyles().getCount());
  
  // Enumerate and list all the styles that a document created using Aspose.Words contains by default.
  Iterator<Style> stylesEnum = doc.getStyles().iterator();
  while (stylesEnum.hasNext()) {
      Style curStyle = stylesEnum.next();
      System.out.println(MessageFormat.format("Style name:\t\"{0}\", of type \"{1}\"", curStyle.getName(), curStyle.getType()));
      System.out.println(MessageFormat.format("\tSubsequent style:\t{0}", curStyle.getNextParagraphStyleName()));
      System.out.println(MessageFormat.format("\tIs heading:\t\t\t{0}", curStyle.isHeading()));
      System.out.println(MessageFormat.format("\tIs QuickStyle:\t\t{0}", curStyle.isQuickStyle()));
  
      Assert.assertEquals(curStyle.getDocument(), doc);
  }

• getTopPadding/setTopPadding

  public double getTopPadding() / public void setTopPadding(double value)
  

  Gets or sets the amount of space (in points) to add above the contents of table cells.

  Example:

  Shows how to create custom style settings for the table.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Name");
  builder.insertCell();
  builder.write("مرحبًا");
  builder.endRow();
  builder.insertCell();
  builder.insertCell();
  builder.endTable();
  
  TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  tableStyle.setAllowBreakAcrossPages(true);
  tableStyle.setBidi(true);
  tableStyle.setCellSpacing(5.0);
  tableStyle.setBottomPadding(20.0);
  tableStyle.setLeftPadding(5.0);
  tableStyle.setRightPadding(10.0);
  tableStyle.setTopPadding(20.0);
  tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
  tableStyle.getBorders().setColor(Color.BLACK);
  tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
  tableStyle.setVerticalAlignment(CellVerticalAlignment.CENTER);
  
  table.setStyle(tableStyle);
  
  // Setting the style properties of a table may affect the properties of the table itself.
  Assert.assertTrue(table.getBidi());
  Assert.assertEquals(5.0d, table.getCellSpacing());
  Assert.assertEquals("MyTableStyle1", table.getStyleName());
  
  doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");

• getType

  public int getType()
  

  Gets the style type (paragraph or character). The value of the property is StyleType integer constant.

  Example:

  Shows how to access a document's style collection.

  Document doc = new Document();
  
  Assert.assertEquals(4, doc.getStyles().getCount());
  
  // Enumerate and list all the styles that a document created using Aspose.Words contains by default.
  Iterator<Style> stylesEnum = doc.getStyles().iterator();
  while (stylesEnum.hasNext()) {
      Style curStyle = stylesEnum.next();
      System.out.println(MessageFormat.format("Style name:\t\"{0}\", of type \"{1}\"", curStyle.getName(), curStyle.getType()));
      System.out.println(MessageFormat.format("\tSubsequent style:\t{0}", curStyle.getNextParagraphStyleName()));
      System.out.println(MessageFormat.format("\tIs heading:\t\t\t{0}", curStyle.isHeading()));
      System.out.println(MessageFormat.format("\tIs QuickStyle:\t\t{0}", curStyle.isQuickStyle()));
  
      Assert.assertEquals(curStyle.getDocument(), doc);
  }

• getVerticalAlignment/setVerticalAlignment

  public int getVerticalAlignment() / public void setVerticalAlignment(int value)
  

  Specifies the vertical alignment for the cells. The value of the property is CellVerticalAlignment integer constant.

  The default value is CellVerticalAlignment.TOP.

  Example:

  Shows how to create custom style settings for the table.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Name");
  builder.insertCell();
  builder.write("مرحبًا");
  builder.endRow();
  builder.insertCell();
  builder.insertCell();
  builder.endTable();
  
  TableStyle tableStyle = (TableStyle) doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  tableStyle.setAllowBreakAcrossPages(true);
  tableStyle.setBidi(true);
  tableStyle.setCellSpacing(5.0);
  tableStyle.setBottomPadding(20.0);
  tableStyle.setLeftPadding(5.0);
  tableStyle.setRightPadding(10.0);
  tableStyle.setTopPadding(20.0);
  tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
  tableStyle.getBorders().setColor(Color.BLACK);
  tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
  tableStyle.setVerticalAlignment(CellVerticalAlignment.CENTER);
  
  table.setStyle(tableStyle);
  
  // Setting the style properties of a table may affect the properties of the table itself.
  Assert.assertTrue(table.getBidi());
  Assert.assertEquals(5.0d, table.getCellSpacing());
  Assert.assertEquals("MyTableStyle1", table.getStyleName());
  
  doc.save(getArtifactsDir() + "Table.TableStyleCreation.docx");

Method Detail

• 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.

  Example:

  Shows how to use style aliases.

  Document doc = new Document(getMyDir() + "Style with alias.docx");
  
  // This document contains a style named "MyStyle,MyStyle Alias 1,MyStyle Alias 2".
  // If a style's name has multiple values separated by commas, each clause is a separate alias.
  Style style = doc.getStyles().get("MyStyle");
  Assert.assertEquals(new String[]{"MyStyle Alias 1", "MyStyle Alias 2"}, style.getAliases());
  Assert.assertEquals("Title", style.getBaseStyleName());
  Assert.assertEquals("MyStyle Char", style.getLinkedStyleName());
  
  // We can reference a style using its alias, as well as its name.
  Assert.assertEquals(doc.getStyles().get("MyStyle Alias 1"), doc.getStyles().get("MyStyle Alias 2"));
  
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.moveToDocumentEnd();
  builder.getParagraphFormat().setStyle(doc.getStyles().get("MyStyle Alias 1"));
  builder.writeln("Hello world!");
  builder.getParagraphFormat().setStyle(doc.getStyles().get("MyStyle Alias 2"));
  builder.write("Hello again!");
  
  Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().get(0).getParagraphFormat().getStyle(),
          doc.getFirstSection().getBody().getParagraphs().get(1).getParagraphFormat().getStyle());

• 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.

  Example:

  Shows how to create and apply a custom style.

  Document doc = new Document();
  
  Style style = doc.getStyles().add(StyleType.PARAGRAPH, "MyStyle");
  style.getFont().setName("Times New Roman");
  style.getFont().setSize(16.0);
  style.getFont().setColor(Color.magenta);
  
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Apply one of the styles from the document to the paragraph that the document builder is creating.
  builder.getParagraphFormat().setStyle(doc.getStyles().get("MyStyle"));
  builder.writeln("Hello world!");
  
  Style firstParagraphStyle = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getStyle();
  
  Assert.assertEquals(style, firstParagraphStyle);
  
  // Remove our custom style from the document's styles collection.
  doc.getStyles().get("MyStyle").remove();
  
  firstParagraphStyle = doc.getFirstSection().getBody().getFirstParagraph().getParagraphFormat().getStyle();
  
  // Any text that used a removed style reverts to the default formatting.
  Assert.assertFalse(IterableUtils.matchesAny(doc.getStyles(), s -> s.getName() == "MyStyle"));
  Assert.assertEquals("Times New Roman", firstParagraphStyle.getFont().getName());
  Assert.assertEquals(12.0d, firstParagraphStyle.getFont().getSize());
  Assert.assertEquals(0, firstParagraphStyle.getFont().getColor().getRGB());