Aspose::Words::Drawing::TextBox Class Reference

Defines attributes that specify how a text is displayed inside a shape. More...

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

Inherits System::Object.

Public Member Functions

double get_InternalMarginLeft ()
 Specifies the inner left margin in points for a shape. More...
 
void set_InternalMarginLeft (double value)
 Setter for Aspose::Words::Drawing::TextBox::get_InternalMarginLeft. More...
 
double get_InternalMarginRight ()
 Specifies the inner right margin in points for a shape. More...
 
void set_InternalMarginRight (double value)
 Setter for Aspose::Words::Drawing::TextBox::get_InternalMarginRight. More...
 
double get_InternalMarginTop ()
 Specifies the inner top margin in points for a shape. More...
 
void set_InternalMarginTop (double value)
 Setter for Aspose::Words::Drawing::TextBox::get_InternalMarginTop. More...
 
double get_InternalMarginBottom ()
 Specifies the inner bottom margin in points for a shape. More...
 
void set_InternalMarginBottom (double value)
 Setter for Aspose::Words::Drawing::TextBox::get_InternalMarginBottom. More...
 
bool get_FitShapeToText ()
 Determines whether Microsoft Word will grow the shape to fit text. More...
 
void set_FitShapeToText (bool value)
 Setter for Aspose::Words::Drawing::TextBox::get_FitShapeToText. More...
 
Aspose::Words::Drawing::LayoutFlow get_LayoutFlow ()
 Determines the flow of the text layout in a shape. More...
 
void set_LayoutFlow (Aspose::Words::Drawing::LayoutFlow value)
 Setter for Aspose::Words::Drawing::TextBox::get_LayoutFlow. More...
 
Aspose::Words::Drawing::TextBoxWrapMode get_TextBoxWrapMode ()
 Determines how text wraps inside a shape. More...
 
void set_TextBoxWrapMode (Aspose::Words::Drawing::TextBoxWrapMode value)
 Setter for Aspose::Words::Drawing::TextBox::get_TextBoxWrapMode. More...
 
Aspose::Words::Drawing::TextBoxAnchor get_VerticalAnchor ()
 Specifies the vertical alignment of the text within a shape. More...
 
void set_VerticalAnchor (Aspose::Words::Drawing::TextBoxAnchor value)
 Setter for Aspose::Words::Drawing::TextBox::get_VerticalAnchor. More...
 
System::SharedPtr< Aspose::Words::Drawing::TextBoxget_Next ()
 Returns or sets a TextBox that represents the next TextBox in a sequence of shapes. More...
 
void set_Next (System::SharedPtr< Aspose::Words::Drawing::TextBox > value)
 Setter for Aspose::Words::Drawing::TextBox::get_Next. More...
 
System::SharedPtr< Aspose::Words::Drawing::TextBoxget_Previous ()
 Returns a TextBox that represents the previous TextBox in a sequence of shapes. More...
 
System::SharedPtr< Aspose::Words::Drawing::Shapeget_Parent () const
 Gets a parent shape for the TextBox. More...
 
bool IsValidLinkTarget (System::SharedPtr< Aspose::Words::Drawing::TextBox > target)
 Determines whether this TextBox can be linked to the target Textbox. More...
 
void BreakForwardLink ()
 Breaks the link to the next TextBox. 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 attributes that specify how a text is displayed inside a shape.

Use the Aspose::Words::Drawing::Shape::get_TextBox property to access text properties of a shape. You do not create instances of the Aspose::Words::Drawing::TextBox class directly.

See also
Aspose::Words::Drawing::Shape::get_TextBox

Member Function Documentation

◆ BreakForwardLink()

void Aspose::Words::Drawing::TextBox::BreakForwardLink ( )

Breaks the link to the next TextBox.

BreakForwardLink() doesn't break all other links in the current sequence of shapes. For example: 1-2-3-4 sequence and BreakForwardLink at the 2-nd textbox will create two sequences 1-2, 3-4.

◆ get_FitShapeToText()

bool Aspose::Words::Drawing::TextBox::get_FitShapeToText ( )

Determines whether Microsoft Word will grow the shape to fit text.

The default value is false.

◆ get_InternalMarginBottom()

double Aspose::Words::Drawing::TextBox::get_InternalMarginBottom ( )

Specifies the inner bottom margin in points for a shape.

The default value is 1/20 inch.

◆ get_InternalMarginLeft()

double Aspose::Words::Drawing::TextBox::get_InternalMarginLeft ( )

Specifies the inner left margin in points for a shape.

The default value is 1/10 inch.

◆ get_InternalMarginRight()

double Aspose::Words::Drawing::TextBox::get_InternalMarginRight ( )

Specifies the inner right margin in points for a shape.

The default value is 1/10 inch.

◆ get_InternalMarginTop()

double Aspose::Words::Drawing::TextBox::get_InternalMarginTop ( )

Specifies the inner top margin in points for a shape.

The default value is 1/20 inch.

◆ get_LayoutFlow()

Aspose::Words::Drawing::LayoutFlow Aspose::Words::Drawing::TextBox::get_LayoutFlow ( )

Determines the flow of the text layout in a shape.

The default value is Aspose::Words::Drawing::LayoutFlow::Horizontal.

◆ get_Next()

System::SharedPtr<Aspose::Words::Drawing::TextBox> Aspose::Words::Drawing::TextBox::get_Next ( )

Returns or sets a TextBox that represents the next TextBox in a sequence of shapes.

◆ get_Parent()

System::SharedPtr<Aspose::Words::Drawing::Shape> Aspose::Words::Drawing::TextBox::get_Parent ( ) const

Gets a parent shape for the TextBox.

◆ get_Previous()

System::SharedPtr<Aspose::Words::Drawing::TextBox> Aspose::Words::Drawing::TextBox::get_Previous ( )

Returns a TextBox that represents the previous TextBox in a sequence of shapes.

◆ get_TextBoxWrapMode()

Aspose::Words::Drawing::TextBoxWrapMode Aspose::Words::Drawing::TextBox::get_TextBoxWrapMode ( )

Determines how text wraps inside a shape.

The default value is Aspose::Words::Drawing::TextBoxWrapMode::Square.

◆ get_VerticalAnchor()

Aspose::Words::Drawing::TextBoxAnchor Aspose::Words::Drawing::TextBox::get_VerticalAnchor ( )

Specifies the vertical alignment of the text within a shape.

The default value is Aspose::Words::Drawing::TextBoxAnchor::Top.

◆ IsValidLinkTarget()

bool Aspose::Words::Drawing::TextBox::IsValidLinkTarget ( System::SharedPtr< Aspose::Words::Drawing::TextBox target)

Determines whether this TextBox can be linked to the target Textbox.

◆ set_FitShapeToText()

void Aspose::Words::Drawing::TextBox::set_FitShapeToText ( bool  value)

◆ set_InternalMarginBottom()

void Aspose::Words::Drawing::TextBox::set_InternalMarginBottom ( double  value)

◆ set_InternalMarginLeft()

void Aspose::Words::Drawing::TextBox::set_InternalMarginLeft ( double  value)

◆ set_InternalMarginRight()

void Aspose::Words::Drawing::TextBox::set_InternalMarginRight ( double  value)

◆ set_InternalMarginTop()

void Aspose::Words::Drawing::TextBox::set_InternalMarginTop ( double  value)

◆ set_LayoutFlow()

void Aspose::Words::Drawing::TextBox::set_LayoutFlow ( Aspose::Words::Drawing::LayoutFlow  value)

◆ set_Next()

void Aspose::Words::Drawing::TextBox::set_Next ( System::SharedPtr< Aspose::Words::Drawing::TextBox value)

◆ set_TextBoxWrapMode()

void Aspose::Words::Drawing::TextBox::set_TextBoxWrapMode ( Aspose::Words::Drawing::TextBoxWrapMode  value)

◆ set_VerticalAnchor()

void Aspose::Words::Drawing::TextBox::set_VerticalAnchor ( Aspose::Words::Drawing::TextBoxAnchor  value)