Aspose::Pdf::Text::TextFormattingOptions Class Referencefinal

Represents text formatting options More...

#include "TextFormattingOptions.h"

Inherits Aspose::Pdf::Text::TextOptions.

Public Types

enum  WordWrapMode { WordWrapMode::NoWrap, WordWrapMode::DiscretionaryHyphenation, WordWrapMode::ByWords, WordWrapMode::Undefined }
 Defines word wrapping strategies More...
 
enum  LineSpacingMode { LineSpacingMode::FontSize, LineSpacingMode::FullSize }
 Defines line spacing specifics More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

ASPOSE_PDF_SHARED_API TextFormattingOptions::WordWrapMode get_WrapMode () const
 Gets word wrap mode. Default value is WordWrapMode.NoWrap More...
 
ASPOSE_PDF_SHARED_API void set_WrapMode (TextFormattingOptions::WordWrapMode value)
 Sets word wrap mode. Default value is WordWrapMode.NoWrap More...
 
ASPOSE_PDF_SHARED_API TextFormattingOptions::LineSpacingMode get_LineSpacing () const
 Gets line spacing mode. Default value is LineSpacingMode.FontSize More...
 
ASPOSE_PDF_SHARED_API void set_LineSpacing (TextFormattingOptions::LineSpacingMode value)
 Sets line spacing mode. Default value is LineSpacingMode.FontSize More...
 
ASPOSE_PDF_SHARED_API System::String get_HyphenSymbol () const
 Gets hyphen symbol that is used in hyphenation process. More...
 
ASPOSE_PDF_SHARED_API void set_HyphenSymbol (System::String value)
 Sets hyphen symbol that is used in hyphenation process. More...
 
ASPOSE_PDF_SHARED_API float get_SubsequentLinesIndent () const
 Gets subsequent lines indent value. More...
 
ASPOSE_PDF_SHARED_API void set_SubsequentLinesIndent (float value)
 Sets subsequent lines indent value. More...
 
ASPOSE_PDF_SHARED_API float get_FirstLineIndent () const
 Gets first line indent value. More...
 
ASPOSE_PDF_SHARED_API void set_FirstLineIndent (float value)
 Sets first line indent value. More...
 
ASPOSE_PDF_SHARED_API TextFormattingOptions (TextFormattingOptions::WordWrapMode wrapMode)
 Initializes new instance of the TextFormattingOptions object for the specified word wrap mode. More...
 
ASPOSE_PDF_SHARED_API TextFormattingOptions ()
 Initializes new instance of the TextFormattingOptions object with undefined word wrap mode. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API 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 reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

bool get_IsChanged () const
 
void set_IsChanged (bool value)
 
System::SharedPtr< TextFormattingOptionsClone ()
 Clones TextFormattingOptions instance. More...
 

Additional Inherited Members

- 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 ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Represents text formatting options

Member Enumeration Documentation

◆ LineSpacingMode

Defines line spacing specifics

Enumerator
FontSize 

Line spacing is font size

FullSize 

Line spacing is a full space between descender and ascender

◆ WordWrapMode

Defines word wrapping strategies

Enumerator
NoWrap 

No wrapping is performed

DiscretionaryHyphenation 

Discretionary hyphenation is performed. Allows breaking words in the middle.

ByWords 

Word wrapping only wraps complete words. If the complete word cannot be wrapped, attempts to use discretionary hyphenation

Undefined 

WordWrapMode not set. Wrapping strategie of upper level structure (table cell, paragraph etc.) will be used.

Constructor & Destructor Documentation

◆ TextFormattingOptions() [1/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextFormattingOptions::TextFormattingOptions ( TextFormattingOptions::WordWrapMode  wrapMode)

Initializes new instance of the TextFormattingOptions object for the specified word wrap mode.

Parameters
wrapModeWord wrap mode.

◆ TextFormattingOptions() [2/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextFormattingOptions::TextFormattingOptions ( )

Initializes new instance of the TextFormattingOptions object with undefined word wrap mode.

Member Function Documentation

◆ Clone()

System::SharedPtr<TextFormattingOptions> Aspose::Pdf::Text::TextFormattingOptions::Clone ( )
protected

Clones TextFormattingOptions instance.

Returns
Cloned TextFormattingOptions

◆ get_FirstLineIndent()

ASPOSE_PDF_SHARED_API float Aspose::Pdf::Text::TextFormattingOptions::get_FirstLineIndent ( ) const

Gets first line indent value.

◆ get_HyphenSymbol()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Text::TextFormattingOptions::get_HyphenSymbol ( ) const

Gets hyphen symbol that is used in hyphenation process.

To eliminate hyphen drawing (with wrapping procedure still in place) please set empty string string.Empty for HyphenSymbol.

◆ get_IsChanged()

bool Aspose::Pdf::Text::TextFormattingOptions::get_IsChanged ( ) const
protected

◆ get_LineSpacing()

ASPOSE_PDF_SHARED_API TextFormattingOptions::LineSpacingMode Aspose::Pdf::Text::TextFormattingOptions::get_LineSpacing ( ) const

Gets line spacing mode. Default value is LineSpacingMode.FontSize

◆ get_SubsequentLinesIndent()

ASPOSE_PDF_SHARED_API float Aspose::Pdf::Text::TextFormattingOptions::get_SubsequentLinesIndent ( ) const

Gets subsequent lines indent value.

◆ get_WrapMode()

ASPOSE_PDF_SHARED_API TextFormattingOptions::WordWrapMode Aspose::Pdf::Text::TextFormattingOptions::get_WrapMode ( ) const

Gets word wrap mode. Default value is WordWrapMode.NoWrap

◆ set_FirstLineIndent()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFormattingOptions::set_FirstLineIndent ( float  value)

Sets first line indent value.

◆ set_HyphenSymbol()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFormattingOptions::set_HyphenSymbol ( System::String  value)

Sets hyphen symbol that is used in hyphenation process.

To eliminate hyphen drawing (with wrapping procedure still in place) please set empty string string.Empty for HyphenSymbol.

◆ set_IsChanged()

void Aspose::Pdf::Text::TextFormattingOptions::set_IsChanged ( bool  value)
protected

◆ set_LineSpacing()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFormattingOptions::set_LineSpacing ( TextFormattingOptions::LineSpacingMode  value)

Sets line spacing mode. Default value is LineSpacingMode.FontSize

◆ set_SubsequentLinesIndent()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFormattingOptions::set_SubsequentLinesIndent ( float  value)

Sets subsequent lines indent value.

◆ set_WrapMode()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextFormattingOptions::set_WrapMode ( TextFormattingOptions::WordWrapMode  value)

Sets word wrap mode. Default value is WordWrapMode.NoWrap