←Select platform

AddFromImageFile Method

Summary

Adds a new raster image item from a disk file.

Syntax
C#
VB
C++
public ImageViewerItem AddFromImageFile( 
   string fileName, 
   int pageNumber 
) 
Public Function AddFromImageFile( 
   ByVal fileName As String, 
   ByVal pageNumber As Integer 
) As ImageViewerItem 
public:  
   ImageViewerItem^ AddFromImageFile( 
      String^ fileName, 
      int pageNumber 
   ) 

Parameters

fileName

Disk file containing the image file.

pageNumber

The 1-based page number to load. Use this if fileName contains more than one page. Pass 1 to load

the first page found.

Return Value

The newly created item of successful

Remarks

This method will load the data as a raster image using ImageViewer.RasterCodecsInstance.Load. To load the data as an SVG document, use AddFromSvgFile.

This method allows you to quickly add an item from a disk file. It is the equivalent of the following code:

ImageViewerItem item = new ImageViewerItem(); 
item.Image = imageViewer.RasterCodecsInstance.Load(fileName, pageNumber); 
imageViewer.Items.Add(item); 

Example
C#
VB
using Leadtools; 
using Leadtools.Controls; 
using Leadtools.Codecs; 
using Leadtools.Drawing; 
using LeadtoolsExamples.Common; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
 
try 
{ 
   string fileName = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.tif"); 
   _imageViewer.Items.AddFromImageFile(fileName, 1); 
} 
catch (Exception ex) 
{ 
   MessageBox.Show(ex.Message, "Error"); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
} 
Imports Leadtools 
Imports Leadtools.Controls 
Imports Leadtools.Codecs 
Imports Leadtools.Drawing 
Imports Leadtools.ImageProcessing 
Imports Leadtools.ImageProcessing.Color 
Imports Leadtools.Svg 
 
Try 
   Dim fileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.tif") 
   _imageViewer.Items.AddFromImageFile(fileName, 1) 
Catch ex As Exception 
   MessageBox.Show(ex.Message, "Error") 
End Try 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class 

Requirements

Target Platforms

Help Version 20.0.2019.3.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Controls Assembly