**Inheritance:** java.lang.Object ``` public class TextPath ``` Defines the text and formatting of the text path (of a WordArt object). To learn more, visit the [ Working with Shapes ][Working with Shapes] documentation article. **Remarks:** Use the [Shape.getTextPath()](../../com.aspose.words/shape/\#getTextPath) property to access WordArt properties of a shape. You do not create instances of the [TextPath](../../com.aspose.words/textpath/) class directly. **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` [Working with Shapes]: https://docs.aspose.com/words/java/working-with-shapes/ ## Methods | Method | Description | | --- | --- | | [getBold()](#getBold) | True if the font is formatted as bold. | | [getFitPath()](#getFitPath) | Defines whether the text fits the path of a shape. | | [getFitShape()](#getFitShape) | Defines whether the text fits bounding box of a shape. | | [getFontFamily()](#getFontFamily) | Defines the family of the textpath font. | | [getItalic()](#getItalic) | True if the font is formatted as italic. | | [getKerning()](#getKerning) | Determines whether kerning is turned on. | | [getOn()](#getOn) | Defines whether the text is displayed. | | [getReverseRows()](#getReverseRows) | Determines whether the layout order of rows is reversed. | | [getRotateLetters()](#getRotateLetters) | Determines whether the letters of the text are rotated. | | [getSameLetterHeights()](#getSameLetterHeights) | Determines whether all letters will be the same height regardless of initial case. | | [getShadow()](#getShadow) | Defines whether a shadow is applied to the text on a text path. | | [getSize()](#getSize) | Defines the size of the font in points. | | [getSmallCaps()](#getSmallCaps) | True if the font is formatted as small capital letters. | | [getSpacing()](#getSpacing) | Defines the amount of spacing for text. | | [getStrikeThrough()](#getStrikeThrough) | True if the font is formatted as strikethrough text. | | [getText()](#getText) | Defines the text of the text path. | | [getTextPathAlignment()](#getTextPathAlignment) | Defines the alignment of text. | | [getTrim()](#getTrim) | Determines whether extra space is removed above and below the text. | | [getUnderline()](#getUnderline) | True if the font is underlined. | | [getXScale()](#getXScale) | Determines whether a straight textpath will be used instead of the shape path. | | [setBold(boolean value)](#setBold-boolean) | True if the font is formatted as bold. | | [setFitPath(boolean value)](#setFitPath-boolean) | Defines whether the text fits the path of a shape. | | [setFitShape(boolean value)](#setFitShape-boolean) | Defines whether the text fits bounding box of a shape. | | [setFontFamily(String value)](#setFontFamily-java.lang.String) | Defines the family of the textpath font. | | [setItalic(boolean value)](#setItalic-boolean) | True if the font is formatted as italic. | | [setKerning(boolean value)](#setKerning-boolean) | Determines whether kerning is turned on. | | [setOn(boolean value)](#setOn-boolean) | Defines whether the text is displayed. | | [setReverseRows(boolean value)](#setReverseRows-boolean) | Determines whether the layout order of rows is reversed. | | [setRotateLetters(boolean value)](#setRotateLetters-boolean) | Determines whether the letters of the text are rotated. | | [setSameLetterHeights(boolean value)](#setSameLetterHeights-boolean) | Determines whether all letters will be the same height regardless of initial case. | | [setShadow(boolean value)](#setShadow-boolean) | Defines whether a shadow is applied to the text on a text path. | | [setSize(double value)](#setSize-double) | Defines the size of the font in points. | | [setSmallCaps(boolean value)](#setSmallCaps-boolean) | True if the font is formatted as small capital letters. | | [setSpacing(double value)](#setSpacing-double) | Defines the amount of spacing for text. | | [setStrikeThrough(boolean value)](#setStrikeThrough-boolean) | True if the font is formatted as strikethrough text. | | [setText(String value)](#setText-java.lang.String) | Defines the text of the text path. | | [setTextPathAlignment(int value)](#setTextPathAlignment-int) | Defines the alignment of text. | | [setTrim(boolean value)](#setTrim-boolean) | Determines whether extra space is removed above and below the text. | | [setUnderline(boolean value)](#setUnderline-boolean) | True if the font is underlined. | | [setXScale(boolean value)](#setXScale-boolean) | Determines whether a straight textpath will be used instead of the shape path. | ### getBold() {#getBold} ``` public boolean getBold() ``` True if the font is formatted as bold. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** boolean - The corresponding boolean value. ### getFitPath() {#getFitPath} ``` public boolean getFitPath() ``` Defines whether the text fits the path of a shape. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** boolean - The corresponding boolean value. ### getFitShape() {#getFitShape} ``` public boolean getFitShape() ``` Defines whether the text fits bounding box of a shape. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** boolean - The corresponding boolean value. ### getFontFamily() {#getFontFamily} ``` public String getFontFamily() ``` Defines the family of the textpath font. **Remarks:** The default value is Arial. **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** java.lang.String - The corresponding java.lang.String value. ### getItalic() {#getItalic} ``` public boolean getItalic() ``` True if the font is formatted as italic. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** boolean - The corresponding boolean value. ### getKerning() {#getKerning} ``` public boolean getKerning() ``` Determines whether kerning is turned on. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** boolean - The corresponding boolean value. ### getOn() {#getOn} ``` public boolean getOn() ``` Defines whether the text is displayed. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** boolean - The corresponding boolean value. ### getReverseRows() {#getReverseRows} ``` public boolean getReverseRows() ``` Determines whether the layout order of rows is reversed. **Remarks:** The default value is false . If true , the layout order of rows is reversed. This attribute is used for vertical text layout. **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** boolean - The corresponding boolean value. ### getRotateLetters() {#getRotateLetters} ``` public boolean getRotateLetters() ``` Determines whether the letters of the text are rotated. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** boolean - The corresponding boolean value. ### getSameLetterHeights() {#getSameLetterHeights} ``` public boolean getSameLetterHeights() ``` Determines whether all letters will be the same height regardless of initial case. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** boolean - The corresponding boolean value. ### getShadow() {#getShadow} ``` public boolean getShadow() ``` Defines whether a shadow is applied to the text on a text path. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** boolean - The corresponding boolean value. ### getSize() {#getSize} ``` public double getSize() ``` Defines the size of the font in points. **Remarks:** The default value is 36. **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** double - The corresponding double value. ### getSmallCaps() {#getSmallCaps} ``` public boolean getSmallCaps() ``` True if the font is formatted as small capital letters. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** boolean - The corresponding boolean value. ### getSpacing() {#getSpacing} ``` public double getSpacing() ``` Defines the amount of spacing for text. 1 means 100%. **Remarks:** The default value is 1. **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** double - The corresponding double value. ### getStrikeThrough() {#getStrikeThrough} ``` public boolean getStrikeThrough() ``` True if the font is formatted as strikethrough text. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** boolean - The corresponding boolean value. ### getText() {#getText} ``` public String getText() ``` Defines the text of the text path. **Remarks:** The default value is an empty string. **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** java.lang.String - The corresponding java.lang.String value. ### getTextPathAlignment() {#getTextPathAlignment} ``` public int getTextPathAlignment() ``` Defines the alignment of text. **Remarks:** The default value is [TextPathAlignment.CENTER](../../com.aspose.words/textpathalignment/\#CENTER). **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** int - The corresponding int value. The returned value is one of [TextPathAlignment](../../com.aspose.words/textpathalignment/) constants. ### getTrim() {#getTrim} ``` public boolean getTrim() ``` Determines whether extra space is removed above and below the text. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** boolean - The corresponding boolean value. ### getUnderline() {#getUnderline} ``` public boolean getUnderline() ``` True if the font is underlined. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** boolean - The corresponding boolean value. ### getXScale() {#getXScale} ``` public boolean getXScale() ``` Determines whether a straight textpath will be used instead of the shape path. **Remarks:** The default value is false . If true , the text runs along a path from left to right along the x value of the lower boundary of the shape. **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Returns:** boolean - The corresponding boolean value. ### setBold(boolean value) {#setBold-boolean} ``` public void setBold(boolean value) ``` True if the font is formatted as bold. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setFitPath(boolean value) {#setFitPath-boolean} ``` public void setFitPath(boolean value) ``` Defines whether the text fits the path of a shape. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setFitShape(boolean value) {#setFitShape-boolean} ``` public void setFitShape(boolean value) ``` Defines whether the text fits bounding box of a shape. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setFontFamily(String value) {#setFontFamily-java.lang.String} ``` public void setFontFamily(String value) ``` Defines the family of the textpath font. **Remarks:** The default value is Arial. **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | The corresponding java.lang.String value. | ### setItalic(boolean value) {#setItalic-boolean} ``` public void setItalic(boolean value) ``` True if the font is formatted as italic. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setKerning(boolean value) {#setKerning-boolean} ``` public void setKerning(boolean value) ``` Determines whether kerning is turned on. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setOn(boolean value) {#setOn-boolean} ``` public void setOn(boolean value) ``` Defines whether the text is displayed. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setReverseRows(boolean value) {#setReverseRows-boolean} ``` public void setReverseRows(boolean value) ``` Determines whether the layout order of rows is reversed. **Remarks:** The default value is false . If true , the layout order of rows is reversed. This attribute is used for vertical text layout. **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setRotateLetters(boolean value) {#setRotateLetters-boolean} ``` public void setRotateLetters(boolean value) ``` Determines whether the letters of the text are rotated. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setSameLetterHeights(boolean value) {#setSameLetterHeights-boolean} ``` public void setSameLetterHeights(boolean value) ``` Determines whether all letters will be the same height regardless of initial case. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setShadow(boolean value) {#setShadow-boolean} ``` public void setShadow(boolean value) ``` Defines whether a shadow is applied to the text on a text path. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setSize(double value) {#setSize-double} ``` public void setSize(double value) ``` Defines the size of the font in points. **Remarks:** The default value is 36. **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | double | The corresponding double value. | ### setSmallCaps(boolean value) {#setSmallCaps-boolean} ``` public void setSmallCaps(boolean value) ``` True if the font is formatted as small capital letters. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setSpacing(double value) {#setSpacing-double} ``` public void setSpacing(double value) ``` Defines the amount of spacing for text. 1 means 100%. **Remarks:** The default value is 1. **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | double | The corresponding double value. | ### setStrikeThrough(boolean value) {#setStrikeThrough-boolean} ``` public void setStrikeThrough(boolean value) ``` True if the font is formatted as strikethrough text. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setText(String value) {#setText-java.lang.String} ``` public void setText(String value) ``` Defines the text of the text path. **Remarks:** The default value is an empty string. **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | The corresponding java.lang.String value. | ### setTextPathAlignment(int value) {#setTextPathAlignment-int} ``` public void setTextPathAlignment(int value) ``` Defines the alignment of text. **Remarks:** The default value is [TextPathAlignment.CENTER](../../com.aspose.words/textpathalignment/\#CENTER). **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | int | The corresponding int value. The value must be one of [TextPathAlignment](../../com.aspose.words/textpathalignment/) constants. | ### setTrim(boolean value) {#setTrim-boolean} ``` public void setTrim(boolean value) ``` Determines whether extra space is removed above and below the text. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setUnderline(boolean value) {#setUnderline-boolean} ``` public void setUnderline(boolean value) ``` True if the font is underlined. **Remarks:** The default value is false . **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setXScale(boolean value) {#setXScale-boolean} ``` public void setXScale(boolean value) ``` Determines whether a straight textpath will be used instead of the shape path. **Remarks:** The default value is false . If true , the text runs along a path from left to right along the x value of the lower boundary of the shape. **Examples:** Shows how to work with WordArt. ``` public void insertTextPaths() throws Exception { Document doc = new Document(); // Insert a WordArt object to display text in a shape that we can re-size and move by using the mouse in Microsoft Word. // Provide a "ShapeType" as an argument to set a shape for the WordArt. Shape shape = appendWordArt(doc, "Hello World! This text is bold, and italic.", "Arial", 480.0, 24.0, Color.WHITE, Color.BLACK, ShapeType.TEXT_PLAIN_TEXT); // Apply the "Bold" and "Italic" formatting settings to the text using the respective properties. shape.getTextPath().setBold(true); shape.getTextPath().setItalic(true); // Below are various other text formatting-related properties. Assert.assertFalse(shape.getTextPath().getUnderline()); Assert.assertFalse(shape.getTextPath().getShadow()); Assert.assertFalse(shape.getTextPath().getStrikeThrough()); Assert.assertFalse(shape.getTextPath().getReverseRows()); Assert.assertFalse(shape.getTextPath().getXScale()); Assert.assertFalse(shape.getTextPath().getTrim()); Assert.assertFalse(shape.getTextPath().getSmallCaps()); Assert.assertEquals(36.0, shape.getTextPath().getSize()); Assert.assertEquals("Hello World! This text is bold, and italic.", shape.getTextPath().getText()); Assert.assertEquals(ShapeType.TEXT_PLAIN_TEXT, shape.getShapeType()); // Use the "On" property to show/hide the text. shape = appendWordArt(doc, "On set to \"true\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(true); shape = appendWordArt(doc, "On set to \"false\"", "Calibri", 150.0, 24.0, Color.YELLOW, Color.pink, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setOn(false); // Use the "Kerning" property to enable/disable kerning spacing between certain characters. shape = appendWordArt(doc, "Kerning: VAV", "Times New Roman", 90.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(true); shape = appendWordArt(doc, "No kerning: VAV", "Times New Roman", 100.0, 24.0, Color.ORANGE, Color.RED, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setKerning(false); // Use the "Spacing" property to set the custom spacing between characters on a scale from 0.0 (none) to 1.0 (default). shape = appendWordArt(doc, "Spacing set to 0.1", "Calibri", 120.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_CASCADE_DOWN); shape.getTextPath().setSpacing(0.1); // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise. shape = appendWordArt(doc, "RotateLetters", "Calibri", 200.0, 36.0, Color.YELLOW, Color.GREEN, ShapeType.TEXT_WAVE); shape.getTextPath().setRotateLetters(true); // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height. shape = appendWordArt(doc, "Same character height for lower and UPPER case", "Calibri", 300.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_SLANT_UP); shape.getTextPath().setSameLetterHeights(true); // By default, the text's size will always scale to fit the containing shape's size, overriding the text size setting. shape = appendWordArt(doc, "FitShape on", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); Assert.assertTrue(shape.getTextPath().getFitShape()); shape.getTextPath().setSize(24.0); // If we set the "FitShape: property to "false", the text will keep the size // which the "Size" property specifies regardless of the size of the shape. // Use the "TextPathAlignment" property also to align the text to a side of the shape. shape = appendWordArt(doc, "FitShape off", "Calibri", 160.0, 24.0, Color.BLUE, Color.BLUE, ShapeType.TEXT_PLAIN_TEXT); shape.getTextPath().setFitShape(false); shape.getTextPath().setSize(24.0); shape.getTextPath().setTextPathAlignment(TextPathAlignment.RIGHT); doc.save(getArtifactsDir() + "Shape.InsertTextPaths.docx"); } /// /// Insert a new paragraph with a WordArt shape inside it. /// private static Shape appendWordArt(Document doc, String text, String textFontFamily, double shapeWidth, double shapeHeight, Color wordArtFill, Color line, int wordArtShapeType) throws Exception { // Create an inline Shape, which will serve as a container for our WordArt. // The shape can only be a valid WordArt shape if we assign a WordArt-designated ShapeType to it. // These types will have "WordArt object" in the description, // and their enumerator constant names will all start with "Text". Shape shape = new Shape(doc, wordArtShapeType); { shape.setWrapType(WrapType.INLINE); shape.setWidth(shapeWidth); shape.setHeight(shapeHeight); shape.setFillColor(wordArtFill); shape.setStrokeColor(line); } shape.getTextPath().setText(text); shape.getTextPath().setFontFamily(textFontFamily); Paragraph para = (Paragraph) doc.getFirstSection().getBody().appendChild(new Paragraph(doc)); para.appendChild(shape); return shape; } ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. |