Aspose::Words::TabStop Class Referencefinal

Detailed Description

Represents a single custom tab stop. The TabStop object is a member of the TabStopCollection collection.

Normally, a tab stop specifies a position where a tab stop exists. But because tab stops can be inherited from parent styles, it might be needed for the child object to define explicitly that there is no tab stop at a given position. To clear an inherited tab stop at a given position, create a TabStop object and set Alignment to TabAlignment.Clear.

For more information see TabStopCollection.

See also
Aspose::Words::ParagraphFormat, Aspose::Words::TabStopCollection, Aspose::Words::Document::get_DefaultTabStop

#include <Aspose.Words.Cpp/Model/Text/TabStop.h>

+ Inheritance diagram for Aspose::Words::TabStop:

Public Member Functions

 TabStop (double position)
 Initializes a new instance of this class. More...
 
 TabStop (double position, TabAlignment alignment, TabLeader leader)
 Initializes a new instance of this class. More...
 
bool Equals (SharedPtr< TabStop > rhs)
 Compares with the specified TabStop. More...
 
TabAlignment get_Alignment () const
 Gets the alignment of text at this tab stop. More...
 
bool get_IsClear ()
 Returns true if this tab stop clears any existing tab stops in this position. More...
 
TabLeader get_Leader () const
 Gets the type of the leader line displayed under the tab character. More...
 
double get_Position ()
 Gets the position of the tab stop in points. More...
 
virtual int32_t GetHashCode () const
 
void set_Alignment (TabAlignment value)
 Sets the alignment of text at this tab stop. More...
 
void set_Leader (TabLeader value)
 Sets the type of the leader line displayed under the tab character. More...
 
- Public Member Functions inherited from Object
ASPOSECPP_SHARED_API Object ()
 
ASPOSECPP_SHARED_API Object (Object const &x)
 
virtual ASPOSECPP_SHARED_API ~Object ()
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 
Detail::SmartPtrCounter * GetCounter ()
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 
ASPOSECPP_SHARED_API void Lock ()
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 
Objectoperator= (Object const &x)
 
bool ReferenceEquals (String const &str, std::nullptr_t)
 
bool ReferenceEquals (String const &str1, String const &str2)
 
int RemovedSharedRefs (int count)
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 
int SharedCount () const
 
ObjectSharedRefAdded ()
 
int SharedRefRemovedSafe ()
 
virtual ASPOSECPP_SHARED_API String ToString () const
 
ASPOSECPP_SHARED_API void Unlock ()
 
Detail::SmartPtrCounter * WeakRefAdded ()
 
void WeakRefRemoved ()
 

Additional Inherited Members

- Public Types inherited from Object
typedef SmartPtr< Objectptr
 
typedef System::Details::SharedMembersType shared_members_type
 
- Static Public Member Functions inherited from Object
bool Equals (double const &objA, double const &objB)
 
bool Equals (float const &objA, float const &objB)
 
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 
static const TypeInfoType ()
 

Constructor & Destructor Documentation

◆ TabStop() [1/2]

Aspose::Words::TabStop::TabStop ( double  position)

Initializes a new instance of this class.

◆ TabStop() [2/2]

Aspose::Words::TabStop::TabStop ( double  position,
Aspose::Words::TabAlignment  alignment,
Aspose::Words::TabLeader  leader 
)

Initializes a new instance of this class.

Parameters
positionThe position of the tab stop in points.
alignmentA TabAlignment value that specifies the alignment of text at this tab stop.
leaderA TabLeader value that specifies the type of the leader line displayed under the tab character.

Member Function Documentation

◆ Equals()

bool Aspose::Words::TabStop::Equals ( System::SharedPtr< Aspose::Words::TabStop rhs)

Compares with the specified TabStop.

◆ get_Alignment()

Aspose::Words::TabAlignment Aspose::Words::TabStop::get_Alignment ( ) const

Gets the alignment of text at this tab stop.

◆ get_IsClear()

bool Aspose::Words::TabStop::get_IsClear ( )

Returns true if this tab stop clears any existing tab stops in this position.

◆ get_Leader()

Aspose::Words::TabLeader Aspose::Words::TabStop::get_Leader ( ) const

Gets the type of the leader line displayed under the tab character.

◆ get_Position()

double Aspose::Words::TabStop::get_Position ( )

Gets the position of the tab stop in points.

◆ GetHashCode()

virtual int32_t Aspose::Words::TabStop::GetHashCode ( ) const
virtual

Reimplemented from System::Object.

◆ set_Alignment()

void Aspose::Words::TabStop::set_Alignment ( Aspose::Words::TabAlignment  value)

Sets the alignment of text at this tab stop.

◆ set_Leader()

void Aspose::Words::TabStop::set_Leader ( Aspose::Words::TabLeader  value)

Sets the type of the leader line displayed under the tab character.