LEADTOOLS (Leadtools assembly)
LEAD Technologies, Inc

Page Property

Example 





Leadtools Namespace > RasterImage Class : Page Property
Gets or sets the current active page for this RasterImage. .NET support Silverlight support WinRT support
Syntax
public int Page {get; set;}
'Declaration
 
Public Property Page As Integer
'Usage
 
Dim instance As RasterImage
Dim value As Integer
 
instance.Page = value
 
value = instance.Page
public int Page {get; set;}
 get_Page();
 set_Page(value);  
public:
property int Page {
   int get();
   void set (    int value);
}

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
  
Public Sub PagesExample()
      Dim codecs As RasterCodecs = New RasterCodecs()

      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
public void PagesExample()
   {
      RasterCodecs codecs = new RasterCodecs();

      string srcFileName1 = Path.Combine(LEAD_VARS.ImagesDir, "eye.gif");
      string srcFileName2 = Path.Combine(LEAD_VARS.ImagesDir, "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();
   }

static class LEAD_VARS
{
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images";
}
RasterImageExamples.prototype.PagesExample = function ( )
{
   Tools.SetLicense ( ) ;
   with ( Leadtools ) {
      with ( Leadtools.Codecs ) {
         var codecs = new RasterCodecs();

         var srcFileName1 = "Assets\\eye.gif";
         var srcFileName2 = "Assets\\Image1.cmp";
         var srcImage;
         // Load the multi-page image
         return Tools.AppInstallFolder().getFileAsync(srcFileName1).then(function (loadFile) {

            return codecs.loadAsync(LeadStreamFactory.create(loadFile));
         })
         .then(function (img) {
            srcImage = img;
            // Show the number of pages in this file
            console.info("Pages in the image: ", srcImage.pageCount);

            // Show and change the active page
            console.info("Active page: ", srcImage.page);
            srcImage.Page = 3;
            console.info("Active page: ", srcImage.page);
            srcImage.Page = 1;

            // Load a single page image and add it to the end
            return Tools.AppInstallFolder().getFileAsync(srcFileName2);
         })
         .then(function (loadFile) {
            return codecs.loadAsync(LeadStreamFactory.create(loadFile));
         })
         .then(function (pageImage) {
            console.info("Adding a single page");

            srcImage.addPage(pageImage);
            console.info("Pages in the image: ", srcImage.pageCount);

            // Load a multi page image and add a few pages to this image
            return Tools.AppInstallFolder().getFileAsync(srcFileName1);
         })
         .then(function (loadFile) {
            return codecs.loadAsync(LeadStreamFactory.create(loadFile));
         })
         .then(function (pageImage) {
            console.info("Adding multi-pages");
            srcImage.addPages(pageImage, 1, 2);
            console.info("Pages in the image: ", srcImage.pageCount);

            // Insert a page in the middle
            console.info("Inserting a page");
            srcImage.insertPage(4, pageImage);
            console.info("Pages in the image: ", srcImage.pageCount);

            // Insert the rest of the pages at the beginning
            console.info("Inserting pages");
            srcImage.insertPages(0, pageImage, 1, -1);
            console.info("Pages in the image: ", srcImage.pageCount);

            // Remove the first page
            console.info("Removing a page");
            srcImage.removePageAt(1);
            console.info("Pages in the image: ", srcImage.pageCount);

            // Remove the last 3 pages
            console.info("Removing pages");
            srcImage.removePages(srcImage.pageCount - 3, -1);
            console.info("Pages in the image: ", srcImage.pageCount);

            // Remove all the pages (leaves 1)
            console.info("Removing all pages");
            srcImage.removeAllPages();
            console.info("Pages in the image: ", srcImage.pageCount);

            srcImage.close();
            codecs.close();
         });
      
      }}
   }
[TestMethod]
public async Task PagesExample()
{
   RasterCodecs codecs = new RasterCodecs();
   string srcFileName1 = @"Assets\eye.gif";
   string srcFileName2 = @"Assets\Image1.cmp";

   // Load the multi-page image
   StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName1);
   RasterImage srcImage = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));

   // 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;

   // Load a single page image and add it to the end
   loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName2);
   RasterImage pageImage = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));
   Debug.WriteLine("Adding a single page");
   srcImage.AddPage(pageImage);
   Debug.WriteLine("Pages in the image: {0}", srcImage.PageCount);

   // Load a multi page image and add a few pages to this image
   loadFile = await Tools.AppInstallFolder.GetFileAsync(srcFileName1);
   pageImage = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile));
   Debug.WriteLine("Adding multi-pages");
   srcImage.AddPages(pageImage, 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, pageImage);
   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, pageImage, 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();
   codecs.Dispose();
}
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();
}
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: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

RasterImage Class
RasterImage Members

 

 

Products | Support | Contact Us | Copyright Notices

© 2006-2012 All Rights Reserved. LEAD Technologies, Inc.