GetOutlineIsOpen

Outlines

Description

Reports whether an outline item (bookmark) is expanded in a viewer. A bookmark counts as open when its visible descendant count is zero or positive; a negative count means the viewer collapses the node and hides its descendants

Syntax

Delphi

Function TPDFlib.GetOutlineIsOpen(OutlineID: Integer): Integer;

Parameters

OutlineID	The ID of the outline as returned by the NewOutline function. Alternatively, use the GetOutlineID function to get a valid outline ID

Return values

1	The bookmark is expanded and its descendants are visible
0	The bookmark is collapsed, or OutlineID is not a valid outline handle

Remarks

A bookmark without a /Count entry is a leaf node and is treated as open. Use GetOutlineLevel to query how deeply the bookmark is nested below the outline root