Represents text paragraphs as multiline text object. More...

#include "TextParagraph.h"

Public Member Functions
ASPOSE_PDF_SHARED_API Aspose::Pdf::VerticalAlignment	get_VerticalAlignment () const
	Gets vertical alignment for the text inside paragrph's Rectangle. More...

ASPOSE_PDF_SHARED_API void	set_VerticalAlignment (Aspose::Pdf::VerticalAlignment value)
	Sets vertical alignment for the text inside paragrph's Rectangle. More...

ASPOSE_PDF_SHARED_API float	get_SubsequentLinesIndent () const
	Gets subsequent lines indent value. If set to a non-zero value, it has an advantage over the FormattingOptions.SubsequentLinesIndent value. More...

ASPOSE_PDF_SHARED_API void	set_SubsequentLinesIndent (float value)
	Sets subsequent lines indent value. If set to a non-zero value, it has an advantage over the FormattingOptions.SubsequentLinesIndent value. More...

ASPOSE_PDF_SHARED_API float	get_FirstLineIndent () const
	Gets subsequent lines indent value. If set to a non-zero value, it has an advantage over the FormattingOptions.SubsequentLinesIndent value. More...

ASPOSE_PDF_SHARED_API void	set_FirstLineIndent (float value)
	Sets subsequent lines indent value. If set to a non-zero value, it has an advantage over the FormattingOptions.SubsequentLinesIndent value. More...

ASPOSE_PDF_SHARED_API bool	get_Justify ()
	Gets value whether text is justified. More...

ASPOSE_PDF_SHARED_API void	set_Justify (bool value)
	Sets value whether text is justified. More...

ASPOSE_PDF_SHARED_API Aspose::Pdf::HorizontalAlignment	get_HorizontalAlignment () const
	Gets horizontal alignment for the text inside paragrph's Rectangle. More...

ASPOSE_PDF_SHARED_API void	set_HorizontalAlignment (Aspose::Pdf::HorizontalAlignment value)
	Sets horizontal alignment for the text inside paragrph's Rectangle. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< TextFormattingOptions >	get_FormattingOptions () const
	Gets formatting options. More...

ASPOSE_PDF_SHARED_API void	set_FormattingOptions (System::SharedPtr< TextFormattingOptions > value)
	Sets formatting options. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Text::Position >	get_Position () const
	Gets position of the paragraph. More...

ASPOSE_PDF_SHARED_API void	set_Position (System::SharedPtr< Aspose::Pdf::Text::Position > value)
	Sets position of the paragraph. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Rectangle >	get_TextRectangle ()
	Gets rectangle of the text placed to the paragraph. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Rectangle >	get_Rectangle () const
	Gets rectangle of the paragraph. More...

ASPOSE_PDF_SHARED_API void	set_Rectangle (System::SharedPtr< Aspose::Pdf::Rectangle > value)
	Sets rectangle of the paragraph. More...

ASPOSE_PDF_SHARED_API System::SharedPtr< MarginInfo >	get_Margin () const
	Gets the padding. More...

ASPOSE_PDF_SHARED_API void	set_Margin (System::SharedPtr< MarginInfo > value)
	Sets the padding. More...

ASPOSE_PDF_SHARED_API double	get_Rotation () const
	Gets rotation angle in degrees. More...

ASPOSE_PDF_SHARED_API void	set_Rotation (double value)
	Sets rotation angle in degrees. More...

ASPOSE_PDF_SHARED_API	TextParagraph ()
	Creates TextParagraph object. More...

ASPOSE_PDF_SHARED_API void	BeginEdit ()
	Begins the editing of the TextParagraph. More...

ASPOSE_PDF_SHARED_API void	EndEdit ()
	Ends the editing of the TextParagraph. More...

ASPOSE_PDF_SHARED_API void	AppendLine (System::String line)
	Appends text line More...

ASPOSE_PDF_SHARED_API void	AppendLine (System::String line, float lineSpacing)
	Appends text line. More...

ASPOSE_PDF_SHARED_API void	AppendLine (System::String line, System::SharedPtr< TextState > textState)
	Appends text line with text state parameters. More...

ASPOSE_PDF_SHARED_API void	AppendLine (System::String line, System::SharedPtr< TextState > textState, float lineSpacing)
	Appends text line with text state parameters More...

ASPOSE_PDF_SHARED_API void	AppendLine (System::SharedPtr< TextFragment > line)
	Appends text line with text state parameters. More...

ASPOSE_PDF_SHARED_API void	AppendLine (System::SharedPtr< TextFragment > line, System::SharedPtr< TextState > textState)
	Appends text line with text state parameters. More...

ASPOSE_PDF_SHARED_API void	AppendLine (System::SharedPtr< TextFragment > line, System::SharedPtr< TextState > textState, float lineSpacing)
	Appends text line with text state parameters 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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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 Types
enum	TextBackgroundMode { TextBackgroundMode::WholeParagraph, TextBackgroundMode::LogicalLine }
	Background mode for TextParagraph More...

Protected Member Functions
const System::SharedPtr< System::Collections::Generic::Dictionary< int32_t, float > > &	get_LineSpacings () const

System::String	get_McName () const

int32_t	get_McId () const

System::SharedPtr< Color >	get_BackgroundColor () const
	Gets background color for the text paragraph. More...

void	set_BackgroundColor (System::SharedPtr< Color > value)
	Sets background color for the text paragraph. More...

bool	get_LimitWithBounds () const
	Gets value whether text is placed behind the bounds (false), or not placed and collection RemainingLines is populated. More...

void	set_LimitWithBounds (bool value)
	Sets value whether text is placed behind the bounds (false), or not placed and collection RemainingLines is populated. More...

bool	get_PreserveOriginalLinespacing () const
	Preserves original line spacing in Lines bloak when reformatting the paragraph. Actual in Search paragraph scenarios where line spacing is unique. More...

void	set_PreserveOriginalLinespacing (bool value)
	Preserves original line spacing in Lines bloak when reformatting the paragraph. Actual in Search paragraph scenarios where line spacing is unique. More...

System::String	get_HyphenSymbol () const
	Gets hyphen symbol that is used in hyphenation process. More...

void	set_HyphenSymbol (System::String value)
	Sets hyphen symbol that is used in hyphenation process. More...

System::SharedPtr< TextFragmentCollection >	get_Lines ()
	Gets lines. More...

System::SharedPtr< TextFragmentCollection >	get_RemainingLines ()
	Gets remaining lines. More...

System::SharedPtr< Aspose::Pdf::Rectangle >	get_TextBox ()
	Gets rectangle of the text with margins. More...

System::SharedPtr< TextSegment >	get_LastSegment ()

double	get_LastFragmentHeight ()

System::SharedPtr< Aspose::Pdf::Matrix >	get_Matrix () const
	Gets Rotation of the paragraph. More...

void	set_Matrix (System::SharedPtr< Aspose::Pdf::Matrix > value)
	Sets Rotation of the paragraph. More...

bool	get_OldCodeCompatibilityMode () const

void	set_OldCodeCompatibilityMode (bool value)

TextParagraph::TextBackgroundMode	get_BackgroundMode () const
	background mode for the text paragraph More...

void	set_BackgroundMode (TextParagraph::TextBackgroundMode value)
	background mode for the text paragraph More...

System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::SegmentsGroupState >	get_GroupState () const

void	set_GroupState (System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::SegmentsGroupState > value)

System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::SegmentsGroupState > > >	get_LineGroupStates () const

void	set_LineGroupStates (System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::SegmentsGroupState >>> value)

System::SharedPtr< System::Collections::Generic::Dictionary< int32_t, System::String > >	get_LineEndReasons () const

void	Attach (System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::TextSegmenter > segmenter)
	Attaches the TextParagraph to the segmenter. More...

void	RemoveLineByIndex (int32_t index)
	Removes previously appended text line by index in collection. More...

void	InsertAtBeginning (System::SharedPtr< TextFragment > line, System::SharedPtr< TextSegment > segmentInserted)
	Inserts the TextSegment at the beginnining of line More...

void	AddToEnd (System::SharedPtr< TextFragment > line, System::SharedPtr< TextSegment > segmentAdded)
	Adds the TextSegment to the end of line More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. 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 TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

Detailed Description

Represents text paragraphs as multiline text object.

Member Enumeration Documentation

◆ TextBackgroundMode

enum Aspose::Pdf::Text::TextParagraph::TextBackgroundMode

strongprotected

Background mode for TextParagraph

Enumerator
WholeParagraph	Background is set for the whole paragraph as single solid rectangle.
LogicalLine	Each line will have it's own rectangle.

Constructor & Destructor Documentation

◆ TextParagraph()

ASPOSE_PDF_SHARED_API Aspose::Pdf::Text::TextParagraph::TextParagraph ( )

Creates TextParagraph object.

Member Function Documentation

◆ AddToEnd()

void Aspose::Pdf::Text::TextParagraph::AddToEnd	(	System::SharedPtr< TextFragment >	line,
		System::SharedPtr< TextSegment >	segmentAdded
	)

protected

Adds the TextSegment to the end of line

<note> This is for low level paragraph post-processing. When in doubt, use a public function instead of this one. </note>

Parameters

line	TextFragment representing line
segmentAdded	TextSegment to add

◆ AppendLine() [1/7]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::AppendLine ( System::String line )

Appends text line

Parameters

line	The new line's text.

◆ AppendLine() [2/7]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::AppendLine	(	System::String	line,
		float	lineSpacing
	)

Appends text line.

Parameters

line	The new line's text.
lineSpacing	Additional spacing (0.0 is default and corresponds to default text line height). The spacing value is added to default line spacing for the particular line, so you may specify 12.0 to get empty row AFTER a text line drawn with 12pt font.

◆ AppendLine() [3/7]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::AppendLine	(	System::String	line,
		System::SharedPtr< TextState >	textState
	)

Appends text line with text state parameters.

Parameters

line	The new line's text.
textState	Text state of the new line.

◆ AppendLine() [4/7]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::AppendLine	(	System::String	line,
		System::SharedPtr< TextState >	textState,
		float	lineSpacing
	)

Appends text line with text state parameters

Parameters

line	The new line's text.
textState	Text state of the new line.
lineSpacing	Additional spacing (0.0 is default and corresponds to default text line height). The spacing value is added to default line spacing for the particular line, so you may specify 12.0 to get empty row AFTER a text line drawn with 12pt font.

◆ AppendLine() [5/7]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::AppendLine ( System::SharedPtr< TextFragment > line )

Appends text line with text state parameters.

Parameters

line	The new line's text.

◆ AppendLine() [6/7]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::AppendLine	(	System::SharedPtr< TextFragment >	line,
		System::SharedPtr< TextState >	textState
	)

Appends text line with text state parameters.

Parameters

line	The new line's text.
textState	Text state of the new line.

◆ AppendLine() [7/7]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::AppendLine	(	System::SharedPtr< TextFragment >	line,
		System::SharedPtr< TextState >	textState,
		float	lineSpacing
	)

Appends text line with text state parameters

Parameters

line	The new line's text.
textState	Text state of the new line.
lineSpacing	Additional spacing (0.0 is default and corresponds to default text line height). The spacing value is added to default line spacing for the particular line, so you may specify 12.0 to get empty row AFTER a text line drawn with 12pt font.

◆ Attach()

void Aspose::Pdf::Text::TextParagraph::Attach ( System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::TextSegmenter > segmenter )

protected

Attaches the TextParagraph to the segmenter.

Parameters

segmenter

◆ BeginEdit()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::BeginEdit ( )

Begins the editing of the TextParagraph.

Improves performance of TextParagraph population. Any layout calculation is suspended until EndEdit method is invoked.

Note that method invoke can't be nested.

◆ EndEdit()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::EndEdit ( )

Ends the editing of the TextParagraph.

Improves performance of TextParagraph population. Any layout calculation is suspended until EndEdit method is invoked.

Note that method invoke can't be nested.

◆ get_BackgroundColor()

System::SharedPtr<Color> Aspose::Pdf::Text::TextParagraph::get_BackgroundColor ( ) const

protected

Gets background color for the text paragraph.

◆ get_BackgroundMode()

TextParagraph::TextBackgroundMode Aspose::Pdf::Text::TextParagraph::get_BackgroundMode ( ) const

protected

background mode for the text paragraph

◆ get_FirstLineIndent()

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

Gets subsequent lines indent value. If set to a non-zero value, it has an advantage over the FormattingOptions.SubsequentLinesIndent value.

◆ get_FormattingOptions()

ASPOSE_PDF_SHARED_API System::SharedPtr<TextFormattingOptions> Aspose::Pdf::Text::TextParagraph::get_FormattingOptions ( ) const

Gets formatting options.

◆ get_GroupState()

System::SharedPtr<Aspose::Pdf::Engine::CommonData::Text::Segmenting::SegmentsGroupState> Aspose::Pdf::Text::TextParagraph::get_GroupState ( ) const

protected

◆ get_HorizontalAlignment()

ASPOSE_PDF_SHARED_API Aspose::Pdf::HorizontalAlignment Aspose::Pdf::Text::TextParagraph::get_HorizontalAlignment ( ) const

Gets horizontal alignment for the text inside paragrph's Rectangle.

HorizontalAlignment.None is equal to HorizontalAlignment.Left.

◆ get_HyphenSymbol()

System::String Aspose::Pdf::Text::TextParagraph::get_HyphenSymbol ( ) const

protected

Gets hyphen symbol that is used in hyphenation process.

The hyphenation symbol is "-" by default. To eliminate hyphen drawing (with wrapping procedure still in place) please set empty string string.Empty for HyphenSymbol.

◆ get_Justify()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Text::TextParagraph::get_Justify ( )

Gets value whether text is justified.

◆ get_LastFragmentHeight()

double Aspose::Pdf::Text::TextParagraph::get_LastFragmentHeight ( )

protected

◆ get_LastSegment()

System::SharedPtr<TextSegment> Aspose::Pdf::Text::TextParagraph::get_LastSegment ( )

protected

◆ get_LimitWithBounds()

bool Aspose::Pdf::Text::TextParagraph::get_LimitWithBounds ( ) const

protected

Gets value whether text is placed behind the bounds (false), or not placed and collection RemainingLines is populated.

◆ get_LineEndReasons()

System::SharedPtr<System::Collections::Generic::Dictionary<int32_t, System::String> > Aspose::Pdf::Text::TextParagraph::get_LineEndReasons ( ) const

protected

◆ get_LineGroupStates()

System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Aspose::Pdf::Engine::CommonData::Text::Segmenting::SegmentsGroupState> > > Aspose::Pdf::Text::TextParagraph::get_LineGroupStates ( ) const

protected

◆ get_Lines()

System::SharedPtr<TextFragmentCollection> Aspose::Pdf::Text::TextParagraph::get_Lines ( )

protected

Gets lines.

◆ get_LineSpacings()

const System::SharedPtr<System::Collections::Generic::Dictionary<int32_t, float> >& Aspose::Pdf::Text::TextParagraph::get_LineSpacings ( ) const

protected

◆ get_Margin()

ASPOSE_PDF_SHARED_API System::SharedPtr<MarginInfo> Aspose::Pdf::Text::TextParagraph::get_Margin ( ) const

Gets the padding.

◆ get_Matrix()

System::SharedPtr<Aspose::Pdf::Matrix> Aspose::Pdf::Text::TextParagraph::get_Matrix ( ) const

protected

Gets Rotation of the paragraph.

◆ get_McId()

int32_t Aspose::Pdf::Text::TextParagraph::get_McId ( ) const

protected

◆ get_McName()

System::String Aspose::Pdf::Text::TextParagraph::get_McName ( ) const

protected

◆ get_OldCodeCompatibilityMode()

bool Aspose::Pdf::Text::TextParagraph::get_OldCodeCompatibilityMode ( ) const

protected

◆ get_Position()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Text::Position> Aspose::Pdf::Text::TextParagraph::get_Position ( ) const

Gets position of the paragraph.

◆ get_PreserveOriginalLinespacing()

bool Aspose::Pdf::Text::TextParagraph::get_PreserveOriginalLinespacing ( ) const

protected

Preserves original line spacing in Lines bloak when reformatting the paragraph. Actual in Search paragraph scenarios where line spacing is unique.

◆ get_Rectangle()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Text::TextParagraph::get_Rectangle ( ) const

Gets rectangle of the paragraph.

◆ get_RemainingLines()

System::SharedPtr<TextFragmentCollection> Aspose::Pdf::Text::TextParagraph::get_RemainingLines ( )

protected

Gets remaining lines.

◆ get_Rotation()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Text::TextParagraph::get_Rotation ( ) const

Gets rotation angle in degrees.

◆ get_SubsequentLinesIndent()

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

Gets subsequent lines indent value. If set to a non-zero value, it has an advantage over the FormattingOptions.SubsequentLinesIndent value.

◆ get_TextBox()

System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Text::TextParagraph::get_TextBox ( )

protected

Gets rectangle of the text with margins.

◆ get_TextRectangle()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Text::TextParagraph::get_TextRectangle ( )

Gets rectangle of the text placed to the paragraph.

◆ get_VerticalAlignment()

ASPOSE_PDF_SHARED_API Aspose::Pdf::VerticalAlignment Aspose::Pdf::Text::TextParagraph::get_VerticalAlignment ( ) const

Gets vertical alignment for the text inside paragrph's Rectangle.

VerticalAlignment.None is equal to VerticalAlignment.Bottom.

◆ InsertAtBeginning()

void Aspose::Pdf::Text::TextParagraph::InsertAtBeginning	(	System::SharedPtr< TextFragment >	line,
		System::SharedPtr< TextSegment >	segmentInserted
	)

protected

Inserts the TextSegment at the beginnining of line

<note> This is for low level paragraph post-processing. When in doubt, use a public function instead of this one. </note>

Parameters

line	TextFragment representing line
segmentInserted	TextSegment to insert

◆ RemoveLineByIndex()

void Aspose::Pdf::Text::TextParagraph::RemoveLineByIndex ( int32_t index )

protected

Removes previously appended text line by index in collection.

Parameters

index Index within the collection.

◆ set_BackgroundColor()

void Aspose::Pdf::Text::TextParagraph::set_BackgroundColor ( System::SharedPtr< Color > value )

protected

Sets background color for the text paragraph.

◆ set_BackgroundMode()

void Aspose::Pdf::Text::TextParagraph::set_BackgroundMode ( TextParagraph::TextBackgroundMode value )

protected

background mode for the text paragraph

◆ set_FirstLineIndent()

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

Sets subsequent lines indent value. If set to a non-zero value, it has an advantage over the FormattingOptions.SubsequentLinesIndent value.

◆ set_FormattingOptions()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::set_FormattingOptions ( System::SharedPtr< TextFormattingOptions > value )

Sets formatting options.

◆ set_GroupState()

void Aspose::Pdf::Text::TextParagraph::set_GroupState ( System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::SegmentsGroupState > value )

protected

◆ set_HorizontalAlignment()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::set_HorizontalAlignment ( Aspose::Pdf::HorizontalAlignment value )

Sets horizontal alignment for the text inside paragrph's Rectangle.

HorizontalAlignment.None is equal to HorizontalAlignment.Left.

◆ set_HyphenSymbol()

void Aspose::Pdf::Text::TextParagraph::set_HyphenSymbol ( System::String value )

protected

Sets hyphen symbol that is used in hyphenation process.

The hyphenation symbol is "-" by default. To eliminate hyphen drawing (with wrapping procedure still in place) please set empty string string.Empty for HyphenSymbol.

◆ set_Justify()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::set_Justify ( bool value )

Sets value whether text is justified.

◆ set_LimitWithBounds()

void Aspose::Pdf::Text::TextParagraph::set_LimitWithBounds ( bool value )

protected

Sets value whether text is placed behind the bounds (false), or not placed and collection RemainingLines is populated.

◆ set_LineGroupStates()

void Aspose::Pdf::Text::TextParagraph::set_LineGroupStates ( System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::SegmentsGroupState >>> value )

protected

◆ set_Margin()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::set_Margin ( System::SharedPtr< MarginInfo > value )

Sets the padding.

◆ set_Matrix()

void Aspose::Pdf::Text::TextParagraph::set_Matrix ( System::SharedPtr< Aspose::Pdf::Matrix > value )

protected

Sets Rotation of the paragraph.

◆ set_OldCodeCompatibilityMode()

void Aspose::Pdf::Text::TextParagraph::set_OldCodeCompatibilityMode ( bool value )

protected

◆ set_Position()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::set_Position ( System::SharedPtr< Aspose::Pdf::Text::Position > value )

Sets position of the paragraph.

◆ set_PreserveOriginalLinespacing()

void Aspose::Pdf::Text::TextParagraph::set_PreserveOriginalLinespacing ( bool value )

protected

Preserves original line spacing in Lines bloak when reformatting the paragraph. Actual in Search paragraph scenarios where line spacing is unique.

◆ set_Rectangle()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::set_Rectangle ( System::SharedPtr< Aspose::Pdf::Rectangle > value )

Sets rectangle of the paragraph.

◆ set_Rotation()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::set_Rotation ( double value )

Sets rotation angle in degrees.

◆ set_SubsequentLinesIndent()

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

Sets subsequent lines indent value. If set to a non-zero value, it has an advantage over the FormattingOptions.SubsequentLinesIndent value.

◆ set_VerticalAlignment()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Text::TextParagraph::set_VerticalAlignment ( Aspose::Pdf::VerticalAlignment value )

Sets vertical alignment for the text inside paragrph's Rectangle.

VerticalAlignment.None is equal to VerticalAlignment.Bottom.

Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TextBackgroundMode

Constructor & Destructor Documentation

◆ TextParagraph()

Member Function Documentation

◆ AddToEnd()

◆ AppendLine() [1/7]

◆ AppendLine() [2/7]

◆ AppendLine() [3/7]

◆ AppendLine() [4/7]

◆ AppendLine() [5/7]

◆ AppendLine() [6/7]

◆ AppendLine() [7/7]

◆ Attach()

◆ BeginEdit()

◆ EndEdit()

◆ get_BackgroundColor()

◆ get_BackgroundMode()

◆ get_FirstLineIndent()

◆ get_FormattingOptions()

◆ get_GroupState()

◆ get_HorizontalAlignment()

◆ get_HyphenSymbol()

◆ get_Justify()

◆ get_LastFragmentHeight()

◆ get_LastSegment()

◆ get_LimitWithBounds()

◆ get_LineEndReasons()

◆ get_LineGroupStates()

◆ get_Lines()

◆ get_LineSpacings()

◆ get_Margin()

◆ get_Matrix()

◆ get_McId()

◆ get_McName()

◆ get_OldCodeCompatibilityMode()

◆ get_Position()

◆ get_PreserveOriginalLinespacing()

◆ get_Rectangle()

◆ get_RemainingLines()

◆ get_Rotation()

◆ get_SubsequentLinesIndent()

◆ get_TextBox()

◆ get_TextRectangle()

◆ get_VerticalAlignment()

◆ InsertAtBeginning()

◆ RemoveLineByIndex()

◆ set_BackgroundColor()

◆ set_BackgroundMode()

◆ set_FirstLineIndent()

◆ set_FormattingOptions()

◆ set_GroupState()

◆ set_HorizontalAlignment()

◆ set_HyphenSymbol()

◆ set_Justify()

◆ set_LimitWithBounds()

◆ set_LineGroupStates()

◆ set_Margin()

◆ set_Matrix()

◆ set_OldCodeCompatibilityMode()

◆ set_Position()

◆ set_PreserveOriginalLinespacing()

◆ set_Rectangle()

◆ set_Rotation()

◆ set_SubsequentLinesIndent()

◆ set_VerticalAlignment()