UserBookmark Property of the Paragraph Object

UserBookmark property of the Paragraph Object in the ABBYY FineReader Engine API — Provides access to a user bookmark by its index in the paragraph’s internal collection; the returned name does not include the type prefix.

This property provides access to the user bookmark by its index in the internal collection of the paragraph’s bookmarks. The bookmark accessed via this property does not contain a prefix in its name.

Syntax

C++

HRESULT get_UserBookmark(
   int   Index,
   BSTR* Bookmark
);

C#

string get_UserBookmark( int Index );

Visual Basic .NET

ReadOnly Property UserBookmark(Index As Integer) As String

Parameters

Index

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

Bookmark

[out, retval] A pointer to BSTR variable that receives the user 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