TiffInsertPageFromGdPictureImage(Int32,Int32,Int32) Method

In This Topic

Inserts a new page from the specified GdPicture image at a given position of an editable multipage TIFF image, that is represented by its unique image identifier.

This method only handles editable multipage TIFF images; otherwise it will fail.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Overloads Function TiffInsertPageFromGdPictureImage( _
   ByVal EditableTiffID As Integer, _
   ByVal Position As Integer, _
   ByVal ImageToAddID As Integer _
) As GdPictureStatus

public GdPictureStatus TiffInsertPageFromGdPictureImage( 
   int EditableTiffID,
   int Position,
   int ImageToAddID
)

public function TiffInsertPageFromGdPictureImage( 
    EditableTiffID: Integer;
    Position: Integer;
    ImageToAddID: Integer
): GdPictureStatus;

public function TiffInsertPageFromGdPictureImage( 
   EditableTiffID : int,
   Position : int,
   ImageToAddID : int
) : GdPictureStatus;

public: GdPictureStatus TiffInsertPageFromGdPictureImage( 
   int EditableTiffID,
   int Position,
   int ImageToAddID
)

public:
GdPictureStatus TiffInsertPageFromGdPictureImage( 
   int EditableTiffID,
   int Position,
   int ImageToAddID
)

Parameters

EditableTiffID: A unique image identifier of the GdPicture image representing the editable multipage TIFF image, in which the new page will be inserted.
Position: The required position of the page to insert, that means the page number for the newly inserted page. It must be a value from 1 to TiffGetPageCount.
ImageToAddID: A unique image identifier of the GdPicture image representing the image, which will be inserted at the given page position of the specified editable multipage TIFF image.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK. We strongly recommend always checking this status first.

Remarks

Be aware that this method only handles editable multipage TIFF images. You can use the TiffIsEditableMultiPage method to check if a required image is an editable multipage TIFF image.

Likewise, for saving the provided modifications you need to use the TiffSaveMultiPageToFile(Int32,String,TiffCompression) method.

This method requires the Image Documents component to run.

Reference

GdPictureImaging Class
GdPictureImaging Members
Overload List
TiffAppendPageFromGdPictureImage(Int32,Int32) Method
TiffInsertPageFromFile(Int32,Int32,String) Method
TiffAppendPageFromFile Method
TiffIsEditableMultiPage Method
TiffSaveMultiPageToFile(Int32,String,TiffCompression) Method