OnScroll-Methode der IInputEvents-Schnittstelle

Diese Methode wird clientseitig implementiert. Sie wird von ABBYY FineReader Engine aufgerufen, wenn die Scroll-Box im Image Viewer, Zoom Viewer, Text Editor, Text Validator oder Document Viewer per Maus- oder Tastaturaktion verschoben wurde. Sie übergibt dem Client den Bildlaufleistencode, die Position der Scroll-Box und die Anzahl der gescrollten Zeilen. Mithilfe dieser Methode kann der Vorgang abgebrochen werden.

Syntax

C++

HRESULT OnScroll(
  int           HorzScrollBarCode,
  int           VertScrollBarCode,
  int           Position,
  int           Count,
  VARIANT_BOOL* Cancel
);

C#

void OnScroll(
  int      HorzScrollBarCode,
  int      VertScrollBarCode,
  int      Position,
  int      Count,
  out bool Cancel
);

Visual Basic .NET

Sub OnScroll( _
  HorzScrollBarCode As Integer, _
  VertScrollBarCode As Integer, _
  Position As Integer, _
  Count As Integer, _
  ByRef Cancel As Boolean _
)

Parameter

HorzScrollBarCode [in] Gibt einen Bildlaufleistencode an, der die Bildlaufanforderung des Benutzers kennzeichnet. Dieser Parameter kann einen der folgenden Werte haben:

SB_LEFT (6) — Ganz nach links scrollen.
SB_ENDSCROLL (8) — Bildlauf beenden.
SB_LINELEFT (0) — Nach links scrollen.
SB_LINERIGHT (1) — Nach rechts scrollen.
SB_PAGELEFT (2) — Eine Seite nach links scrollen.
SB_PAGERIGHT (3) — Eine Seite nach rechts scrollen.
SB_RIGHT (7) — Ganz nach rechts scrollen.
SB_THUMBPOSITION (4) — Zur absoluten Position scrollen. Die aktuelle Position wird durch den Parameter Position angegeben.
SB_THUMBTRACK (5) — Die Scroll-Box an die angegebene Position ziehen. Die aktuelle Position wird durch den Parameter Position angegeben.

Die Konstanten sind in Winuser.h definiert. Der Parameter ist -1, wenn kein horizontaler Bildlauf erfolgt ist. VertScrollBarCode [in] Gibt einen Bildlaufleistencode an, der die Bildlaufanforderung des Benutzers kennzeichnet. Dieser Parameter kann einen der folgenden Werte haben:

SB_BOTTOM (7) — Nach unten scrollen.
SB_ENDSCROLL (8) — Bildlauf beenden.
SB_LINEDOWN (1) — Eine Zeile nach unten scrollen.
SB_LINEUP (0) — Eine Zeile nach oben scrollen.
SB_PAGEDOWN (3) — Eine Seite nach unten scrollen.
SB_PAGEUP (2) — Eine Seite nach oben scrollen.
SB_THUMBPOSITION (4) — Zur absoluten Position scrollen. Die aktuelle Position wird im Parameter Position angegeben.
SB_THUMBTRACK (5) — Die Scroll-Box an die angegebene Position ziehen. Die aktuelle Position wird im Parameter Position angegeben.
SB_TOP (6) — Nach oben scrollen.

Die Konstanten sind in Winuser.h definiert. Der Parameter ist -1, wenn kein vertikaler Bildlauf erfolgt ist. Position [in] Gibt die Position der Scroll-Box an, wenn der Bildlaufleistencode SB_THUMBPOSITION oder SB_THUMBTRACK ist; andernfalls wird dieser Parameter nicht verwendet. Count [in] Enthält die Anzahl der gescrollten Zeilen, wenn der Bildlauf mit dem Mausrad durchgeführt wurde. Cancel [out] Sie können diese Variable auf TRUE setzen, um anzugeben, dass der Prozess beendet werden soll.

Rückgabewerte

[Nur C++] Wenn diese Methode einen anderen Wert als S_OK zurückgibt, bedeutet dies, dass clientseitig ein Fehler aufgetreten ist; in diesem Fall wird der Wert des Parameters Cancel nicht berücksichtigt.

Bemerkungen

Die Client-Implementierung dieser Methode muss sicherstellen, dass alle innerhalb der Methode ausgelösten Ausnahmen abgefangen und behandelt werden und dass keine Ausnahmen über die Methode hinaus propagiert werden. Die Propagierung einer Ausnahme über die Methode hinaus kann zu unvorhersehbaren Ergebnissen führen (z. B. zur Beendigung des Programms).