Pular para o conteúdo principal
Este método é implementado no lado do cliente. Ele é chamado pelo ABBYY FineReader Engine quando a caixa de rolagem é movida por uma ação do mouse ou do teclado em Image Viewer, Zoom Viewer, Text Editor, Text Validator ou Document Viewer. Ele fornece ao cliente o código da barra de rolagem, a posição da caixa de rolagem e o número de linhas roladas. Com este método, é possível cancelar a operação.

Sintaxe

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 um código de barra de rolagem que indica a solicitação de rolagem do usuário. Este parâmetro pode ser um dos seguintes:
  • SB_LEFT (6) — Rola até a extremidade esquerda.
  • SB_ENDSCROLL (8) — Encerra a rolagem.
  • SB_LINELEFT (0) — Rola para a esquerda.
  • SB_LINERIGHT (1) — Rola para a direita.
  • SB_PAGELEFT (2) — Rola uma página para a esquerda.
  • SB_PAGERIGHT (3) — Rola uma página para a direita.
  • SB_RIGHT (7) — Rola até a extremidade direita.
  • SB_THUMBPOSITION (4) — Rola até a posição absoluta. A posição atual é especificada pelo parâmetro Position.
  • SB_THUMBTRACK (5) — Arrasta a caixa de rolagem até a posição especificada. A posição atual é especificada pelo parâmetro Position.
As constantes são definidas em Winuser.h. O parâmetro é -1 se não houve rolagem horizontal. VertScrollBarCode [in] Especifica um código de barra de rolagem que indica a solicitação de rolagem do usuário. Este parâmetro pode ser um dos seguintes:
  • SB_BOTTOM (7) — Rola até a parte inferior.
  • SB_ENDSCROLL (8) — Encerra a rolagem.
  • SB_LINEDOWN (1) — Rola uma linha para baixo.
  • SB_LINEUP (0) — Rola uma linha para cima.
  • SB_PAGEDOWN (3) — Rola uma página para baixo.
  • SB_PAGEUP (2) — Rola uma página para cima.
  • SB_THUMBPOSITION (4) — Rola até a posição absoluta. A posição atual é fornecida no parâmetro Position.
  • SB_THUMBTRACK (5) — Arrasta a caixa de rolagem até a posição especificada. A posição atual é fornecida no parâmetro Position.
  • SB_TOP (6) — Rola até a parte superior.
As constantes são definidas em Winuser.h. O parâmetro é -1 se não houve rolagem vertical. Position [in] Especifica a posição da caixa de rolagem se o código da barra de rolagem for SB_THUMBPOSITION ou SB_THUMBTRACK; caso contrário, não será usado. Count [in] Contém o número de linhas roladas se a rolagem tiver sido feita pela roda do mouse. Cancel [out] Você pode definir esta variável como TRUE para indicar que o processo deve ser encerrado.

Valores de retorno

[somente C++] Se este método retornar um valor diferente de S_OK, isso indica que ocorreu um erro no cliente e, nesse caso, o valor do parâmetro Cancel não será levado em consideração.

Observações

A implementação cliente deste método deve garantir que todas as exceções lançadas dentro do método sejam capturadas e tratadas, e que nenhuma exceção seja propagada para fora dele. A propagação de uma exceção para fora do método pode levar a resultados imprevisíveis (como o encerramento do programa).

Veja também

IInputEvents