TPDFlibFormSession

Formlar, etkileşim, veri türleri

Açıklama

Bir GUI çerçevesine dayanmadan AcroForm isabet testini, klavye gezinmesini, odağı, düzenleme değerini ve metin seçim durumunu sürdürür

Bağlı TPDFlib örneği çağıranın mülkiyetinde kalır ve oturumdan uzun yaşamak zorundadır

Odak geçişleri widget /Fo ve /Bl eylemlerini, türlendirilmiş ana makine geri çağrımları olarak OnAction üzerinden açığa çıkarır

Sayfa dikdörtgenleri sayfa döndürmesinden sonraki görsel CropBox'ı, kitaplığın geçerli ölçü birimleriyle kullanır; başlangıç noktası görsel sol üst köşededir

Yönlü seçimler bağımsız çapa ve imleç konumlarını saklar ve UTF-16 kod birimleri, Unicode kod noktaları veya genişletilmiş grafem kümeleriyle ayarlanabilir ya da sorgulanabilir

İki yönlü düzenlemeler mantıksal alan değeri sırasını korurken gömme düzeylerinden satır başına görsel imleç yuvalarını çözer; böylece fiziksel Sol ve Sağ hareketi, soldan sağa ile sağdan sola karışık metni izler

Seçim değiştirmeleri /K'yı ana makineye gönderir, seçilen ve ikame metni OnTextEdit üzerinden açığa çıkarır, tam grafem sınırlarında /MaxLen'i uygular ve kabul edilen bir düzenlemeden sonra seçimi daraltır

Her etkin düzenleme, form eylemlerini veya ana makine düzenleme geri çağrımlarını yeniden göndermeden geçici değeri, görüntülenen değeri ve yönlü seçimi onaran sınırlı bir fark geçmişi tutar

DispatchInputEvent; platformdan bağımsız işaretçi, tekerlek, adlandırılmış tuş ve birleştirilmiş metin kayıtlarını kısıtlı widget eylemlerine, odak geçişlerine, grafem güvenli düzenlemeye, düğme etkinleştirmeye ve seçim alanı gezinmesine dönüştürür

Oturum girilen ve basılı widget kimliğini saklar; böylece /E, /X, /D ve /U, işaretçi yakalama ve iptali aşsa bile PDF tetikleyici sıralamasını izler

İşlemeler /V ve /F eylemlerini gönderir, belgeyi değiştirmeden önce desteklenen sınırlı JavaScript alt kümesini yürütür ve doğrulama, biçimlendirme veya bir ana makine geri çağrımı işlemi reddettiğinde etkin düzenlemeyi tutar

Doğrulanmış ham değer alana saklanırken DisplayValue ile üretilen widget görünümü biçimlendirme sonucunu korur

Bildirim

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;

Yöntemler

Durum özellikleri

Olaylar

Dönüş değeri

Durum değiştiren işlevler başarıda 1 döndürür ve istek geçersiz, yeniden girişli, veto edilmiş veya kesinleştirilemediğinde 0 döndürür; HitTest bir alan veya geçici Widget dizinini, GetTabSequence ise girdi sayısını döndürür

Seçim birimleri

fsuUTF16CodeUnit eski sıfır tabanlı WideString indeksleme sözleşmesini korur; açıkça istendiğinde bir vekil çiftin içindeki konumlar dahil

fsuUnicodeCodePoint geçerli bir vekil çifti tek yardımcı kod noktası sayar ve eşsiz bir vekili bağımsız tek bir kod noktası sayar

fsuGraphemeCluster eksiksiz genişletilmiş grafem kümelerini sayar; böylece birleştirici diziler ve bitişik emoji bölünmez kalır

Unicode sınır tabloları geçerli düzenleme değeri için önbelleğe alınır ve o değer değiştiğinde geçersiz kılınır

Çift yönlü gezinme

ftdAuto ilk güçlü karakteri kullanır ve düzenlemede güçlü yönlü karakter yoksa varsayılan olarak soldan sağayı seçer

Görsel dizi sırası her satır için bağımsız çözülür ve mantıksal UTF-16 alan değerini, PDF dizisini veya metin hizalamasını değiştirmez

Karışık yön sınırında bir mantıksal indeks iki ayrı görsel yuvayı kaplayabilir; böylece VisualCaretPosition o sınır üzerinden tekrarlanan hareketi ayırt eder

Örnek

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;

Ayrıca bkz.

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