PDFSharedText object

PDFSharedText is one of the PDF Builder objects, and is derived from PDFVisibleContent. PDFSharedText is only for use with PDFMultilineText and PDFRichText objects, for adding the overflow text into a new page.

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 PDFSharedText

  • PDFSharedText is the object returned from the PDFMultilineText/PDFRichText GetOverflowPageText function, and can only be passed to the PDFPage AddContent function. The object does not support any other operations.

  • If the PDFMultilineText/PDFRichText object is not added into a PDFPage or is removed from the PDFPage, executing GetOverflowPageText on the object always returns null.

Properties

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

PDFObject property

Datatype

Description

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.


Events

PDFObject event

Occurs

Constructor

Immediately before the Open event occurs in the window.

Destructor

Immediately after the Close event occurs in the window.


Functions

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

PDFObject function

Datatype returned

Description

ClassName

String

Returns the name assigned to the control.

GetContextService

Integer

Creates a reference to a context-specific instance of the specified service.

GetParent

PowerObject

Returns a reference to the name of the parent object.

PostEvent

Boolean

Adds an event to the end of the message queue for the control.

TriggerEvent

Integer

Triggers a specified event in the control and executes the script for the event.

TypeOf

Object

Returns the type of the control.