Leadtools Send comments on this topic. | Back to Introduction - All Topics | Help Version 15.3.5
InsertPage Method
See Also 
Leadtools Namespace > RasterImage Class : InsertPage Method




index
The 1-based index of the page from image to insert. If index is equal to -1, the page is inserted at the end. Use index = 0 to insert the new page as the beginning (first).
image
The image to add.
Inserts a new page into this RasterImage.

Syntax

Visual Basic (Declaration) 
Public Function InsertPage( _
   ByVal index As Integer, _
   ByVal image As RasterImage _
) As Integer
Visual Basic (Usage)Copy Code
Dim instance As RasterImage
Dim index As Integer
Dim image As RasterImage
Dim value As Integer
 
value = instance.InsertPage(index, image)
C# 
public int InsertPage( 
   int index,
   RasterImage image
)
Managed Extensions for C++ 
public: int InsertPage( 
   int index,
   RasterImage* image
) 
C++/CLI 
public:
int InsertPage( 
   int index,
   RasterImage^ image
) 

Parameters

index
The 1-based index of the page from image to insert. If index is equal to -1, the page is inserted at the end. Use index = 0 to insert the new page as the beginning (first).
image
The image to add.

Return Value

The 1-based index of the newly inserted page.

Example

For an example, refer to Page

Remarks

This method pulls the current active page of image and inserts into the current RasterImage object at index = index. The number of pages in image is decremented by one, if image had only one page prior to calling this method, then the image object is disposed of and should not be used afterwards.

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 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 or a RasterImage object unless otherwise indicated.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also