←Select platform

AddFromImage Method

Summary

Adds a new item from a RasterImage object.

Syntax

C#
VB
C++
public ImageViewerItem AddFromImage( 
   RasterImage rasterImage, 
   int pageNumber 
) 
Public Function AddFromImage( 
   ByVal rasterImage As RasterImage, 
   ByVal pageNumber As Integer 
) As ImageViewerItem 
public:  
   ImageViewerItem^ AddFromImage( 
      RasterImage^ rasterImage, 
      int pageNumber 
   ) 

Parameters

rasterImage

Source image.

pageNumber

1-based page number of rasterImage. Pass 1 if rasterImage contains a single page (frame).

Return Value

The newly created item if successful.

Remarks

Use AddFromSvgDocument to add an item from an SVG document.

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

ImageViewerItem item = new ImageViewerItem(); 
item.Image = rasterImage; 
item.PageNumber = pageNumber; 
imageViewer.Items.Add(item); 

If rasterImage is null, then an empty item is added.

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