Aspose::Pdf::Text::TextBuilder Class Referencefinal

Appends text object to Pdf page. More...

Inherits System::Object.

Public Member Functions

 TextBuilder (System::SharedPtr< Aspose::Pdf::Page > page)
 Initializes a new instance of TextBuilder class for the Pdf page. More...
 
 TextBuilder (System::SharedPtr< Aspose::Pdf::Page > page, System::SharedPtr< BaseOperatorCollection > operatorCollection)
 Initializes a new instance of TextBuilder class for the Pdf page. More...
 
void AppendParagraph (System::SharedPtr< TextParagraph > textParagraph)
 Appends text paragraph to Pdf page. More...
 
void AppendText (System::SharedPtr< TextFragment > textFragment)
 Appends text fragment to Pdf page 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

System::SharedPtr< Aspose::Pdf::Engine::CommonData::Text::Segmenting::TextSegmenter > get_Segmenter () const
 
System::SharedPtr< Aspose::Pdf::Pageget_Page () const
 
 TextBuilder (System::SharedPtr< XForm > xForm)
 
void AppendText (System::SharedPtr< TextFragment > textFragment, bool savePreviousState)
 
void AppendText (System::SharedPtr< TextFragment > textFragment, int32_t rotation, bool savePreviousState)
 Appends text with rotation More...
 
void AppendParagraph (System::SharedPtr< TextParagraph > textParagraph, int32_t rotation)
 Appends paragraph with rotation More...
 

Protected Attributes

System::SharedPtr< Document_document
 

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

Appends text object to Pdf page.

Constructor & Destructor Documentation

◆ TextBuilder() [1/3]

Aspose::Pdf::Text::TextBuilder::TextBuilder ( System::SharedPtr< Aspose::Pdf::Page page)

Initializes a new instance of TextBuilder class for the Pdf page.

The TextBuilder allows to append text objects to Pdf pages.

Parameters
pagePage object.

◆ TextBuilder() [2/3]

Aspose::Pdf::Text::TextBuilder::TextBuilder ( System::SharedPtr< Aspose::Pdf::Page page,
System::SharedPtr< BaseOperatorCollection operatorCollection 
)

Initializes a new instance of TextBuilder class for the Pdf page.

The TextBuilder allows to append text objects to Pdf pages.

Parameters
pagePage object.
operatorCollectionOperator collection.

◆ TextBuilder() [3/3]

Aspose::Pdf::Text::TextBuilder::TextBuilder ( System::SharedPtr< XForm xForm)
protected

Member Function Documentation

◆ AppendParagraph() [1/2]

void Aspose::Pdf::Text::TextBuilder::AppendParagraph ( System::SharedPtr< TextParagraph textParagraph)

Appends text paragraph to Pdf page.

The example demonstrates how to create text paragraph object and append it to the Pdf page.

Document doc = new Document(inFile);
Page page = (Page)doc.Pages[1];
// create text paragraph
TextParagraph paragraph = new TextParagraph();
// set the paragraph rectangle
paragraph.Rectangle = new Rectangle(100, 600, 200, 700);
// set word wrapping options
paragraph.FormattingOptions.WrapMode = TextFormattingOptions.WordWrapMode.ByWords;
// append string lines
paragraph.AppendLine("the quick brown fox jumps over the lazy dog");
paragraph.AppendLine("line2");
paragraph.AppendLine("line3");
// append the paragraph to the Pdf page with the TextBuilder
TextBuilder textBuilder = new TextBuilder(page);
textBuilder.AppendParagraph(paragraph);
// save Pdf document
doc.Save(outFile);
Parameters
textParagraphText paragraph object.

◆ AppendParagraph() [2/2]

void Aspose::Pdf::Text::TextBuilder::AppendParagraph ( System::SharedPtr< TextParagraph textParagraph,
int32_t  rotation 
)
protected

Appends paragraph with rotation

Parameters
textParagraph
rotation

◆ AppendText() [1/3]

void Aspose::Pdf::Text::TextBuilder::AppendText ( System::SharedPtr< TextFragment textFragment)

Appends text fragment to Pdf page

The example demonstrates how to create text fragment object, customize it's text segments and append it to the Pdf page.

Document doc = new Document(inFile);
Page page = (Page)doc.Pages[1];
// create text fragment
TextFragment tf = new TextFragment("main text");
tf.Position = new Position(100, 600);
// set it's text properties
tf.TextState.FontSize = 5;
tf.TextState.Font = FontRepository.FindFont("TimesNewRoman");
tf.TextState.BackgroundColor = Color.LightGray;
tf.TextState.ForegroundColor = Color.Red;
// add one more segment to text fragment's Segments collection
TextSegment segment2 = new TextSegment();
segment2.Text = "another segment";
tf.Segments.Add(segment2);
// create TextBuilder object
TextBuilder builder = new TextBuilder(page);
// append the text fragment to the Pdf page
builder.AppendText(tf);
//save document
doc.Save(outFile);
Parameters
textFragmentText fragment object.

◆ AppendText() [2/3]

void Aspose::Pdf::Text::TextBuilder::AppendText ( System::SharedPtr< TextFragment textFragment,
bool  savePreviousState 
)
protected

◆ AppendText() [3/3]

void Aspose::Pdf::Text::TextBuilder::AppendText ( System::SharedPtr< TextFragment textFragment,
int32_t  rotation,
bool  savePreviousState 
)
protected

Appends text with rotation

◆ get_Page()

System::SharedPtr<Aspose::Pdf::Page> Aspose::Pdf::Text::TextBuilder::get_Page ( ) const
protected

◆ get_Segmenter()

System::SharedPtr<Aspose::Pdf::Engine::CommonData::Text::Segmenting::TextSegmenter> Aspose::Pdf::Text::TextBuilder::get_Segmenter ( ) const
protected

Member Data Documentation

◆ _document

System::SharedPtr<Document> Aspose::Pdf::Text::TextBuilder::_document
protected