SetAnnotIntProperty

Annotations and hotspot links

Description

Sets an integer property of the specified annotation.

When Tag is 109, NewValue is written as the annotation /F flags value. Versioned flags auto-select the required PDF version: NoZoom, NoRotate, NoView, and ReadOnly raise the document to PDF 1.3; Locked raises it to PDF 1.4; ToggleNoView raises it to PDF 1.5; and LockedContents raises it to PDF 1.7. Locked lower save versions still fail through the compatibility gate.

Syntax

Delphi

function TPDFlib.SetAnnotIntProperty(Index, Tag, NewValue: Integer): Integer;

ActiveX

Function PDFlib::SetAnnotIntProperty(Index As Long, Tag As Long, NewValue As Long) As Long

DLL

int DLSetAnnotIntProperty(int InstanceID, int Index, int Tag, int NewValue);

Parameters

IndexThe index of the annotation. The first annotation on the page has an index of 1. 116 = Page number of "GoToR" action (1 is first page) 131 = Page number of "GoTo" action
TagThe new value of the specified annotation and property.
NewValue

Return values

0The annotation specified by the Index parameter was out of range or the Tag parameter was not valid
1The annotation property was set successfully