GetPageViewPortID

Page properties, Measurement and coordinate units

Description

Returns a ViewPortID value for the specified viewport of the selected page.

This value can be used with the GetViewPortName and GetViewPortMeasureDict functions. Use the GetPageViewPortCount function to determine the number of viewports on the page.

Syntax

Delphi

function TPDFlib.GetPageViewPortID(Index: Integer): Integer;

ActiveX

Function PDFlib::GetPageViewPortID(Index As Long) As Long

DLL

int DLGetPageViewPortID(int InstanceID, int Index);

Parameters

IndexThe index of the viewport. The first viewport on the page has an index value of 1.

Return values

0The view port at the specified index could not be found
Non-zeroA ViewPortID value