GdPicture.NET Reference Guide
TiffInsertPageFromFile Method (GdPictureImaging)





GdPicture14 Namespace > GdPictureImaging Class : TiffInsertPageFromFile Method
A unique image identifier of the GdPicture image representing the editable multipage TIFF image, in which the new page will be inserted.
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.
The file path of the image file, which will be inserted at the given page position of an editable multipage TIFF image.

Supported input document formats are listed here.

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

Please note that this method only handles editable multipage TIFF images; otherwise it will fail.

Syntax
'Declaration
 
Public Function TiffInsertPageFromFile( _
   ByVal EditableTiffID As Integer, _
   ByVal Position As Integer, _
   ByVal FilePath As String _
) As GdPictureStatus
public GdPictureStatus TiffInsertPageFromFile( 
   int EditableTiffID,
   int Position,
   string FilePath
)
public function TiffInsertPageFromFile( 
    EditableTiffID: Integer;
    Position: Integer;
    FilePath: String
): GdPictureStatus; 
public function TiffInsertPageFromFile( 
   EditableTiffID : int,
   Position : int,
   FilePath : String
) : GdPictureStatus;
public: GdPictureStatus TiffInsertPageFromFile( 
   int EditableTiffID,
   int Position,
   string* FilePath
) 
public:
GdPictureStatus TiffInsertPageFromFile( 
   int EditableTiffID,
   int Position,
   String^ FilePath
) 

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.
FilePath
The file path of the image file, which will be inserted at the given page position of an editable multipage TIFF image.

Supported input document formats are listed here.

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.

See Also

Reference

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