Background mode for TextParagraph More...
Inherits System::Object.
Public Member Functions | |
Aspose::Pdf::VerticalAlignment | get_VerticalAlignment () const |
Gets vertical alignment for the text inside paragrph's Rectangle. More... | |
void | set_VerticalAlignment (Aspose::Pdf::VerticalAlignment value) |
Sets vertical alignment for the text inside paragrph's Rectangle. More... | |
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... | |
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... | |
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... | |
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... | |
bool | get_Justify () |
Gets value whether text is justified. More... | |
void | set_Justify (bool value) |
Sets value whether text is justified. More... | |
Aspose::Pdf::HorizontalAlignment | get_HorizontalAlignment () const |
Gets horizontal alignment for the text inside paragrph's Rectangle. More... | |
void | set_HorizontalAlignment (Aspose::Pdf::HorizontalAlignment value) |
Sets horizontal alignment for the text inside paragrph's Rectangle. More... | |
System::SharedPtr< TextFormattingOptions > | get_FormattingOptions () const |
Gets formatting options. More... | |
void | set_FormattingOptions (System::SharedPtr< TextFormattingOptions > value) |
Sets formatting options. More... | |
System::SharedPtr< Aspose::Pdf::Text::Position > | get_Position () const |
Gets position of the paragraph. More... | |
void | set_Position (System::SharedPtr< Aspose::Pdf::Text::Position > value) |
Sets position of the paragraph. More... | |
System::SharedPtr< Aspose::Pdf::Rectangle > | get_TextRectangle () |
Gets rectangle of the text placed to the paragraph. More... | |
System::SharedPtr< Aspose::Pdf::Rectangle > | get_Rectangle () const |
Gets rectangle of the paragraph. More... | |
void | set_Rectangle (System::SharedPtr< Aspose::Pdf::Rectangle > value) |
Sets rectangle of the paragraph. More... | |
System::SharedPtr< MarginInfo > | get_Margin () const |
Gets the padding. More... | |
void | set_Margin (System::SharedPtr< MarginInfo > value) |
Sets the padding. More... | |
double | get_Rotation () const |
Gets rotation angle in degrees. More... | |
void | set_Rotation (double value) |
Sets rotation angle in degrees. More... | |
TextParagraph () | |
Creates TextParagraph object. More... | |
void | BeginEdit () |
Begins the editing of the TextParagraph. More... | |
void | EndEdit () |
Ends the editing of the TextParagraph. More... | |
void | AppendLine (System::String line) |
Appends text line More... | |
void | AppendLine (System::String line, float lineSpacing) |
Appends text line. More... | |
void | AppendLine (System::String line, System::SharedPtr< TextState > textState) |
Appends text line with text state parameters. More... | |
void | AppendLine (System::String line, System::SharedPtr< TextState > textState, float lineSpacing) |
Appends text line with text state parameters More... | |
void | AppendLine (System::SharedPtr< TextFragment > line) |
Appends text line with text state parameters. More... | |
void | AppendLine (System::SharedPtr< TextFragment > line, System::SharedPtr< TextState > textState) |
Appends text line with text state parameters. More... | |
void | AppendLine (System::SharedPtr< TextFragment > line, System::SharedPtr< TextState > textState, float lineSpacing) |
Appends text line with text state parameters More... | |
![]() | |
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 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 () 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 (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 Types | |
enum | TextBackgroundMode { TextBackgroundMode::WholeParagraph, TextBackgroundMode::LogicalLine } |
Background mode for TextParagraph More... | |
Protected Member Functions | |
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... | |
Protected Attributes | |
int32_t | updatePositioningCalls |
Additional Inherited Members | |
![]() | |
typedef SmartPtr< Object > | ptr |
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 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 () |
Impleemnts C# typeof(System.Object) construct. More... | |
Background mode for TextParagraph
|
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. |
Aspose::Pdf::Text::TextParagraph::TextParagraph | ( | ) |
Creates TextParagraph object.
void Aspose::Pdf::Text::TextParagraph::AppendLine | ( | System::String | line | ) |
Appends text line
line | The new line's text. |
void Aspose::Pdf::Text::TextParagraph::AppendLine | ( | System::String | line, |
float | lineSpacing | ||
) |
Appends text line.
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. |
void Aspose::Pdf::Text::TextParagraph::AppendLine | ( | System::String | line, |
System::SharedPtr< TextState > | textState | ||
) |
Appends text line with text state parameters.
line | The new line's text. |
textState | Text state of the new line. |
void Aspose::Pdf::Text::TextParagraph::AppendLine | ( | System::String | line, |
System::SharedPtr< TextState > | textState, | ||
float | lineSpacing | ||
) |
Appends text line with text state 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. |
void Aspose::Pdf::Text::TextParagraph::AppendLine | ( | System::SharedPtr< TextFragment > | line | ) |
Appends text line with text state parameters.
line | The new line's text. |
void Aspose::Pdf::Text::TextParagraph::AppendLine | ( | System::SharedPtr< TextFragment > | line, |
System::SharedPtr< TextState > | textState | ||
) |
Appends text line with text state parameters.
line | The new line's text. |
textState | Text state of the new line. |
void Aspose::Pdf::Text::TextParagraph::AppendLine | ( | System::SharedPtr< TextFragment > | line, |
System::SharedPtr< TextState > | textState, | ||
float | lineSpacing | ||
) |
Appends text line with text state 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. |
|
protected |
Attaches the TextParagraph to the segmenter.
segmenter |
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.
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.
|
protected |
Gets background color for the text paragraph.
|
protected |
background mode for the text paragraph
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.
System::SharedPtr<TextFormattingOptions> Aspose::Pdf::Text::TextParagraph::get_FormattingOptions | ( | ) | const |
Gets formatting options.
|
protected |
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.
|
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.
bool Aspose::Pdf::Text::TextParagraph::get_Justify | ( | ) |
Gets value whether text is justified.
|
protected |
|
protected |
|
protected |
Gets value whether text is placed behind the bounds (false), or not placed and collection RemainingLines is populated.
|
protected |
|
protected |
|
protected |
Gets lines.
|
protected |
System::SharedPtr<MarginInfo> Aspose::Pdf::Text::TextParagraph::get_Margin | ( | ) | const |
Gets the padding.
|
protected |
Gets Rotation of the paragraph.
|
protected |
|
protected |
|
protected |
System::SharedPtr<Aspose::Pdf::Text::Position> Aspose::Pdf::Text::TextParagraph::get_Position | ( | ) | const |
Gets position of the paragraph.
|
protected |
Preserves original line spacing in Lines bloak when reformatting the paragraph. Actual in Search paragraph scenarios where line spacing is unique.
System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Text::TextParagraph::get_Rectangle | ( | ) | const |
Gets rectangle of the paragraph.
|
protected |
Gets remaining lines.
double Aspose::Pdf::Text::TextParagraph::get_Rotation | ( | ) | const |
Gets rotation angle in degrees.
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.
|
protected |
Gets rectangle of the text with margins.
System::SharedPtr<Aspose::Pdf::Rectangle> Aspose::Pdf::Text::TextParagraph::get_TextRectangle | ( | ) |
Gets rectangle of the text placed to the paragraph.
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.
|
protected |
Removes previously appended text line by index in collection.
index | Index within the collection. |
|
protected |
Sets background color for the text paragraph.
|
protected |
background mode for the text paragraph
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.
void Aspose::Pdf::Text::TextParagraph::set_FormattingOptions | ( | System::SharedPtr< TextFormattingOptions > | value | ) |
Sets formatting options.
|
protected |
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.
|
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.
void Aspose::Pdf::Text::TextParagraph::set_Justify | ( | bool | value | ) |
Sets value whether text is justified.
|
protected |
Sets value whether text is placed behind the bounds (false), or not placed and collection RemainingLines is populated.
|
protected |
void Aspose::Pdf::Text::TextParagraph::set_Margin | ( | System::SharedPtr< MarginInfo > | value | ) |
Sets the padding.
|
protected |
Sets Rotation of the paragraph.
|
protected |
void Aspose::Pdf::Text::TextParagraph::set_Position | ( | System::SharedPtr< Aspose::Pdf::Text::Position > | value | ) |
Sets position of the paragraph.
|
protected |
Preserves original line spacing in Lines bloak when reformatting the paragraph. Actual in Search paragraph scenarios where line spacing is unique.
void Aspose::Pdf::Text::TextParagraph::set_Rectangle | ( | System::SharedPtr< Aspose::Pdf::Rectangle > | value | ) |
Sets rectangle of the paragraph.
void Aspose::Pdf::Text::TextParagraph::set_Rotation | ( | double | value | ) |
Sets rotation angle in degrees.
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.
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.
|
protected |