Méthode OnScroll de l’interface IInputEvents

Cette méthode est implémentée côté client. Elle est appelée par ABBYY FineReader Engine lorsque la zone de défilement a été déplacée à l’aide de la souris ou du clavier dans Image Viewer, Zoom Viewer, Text Editor, Text Validator ou Document Viewer.

Elle transmet au client le code de la barre de défilement, la position de la zone de défilement et le nombre de lignes défilées. Cette méthode permet d’annuler l’opération.

​

Syntaxe

​

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 _
)

​

Paramètres

HorzScrollBarCode

[in] Spécifie un code de la barre de défilement qui indique l’action de défilement demandée par l’utilisateur. Ce paramètre peut avoir l’une des valeurs suivantes :

• SB_LEFT (6) — Faire défiler jusqu’à l’extrême gauche.
• SB_ENDSCROLL (8) — Mettre fin au défilement.
• SB_LINELEFT (0) — Faire défiler vers la gauche.
• SB_LINERIGHT (1) — Faire défiler vers la droite.
• SB_PAGELEFT (2) — Faire défiler d’une page vers la gauche.
• SB_PAGERIGHT (3) — Faire défiler d’une page vers la droite.
• SB_RIGHT (7) — Faire défiler jusqu’à l’extrême droite.
• SB_THUMBPOSITION (4) — Faire défiler jusqu’à la position absolue. La position actuelle est spécifiée par le paramètre Position.
• SB_THUMBTRACK (5) — Faire glisser la zone de défilement jusqu’à la position spécifiée. La position actuelle est spécifiée par le paramètre Position.

Les constantes sont définies dans Winuser.h. Le paramètre vaut -1 s’il n’y a pas eu de défilement horizontal.

VertScrollBarCode

[in] Spécifie un code de la barre de défilement qui indique l’action de défilement demandée par l’utilisateur. Ce paramètre peut avoir l’une des valeurs suivantes :

• SB_BOTTOM (7) — Faire défiler jusqu’en bas.
• SB_ENDSCROLL (8) — Mettre fin au défilement.
• SB_LINEDOWN (1) — Faire défiler d’une ligne vers le bas.
• SB_LINEUP (0) — Faire défiler d’une ligne vers le haut.
• SB_PAGEDOWN (3) — Faire défiler d’une page vers le bas.
• SB_PAGEUP (2) — Faire défiler d’une page vers le haut.
• SB_THUMBPOSITION (4) — Faire défiler jusqu’à la position absolue. La position actuelle est fournie dans le paramètre Position.
• SB_THUMBTRACK (5) — Faire glisser la zone de défilement jusqu’à la position spécifiée. La position actuelle est fournie dans le paramètre Position.
• SB_TOP (6) — Faire défiler jusqu’en haut.

Les constantes sont définies dans Winuser.h. Le paramètre vaut -1 s’il n’y a pas eu de défilement vertical.

Position

[in] Spécifie la position de la zone de défilement si le code de la barre de défilement est SB_THUMBPOSITION ou SB_THUMBTRACK ; sinon, il n’est pas utilisé.

Count

[in] Contient le nombre de lignes défilées si le défilement a été effectué à l’aide de la molette de la souris.

Cancel

[out] Vous pouvez définir cette variable sur TRUE pour indiquer que le processus doit être interrompu.

​

Valeurs de retour

[C++ uniquement] Si cette méthode renvoie une valeur autre que S_OK, cela signifie qu’une erreur s’est produite côté client et, dans ce cas, la valeur du paramètre Cancel n’est pas prise en compte.

​

Remarques

L’implémentation côté client de cette méthode doit garantir que toutes les exceptions levées à l’intérieur de la méthode sont interceptées et gérées, et qu’aucune exception ne se propage en dehors de la méthode. La propagation d’une exception en dehors de la méthode peut entraîner des résultats imprévisibles (comme l’arrêt du programme).

​

Voir aussi

IInputEvents