Aspose::Words::Drawing::TextPath Class Reference

Defines the text and formatting of the text path (of a WordArt object). More...

#include "Aspose.Words.Cpp/Model/Drawing/TextPath.h"

Inherits System::Object.

Public Member Functions

bool get_On ()
 Defines whether the text is displayed. More...
 
void set_On (bool value)
 Setter for Aspose::Words::Drawing::TextPath::get_On. More...
 
bool get_FitPath ()
 Defines whether the text fits the path of a shape. More...
 
void set_FitPath (bool value)
 Setter for Aspose::Words::Drawing::TextPath::get_FitPath. More...
 
bool get_FitShape ()
 Defines whether the text fits bounding box of a shape. More...
 
void set_FitShape (bool value)
 Setter for Aspose::Words::Drawing::TextPath::get_FitShape. More...
 
System::String get_FontFamily ()
 Defines the family of the textpath font. More...
 
void set_FontFamily (System::String value)
 Setter for Aspose::Words::Drawing::TextPath::get_FontFamily. More...
 
double get_Size ()
 Defines the size of the font in points. More...
 
void set_Size (double value)
 Setter for Aspose::Words::Drawing::TextPath::get_Size. More...
 
bool get_Bold ()
 True if the font is formatted as bold. More...
 
void set_Bold (bool value)
 Setter for Aspose::Words::Drawing::TextPath::get_Bold. More...
 
bool get_Italic ()
 True if the font is formatted as italic. More...
 
void set_Italic (bool value)
 Setter for Aspose::Words::Drawing::TextPath::get_Italic. More...
 
bool get_SmallCaps ()
 True if the font is formatted as small capital letters. More...
 
void set_SmallCaps (bool value)
 Setter for Aspose::Words::Drawing::TextPath::get_SmallCaps. More...
 
bool get_RotateLetters ()
 Determines whether the letters of the text are rotated. More...
 
void set_RotateLetters (bool value)
 Setter for Aspose::Words::Drawing::TextPath::get_RotateLetters. More...
 
bool get_Trim ()
 Determines whether extra space is removed above and below the text. More...
 
void set_Trim (bool value)
 Setter for Aspose::Words::Drawing::TextPath::get_Trim. More...
 
bool get_Kerning ()
 Determines whether kerning is turned on. More...
 
void set_Kerning (bool value)
 Setter for Aspose::Words::Drawing::TextPath::get_Kerning. More...
 
bool get_Shadow ()
 Defines whether a shadow is applied to the text on a text path. More...
 
void set_Shadow (bool value)
 Setter for Aspose::Words::Drawing::TextPath::get_Shadow. More...
 
bool get_Underline ()
 True if the font is underlined. More...
 
void set_Underline (bool value)
 Setter for Aspose::Words::Drawing::TextPath::get_Underline. More...
 
bool get_StrikeThrough ()
 True if the font is formatted as strikethrough text. More...
 
void set_StrikeThrough (bool value)
 Setter for Aspose::Words::Drawing::TextPath::get_StrikeThrough. More...
 
bool get_SameLetterHeights ()
 Determines whether all letters will be the same height regardless of initial case. More...
 
void set_SameLetterHeights (bool value)
 Setter for Aspose::Words::Drawing::TextPath::get_SameLetterHeights. More...
 
System::String get_Text ()
 Defines the text of the text path. More...
 
void set_Text (System::String value)
 Setter for Aspose::Words::Drawing::TextPath::get_Text. More...
 
Aspose::Words::Drawing::TextPathAlignment get_TextPathAlignment ()
 Defines the alignment of text. More...
 
void set_TextPathAlignment (Aspose::Words::Drawing::TextPathAlignment value)
 Setter for Aspose::Words::Drawing::TextPath::get_TextPathAlignment. More...
 
bool get_ReverseRows ()
 Determines whether the layout order of rows is reversed. More...
 
void set_ReverseRows (bool value)
 Setter for Aspose::Words::Drawing::TextPath::get_ReverseRows. More...
 
double get_Spacing ()
 Defines the amount of spacing for text. 1 means 100%. More...
 
void set_Spacing (double value)
 Setter for Aspose::Words::Drawing::TextPath::get_Spacing. More...
 
bool get_XScale ()
 Determines whether a straight textpath will be used instead of the shape path. More...
 
void set_XScale (bool value)
 Setter for Aspose::Words::Drawing::TextPath::get_XScale. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Detailed Description

Defines the text and formatting of the text path (of a WordArt object).

Use the Aspose::Words::Drawing::Shape::get_TextPath property to access WordArt properties of a shape. You do not create instances of the Aspose::Words::Drawing::TextPath class directly.

See also
Aspose::Words::Drawing::Shape::get_TextPath

Member Function Documentation

◆ get_Bold()

bool Aspose::Words::Drawing::TextPath::get_Bold ( )

True if the font is formatted as bold.

The default value is false.

◆ get_FitPath()

bool Aspose::Words::Drawing::TextPath::get_FitPath ( )

Defines whether the text fits the path of a shape.

The default value is false.

◆ get_FitShape()

bool Aspose::Words::Drawing::TextPath::get_FitShape ( )

Defines whether the text fits bounding box of a shape.

The default value is false.

◆ get_FontFamily()

System::String Aspose::Words::Drawing::TextPath::get_FontFamily ( )

Defines the family of the textpath font.

The default value is Arial.

◆ get_Italic()

bool Aspose::Words::Drawing::TextPath::get_Italic ( )

True if the font is formatted as italic.

The default value is false.

◆ get_Kerning()

bool Aspose::Words::Drawing::TextPath::get_Kerning ( )

Determines whether kerning is turned on.

The default value is false.

◆ get_On()

bool Aspose::Words::Drawing::TextPath::get_On ( )

Defines whether the text is displayed.

The default value is false.

◆ get_ReverseRows()

bool Aspose::Words::Drawing::TextPath::get_ReverseRows ( )

Determines whether the layout order of rows is reversed.

The default value is false.

If true, the layout order of rows is reversed. This attribute is used for vertical text layout.

◆ get_RotateLetters()

bool Aspose::Words::Drawing::TextPath::get_RotateLetters ( )

Determines whether the letters of the text are rotated.

The default value is false.

◆ get_SameLetterHeights()

bool Aspose::Words::Drawing::TextPath::get_SameLetterHeights ( )

Determines whether all letters will be the same height regardless of initial case.

The default value is false.

◆ get_Shadow()

bool Aspose::Words::Drawing::TextPath::get_Shadow ( )

Defines whether a shadow is applied to the text on a text path.

The default value is false.

◆ get_Size()

double Aspose::Words::Drawing::TextPath::get_Size ( )

Defines the size of the font in points.

The default value is 36.

◆ get_SmallCaps()

bool Aspose::Words::Drawing::TextPath::get_SmallCaps ( )

True if the font is formatted as small capital letters.

The default value is false.

◆ get_Spacing()

double Aspose::Words::Drawing::TextPath::get_Spacing ( )

Defines the amount of spacing for text. 1 means 100%.

The default value is 1.

◆ get_StrikeThrough()

bool Aspose::Words::Drawing::TextPath::get_StrikeThrough ( )

True if the font is formatted as strikethrough text.

The default value is false.

◆ get_Text()

System::String Aspose::Words::Drawing::TextPath::get_Text ( )

Defines the text of the text path.

The default value is an empty string.

◆ get_TextPathAlignment()

Aspose::Words::Drawing::TextPathAlignment Aspose::Words::Drawing::TextPath::get_TextPathAlignment ( )

Defines the alignment of text.

The default value is Aspose::Words::Drawing::TextPathAlignment::Center.

◆ get_Trim()

bool Aspose::Words::Drawing::TextPath::get_Trim ( )

Determines whether extra space is removed above and below the text.

The default value is false.

◆ get_Underline()

bool Aspose::Words::Drawing::TextPath::get_Underline ( )

True if the font is underlined.

The default value is false.

◆ get_XScale()

bool Aspose::Words::Drawing::TextPath::get_XScale ( )

Determines whether a straight textpath will be used instead of the shape path.

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.

◆ set_Bold()

void Aspose::Words::Drawing::TextPath::set_Bold ( bool  value)

◆ set_FitPath()

void Aspose::Words::Drawing::TextPath::set_FitPath ( bool  value)

◆ set_FitShape()

void Aspose::Words::Drawing::TextPath::set_FitShape ( bool  value)

◆ set_FontFamily()

void Aspose::Words::Drawing::TextPath::set_FontFamily ( System::String  value)

◆ set_Italic()

void Aspose::Words::Drawing::TextPath::set_Italic ( bool  value)

◆ set_Kerning()

void Aspose::Words::Drawing::TextPath::set_Kerning ( bool  value)

◆ set_On()

void Aspose::Words::Drawing::TextPath::set_On ( bool  value)

◆ set_ReverseRows()

void Aspose::Words::Drawing::TextPath::set_ReverseRows ( bool  value)

◆ set_RotateLetters()

void Aspose::Words::Drawing::TextPath::set_RotateLetters ( bool  value)

◆ set_SameLetterHeights()

void Aspose::Words::Drawing::TextPath::set_SameLetterHeights ( bool  value)

◆ set_Shadow()

void Aspose::Words::Drawing::TextPath::set_Shadow ( bool  value)

◆ set_Size()

void Aspose::Words::Drawing::TextPath::set_Size ( double  value)

◆ set_SmallCaps()

void Aspose::Words::Drawing::TextPath::set_SmallCaps ( bool  value)

◆ set_Spacing()

void Aspose::Words::Drawing::TextPath::set_Spacing ( double  value)

◆ set_StrikeThrough()

void Aspose::Words::Drawing::TextPath::set_StrikeThrough ( bool  value)

◆ set_Text()

void Aspose::Words::Drawing::TextPath::set_Text ( System::String  value)

◆ set_TextPathAlignment()

void Aspose::Words::Drawing::TextPath::set_TextPathAlignment ( Aspose::Words::Drawing::TextPathAlignment  value)

◆ set_Trim()

void Aspose::Words::Drawing::TextPath::set_Trim ( bool  value)

◆ set_Underline()

void Aspose::Words::Drawing::TextPath::set_Underline ( bool  value)

◆ set_XScale()

void Aspose::Words::Drawing::TextPath::set_XScale ( bool  value)