| Control Reference > VSPrinter Control > VSPrinter Properties > RetrieveText Property |
Returns a string containing the text on a region of the current document.
val$ = [form!]VSPrinter.RetrieveText(Left As Variant, Top As Variant, [ Right As Variant ], [ Bottom As Variant ], [ Page As Variant ], [ ClientCoords As Variant ])
The RetrieveText property allows you to retrieve text based on its position in the document. To search for text within a document, use the FindText property instead.
The parameters for the RetrieveText property are described below:
Left, Top As Variant
These parameters define the left and top coordinates of the region to be searched for a tag. You may specify units with these parameters (inches, points, twips, cm, mm, or pixels). The default unit is twips. For details on using unit-aware measurements, see the Using Unit-Aware Properties topic.
Right, Bottom As Variant (optional)
These parameters define the right and bottom coordinates of the region to be searched for a tag. They are optional, and default to the values of the Left and Top parameters (in which case the control looks for a tag that contains the given point).
Page As Variant (optional)
This parameter defines the page to be searched for a tag. It is optional, and defaults to the current preview page (PreviewPage property).
ClientCoords As Variant (optional)
This parameter determines whether the Left, Top, Right, and Bottom parameters express coordinates in client coordinates (as opposed to page coordinates). This parameter is optional and defaults to False (page coordinates). Note that you may convert coordinates using the ClientToPage and PageToClient methods.
The property returns the text contained in the specified region.
String