GetSelectedFormText method

Questa voce API conserva identificatori, firme, blocchi di codice e termini PDF nella forma originale.

Returns the text currently selected inside the focused AcroForm widget on the view's active page.

GetSelectedFormText is a high-level entry point on top of PDFium's FORM_GetSelectedText binding. The PDFium API was already bound at the unit level but had no Pascal-friendly accessor until v1.23.0; this method wraps it cleanly.

The method targets whatever AcroForm widget currently owns the focus on the view's active page (the same widget that responds to keyboard input). When the user has selected a range of characters inside that widget — for example by Shift+Arrow or click-and- drag — GetSelectedFormText returns the selection text as a WString. When no text is selected (just a caret position), GetSelectedFormText returns an empty string.

The method is a no-op when:

• the view is inactive (Active = False);
• the document carries no AcroForm (FormType = ftNone);
• or no widget is focused on the current page.

In all three cases the return value is an empty string — the method never raises.

• Pair with SelectAllFormText to support a "Select All" menu item, then use GetSelectedFormText to feed the selection to Clipboard.AsText.
• The selection is widget-local — selecting page text outside any widget does not return through GetSelectedFormText; for that use the character-level text extraction APIs.
• The selection state is managed by PDFium's form-fill module; assigning a new value through FormField[i] := ... may collapse the selection back to a caret.

SelectAllFormText, FormUndo, FormRedo, FormField