Instance Method

searchString:inUserInterfaceItemString:searchRange:foundRange:

Searches for the string in the user interface.

Declaration

- (BOOL)searchString:(NSString *)searchString inUserInterfaceItemString:(NSString *)stringToSearch searchRange:(NSRange)searchRange foundRange:(NSRange *)foundRange;

Parameters

searchString

The search string.

stringToSearch

The string to search.

searchRange

The subrange of the stringToSearch to restrict the search to.

foundRange

Returns, by-reference, the range of the searchString within stringToSearch.

Return Value

YES if the searchString is matched, otherwise NO.

Discussion

The search uses the default matching rules for Spotlight for Help.

See Also

Providing Help Information

- registerUserInterfaceItemSearchHandler:

Register an object that provides help data to your app.

- unregisterUserInterfaceItemSearchHandler:

Unregister an object that provides help data to your app.

- showHelp:

If your project is properly registered, and the necessary keys have been set in the property list, this method launches Help Viewer and displays the first page of your app’s help book.

- activateContextHelpMode:

Places the receiver in context-sensitive help mode.

helpMenu

The help menu used by the app.