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.
-
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.
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. |
|
PDFRichText event |
Occurs |
|---|---|
|
Immediately before the Open event occurs in the window. |
|
|
Immediately after the Close event occurs in the window. |
PDFRichText provides the following functions. In addition, it inherits the functions from its parent, PDFVisibleContent.
|
PDFRichText function |
Datatype returned |
Description |
|---|---|---|
|
PDFTextBlock |
Adds a text block. |
|
|
String |
Returns the name assigned to the control. |
|
|
PDFRichText |
Clones the current object. |
|
|
Integer |
Creates a reference to a context-specific instance of the specified service. |
|
|
PDFSharedText |
Gets the text that overflows beyond the current page. The returned PDFSharedText can only be used in the AddContent function of PDFPage. |
|
|
PowerObject |
Returns a reference to the name of the parent object. |
|
|
PDFTextBlock |
Gets the specified text block. |
|
|
Long |
Gets the number of text blocks in the object. |
|
|
PDFImage |
Gets an image that the current PDFRichText object wraps around. |
|
|
Long |
Gets the number of wrapped images in the object. |
|
|
Boolean |
Returns whether the current object has page overflow. |
|
|
Boolean |
Adds an event to the end of the message queue for the control. |
|
|
Long |
Removes a text block. |
|
|
Long |
Removes an image that the current PDFRichText object wraps around. |
|
|
Integer |
Triggers a specified event in the control and executes the script for the event. |
|
|
Object |
Returns the type of the control. |
|
|
PDFImage |
Sets the image that the PDFRichText object shall wrap around. |
