PDFMultilineText is one of the PDF Builder objects, and is derived from PDFVisibleContent. A PDFMultilineText object is used for inserting a multi-line text block into the PDF document.
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.
PDFMultilineText provides the following properties. In addition, it inherits the properties from its parent, PDFVisibleContent.
|
PDFMultiLineText property |
Datatype |
Description |
|---|---|---|
|
PDFColor |
Sets the back color of the text in the object. |
|
|
ClassDefinition |
PowerObject |
An object of type PowerObject containing information about the class definition of the object or control. |
|
String |
Sets the content of the object. |
|
|
PDFFont |
Sets the font of the text in the object. |
|
|
PDFTextLayout |
Sets the layout of the object. |
|
|
PDFColor |
Sets the color of the text in the object. |
|
PDFMultiLineText event |
Occurs |
|---|---|
|
Immediately before the Open event occurs in the window. |
|
|
Immediately after the Close event occurs in the window. |
PDFMultilineText provides the following functions. In addition, it inherits the functions from its parent, PDFVisibleContent.
|
PDFMultiLineText function |
Datatype returned |
Description |
|---|---|---|
|
String |
Returns the name assigned to the control. |
|
|
PDFText |
Clones the current object. |
|
|
Integer |
Creates a reference to a context-specific instance of the specified service. |
|
|
String |
Gets the URL that the current object links to. |
|
|
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. |
|
|
Boolean |
Returns whether the current object has page overflow. |
|
|
Long |
Links the current object to the specified object. |
|
|
Boolean |
Adds an event to the end of the message queue for the control. |
|
|
Long |
Sets the URL that the current object links to. |
|
|
Integer |
Triggers a specified event in the control and executes the script for the event. |
|
|
Object |
Returns the type of the control. |
