NSHelpManagerMBS.Constructor

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Cocoa	MBS MacBase Plugin	11.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Creates an NSHelpManagerMBS object in Xojo which points to the shared NSHelpManager object.

NSHelpManagerMBS.findString(query as string, book as string)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Cocoa	MBS MacBase Plugin	11.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Performs a search for the specified string in the specified book.

query: String to search for.
book: Localized help book to search. When "", all installed help books are searched.

NSHelpManagerMBS.openHelpAnchor(anchor as string, book as string)

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Cocoa	MBS MacBase Plugin	11.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Finds and displays the text at the given anchor location in the given book.

anchor: Location of the desired text.
book: Help book containing the anchor. When "", all installed help books are searched.

NSHelpManagerMBS.registerBooksInBundle(bundle as NSBundleMBS) as boolean

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Cocoa	MBS MacBase Plugin	11.1	✅ Yes	❌ No	❌ No	❌ No	Desktop only

Registers one or more help books in the given bundle.

bundle: The bundle for additional help books. Books in the main bundle are automatically registered.

Returns true if registration is successful, false if if the bundle doesn't contain any help books or if registration fails.

You use registerBooksInBundle to register help books in, for example, a plug-in bundle. The Info.plist in the bundle should contain a help book directory path, which specifies one or more folders containing help books.

The main bundle is automatically registered by openHelpAnchor and findString.