C# 如何生成CHM幫助文件

時間 2020-09-20

標籤 c# 如何生成 chm 幫助文件欄目 C# 简体版

原文原文鏈接

前一段時間應公司要求，讓我開發一個數據庫字段信息CHM幫助文件生成軟件。結果當時我就二了，這個東西我只用過，不知道咋作啊。沒想到老大很隨意說一句:"沒事，這個軟件我以前有有源碼，只不過如今不能用了，你等會參考一下就能夠了"。我當時還傻乎乎的謝天謝地，總算有源碼能夠參考了。當源代碼發過來之後，我頓時石化了，我。。。。。，那玩意兒用c++builder開發的，硬着頭皮看了一遍，全是帶*指針變量、數組、集合、函數，更要命的是，一個類裏面寫了四五千行沒注視的代碼，函數中五六百行代碼的有幾個。我說這不是坑人嘛？結果看了一天後，我果斷放棄看了那個源碼了，最後仍是的感謝網上活躍的一幫朋友，在一個源碼的幫助下（源碼我不知道怎麼上傳，），終於完成了任務啊，html

吐槽到此爲止，言歸正傳，首先以下：c++

生成事件sql

        /// <summary>
        /// 生成
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void button1_Click(object sender, EventArgs e)
        {
            try
            {
                if (!Directory.Exists("HTML"))  //判斷名爲HTML文件夾是否存在，不存在的話就建立一個
                {
                    Directory.CreateDirectory("HTML"); 
                }
                startPath = Application.StartupPath;//起始路徑
                OpenHhp(_defaultTopic);//打開hhp文件
                OpenHhc(_defaultTopic);//打開hhc文件
                OpenHhk();//打開hhk文件
                Compile();
                MessageBox.Show("生成成功！");
            }
            catch (Exception ex)
            {
                MessageBox.Show("生成失敗！");
                throw;
            }
          
        }

從方法中我能夠看出，咱們須要一個hhp文件，hhc文件，hhk文件，而後再執行compile方法就能夠了數據庫

首先動態生一個hhp，代碼以下：windows

 1   /// <summary>
 2         /// 建立hhp文件
 3         /// </summary>
 4         /// <param name="htmFile">htm文件名</param>
 5         public void OpenHhp(string htmFile)
 6         {
 7             FileStream fs = new FileStream("test.hhp", FileMode.Create); //建立hhp文件
 8             streamWriter = new System.IO.StreamWriter(fs, System.Text.Encoding.GetEncoding("GB18030"));
 9             
10 
11             streamWriter.WriteLine("[OPTIONS]");
12             streamWriter.WriteLine("Compatibility=1.1 or later");
13             streamWriter.WriteLine("Compiled file=" + textBox1 .Text.Trim()+ ".chm");      //定義生成文件名稱
14             streamWriter.WriteLine("Contents file=test.hhc");
15             streamWriter.WriteLine("Default topic=HTML\\所有對象.htm");
16             streamWriter.WriteLine("Display compile progress=Yes");
17             streamWriter.WriteLine("Index file=DBO_HELP.hhk");
18             streamWriter.WriteLine("Language=0x804 中文(中國)");
19             streamWriter.WriteLine("Title=數據庫結構展現");
20             streamWriter.WriteLine("      ");
21             streamWriter.WriteLine("[FILES]");
22             streamWriter.WriteLine("所有對象.htm");
23             streamWriter.WriteLine("       ");
24             streamWriter.WriteLine("[INFOTYPES]");
25             streamWriter.WriteLine(htmFile);
26             streamWriter.WriteLine();
27             streamWriter.Close();
28         }

這樣在項目的根目錄上面就生成了一個hhp文件
如今就要生成hhc文件了，它主要就是生成chm文件左邊顯示樹形的內容，當點擊節點，能夠超連接要顯示的頁面（其實CHM中的內容都是HTML，你能夠直接鏈接靜態網頁，），固然是顯示在右邊，而個人項目中要顯示東西都是動態生成HTML文件，因此這個生成有些複雜，不過我這裏會截取主要部分代碼講解：數組

  private void OpenHhc(string htmFile)
 {
     StringBuilder Modes = new StringBuilder();

   FileStream fs = new FileStream(GetContentsHtmlFilename(), FileMode.Create); //建立hhp文件
            streamWriter = new System.IO.StreamWriter(fs, System.Text.Encoding.GetEncoding("GB18030"));
            FileStream fs1 = new FileStream("HTML\\所有對象.htm", FileMode.Create); //
            str1 = new System.IO.StreamWriter(fs1, System.Text.Encoding.GetEncoding("GB18030"));
           
            streamWriter.WriteLine("<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">");
            streamWriter.WriteLine("<HTML>");
            streamWriter.WriteLine("<HEAD>");
            streamWriter.WriteLine("<meta name=\"GENERATOR\" content=\"Microsoft&reg; HTML Help Workshop 4.1\">");
            streamWriter.WriteLine("<!-- Sitemap 1.0 -->");
            streamWriter.WriteLine("</HEAD>");
            streamWriter.WriteLine("<BODY>");
            streamWriter.WriteLine("<OBJECT type=\"text/site properties\">");
            streamWriter.WriteLine("<param name=\"Window Styles\" value=\"0x800025\">");
            streamWriter.WriteLine("</OBJECT>");
           

            string sql = "SELECT mId,mName FROM Models";
            DataTable dt = DBHelper.getDatatable(sql);

            for (int i = 0; i < dt.Rows.Count; i++)
            {
                #region
                if (i == 0)
                    {
                        streamWriter.WriteLine("    <UL>");
                        streamWriter.WriteLine("        <LI> <OBJECT type=\"text/sitemap\">");
                        streamWriter.WriteLine("            <param name=\"Name\" value=\"數據庫服務器\">");
                        streamWriter.WriteLine("            <param name=\"Local\" value=\"HTML\\所有對象.htm\">");
                        streamWriter.WriteLine("            <param name=\"ImageNumber\" value=\"13\">");
                        streamWriter.WriteLine("            </OBJECT>");
                        streamWriter.WriteLine("    <UL>");
                       

                        Modes.Append("<!doctype html public \"-//W3C//DTD HTML 4.0 Transitional//EN\"> \r");
                        Modes.Append("<html>  \r");
                        Modes.Append("      <head>  \r");
                        Modes.Append("       <title>全部模塊</title>    \r");
                        Modes.Append("     <meta name=\"Generator\" content=\"EditPlus\">  \r");
                        Modes.Append("       <meta name=\"Author\" content=\"\"> \r");
                        Modes.Append("       <meta name=\"Keywords\" content=\"\">   \r");
                        Modes.Append("       <meta name=\"Description\" content=\"\">  \r");
                        Modes.Append("        </head> \r");
                        Modes.Append("       <body>  \r");
                        Modes.Append("       <div align=\"Center\" style=\"font-size:20px;font-width:bold;;color:green\">所有模塊</div>\r");
                        Modes.Append(" <hr color = #FF0000>");
                        Modes.Append("       <div align=\"Center\"><A href=\""+dt.Rows[i]["mName"].ToString()+".htm\">"+dt.Rows[i]["mName"].ToString()+"</A></div>\r");

                      
                    }
                    if (i > 0)
                    {
                      Modes.Append("  <br/>");
                        Modes.Append("       <div align=\"Center\"><A href=\"" + dt.Rows[i]["mName"].ToString() + ".htm\">"+dt.Rows[i]["mName"].ToString()+"</A></div>\r");
                    }
                  
                    streamWriter.WriteLine("        <LI> <OBJECT type=\"text/sitemap\">");
                    streamWriter.WriteLine("            <param name=\"Name\" value=\"" + dt.Rows[i]["mName"].ToString() + "\">");
                    streamWriter.WriteLine("            <param name=\"Local\" value=\"HTML\\" + dt.Rows[i]["mName"].ToString() + ".htm\">");
                    streamWriter.WriteLine("            <param name=\"ImageNumber\" value=\"21\">");
                    //streamWriter.WriteLine("            <param name=\"ImageNumber\" value=\"1\">");
                    streamWriter.WriteLine("            </OBJECT>");
 streamWriter.WriteLine("</UL>");
                    Modes.Append(" </BODY>\r</HTML>");
                   
            }
            streamWriter.WriteLine("</UL>\r</UL>\r</BODY>\r</HTML>");


            streamWriter.WriteLine();
            streamWriter.Close();
            str1.WriteLine(Modes);
            str1.Close();
           

           
        }
}

這語法很像HTML，但同時也不是，<UL></UL>表明一級節點，其中中間的 " <LI> <OBJECT type=\"text/sitemap\"><param name=\"Name\" value=\"數據庫服務器\"><param name=\"Local\" value=\"HTML\\所有對象.htm\"><param name=\"ImageNumber\" value=\"13\"></OBJECT>"這段代碼負責節點內容、鏈接、圖片顯示功能，若是<UL>內容嵌套的話，則表示下一級節點。還有我定義的modes，它主要負責生成一個Htm文件（記住用文件流生成，文件後綴名不要用html，而要用htm，否則會有錯誤，具體我也不知道啥緣由），這樣hhc文件生成在根目錄下服務器

接下來，則要生成hhk文件了函數

它主要負責你索引部分要顯示的內容，這裏生成也很簡單工具

 1 private void OpenHhk()
 2         {
 3             FileStream fs = new FileStream(startPath + @"\test.hhk", FileMode.Create); //建立hhp文件
 4             //streamWriter = new System.IO.StreamWriter(fs, System.Text.Encoding.GetEncoding("GB18030"));
 5             streamWriter = new System.IO.StreamWriter(fs, System.Text.Encoding.GetEncoding("UTF-8"));
 6             streamWriter.WriteLine("<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML//EN\">");
 7             streamWriter.WriteLine("<HTML>");
 8             streamWriter.WriteLine("<HEAD>");
 9             streamWriter.WriteLine("<meta name=\"GENERATOR\" content=\"Microsoft&reg; HTML Help Workshop 4.1\">");
10             streamWriter.WriteLine("<!-- Sitemap 1.0 -->");
11             streamWriter.WriteLine("</HEAD>");
12             streamWriter.WriteLine("<BODY>");
13             streamWriter.WriteLine("<UL>");
14             string sql = "SELECT dId,dName,status,dCreTime,dFieidNum,dChName,dFunctionDesc FROM Documents order by dName";
15             //string sqls = "";
16             DataTable dt1 = DBHelper.getDatatable(sql);
17             foreach (DataRow dr in dt1.Rows)
18             {
19                 streamWriter.WriteLine("    <LI> <OBJECT type=\"text/sitemap\">");
20                 streamWriter.WriteLine("        <param name=\"Name\" value=\"" + dr["dName"].ToString() + "\">");
21                 streamWriter.WriteLine("<param name=\"Local\" value=\"" + dr["dName"].ToString() + ".htm\">");
22                 streamWriter.WriteLine("</OBJECT>");
23             }
24             streamWriter.WriteLine("</UL>");
25             streamWriter.WriteLine("</BODY>");
26             streamWriter.WriteLine("</HTML>");
27             streamWriter.WriteLine();
28             streamWriter.Close();
29         }

執行之後就能夠在根目錄下生成hhk文件了post

到此爲止，生成chm文件的必須的三大文件已經搞定了，下面就是compile方法了

 1  string hhcFile = @"C:\Program Files\HTML Help Workshop\hhc.exe";//hhc.exe文件位置，windows自帶的，通常是這個路徑
 2         public string _defaultTopic = "";//默認的頁面
 3  private bool Compile()
 4         {
 5             string _chmFile = startPath + @"\test.chm";//chm文件存儲路徑
 6             Process helpCompileProcess = new Process();  //建立新的進程，用Process啓動HHC.EXE來Compile一個CHM文件
 7             try
 8             {
 9                 //判斷文件是否存在並不被佔用
10                 try
11                 {
12                     string path = _chmFile;  //chm生成路徑
13                     if (File.Exists(path))
14                     {
15                         File.Delete(path);
16                     }
17                 }
18                 catch(Exception e)
19                 {
20                     throw new Exception("文件被打開！");
21                 }
22 
23                 ProcessStartInfo processStartInfo = new ProcessStartInfo();
24                 processStartInfo.WindowStyle = ProcessWindowStyle.Hidden;
25                 processStartInfo.FileName = hhcFile;  //調入HHC.EXE文件 
26                 processStartInfo.Arguments = "\"" + GetPathToProjectFile() + "\"";//獲取空的HHP文件
27                 processStartInfo.UseShellExecute = false;
28                 helpCompileProcess.StartInfo = processStartInfo;
29                 helpCompileProcess.Start();
30                 helpCompileProcess.WaitForExit(); //組件無限期地等待關聯進程退出
31 
32                 if (helpCompileProcess.ExitCode == 0)
33                 {
34                     MessageBox.Show(new Exception().Message);
35                     return false;
36                 }
37             }
38             finally
39             {
40                 helpCompileProcess.Close();
41             }
42             return true;
43         }