←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); 

Requirements

Target Platforms

Help Version 19.0.2017.10.19
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Controls.WinForms Assembly