PDFRichText object

PDFRichText is one of the PDF Builder objects, and is derived from
PDFVisibleContent. PDFRichText refers to a text block with rich text
formatting.

To view the full hierarchy of the PDF Builder objects, find
“pdfobject” in the Browser, right-click the object, and then select “Show
Hierarchy” in the pop-up menu.

Notes when working with PDFRichText

The default Width property for the object is 300 points
(pt).
Unless being specified, before the object is added into a
PDFPage, the height of the object is calculated based on its content
and width; after the object is added into a PDFPage, the height is
the maximum height available on the first page.
If the object is not added into a PDFPage or is removed from
the PDFPage, executing GetOverflowPageText on the object always
returns null; and executing the IsOverflowPage always returns
False.

Properties

PDFRichText provides the following property. In addition, it
inherits the properties from its parent, PDFVisibleContent.

PDFRichText property	Datatype	Description
ClassDefinition	PowerObject	An object of type PowerObject containing information about the class definition of the object or control.

Events

PDFRichText event	Occurs
Constructor	Immediately before the Open event occurs in the window.
Destructor	Immediately after the Close event occurs in the window.

Functions

PDFRichText provides the following functions. In addition, it
inherits the functions from its parent, PDFVisibleContent.

PDFRichText function	Datatype returned	Description
AddTextBlock	PDFTextBlock	Adds a text block.
ClassName	String	Returns the name assigned to the control.
Clone	PDFRichText	Clones the current object.
GetContextService	Integer	Creates a reference to a context-specific instance of the specified service.
GetOverflowPageText	PDFSharedText	Gets the text that overflows beyond the current page. The returned PDFSharedText can only be used in the AddContent function of PDFPage.
GetParent	PowerObject	Returns a reference to the name of the parent object.
GetTextBlock	PDFTextBlock	Gets the specified text block.
GetTextBlockCount	Long	Gets the number of text blocks in the object.
GetWrapImage	PDFImage	Gets an image that the current PDFRichText object wraps around.
GetWrapImageCount	Long	Gets the number of wrapped images in the object.
IsOverflowPage	Boolean	Returns whether the current object has page overflow.
PostEvent	Boolean	Adds an event to the end of the message queue for the control.
RemoveTextBlock	Long	Removes a text block.
RemoveWrapImage	Long	Removes an image that the current PDFRichText object wraps around.
TriggerEvent	Integer	Triggers a specified event in the control and executes the script for the event.
TypeOf	Object	Returns the type of the control.
WrapImage	PDFImage	Sets the image that the PDFRichText object shall wrap around.

Document get from Powerbuilder help

Thank you for watching.

Powerbuilder Documentation 2022

August 21, 2023

Was this article helpful?

Connection Information

PDFRichText object – PB Docs 2022