Aspose::Words::TabStop Class Referencefinal

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

#include "Aspose.Words.Cpp/Model/Text/TabStop.h"

Inherits System::Object.

Public Member Functions

double get_Position ()
 Gets the position of the tab stop in points. More...
 
Aspose::Words::TabAlignment get_Alignment () const
 Gets or sets the alignment of text at this tab stop. More...
 
void set_Alignment (Aspose::Words::TabAlignment value)
 Setter for Aspose::Words::TabStop::get_Alignment. More...
 
Aspose::Words::TabLeader get_Leader () const
 Gets or sets the type of the leader line displayed under the tab character. More...
 
void set_Leader (Aspose::Words::TabLeader value)
 Setter for Aspose::Words::TabStop::get_Leader. More...
 
bool get_IsClear ()
 Returns true if this tab stop clears any existing tab stops in this position. More...
 
 TabStop (double position)
 Initializes a new instance of this class. More...
 
 TabStop (double position, Aspose::Words::TabAlignment alignment, Aspose::Words::TabLeader leader)
 Initializes a new instance of this class. More...
 
bool Equals (System::SharedPtr< Aspose::Words::TabStop > rhs)
 Compares with the specified TabStop. 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

Represents a single custom tab stop. The TabStop object is a member of the Aspose::Words::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 Aspose::Words::TabStop::get_Alignment to TabAlignment.Clear.

For more information see Aspose::Words::TabStopCollection.

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

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 Aspose::Words::TabAlignment value that specifies the alignment of text at this tab stop.
leaderA Aspose::Words::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 or sets 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 or sets 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.

◆ set_Alignment()

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

◆ set_Leader()

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