Método OnScroll de la interfaz IInputEvents

Este método se implementa del lado del cliente. ABBYY FineReader Engine lo llama cuando el cuadro de desplazamiento se mueve mediante una acción del mouse o del teclado en Visor de imágenes, Visor de zoom, Editor de texto, Validador de texto o Visor de documentos.

Proporciona al cliente el código de la barra de desplazamiento, la posición del cuadro de desplazamiento y el número de líneas desplazadas. Con este método, es posible cancelar la operación.

​

Sintaxis

​

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

​

Parámetros

HorzScrollBarCode

[in] Especifica un código de barra de desplazamiento que indica la acción de desplazamiento solicitada por el usuario. Este parámetro puede ser uno de los siguientes:

• SB_LEFT (6) — Desplazarse hasta el extremo izquierdo.
• SB_ENDSCROLL (8) — Finalizar el desplazamiento.
• SB_LINELEFT (0) — Desplazarse a la izquierda.
• SB_LINERIGHT (1) — Desplazarse a la derecha.
• SB_PAGELEFT (2) — Desplazarse una página a la izquierda.
• SB_PAGERIGHT (3) — Desplazarse una página a la derecha.
• SB_RIGHT (7) — Desplazarse hasta el extremo derecho.
• SB_THUMBPOSITION (4) — Desplazarse a una posición absoluta. La posición actual se especifica mediante el parámetro Position.
• SB_THUMBTRACK (5) — Arrastrar el cuadro de desplazamiento hasta la posición especificada. La posición actual se especifica mediante el parámetro Position.

Las constantes están definidas en Winuser.h. El parámetro es -1 si no hubo desplazamiento horizontal.

VertScrollBarCode

[in] Especifica un código de barra de desplazamiento que indica la acción de desplazamiento solicitada por el usuario. Este parámetro puede ser uno de los siguientes:

• SB_BOTTOM (7) — Desplazarse hasta la parte inferior.
• SB_ENDSCROLL (8) — Finalizar el desplazamiento.
• SB_LINEDOWN (1) — Desplazarse una línea hacia abajo.
• SB_LINEUP (0) — Desplazarse una línea hacia arriba.
• SB_PAGEDOWN (3) — Desplazarse una página hacia abajo.
• SB_PAGEUP (2) — Desplazarse una página hacia arriba.
• SB_THUMBPOSITION (4) — Desplazarse a una posición absoluta. La posición actual se especifica mediante el parámetro Position.
• SB_THUMBTRACK (5) — Arrastrar el cuadro de desplazamiento hasta la posición especificada. La posición actual se especifica mediante el parámetro Position.
• SB_TOP (6) — Desplazarse hasta la parte superior.

Las constantes están definidas en Winuser.h. El parámetro es -1 si no hubo desplazamiento vertical.

Position

[in] Especifica la posición del cuadro de desplazamiento si el código de barra de desplazamiento es SB_THUMBPOSITION o SB_THUMBTRACK; de lo contrario, no se utiliza.

Count

[in] Contiene el número de líneas desplazadas si el desplazamiento se realizó con la rueda del ratón.

Cancel

[out] Puede establecer esta variable en TRUE para indicar que el proceso debe finalizar.

​

Valores de retorno

[Solo C++] Si este método devuelve un valor distinto de S_OK, indica que se produjo un error del lado del cliente y, en ese caso, no se tiene en cuenta el valor del parámetro Cancel.

​

Observaciones

La implementación del cliente para este método debe garantizar que todas las excepciones que se lancen dentro del método se capturen y se controlen, y que no se propaguen fuera del método. La propagación de una excepción fuera del método puede dar lugar a resultados impredecibles (como la terminación del programa).

​

Consulte también

IInputEvents