Debenu Quick PDF logo

SetAnnotOptional

Annotations and hotspot links, Content Streams and Optional Content Groups

Version history

This function was introduced in Quick PDF Library version 11.14.

Description

Adds an annotation to the specified optional content group. This allows the annotation to be made visible or hidden using the layers functionality within the PDF viewer.

Syntax

Delphi

function TDebenuPDFLibrary1511.SetAnnotOptional(Index, 
  OptionalContentGroupID: Integer): Integer;

ActiveX

Function DebenuPDFLibrary1511.PDFLibrary::SetAnnotOptional(Index As Long,
  OptionalContentGroupID As Long) As Long

DLL

int DPLSetAnnotOptional(int InstanceID, int Index, int OptionalContentGroupID)

Parameters

Index The index of the annotation. The first annotation on the page has an index of 1.
OptionalContentGroupID An ID returned by the NewOptionalContentGroup, GetOptionalContentGroupID or GetOptionalContentConfigOrderItemID functions

Return values

0 The annotation could not be added to the specified optional content group
1 Success

Copyright © 2014 Debenu. All rights reserved. AboutContactBlogNewsletterSupport