Aspose::Words::Drawing::TextPath class

TextPath class

Defines the text and formatting of the text path (of a WordArt object). To learn more, visit the Working with Shapes documentation article.

class TextPath : public System::Object

Methods

MethodDescription
get_Bold()True if the font is formatted as bold.
get_FitPath()Defines whether the text fits the path of a shape.
get_FitShape()Defines whether the text fits bounding box of a shape.
get_FontFamily()Defines the family of the textpath font.
get_Italic()True if the font is formatted as italic.
get_Kerning()Determines whether kerning is turned on.
get_On()Defines whether the text is displayed.
get_ReverseRows()Determines whether the layout order of rows is reversed.
get_RotateLetters()Determines whether the letters of the text are rotated.
get_SameLetterHeights()Determines whether all letters will be the same height regardless of initial case.
get_Shadow()Defines whether a shadow is applied to the text on a text path.
get_Size()Defines the size of the font in points.
get_SmallCaps()True if the font is formatted as small capital letters.
get_Spacing()Defines the amount of spacing for text. 1 means 100%.
get_StrikeThrough()True if the font is formatted as strikethrough text.
get_Text()Defines the text of the text path.
get_TextPathAlignment()Defines the alignment of text.
get_Trim()Determines whether extra space is removed above and below the text.
get_Underline()True if the font is underlined.
get_XScale()Determines whether a straight textpath will be used instead of the shape path.
GetType() const override
Is(const System::TypeInfo&) const override
set_Bold(bool)Setter for Aspose::Words::Drawing::TextPath::get_Bold.
set_FitPath(bool)Setter for Aspose::Words::Drawing::TextPath::get_FitPath.
set_FitShape(bool)Setter for Aspose::Words::Drawing::TextPath::get_FitShape.
set_FontFamily(const System::String&)Setter for Aspose::Words::Drawing::TextPath::get_FontFamily.
set_Italic(bool)Setter for Aspose::Words::Drawing::TextPath::get_Italic.
set_Kerning(bool)Setter for Aspose::Words::Drawing::TextPath::get_Kerning.
set_On(bool)Setter for Aspose::Words::Drawing::TextPath::get_On.
set_ReverseRows(bool)Setter for Aspose::Words::Drawing::TextPath::get_ReverseRows.
set_RotateLetters(bool)Setter for Aspose::Words::Drawing::TextPath::get_RotateLetters.
set_SameLetterHeights(bool)Setter for Aspose::Words::Drawing::TextPath::get_SameLetterHeights.
set_Shadow(bool)Setter for Aspose::Words::Drawing::TextPath::get_Shadow.
set_Size(double)Defines the size of the font in points.
set_SmallCaps(bool)Setter for Aspose::Words::Drawing::TextPath::get_SmallCaps.
set_Spacing(double)Setter for Aspose::Words::Drawing::TextPath::get_Spacing.
set_StrikeThrough(bool)Setter for Aspose::Words::Drawing::TextPath::get_StrikeThrough.
set_Text(const System::String&)Setter for Aspose::Words::Drawing::TextPath::get_Text.
set_TextPathAlignment(Aspose::Words::Drawing::TextPathAlignment)Setter for Aspose::Words::Drawing::TextPath::get_TextPathAlignment.
set_Trim(bool)Setter for Aspose::Words::Drawing::TextPath::get_Trim.
set_Underline(bool)Setter for Aspose::Words::Drawing::TextPath::get_Underline.
set_XScale(bool)Setter for Aspose::Words::Drawing::TextPath::get_XScale.
static Type()

Remarks

Use the TextPath property to access WordArt properties of a shape. You do not create instances of the TextPath class directly.

Examples

Shows how to work with WordArt.

void InsertTextPaths()
{
    auto doc = MakeObject<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.
    SharedPtr<Shape> shape = AppendWordArt(doc, u"Hello World! This text is bold, and italic.", u"Arial", 480, 24, System::Drawing::Color::get_White(),
                                           System::Drawing::Color::get_Black(), ShapeType::TextPlainText);

    // Apply the "Bold' and "Italic" formatting settings to the text using the respective properties.
    shape->get_TextPath()->set_Bold(true);
    shape->get_TextPath()->set_Italic(true);

    // Below are various other text formatting-related properties.
    ASSERT_FALSE(shape->get_TextPath()->get_Underline());
    ASSERT_FALSE(shape->get_TextPath()->get_Shadow());
    ASSERT_FALSE(shape->get_TextPath()->get_StrikeThrough());
    ASSERT_FALSE(shape->get_TextPath()->get_ReverseRows());
    ASSERT_FALSE(shape->get_TextPath()->get_XScale());
    ASSERT_FALSE(shape->get_TextPath()->get_Trim());
    ASSERT_FALSE(shape->get_TextPath()->get_SmallCaps());

    ASPOSE_ASSERT_EQ(36.0, shape->get_TextPath()->get_Size());
    ASSERT_EQ(u"Hello World! This text is bold, and italic.", shape->get_TextPath()->get_Text());
    ASSERT_EQ(ShapeType::TextPlainText, shape->get_ShapeType());

    // Use the "On" property to show/hide the text.
    shape = AppendWordArt(doc, u"On set to \"true\"", u"Calibri", 150, 24, System::Drawing::Color::get_Yellow(), System::Drawing::Color::get_Red(),
                          ShapeType::TextPlainText);
    shape->get_TextPath()->set_On(true);

    shape = AppendWordArt(doc, u"On set to \"false\"", u"Calibri", 150, 24, System::Drawing::Color::get_Yellow(), System::Drawing::Color::get_Purple(),
                          ShapeType::TextPlainText);
    shape->get_TextPath()->set_On(false);

    // Use the "Kerning" property to enable/disable kerning spacing between certain characters.
    shape = AppendWordArt(doc, u"Kerning: VAV", u"Times New Roman", 90, 24, System::Drawing::Color::get_Orange(), System::Drawing::Color::get_Red(),
                          ShapeType::TextPlainText);
    shape->get_TextPath()->set_Kerning(true);

    shape = AppendWordArt(doc, u"No kerning: VAV", u"Times New Roman", 100, 24, System::Drawing::Color::get_Orange(), System::Drawing::Color::get_Red(),
                          ShapeType::TextPlainText);
    shape->get_TextPath()->set_Kerning(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, u"Spacing set to 0.1", u"Calibri", 120, 24, System::Drawing::Color::get_BlueViolet(), System::Drawing::Color::get_Blue(),
                          ShapeType::TextCascadeDown);
    shape->get_TextPath()->set_Spacing(0.1);

    // Set the "RotateLetters" property to "true" to rotate each character 90 degrees counterclockwise.
    shape = AppendWordArt(doc, u"RotateLetters", u"Calibri", 200, 36, System::Drawing::Color::get_GreenYellow(), System::Drawing::Color::get_Green(),
                          ShapeType::TextWave);
    shape->get_TextPath()->set_RotateLetters(true);

    // Set the "SameLetterHeights" property to "true" to get the x-height of each character to equal the cap height.
    shape = AppendWordArt(doc, u"Same character height for lower and UPPER case", u"Calibri", 300, 24, System::Drawing::Color::get_DeepSkyBlue(),
                          System::Drawing::Color::get_DodgerBlue(), ShapeType::TextSlantUp);
    shape->get_TextPath()->set_SameLetterHeights(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, u"FitShape on", u"Calibri", 160, 24, System::Drawing::Color::get_LightBlue(), System::Drawing::Color::get_Blue(),
                          ShapeType::TextPlainText);
    ASSERT_TRUE(shape->get_TextPath()->get_FitShape());
    shape->get_TextPath()->set_Size(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, u"FitShape off", u"Calibri", 160, 24, System::Drawing::Color::get_LightBlue(), System::Drawing::Color::get_Blue(),
                          ShapeType::TextPlainText);
    shape->get_TextPath()->set_FitShape(false);
    shape->get_TextPath()->set_Size(24.0);
    shape->get_TextPath()->set_TextPathAlignment(TextPathAlignment::Right);

    doc->Save(ArtifactsDir + u"Shape.InsertTextPaths.docx");
}

static SharedPtr<Shape> AppendWordArt(SharedPtr<Document> doc, String text, String textFontFamily, double shapeWidth, double shapeHeight,
                                      System::Drawing::Color wordArtFill, System::Drawing::Color line, ShapeType wordArtShapeType)
{
    // 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".
    auto shape = MakeObject<Shape>(doc, wordArtShapeType);
    shape->set_WrapType(WrapType::Inline);
    shape->set_Width(shapeWidth);
    shape->set_Height(shapeHeight);
    shape->set_FillColor(wordArtFill);
    shape->set_StrokeColor(line);

    shape->get_TextPath()->set_Text(text);
    shape->get_TextPath()->set_FontFamily(textFontFamily);

    auto para = System::ExplicitCast<Paragraph>(doc->get_FirstSection()->get_Body()->AppendChild(MakeObject<Paragraph>(doc)));
    para->AppendChild(shape);
    return shape;
}

See Also

Aspose::Words::Drawing::TextBox class Aspose::Words::Drawing::ArrowLength enum