Methods of the WORD CLIENT Object - Prefix BKM

BKM_ADD

Creates a bookmark to mark the current range. The current range may be collapsed. The bookmark name must contain a single word.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax
CALL_METHOD NameWordClientObject BKM_ADD BookmarkName ReturnCode
Parameters
BookmarkName	ALPHA(50) type (input parameter)
ReturnCode	NUM_BIN_4 type (output parameter)

BKM_EXISTS

Indicates whether a bookmark exists with the specified name.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax
CALL_METHOD NameWordClientObject BKM_EXISTS BookmarkName Existence ReturnCode
Parameters
BookmarkName	ALPHA(50) type (input parameter)
Existence	BOOL type (output parameter)
ReturnCode	NUM_BIN_4 type (output parameter)

BKM_DELETE

Deletes a given bookmark.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax
CALL_METHOD NameWordClientObject BKM_DELETE BookmarkName ReturnCode
Parameters
BookmarkName	ALPHA(50) type (input parameter)
ReturnCode	NUM_BIN_4 type (output parameter)

BKM_EMPTY

Indicates whether the bookmark with the specified name is empty.

The ReturnCode parameter will be set to "0" if the method is called successfully, or to a value other than "0" if this is not the case.

Syntax
CALL_METHOD NameWordClientObject BKM_EMPTY BookmarkName Contents ReturnCode
Parameters
BookmarkName	ALPHA(50) type (input parameter)
Contents	BOOL type (output parameter)
ReturnCode	NUM_BIN_4 type (output parameter)

See also...