Aspose::Pdf::Facades::FormattedText Class Referencefinal

Class which represents formatted text. Contains information about text and its color, size, style. More...

Inherits System::Object.

Public Member Functions

float get_TextHeight ()
 Gets height of text. More...
 
float get_TextWidth ()
 Gets width of text. More...
 
 FormattedText ()
 Initializes FormattedText. More...
 
 FormattedText (System::String text)
 Initializes FormattedText. More...
 
 FormattedText (System::String text, System::SharedPtr< FontColor > fontColor, FontStyle fontStyle, EncodingType encodingType, bool embedded, float textSize)
 Initializes FormattedText. More...
 
 FormattedText (System::String text, System::SharedPtr< FontColor > fontColor, FontStyle textFont, EncodingType textEncoding, bool embedded, float textSize, float lineSpacing)
 Initialize FormattedText. More...
 
 FormattedText (System::String text, System::Drawing::Color color, FontStyle textFont, EncodingType textEncoding, bool embedded, float textSize)
 Initializes FormattedText. More...
 
 FormattedText (System::String text, System::Drawing::Color textColor, FontStyle textFont, EncodingType textEncoding, bool embedded, float textSize, float lineSpacing)
 Initializes FormattedText. More...
 
 FormattedText (System::String text, System::SharedPtr< FontColor > textColor, System::SharedPtr< FontColor > backColor, FontStyle textFont, EncodingType textEncoding, bool embedded, float textSize)
 Initializes FormattedText. More...
 
 FormattedText (System::String text, System::SharedPtr< FontColor > textColor, System::SharedPtr< FontColor > backColor, FontStyle textFont, EncodingType textEncoding, bool embedded, float textSize, float lineSpacing)
 Initializes FormattedText. More...
 
 FormattedText (System::String text, System::Drawing::Color textColor, System::Drawing::Color backColor, FontStyle textFont, EncodingType encoding, bool embedded, float textSize)
 Initializes FormattedText. More...
 
 FormattedText (System::String text, System::Drawing::Color textColor, System::Drawing::Color backColor, FontStyle textFont, EncodingType textEncoding, bool embedded, float textSize, float lineSpacing)
 Initializes FormattedText. More...
 
 FormattedText (System::String text, System::Drawing::Color textColor, System::Drawing::Color backColor, System::String fontName, EncodingType textEncoding, bool embedded, float fontSize)
 Initializes FormattedText. More...
 
 FormattedText (System::String text, System::Drawing::Color textColor, System::Drawing::Color backColor)
 Initializes FormattedText. More...
 
void AddNewLineText (System::String newLineText)
 Adds a new line to the FormattedText object and sets the newLineText to the next line's text. More...
 
void AddNewLineText (System::String newLineText, float lineSpacing)
 Adds a new line to the FormattedText object and sets the newLineText to the next line's text. More...
 
 FormattedText (System::String text, System::Drawing::Color textColor, System::String fontName, EncodingType textEncoding, bool embedded, float fontSize)
 Initializes FormattedText. 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 refernce 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_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 (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. 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)
 

Protected Member Functions

float LineSpacing (int32_t idx)
 Returns line height for the specific line of the multi-line text More...
 
System::String getFirstLine ()
 Gets first line More...
 
System::Drawing::Color getTextColor ()
 Gets text color More...
 
System::Drawing::Color getBackColor ()
 Gets back color More...
 
System::SharedPtr< Aspose::Pdf::Text::FontgetFont ()
 Gets font More...
 
float getFontSize ()
 Gets font size More...
 

Protected Attributes

System::SharedPtr< System::Collections::Generic::List< System::String > > text
 
System::SharedPtr< System::Collections::Generic::Dictionary< int32_t, float > > mpCustomLineSpacing
 

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...
 

Detailed Description

Class which represents formatted text. Contains information about text and its color, size, style.

Constructor & Destructor Documentation

◆ FormattedText() [1/13]

Aspose::Pdf::Facades::FormattedText::FormattedText ( )

Initializes FormattedText.

◆ FormattedText() [2/13]

Aspose::Pdf::Facades::FormattedText::FormattedText ( System::String  text)

Initializes FormattedText.

Parameters
textText which contained in FormattedText.

◆ FormattedText() [3/13]

Aspose::Pdf::Facades::FormattedText::FormattedText ( System::String  text,
System::SharedPtr< FontColor fontColor,
FontStyle  fontStyle,
EncodingType  encodingType,
bool  embedded,
float  textSize 
)

Initializes FormattedText.

Parameters
textText content of the string.
fontColorColor of the text.
fontStyleStyle of the text.
encodingTypeEncoding type (value of EncodingType enumeration).
embeddedTrue if the font will be embedded.
textSizeSize of the text.

◆ FormattedText() [4/13]

Aspose::Pdf::Facades::FormattedText::FormattedText ( System::String  text,
System::SharedPtr< FontColor fontColor,
FontStyle  textFont,
EncodingType  textEncoding,
bool  embedded,
float  textSize,
float  lineSpacing 
)

Initialize FormattedText.

Parameters
textText content of the string.
fontColorColor of the text.
textFontFont of the text.
textEncodingEncoding of the text.
embeddedTrue if text will be embedded.
textSizeSize of the text.
lineSpacingAdditional spacing.

◆ FormattedText() [5/13]

Aspose::Pdf::Facades::FormattedText::FormattedText ( System::String  text,
System::Drawing::Color  color,
FontStyle  textFont,
EncodingType  textEncoding,
bool  embedded,
float  textSize 
)

Initializes FormattedText.

Parameters
textText content of the string.
colorColor of the text.
textFontFont of the text.
textEncodingEncoding of the text.
embeddedTrue if text will be embedded.
textSizeSize of the text.

◆ FormattedText() [6/13]

Aspose::Pdf::Facades::FormattedText::FormattedText ( System::String  text,
System::Drawing::Color  textColor,
FontStyle  textFont,
EncodingType  textEncoding,
bool  embedded,
float  textSize,
float  lineSpacing 
)

Initializes FormattedText.

Parameters
textText contents of the string.
textColorColor of the text.
textFontFont of the text.
textEncodingEncoding of the text.
embeddedIf true font will be embedded.
textSizeSize of the text.
lineSpacingAdditional spacing.

◆ FormattedText() [7/13]

Aspose::Pdf::Facades::FormattedText::FormattedText ( System::String  text,
System::SharedPtr< FontColor textColor,
System::SharedPtr< FontColor backColor,
FontStyle  textFont,
EncodingType  textEncoding,
bool  embedded,
float  textSize 
)

Initializes FormattedText.

Parameters
textText content of the string.
textColorColor of the text.
backColorColor of background.
textFontFont of the text.
textEncodingEncoding of the text.
embeddedIf true font will be embedded.
textSizeSize of the text.

◆ FormattedText() [8/13]

Aspose::Pdf::Facades::FormattedText::FormattedText ( System::String  text,
System::SharedPtr< FontColor textColor,
System::SharedPtr< FontColor backColor,
FontStyle  textFont,
EncodingType  textEncoding,
bool  embedded,
float  textSize,
float  lineSpacing 
)

Initializes FormattedText.

Parameters
textText content.
textColorColor of the text.
backColorColor of background.
textFontFont of the text.
textEncodingEncoding of the text.
embeddedIf true font will be embedded.
textSizeSize of the text.
lineSpacingAdditional spacing.

◆ FormattedText() [9/13]

Aspose::Pdf::Facades::FormattedText::FormattedText ( System::String  text,
System::Drawing::Color  textColor,
System::Drawing::Color  backColor,
FontStyle  textFont,
EncodingType  encoding,
bool  embedded,
float  textSize 
)

Initializes FormattedText.

Parameters
textText content of the string.
textColorColor of the text.
backColorColor of background.
textFontFont of the text.
encodingEncoding of the text.
embeddedTrue if font will be embedded.
textSizeSize of the text.

◆ FormattedText() [10/13]

Aspose::Pdf::Facades::FormattedText::FormattedText ( System::String  text,
System::Drawing::Color  textColor,
System::Drawing::Color  backColor,
FontStyle  textFont,
EncodingType  textEncoding,
bool  embedded,
float  textSize,
float  lineSpacing 
)

Initializes FormattedText.

Parameters
textText contents of the string.
textColorColor of the text.
backColorColor of the background.
textFontFont of the text.
textEncodingEncoding of the text.
embeddedIf true font is embedded.
textSizeSize of the text.
lineSpacingAdditional spacing.

◆ FormattedText() [11/13]

Aspose::Pdf::Facades::FormattedText::FormattedText ( System::String  text,
System::Drawing::Color  textColor,
System::Drawing::Color  backColor,
System::String  fontName,
EncodingType  textEncoding,
bool  embedded,
float  fontSize 
)

Initializes FormattedText.

Parameters
textText content.
textColorColor of the text.
backColorColor of background.
fontNameFont of the text.
textEncodingEncoding of the text.
embeddedIf true font will be embedded.
fontSizeSize of the text.

◆ FormattedText() [12/13]

Aspose::Pdf::Facades::FormattedText::FormattedText ( System::String  text,
System::Drawing::Color  textColor,
System::Drawing::Color  backColor 
)

Initializes FormattedText.

Parameters
textText content.
textColorColor of the text.
backColorColor of background.

◆ FormattedText() [13/13]

Aspose::Pdf::Facades::FormattedText::FormattedText ( System::String  text,
System::Drawing::Color  textColor,
System::String  fontName,
EncodingType  textEncoding,
bool  embedded,
float  fontSize 
)

Initializes FormattedText.

Parameters
textText content.
textColorColor of the text.
fontNameFont of the text.
textEncodingEncoding of the text.
embeddedIf true font will be embedded.
fontSizeSize of the text.

Member Function Documentation

◆ AddNewLineText() [1/2]

void Aspose::Pdf::Facades::FormattedText::AddNewLineText ( System::String  newLineText)

Adds a new line to the FormattedText object and sets the newLineText to the next line's text.

Parameters
newLineTextText of new added line.

◆ AddNewLineText() [2/2]

void Aspose::Pdf::Facades::FormattedText::AddNewLineText ( System::String  newLineText,
float  lineSpacing 
)

Adds a new line to the FormattedText object and sets the newLineText to the next line's text.

Parameters
newLineTextText of new added line.
lineSpacingSpacing of the line.

◆ get_TextHeight()

float Aspose::Pdf::Facades::FormattedText::get_TextHeight ( )

Gets height of text.

◆ get_TextWidth()

float Aspose::Pdf::Facades::FormattedText::get_TextWidth ( )

Gets width of text.

◆ getBackColor()

System::Drawing::Color Aspose::Pdf::Facades::FormattedText::getBackColor ( )
protected

Gets back color

Returns

◆ getFirstLine()

System::String Aspose::Pdf::Facades::FormattedText::getFirstLine ( )
protected

Gets first line

Returns

◆ getFont()

System::SharedPtr<Aspose::Pdf::Text::Font> Aspose::Pdf::Facades::FormattedText::getFont ( )
protected

Gets font

Returns

◆ getFontSize()

float Aspose::Pdf::Facades::FormattedText::getFontSize ( )
protected

Gets font size

Returns

◆ getTextColor()

System::Drawing::Color Aspose::Pdf::Facades::FormattedText::getTextColor ( )
protected

Gets text color

Returns

◆ LineSpacing()

float Aspose::Pdf::Facades::FormattedText::LineSpacing ( int32_t  idx)
protected

Returns line height for the specific line of the multi-line text

Parameters
idx
Returns

Member Data Documentation

◆ mpCustomLineSpacing

System::SharedPtr<System::Collections::Generic::Dictionary<int32_t, float> > Aspose::Pdf::Facades::FormattedText::mpCustomLineSpacing
protected

◆ text

System::SharedPtr<System::Collections::Generic::List<System::String> > Aspose::Pdf::Facades::FormattedText::text
protected