PDFium Delphi Component Docs

GetSelectedFormText メソッド

コンポーネント: TPdfView  ·  ユニット: PDFium
ビューのアクティブページでフォーカスされている AcroForm ウィジェット内の、現在選択されているテキストを返します

構文

function GetSelectedFormText: WString;

説明

GetSelectedFormText は PDFium の FORM_GetSelectedText バインディングの上に置かれた高レベルのエントリポイントです。この PDFium API はユニットレベルでは以前からバインドされていましたが、v1.23.0 まで Pascal から扱いやすいアクセサが存在しませんでした。このメソッドがそれをきれいにラップします

メソッドの対象は、ビューのアクティブページで現在フォーカスを保持している AcroForm ウィジェット (キーボード入力に応答するのと同じウィジェット) です。ユーザーがそのウィジェット内で文字範囲を選択している場合 — たとえば Shift+Arrow やクリック&ドラッグによって — GetSelectedFormText は選択テキストを WString として返します。テキストが選択されていない (キャレット位置だけの) 場合、GetSelectedFormText は空の文字列を返します

このメソッドが何も行わないケースは次のとおりです

いずれの場合も戻り値は空の文字列です — メソッドが例外を発生させることはありません

備考

例

procedure TForm1.btnCopyClick(Sender: TObject);
begin
  if not PdfView1.CopySelectedFormTextToClipboard then
    ShowMessage('No form text selected');
end;

関連項目

CopySelectedFormTextToClipboard, SelectAllFormText, FormUndo, FormRedo, FormField