Instance Method インスタンスメソッド

contextHelp(forKey:)

Returns the context-sensitive help for the specified key from the bundle's help file. バンドルの持つヘルプファイルから、指定キーに対するコンテキスト依存ヘルプを返します。

Declaration 宣言

func contextHelp(forKey key: NSHelpManager.ContextHelpKey) -> NSAttributedString?

Parameters パラメータ

key

A key in your application's Help.plist file that identifies the context-sensitive help to return. あなたのアプリケーションの持つHelp.plistファイルの中のあるキー、それは返されることになるコンテキスト対応ヘルプを識別します。

Return Value 戻り値

The help string or nil if the application does not have a Help.plist file or the file does not contain an entry for the specified key. ヘルプ文字列、またはnil、もしアプリケーションがHelp.plistファイルを持たない、または指定されたkeyに対してファイルが何ら登録項目を含まないならば。

Discussion 議論

When you build your application, you can merge multiple RTF-based help files together using the /usr/bin/compileHelp tool, which then packages your help file information into a property list named Help.plist. After placing this property-list file in your application bundle, you can use this method to extract context help information from it. To look up a particular entry, you specify the name of the original RTF help file in the key parameter of this method. For example, if your application project contains a help file named Copy.rtf, you would retrieve the text from this file by passing the value @"Copy.rtf" to the key parameter. あなたがあなたのアプリケーションをビルドする時、あなたは複数のRTFに基づくヘルプファイルを、/usr/bin/compileHelpツールを使って1つに結合します、それはそれからあなたのヘルプファイル情報をHelp.plistと名付けられるプロパティリストにまとめます。このプロパティリストファイルをあなたのアプリケーションバンドルの中に置いた後、あなたはこのメソッドを使ってコンテキストヘルプ情報をそれから抽出します。特定の登録項目を捜すには、あなたは元のRTFヘルプファイルの名前をこのメソッドのkeyパラメータにおいて指定します。例えば、あなたのアプリケーションプロジェクトがCopy.rtfと命名されるヘルプファイルを含むならば、あなたはこのファイルからテキストを、値@"Copy.rtf"keyパラメータに渡すことによって回収します。

This method is declared in NSHelpManager.h. このメソッドは、NSHelpManager.hにおいて宣言されます。

See Also 参照

Related Documentation 関連文書