GdPicture.NET.14.API
GdPicture14 Namespace / GdPicturePDF Class / OverlayPage Method / OverlayPage(GdPicturePDF,Int32,Single,Single,Single,Single) Method
A GdPicturePDF object. The source PDF document, which contains the page you want to use as overlay.
Page number that shall be used as overlay.
The horizontal (X) coordinate of the bottom left point, where the overlay page is to be drawn, expressed in the current units specified by the SetMeasurementUnit method with respect to the currently defined origin, related to the currently selected page.
The vertical (Y) coordinate of the bottom left point, where the overlay page is to be drawn, expressed in the current units specified by the SetMeasurementUnit method with respect to the currently defined origin, related to the currently selected page.
The horizontal scale factor for overlay, it corresponds to the overlay page width.

For example, if this parameter is set to 2.0, it multiplies the width of the overlay page by 2, and if it is set to 0.5, it divides the width by 2.

The vertical scale factor for overlay, it corresponds to the overlay page height.

For example, if this parameter is set to 2.0, it multiplies the height of the overlay page by 2, and if it is set to 0.5, it divides the height by 2.

Example





In This Topic
OverlayPage(GdPicturePDF,Int32,Single,Single,Single,Single) Method
In This Topic
Overlays currently selected page of loaded PDF document with specified page from other document.
Syntax
'Declaration
 
Public Overloads Function OverlayPage( _
   ByVal FromPDF As GdPicturePDF, _
   ByVal PageNo As Integer, _
   ByVal DstX As Single, _
   ByVal DstY As Single, _
   ByVal ScaleX As Single, _
   ByVal ScaleY As Single _
) As GdPictureStatus
public GdPictureStatus OverlayPage( 
   GdPicturePDF FromPDF,
   int PageNo,
   float DstX,
   float DstY,
   float ScaleX,
   float ScaleY
)
public function OverlayPage( 
    FromPDF: GdPicturePDF;
    PageNo: Integer;
    DstX: Single;
    DstY: Single;
    ScaleX: Single;
    ScaleY: Single
): GdPictureStatus; 
public function OverlayPage( 
   FromPDF : GdPicturePDF,
   PageNo : int,
   DstX : float,
   DstY : float,
   ScaleX : float,
   ScaleY : float
) : GdPictureStatus;
public: GdPictureStatus OverlayPage( 
   GdPicturePDF* FromPDF,
   int PageNo,
   float DstX,
   float DstY,
   float ScaleX,
   float ScaleY
) 
public:
GdPictureStatus OverlayPage( 
   GdPicturePDF^ FromPDF,
   int PageNo,
   float DstX,
   float DstY,
   float ScaleX,
   float ScaleY
) 

Parameters

FromPDF
A GdPicturePDF object. The source PDF document, which contains the page you want to use as overlay.
PageNo
Page number that shall be used as overlay.
DstX
The horizontal (X) coordinate of the bottom left point, where the overlay page is to be drawn, expressed in the current units specified by the SetMeasurementUnit method with respect to the currently defined origin, related to the currently selected page.
DstY
The vertical (Y) coordinate of the bottom left point, where the overlay page is to be drawn, expressed in the current units specified by the SetMeasurementUnit method with respect to the currently defined origin, related to the currently selected page.
ScaleX
The horizontal scale factor for overlay, it corresponds to the overlay page width.

For example, if this parameter is set to 2.0, it multiplies the width of the overlay page by 2, and if it is set to 0.5, it divides the width by 2.

ScaleY
The vertical scale factor for overlay, it corresponds to the overlay page height.

For example, if this parameter is set to 2.0, it multiplies the height of the overlay page by 2, and if it is set to 0.5, it divides the height by 2.

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
This method is only allowed for use with non-encrypted documents.

Be aware that the values of coordinates and dimensions are expressed in the current units defined by the GdPicturePDF.SetMeasurementUnit method according to the current coordinate space defined by the GdPicturePDF.SetOrigin method.

Example
How to overlay specified page from external document with curent page.

	
See Also