Share via


HOW TO:在 Windows 應用程式中提供說明

更新:2007 年 11 月

您可以使用 HelpProvider 元件將說明檔中的說明主題附加至 Windows Form 上的特定控制項。說明檔可以是 HTML 或 HTMLHelp 1.x 或更高階的格式。

注意事項:

根據目前使用的設定與版本,您所看到的對話方塊與功能表命令可能會與 [說明] 中所描述的不同。如果要變更設定,請從 [工具] 功能表中選取 [匯入和匯出設定]。如需詳細資訊,請參閱 Visual Studio 設定

若要提供說明

  1. 從 [工具箱] 將 HelpProvider 元件拖曳至表單。

    接著元件就會出現在 Windows Form 設計工具下方的匣中。

  2. 在 [屬性] 視窗中,將 HelpNamespace 屬性設定為 .chm、.col 或 .htm 說明檔。

  3. 選取表單上的另一個控制項,並在 [屬性] 視窗中設定 HelpKeyword 屬性。

    這是一個透過 HelpProvider 元件傳遞至說明檔的字串,用來召喚適當的說明主題。

  4. 在 [屬性] 視窗中,將 HelpNavigator 屬性設定為 HelpNavigator 列舉型別的值。

    這樣可以決定 HelpKeyword 屬性傳遞至說明系統的方式。下表列出可能的設定以及說明。

    成員名稱

    說明

    AssociateIndex

    指定特定主題的索引在特定 URL 中執行。

    Find

    指定顯示特定 URL 的搜尋網頁。

    Index

    指定顯示特定 URL 的索引。

    KeywordIndex

    指定要在特定的 URL 中搜尋的關鍵字和執行的動作。

    TableOfContents

    指定顯示 HTML 1.0 說明檔的目錄。

    Topic

    指定顯示特定 URL 所參考的主題。

在執行階段,如果焦點 (Focus) 在控制項上 (已設定 HelpKeywordHelpNavigator 屬性的控制項),則按下 F1 鍵會開啟和 HelpProvider 元件相關的說明檔。

目前 HelpNamespace 屬性可支援下列三種格式的說明檔:HTMLHelp 1.x、HTMLHelp 2.0 和 HTML。因此,您可以將 HelpNamespace 屬性設定為 http:// 位址 (例如 Web 網頁)。如果已經這麼做了,它會以做為錨定的 HelpKeyword 屬性中所指定的字串開啟預設瀏覽器並顯示 Web 網頁,此錨定是用來跳至 HTML 網頁的特定部分。

安全性注意事項:

在應用程式中使用從用戶端傳來的任何資訊前,請小心檢查。惡意使用者可能嘗試傳送或插入可執行的指令碼、SQL 陳述式或其他程式碼。在顯示使用者的輸入前,請先將它儲存在資料庫中或使用它,檢查它確實不包含可能不安全的資訊。檢查的一般方式,是從使用者接收輸入時,使用規則運算式尋找如「SCRIPT」之類的關鍵字。

您也可以使用 HelpProvider 元件來顯示快顯說明,即使您已將其設定為要顯示 Windows Form 上控制項的說明檔,也是一樣。如需詳細資訊,請參閱 HOW TO:顯示快顯說明

請參閱

工作

HOW TO:顯示快顯說明

概念

使用工具提示來顯示控制項說明

其他資源

整合 Windows Form 中的使用者說明

Windows Form