TPDFlibFormSession

Formulários, interação, tipos de dados

Descrição

Mantém o teste de incidência AcroForm, a navegação por teclado, o foco, o valor de edição e o estado de seleção de texto sem depender de um framework GUI A instância

TPDFlib

/Fo/BlOnAction

/KOnTextEdit/MaxLen

DispatchInputEvent

/E anexada permanece propriedade do chamador e tem de sobreviver à sessão As transições de foco expõem as ações de Widget /X e /D como callbacks tipadas do anfitrião através de /U Os retângulos de página usam o CropBox visual após a rotação da página, nas unidades de medição atuais da biblioteca, com a origem no canto superior esquerdo visual As seleções direcionadas retêm posições independentes de âncora e cursor e podem ser definidas ou consultadas em unidades de código UTF-16, pontos de código Unicode ou aglomerados de grafemas extensos As edições bidirecionais retêm a ordem lógica do valor do campo, resolvendo as ranhuras visuais do cursor por linha a partir dos níveis de incorporação, pelo que o movimento físico para a esquerda e para a direita segue texto misto da esquerda para a direita e da direita para a esquerda As substituições de seleção expedem

/V ao anfitrião, expõem o texto selecionado e o de substituição através de /F, impõem

DisplayValue em fronteiras de grafemas completas e colapsam a seleção após uma edição aceite Cada edição ativa mantém um histórico de deltas delimitado que restaura o valor transitório, o valor de apresentação e a seleção direcionada sem reexpedir ações de formulário nem callbacks de edição do anfitrião

Declaraçã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;

Métodos

Propriedades de estado

Eventos

Valor devolvido

As funções que alteram o estado devolvem 1 em caso de êxito e 0 quando o pedido é inválido, reentrante, vetado ou não pode ser confirmado; HitTest devolve um índice de campo ou de Widget temporário, e GetTabSequence devolve o número de entradas

Unidades de seleção

fsuUTF16CodeUnit preserva o contrato legado de indexação WideString com base zero, incluindo posições dentro de um par substituto quando explicitamente pedido

fsuUnicodeCodePoint conta um par substituto válido como um ponto de código suplementar e trata um substituto não emparelhado como um ponto de código isolado

fsuGraphemeCluster conta aglomerados de grafemas extensos completos, para que sequências combináveis e emojis unidos permaneçam indivisíveis As tabelas de fronteiras Unicode são postas em cache para o valor de edição atual e invalidadas quando esse valor muda

Navegação bidirecional

ftdAuto usa o primeiro caráter forte e assume da esquerda para a direita quando a edição não tem nenhum caráter direcional forte A ordem visual dos segmentos é resolvida independentemente para cada linha e não altera o valor lógico UTF-16 do campo, a cadeia PDF nem o alinhamento do texto Um índice lógico pode ocupar duas ranhuras visuais distintas numa fronteira de direção mista, pelo que

VisualCaretPosition desambigua o movimento repetido através dessa fronteira

Exemplo

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;

Consulte também

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