インスタンスメソッド


contextHelp(forKey:)


バンドルのヘルプファイルから指定されたキーの文脈依存ヘルプを返します。



macOS 10.0+

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




パラメータ


key

返される文脈依存のヘルプを識別する、あなたのアプリケーションの Help.plist ファイル内のキー。



戻り値


アプリケーションに Help.plist ファイルがない場合、またはファイルに指定された key のエントリが含まれていない場合は、ヘルプ文字列または nil になります。


議論


あなたのアプリケーションをビルドするときに、/usr/bin/compileHelp ツールを使用して複数の RTF ベースのヘルプファイルを一緒に結合できます。このツールは、ヘルプファイル情報を Help.plist というプロパティリストにパッケージ化します。このプロパティリストファイルをアプリケーションバンドルに配置した後、このメソッドを使用してそこから文脈ヘルプ情報を抽出できます。特定のエントリを検索するには、このメソッドの key パラメータに元の RTF ヘルプファイルの名前を指定します。たとえば、アプリケーションプロジェクトに Copy.rtf というヘルプファイルが含まれている場合、値 @"Copy.rtf"key パラメータに渡すことで、このファイルからテキストを取得します。


このメソッドは NSHelpManager.h で宣言されています。





以下も見よ


関連した文書


func contextHelp(for: Any) -> NSAttributedString?

オブジェクトのコンテキスト (文脈) に応じたヘルプを返します。














トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ