InsertFromImageFile Method

Summary

Inserts a new raster image item from a disk file.

Syntax

C++

public ImageViewerItem InsertFromImageFile( 
   int index, 
   string fileName, 
   int pageNumber 
)

Public Function InsertFromImageFile( 
   ByVal index As Integer, 
   ByVal fileName As String, 
   ByVal pageNumber As Integer 
) As ImageViewerItem

public:  
   ImageViewerItem^ InsertFromImageFile( 
      int index, 
      String^ fileName, 
      int pageNumber 
   )

Parameters

index

0-based index of the item.

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 InsertFromSvgFile.

This method allows you to quickly insert 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.Insert(index, item);

Requirements

Target Platforms