Bookmark Property of the Paragraph Object

Bookmark property of the Paragraph Object in the ABBYY FineReader Engine API — Provides access to a bookmark (technical or user) of the paragraph by its index; bookmark name includes a type prefix.

This property provides access to the bookmark of any type (technical or user) by its index in the internal collection of the paragraph’s bookmarks. The bookmark accessed via this property contains a prefix in its name.

Syntax

C++

HRESULT get_Bookmark(
   int   Index,
   BSTR* Bookmark
);

C#

string get_Bookmark( int Index );

Visual Basic .NET

ReadOnly Property Bookmark(Index As Integer) As String

Parameters

Index

[in] This variable contains the index of the bookmark in the internal collection of the paragraph’s bookmarks. The value of this property must be in range from 0 to IParagraph::BookmarkCount -1.

Bookmark

[out, retval] A pointer to BSTR variable that receives the bookmark.

Return values

This function has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

See also

Paragraph

Working with Properties