←Select platform

CurrentPageNumber Property

Summary

Current page number.

Syntax

C++

public virtual int CurrentPageNumber { get; }

Public Overridable ReadOnly Property CurrentPageNumber() As Integer 
   Get

public:  
   virtual property int CurrentPageNumber 
   { 
      int get() 
   }

Property Value

The 1-based number of the current page.

Remarks

The CurrentPageNumber is the page with the largest area currently visible in the View.

This is obtained by calling View.ImageViewer.GetLargestVisibleItemIndex.

The value changes when the user scrolls the view or zooms in or out and should not be saved. Instead, use CurrentPageNumber every time the "largest visible page" is needed. For example, the application can have a "Find text in this page" or "Find text in the whole document" operations. When the user runs the "Find text in this page", they are referring to the largest page in the viewer, and the application should call CurrentPageNumber to get this value when the action is invoked.

Example

Start with the example created in DocumentViewer, remove all the code in the Example function and add the code below.

When the user clicks the Example button, We will intercept when the user changes the page number, show the current page in the label.

using Leadtools; 
using Leadtools.Controls; 
using Leadtools.Documents; 
using Leadtools.Documents.UI; 
using Leadtools.Codecs; 
using Leadtools.Caching; 
using Leadtools.Annotations.Core; 
using Leadtools.Forms.Ocr; 
 
// Disable the example button, this should only run once 
exampleButton.Enabled = false; 
_documentViewer.Operation += (sender, e) => 
{ 
   if (e.Operation == DocumentViewerOperation.GotoPage && e.IsPostOperation) 
   { 
      var pageNumber = _documentViewer.CurrentPageNumber; 
      var infoLabel = this.Controls.Find("infoLabel", true)[0]; 
      infoLabel.Text = "Current page number is " + pageNumber; 
   } 
};

Imports Leadtools 
Imports Leadtools.Controls 
Imports Leadtools.Documents 
Imports Leadtools.Documents.UI 
Imports Leadtools.Codecs 
Imports Leadtools.Caching 
Imports Leadtools.Annotations.Core 
Imports Leadtools.Forms.Ocr 
 
' Disable the example button, this should only run once 
exampleButton.Enabled = False 
AddHandler _documentViewer.Operation, 
   Sub(sender, e) 
      If e.Operation = DocumentViewerOperation.GotoPage AndAlso e.IsPostOperation Then 
         Dim pageNumber As Integer = _documentViewer.CurrentPageNumber 
         Dim infoLabel As Control = Me.Controls.Find("infoLabel", True)(0) 
         infoLabel.Text = "Current page number is " + pageNumber.ToString() 
      End If 
   End Sub

Requirements

Target Platforms

Reference

DocumentViewer Class

DocumentViewer Members

Leadtools.Documents.UI Namespace

Help Version 19.0.2017.10.27

Leadtools.Documents.UI.WinForms Assembly

Introduction

Getting Started

Namespaces

Leadtools.Documents.UI Namespace

Assemblies