Page Property

Summary

Gets or sets the current active page for this RasterImage.

Syntax

Objective-C

C++

Java

public int Page { get; set; }

Public Property Page As Integer

@property (nonatomic, assign) NSInteger page

public int getPage() 
public void setPage(int value)

public: 
property int Page { 
   int get(); 
   void set (    int ); 
}

Property Value

The 1-based index of the current page for this RasterImage.

Remarks

The RasterImage object can hold multiple pages with different sizes. The AddPage, AddPages, InsertPage and InsertPages methods allows adding new pages to an existing RasterImage.

The RemovePageAt, RemovePages and RemoveAllPages methods allows removing existing pages from a RasterImage object.

The ReplacePage and ReplacePages methods allows replace existing pages in a RasterImage object.

The PageCount property holds the total number of pages in a RasterImage object while the Page property allows you to change the current active page.

The current active page (The page indicated by the Page property) is used by default when accessing the data of a RasterImage object unless otherwise indicated.

Example

This example demonstrates how to deal with multipage RasterImage objects.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Core; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Dicom; 
using Leadtools.Drawing; 
using Leadtools.Controls; 
using LeadtoolsExamples.Common; 
using Leadtools.Svg; 
 
public void PagesExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.Options.Load.AllPages = true; 
 
   string srcFileName1 = Path.Combine(ImagesPath.Path, "eye.gif"); 
   string srcFileName2 = Path.Combine(ImagesPath.Path, "image1.cmp"); 
 
   // Load the multi-page image 
   RasterImage srcImage = codecs.Load(srcFileName1); 
 
   // Show the number of pages in this file 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   // Show and change the active page 
   Console.WriteLine("Active page: {0}", srcImage.Page); 
   srcImage.Page = 3; 
   Console.WriteLine("Active page: {0}", srcImage.Page); 
   srcImage.Page = 1; 
 
   // Load a single page image and add it to the end 
   RasterImage pageImage = codecs.Load(srcFileName2); 
   Console.WriteLine("Adding a single page"); 
   srcImage.AddPage(pageImage); 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   // Load a multi page image and add a few pages to this image 
   pageImage = codecs.Load(srcFileName1); 
   Console.WriteLine("Adding multi-pages"); 
   srcImage.AddPages(pageImage, 1, 2); 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   // Insert a page in the middle 
   Console.WriteLine("Inserting a page"); 
   srcImage.InsertPage(4, pageImage); 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   // Insert the rest of the pages at the beginning 
   Console.WriteLine("Inserting pages"); 
   srcImage.InsertPages(0, pageImage, 1, -1); 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   // Remove the first page 
   Console.WriteLine("Removing a page"); 
   srcImage.RemovePageAt(1); 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   // Remove the last 3 pages 
   Console.WriteLine("Removing pages"); 
   srcImage.RemovePages(srcImage.PageCount - 3, -1); 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   // Remove all the pages (leaves 1) 
   Console.WriteLine("Removing all pages"); 
   srcImage.RemoveAllPages(); 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   srcImage.Dispose(); 
   codecs.Dispose(); 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Core 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Controls 
Imports Leadtools.Dicom 
Imports Leadtools.Drawing 
Imports Leadtools.Svg 
 
Public Sub PagesExample() 
   Dim codecs As RasterCodecs = New RasterCodecs() 
   codecs.Options.Load.AllPages = True 
 
   Dim srcFileName1 As String = Path.Combine(LEAD_VARS.ImagesDir, "eye.gif") 
   Dim srcFileName2 As String = Path.Combine(LEAD_VARS.ImagesDir, "image1.cmp") 
 
   ' Load the multi-page image 
   Dim srcImage As RasterImage = codecs.Load(srcFileName1) 
 
   ' Show the number of pages in this file 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   ' Show and change the active page 
   Console.WriteLine("Active page: {0}", srcImage.Page) 
   srcImage.Page = 3 
   Console.WriteLine("Active page: {0}", srcImage.Page) 
   srcImage.Page = 1 
 
   ' Load a single page image and add it to the end 
   Dim pageImage As RasterImage = codecs.Load(srcFileName2) 
   Console.WriteLine("Adding a single page") 
   srcImage.AddPage(pageImage) 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   ' Load a multi page image and add a few pages to this image 
   pageImage = codecs.Load(srcFileName1) 
   Console.WriteLine("Adding multi-pages") 
   srcImage.AddPages(pageImage, 1, 2) 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   ' Insert a page in the middle 
   Console.WriteLine("Inserting a page") 
   srcImage.InsertPage(4, pageImage) 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   ' Insert the rest of the pages at the beginning 
   Console.WriteLine("Inserting pages") 
   srcImage.InsertPages(0, pageImage, 1, -1) 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   ' Remove the first page 
   Console.WriteLine("Removing a page") 
   srcImage.RemovePageAt(1) 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   ' Remove the last 3 pages 
   Console.WriteLine("Removing pages") 
   srcImage.RemovePages(srcImage.PageCount - 3, -1) 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   ' Remove all the pages (leaves 1) 
   Console.WriteLine("Removing all pages") 
   srcImage.RemoveAllPages() 
   Console.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   srcImage.Dispose() 
   codecs.Dispose() 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

c#[Silverlight C# Example] 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Dicom; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Core; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Examples; 
using Leadtools.Windows.Media; 
 
public void PagesExample(RasterImage image) 
{ 
   RasterImage srcImage = image; // should be a multi-page image (eye.gif) 
 
   // Show the number of pages in this file 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   // Show and change the active page 
   Debug.WriteLine("Active page: {0}", srcImage.Page); 
   srcImage.Page = 3; 
   Debug.WriteLine("Active page: {0}", srcImage.Page); 
   srcImage.Page = 1; 
 
   // create a new image and add it to the end 
   RasterImage pageImage = new RasterImage(RasterMemoryFlags.Conventional, 200, 200, 8, RasterByteOrder.Bgr, RasterViewPerspective.TopLeft, null, null, 0); 
   Debug.WriteLine("Adding a single page"); 
   srcImage.AddPage(pageImage); 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   // create a multi page image and add a few pages to this image 
   RasterImage multiPageImage = new RasterImage(RasterMemoryFlags.Conventional, 200, 200, 8, RasterByteOrder.Bgr, RasterViewPerspective.TopLeft, null, null, 0); 
   // add a few more pages 
   for (int x = 0; x < 10; x++) 
   { 
      pageImage = new RasterImage(RasterMemoryFlags.Conventional, 200, 200, 8, RasterByteOrder.Bgr, RasterViewPerspective.TopLeft, null, null, 0); 
      multiPageImage.AddPage(pageImage); 
   } 
 
   Debug.WriteLine("Adding multi-pages"); 
   srcImage.AddPages(multiPageImage, 1, 2); 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   // Insert a page in the middle 
   Debug.WriteLine("Inserting a page"); 
   srcImage.InsertPage(4, multiPageImage); 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   // Insert the rest of the pages at the beginning 
   Debug.WriteLine("Inserting pages"); 
   srcImage.InsertPages(0, multiPageImage, 1, -1); 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   // Remove the first page 
   Debug.WriteLine("Removing a page"); 
   srcImage.RemovePageAt(1); 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   // Remove the last 3 pages 
   Debug.WriteLine("Removing pages"); 
   srcImage.RemovePages(srcImage.PageCount - 3, -1); 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   // Remove all the pages (leaves 1) 
   Debug.WriteLine("Removing all pages"); 
   srcImage.RemoveAllPages(); 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount); 
 
   srcImage.Dispose(); 
} 
vb[Silverlight VB Example] 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Dicom 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Core 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Windows.Media 
 
Public Sub PagesExample(ByVal image As RasterImage) 
   Dim srcImage As RasterImage = image ' should be a multi-page image (eye.gif) 
 
   ' Show the number of pages in this file 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   ' Show and change the active page 
   Debug.WriteLine("Active page: {0}", srcImage.Page) 
   srcImage.Page = 3 
   Debug.WriteLine("Active page: {0}", srcImage.Page) 
   srcImage.Page = 1 
 
   ' create a new image and add it to the end 
   Dim pageImage As RasterImage = New RasterImage(RasterMemoryFlags.Conventional, 200, 200, 8, RasterByteOrder.Bgr, RasterViewPerspective.TopLeft, Nothing, Nothing, 0) 
   Debug.WriteLine("Adding a single page") 
   srcImage.AddPage(pageImage) 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   ' create a multi page image and add a few pages to this image 
   Dim multiPageImage As RasterImage = New RasterImage(RasterMemoryFlags.Conventional, 200, 200, 8, RasterByteOrder.Bgr, RasterViewPerspective.TopLeft, Nothing, Nothing, 0) 
   ' add a few more pages 
   For x As Integer = 0 To 9 
      pageImage = New RasterImage(RasterMemoryFlags.Conventional, 200, 200, 8, RasterByteOrder.Bgr, RasterViewPerspective.TopLeft, Nothing, Nothing, 0) 
      multiPageImage.AddPage(pageImage) 
   Next x 
 
   Debug.WriteLine("Adding multi-pages") 
   srcImage.AddPages(multiPageImage, 1, 2) 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   ' Insert a page in the middle 
   Debug.WriteLine("Inserting a page") 
   srcImage.InsertPage(4, multiPageImage) 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   ' Insert the rest of the pages at the beginning 
   Debug.WriteLine("Inserting pages") 
   srcImage.InsertPages(0, multiPageImage, 1, -1) 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   ' Remove the first page 
   Debug.WriteLine("Removing a page") 
   srcImage.RemovePageAt(1) 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   ' Remove the last 3 pages 
   Debug.WriteLine("Removing pages") 
   srcImage.RemovePages(srcImage.PageCount - 3, -1) 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   ' Remove all the pages (leaves 1) 
   Debug.WriteLine("Removing all pages") 
   srcImage.RemoveAllPages() 
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount) 
 
   srcImage.Dispose() 
End Sub

Requirements

Target Platforms

Reference

RasterImage Class

RasterImage Members

Download our FREE evaluation

Help Version 20.0.2020.4.2

Leadtools Assembly

Introduction

Getting Started

Namespaces

Leadtools Namespace

Leadtools.ImageProcessing Namespace

Assemblies