TPDFlibFormSession

Biểu mẫu, tương tác, kiểu dữ liệu

Mô tả

Duy trì kiểm tra trúng AcroForm, điều hướng bàn phím, tiêu điểm, giá trị chỉnh sửa và trạng thái vùng chọn văn bản mà không phụ thuộc một framework GUI Thực thể

TPDFlib

/Fo/BlOnAction

Hình chữ nhật trang dùng CropBox hiển thị sau khi xoay trang, theo đơn vị đo hiện tại của thư viện, gốc tọa độ ở trên trái hiển thị

Vùng chọn có hướng giữ vị trí anchor và caret độc lập, đặt hay truy vấn được theo đơn vị code UTF-16, code point Unicode hoặc extended grapheme cluster

Chỉnh sửa hai chiều giữ thứ tự logic của giá trị trường, đồng thời giải slot hiển thị của caret theo từng dòng từ embedding level, nên di chuyển Left/Right vật lý bám theo văn bản trộn trái-sang-phải và phải-sang-trái

/KOnTextEdit/MaxLen

Mỗi chỉnh sửa đang hoạt động giữ một lịch sử delta có giới hạn để khôi phục giá trị tạm, giá trị hiển thị và vùng chọn có hướng mà không dispatch lại form action hay host edit callback

DispatchInputEvent

/E được gắn vẫn thuộc sở hữu caller và phải tồn tại lâu hơn phiên Các chuyển tiếp tiêu điểm lộ các hành động Widget /X và /D dưới dạng callback host có kiểu qua /U Các hình chữ nhật trang dùng CropBox trực quan sau xoay trang theo đơn vị đo hiện tại của thư viện, với gốc ở góc trên trái trực quan Các vùng chọn có hướng giữ các vị trí điểm neo và con trỏ độc lập và có thể được đặt hay truy vấn theo đơn vị mã UTF-16, điểm mã Unicode hoặc cụm grapheme mở rộng Các chỉnh sửa hai chiều giữ thứ tự logic giá trị trường trong khi suy các vị trí con trỏ trực quan từng dòng từ các cấp nhúng, nên chuyển động Left và Right vật lý đi theo văn bản trái-sang-phải và phải-sang-trái hỗn hợp Các phép thay vùng chọn gửi

/V tới host, lộ văn bản được chọn và thay thế qua /F, thực thi

DisplayValue tại các biên grapheme hoàn chỉnh và thu vùng chọn sau một chỉnh sửa được chấp nhận Mỗi phiên chỉnh sửa đang hoạt động giữ một lịch sử delta có biên khôi phục giá trị tạm thời, giá trị hiển thị và vùng chọn có hướng mà không gửi lại các hành động biểu mẫu hay callback chỉnh sửa của host

Khai báo

type
  TPDFlibFormFieldIndices = array of Integer;

  TPDFlibFormSelectionUnit = (fsuUTF16CodeUnit,
    fsuUnicodeCodePoint, fsuGraphemeCluster);

  TPDFlibFormTextDirection = (ftdAuto,
    ftdLeftToRight, ftdRightToLeft);
  TPDFlibFormCaretIndices = array of Integer;

  TPDFlibFormSelection = record
    IndexUnit: TPDFlibFormSelectionUnit;
    AnchorIndex: Integer;
    CaretIndex: Integer;
    StartIndex: Integer;
    SelectionLength: Integer;
    IsReversed: Boolean;
  end;

  TPDFlibFormSessionActionEvent = procedure(Sender: TObject;
    FieldIndex: Integer; const TriggerEvent: AnsiString;
    const ActionInfo: TPDFlibActionInfo; var Allow: Boolean) of object;
  TPDFlibFormSessionFocusEvent = procedure(Sender: TObject;
    OldFieldIndex, NewFieldIndex: Integer) of object;
  TPDFlibFormSessionValueEvent = procedure(Sender: TObject;
    FieldIndex: Integer; const OldValue, NewValue: WideString) of object;
  TPDFlibFormEditKind = (fekReplaceSelection,
    fekCutSelection, fekPasteText);
  TPDFlibFormSessionTextEditEvent = procedure(Sender: TObject;
    FieldIndex: Integer; EditKind: TPDFlibFormEditKind;
    SelectionStart, SelectionLength: Integer;
    const SelectedText: WideString; var ReplacementText: WideString;
    var Allow: Boolean) of object;

  TPDFlibFormInputEventKind = (fiekPointerMove,
    fiekPointerDown, fiekPointerUp, fiekPointerDoubleClick,
    fiekPointerLeave, fiekPointerCancel, fiekWheel,
    fiekKeyDown, fiekKeyUp, fiekTextInput);
  TPDFlibFormInputModifiers = set of TPDFlibFormInputModifier;

  TPDFlibFormInputEvent = record
    Kind: TPDFlibFormInputEventKind;
    Modifiers: TPDFlibFormInputModifiers;
    Button: TPDFlibFormInputButton;
    Key: TPDFlibFormInputKey;
    Page: Integer;
    X, Y: Double;
    WheelDeltaX, WheelDeltaY: Double;
    Text: WideString;
  end;

  TPDFlibFormSession = class
  public
    constructor Create(ALibrary: TPDFlib);
    procedure AttachLibrary(ALibrary: TPDFlib);
    procedure Reset;
    function FocusField(FieldIndex: Integer;
      CommitCurrent: Boolean = True): Integer;
    function GetFieldPageRect(FieldIndex: Integer; out Page: Integer;
      out Left, Top, Width, Height: Double): Integer;
    function HitTest(Page: Integer; X, Y: Double): Integer;
    function GetTabSequence(out FieldIndices: TPDFlibFormFieldIndices): Integer;
    function FocusAt(Page: Integer; X, Y: Double;
      CommitCurrent: Boolean = True): Integer;
    function FocusNext(Backwards: Boolean = False;
      WrapAround: Boolean = True; CommitCurrent: Boolean = True): Integer;
    function Blur(CommitCurrent: Boolean = True): Integer;
    function BeginEdit(FieldIndex: Integer): Integer;
    function SetEditValue(const NewValue: WideString): Integer;
    function SetSelection(StartIndex, SelectionLength: Integer): Integer;
    function SetSelectionRange(AnchorIndex, CaretIndex: Integer;
      IndexUnit: TPDFlibFormSelectionUnit): Integer;
    function GetSelectionRange(IndexUnit: TPDFlibFormSelectionUnit;
      out Selection: TPDFlibFormSelection): Integer;
    function SetTextDirection(
      Direction: TPDFlibFormTextDirection): Integer;
    function GetVisualCaretOrder(IndexUnit: TPDFlibFormSelectionUnit;
      out CaretIndices: TPDFlibFormCaretIndices): Integer;
    function MoveVisualCaret(ToRight: Boolean;
      ExtendSelection: Boolean = False): Integer;
    function GetSelectedText: WideString;
    function ReplaceSelection(const ReplacementText: WideString): Integer;
    function CutSelection(out CutText: WideString): Integer;
    function PasteText(const Text: WideString): Integer;
    function CanUndoEdit: Boolean;
    function CanRedoEdit: Boolean;
    function UndoEdit: Integer;
    function RedoEdit: Integer;
    procedure ClearEditHistory;
    function DispatchInputEvent(
      const InputEvent: TPDFlibFormInputEvent;
      out InputResult: TPDFlibFormInputResult): Integer;
    function CommitEdit: Integer;
    procedure CancelEdit;
    property TextDirection: TPDFlibFormTextDirection;
    property ResolvedTextDirection: TPDFlibFormTextDirection;
    property VisualCaretPosition: Integer;
    property MaxUndoSteps: Integer;
    property UndoEditCount: Integer;
    property RedoEditCount: Integer;
    property HoveredFieldIndex: Integer;
    property PressedFieldIndex: Integer;
  end;

Phương thức

Thuộc tính trạng thái

Sự kiện

Giá trị trả về

Các hàm thay đổi trạng thái trả về 1 khi thành công và 0 khi yêu cầu không hợp lệ, tái nhập, bị phủ quyết hoặc không thể xác nhận; HitTest trả về một chỉ số trường hoặc Widget tạm và GetTabSequence trả về số mục

Đơn vị lựa chọn

fsuUTF16CodeUnit giữ hợp đồng chỉ mục WideString tính từ 0 kiểu cũ, bao gồm cả các vị trí bên trong một cặp surrogate khi được yêu cầu tường minh

fsuUnicodeCodePoint đếm một cặp surrogate hợp lệ là một điểm mã bổ sung và coi một surrogate đơn lẻ là một điểm mã độc lập

fsuGraphemeCluster đếm các cụm grapheme mở rộng hoàn chỉnh nên các chuỗi kết hợp và emoji ghép vẫn không thể chia Các bảng biên Unicode được cache cho giá trị chỉnh sửa hiện tại và bị vô hiệu hóa khi giá trị đó thay đổi

Các bảng ranh giới Unicode được cache cho giá trị sửa hiện tại và vô hiệu khi giá trị đổi

Điều hướng hai chiều

ftdAuto dùng ký tự mạnh đầu tiên và mặc định trái-sang-phải khi phiên chỉnh sửa không có ký tự có chiều mạnh nào Thứ tự run trực quan được suy độc lập cho từng dòng và không thay giá trị trường UTF-16 logic, chuỗi PDF hay căn chỉnh văn bản Một chỉ số logic có thể chiếm hai vị trí trực quan riêng tại một biên hỗn hợp chiều, nên

Thứ tự run hiển thị được giải độc lập từng dòng và không đổi giá trị trường UTF-16 logic, PDF string hay căn lề văn bản

VisualCaretPosition phân biệt các lần di chuyển lặp qua biên đó

Ví dụ

var
  Session: TPDFlibFormSession;
  Selection: TPDFlibFormSelection;
begin
  Session := TPDFlibFormSession.Create(PDF);
  try
    if Session.FocusAt(PageNumber, MouseX, MouseY) = 1 then
      Session.FocusNext(False, True);
    if Session.BeginEdit(Session.FocusedFieldIndex) = 1 then
    begin
      Session.SetEditValue('A' + WideChar($D83D) + WideChar($DE00) + 'B');
      Session.SetSelectionRange(1, 2, fsuUnicodeCodePoint);
      Session.GetSelectionRange(fsuUTF16CodeUnit, Selection);
      Session.SetTextDirection(ftdAuto);
      Session.MoveVisualCaret(True, True);
      Session.PasteText('replacement');
      if Session.CanUndoEdit then
        Session.UndoEdit;
      if Session.CanRedoEdit then
        Session.RedoEdit;
      Session.CommitEdit;
    end;
  finally
    Session.Free;
  end;
end;

Xem thêm

SetTextDirection, GetVisualCaretOrder, MoveVisualCaret, TPDFlibFormTextDirection, DispatchInputEvent, TPDFlibFormInputEvent, TPDFlibFormInputResult, UndoEdit, RedoEdit, ClearEditHistory, ReplaceSelection, CutSelection, PasteText, TPDFlibFormEditKind, SetSelectionRange, GetSelectionRange, ExecuteFormFieldScript, TPDFlibActionInfo