用C#寫個PDF批次合併工具簡化日常工作

IT老彭發表於2024-09-23
C#

一. 前言

由於專案需要編寫大量的材料，以及各種簽字表格、文書等，最後以PDF作為材料交付的文件格式，過程文件時有變化或補充，故此處理PDF文件已經成為日常工作的一部分。
網上有各種PDF處理工具，總是感覺用得不跟手。最後回顧自己的需求總結為以下幾項：
1.可以便捷、快速的對多份PDF進行合併。
2.可以從源PDF選取指定頁碼進行合併。
3.可以從單個PDF提取特定頁碼（拆分PDF）。
4.對多個PDF分組，合併作為最終PDF的導航書籤，可用作快速定位。
5.統一合成後PDF頁面尺寸，如統一為A4幅面。
6.操作儘量簡便，支援檔案拖放，不需要花巧的東西。

二、最終效果

首先，我們看看最終成品：

①.可以批次新增多個PDF到合併列表，也可以從資源管理器將檔案批次拖進來實現新增。
②.定義分組標題對檔案進行分組，並作為合併後PDF的書籤。
③.將列表中PDF批次合併到一個檔案中。如果只有一個PDF，而且定義了頁碼範圍，則轉換為拆分功能。
④.顯示PDF總頁數，如果只需提取部分內容，可以定義頁碼範圍。
⑤.可以更改合併後PDF頁面的尺寸，統一為A4、B4或A5幅面。

三、功能實現

搜尋發現github有個開源的PdfBinder1.2(https://github.com/schourode/pdfbinder)比較接近想要的效果，本著能省即省、成本最低、能效更高的原則，直接以此為基礎進行擴充套件，開發自身所需的功能。

1.新增檔案

這個比較簡單，點選按鈕後彈出選擇對話方塊，將選擇的檔案逐一加到ListBox中。

private void addFileButton_Click(object sender, EventArgs e)
{

    if (addFileDialog.ShowDialog() == DialogResult.OK)
    {
        foreach (string file in addFileDialog.FileNames)
        {
            AddInputFile(file);
        }
        UpdateUI();
    }
}

其中AddInputFile函式單獨編寫是為了在拖放事件中複用。

public void AddInputFile(string file)
{
    int Pages = 0;
    switch (Combiner.TestSourceFile(file, out Pages))
    {
        case Combiner.SourceTestResult.Unreadable:
            MessageBox.Show(string.Format(resources.GetString("Error.Unreadable.Text"), file), resources.GetString("Error.Unreadable.Title"), MessageBoxButtons.OK, MessageBoxIcon.Error);
            break;
        case Combiner.SourceTestResult.Protected:
            MessageBox.Show(string.Format(resources.GetString("Error.Protected.Text"), file), resources.GetString("Error.Protected.Title"), MessageBoxButtons.OK, MessageBoxIcon.Hand);
            break;
        case Combiner.SourceTestResult.Ok:
            FileListBox.Items.Add(new PdfInfo() { Fullname = file, Filename = Path.GetFileName(file), Ranges = "", TotalPages = Pages });
            break;
    }
}

這裡對PDF檔案有效性進行了檢查，而且新增到ListBox的是PdfInfo物件，它還記錄了總頁數、提取的頁面範圍等資訊。
檔案拖放的實現：

private void FileListBox_DragEnter(object sender, DragEventArgs e)
{
    e.Effect = e.Data.GetDataPresent(DataFormats.FileDrop, false) ? DragDropEffects.All : DragDropEffects.None;
}
private void FileListBox_DragDrop(object sender, DragEventArgs e)
{
    var fileNames = (string[])e.Data.GetData(DataFormats.FileDrop);
    Array.Sort(fileNames);

    foreach (var file in fileNames)
    {
        AddInputFile(file);
    }

    UpdateUI();
}

2.檔案分組（書籤）

using BookmarkName = System.String;
private void addBookmarkButton_Click(object sender, EventArgs e)
{
    //未新增檔案不處理
    if (FileListBox.SelectedIndex < 0) return;

    //如果選擇的書籤(組名），讀取名稱供修改
    BookmarkName bookmark = "";
    if (FileListBox.SelectedItem is BookmarkName)
        bookmark = (BookmarkName)FileListBox.SelectedItem;
    else 
    {
        //如果選擇的是檔案，提取檔名作預設值
        bookmark = ((PdfInfo)FileListBox.SelectedItem).Filename;
        if (bookmark.Contains("."))
            bookmark = bookmark.Substring(0, bookmark.LastIndexOf("."));
    }

    //如果輸入有效，新增書籤(組名）
    BookmarkName newName = Interaction.InputBox(resources.GetString("SetBookmark.Prompt"), resources.GetString("SetBookmark.Title"), bookmark);
    if (newName != "")
    {
        if (FileListBox.SelectedItem is BookmarkName)
            //更新
            FileListBox.Items[FileListBox.SelectedIndex] = newName;
        else
        {
            //新增
            FileListBox.Items.Insert(FileListBox.SelectedIndex, newName);
            BookmarkCounter++;
        }
    }
}

3.定義頁碼範圍

沒有定義頁碼範圍表示整個PDF進行合併。定義了頁面範圍，合併時只提取相應的頁面進行合併。
頁碼範圍的格式與常見的列印功能的頁碼定義相一致，如：1,2,3,6-9。
這個操作放在右鍵彈出選單中實現。

private void mnuSetPageRange_Click(object sender, EventArgs e)
{
    PdfInfo item = ((PdfInfo)FileListBox.SelectedItem);
    string range = Interaction.InputBox(resources.GetString("SetPageRange.Prompt"), resources.GetString("SetPageRange.Title"), item.Ranges);
    //內容未變更的不用處理
    if (range != item.Ranges)
    {
        if (range == "")
        {
            ((PdfInfo)FileListBox.Items[FileListBox.SelectedIndex]).Ranges = "";
            return;
        }

        //針對逗號和空格做處理
        string[] arr = range.Replace("，", ",").Replace(" ", "").Split(',');
        range = "";
        for (int i = 0; i < arr.Length; i++)
        {
            //用正規表示式判斷有效性
            if ("" == arr[i]) continue;
            if (Regex.IsMatch(arr[i], @"^\d+$") || Regex.IsMatch(arr[i], @"^\d+-\d+$"))
                range += ("" == range ? "" : ",") + arr[i];
            else
            {
                MessageBox.Show(resources.GetString("Error.RangeValid")); 
                return;
            }
        }
        //輸入有效，更新
        ((PdfInfo)FileListBox.Items[FileListBox.SelectedIndex]).Ranges = range;
        UpdateUI();
    }
}

4.自定義顯示

為了在ListBox中顯示書籤、總頁數和提取頁碼範圍，需要接管ListBox的繪製事件。

private void FileListBox_DrawItem(object sender, DrawItemEventArgs e)
{
    ...
    StringFormat Formater = new StringFormat();
    Formater.Alignment = StringAlignment.Near;
    Formater.LineAlignment = StringAlignment.Center;
    Formater.Trimming = StringTrimming.EllipsisPath;
    Formater.FormatFlags = StringFormatFlags.NoWrap;

    //繪製書籤（分組名）
    if (FileListBox.Items[e.Index] is BookmarkName)
    {
        //繪書籤（分組名）圖示
        e.Graphics.DrawImage(addBookmarkButton.Image, e.Bounds.X, e.Bounds.Y + ((e.Bounds.Height - addBookmarkButton.Image.Height) /2));
        //繪書籤（分組名）
        e.Graphics.DrawString((BookmarkName)FileListBox.Items[e.Index], e.Font, Brushes.Black
            , new Rectangle(e.Bounds.X + addBookmarkButton.Image.Width, e.Bounds.Y, e.Bounds.Width - RIGHT_MARGIN, e.Bounds.Height), Formater);
        return;
    }

    //繪製PDF檔名
    PdfInfo item = (PdfInfo)FileListBox.Items[e.Index];
    e.Graphics.DrawString(showNameButton.Checked ? item.Fullname : item.Filename, e.Font, Brushes.Black
        , new Rectangle(e.Bounds.X + (BookmarkCounter > 0 ? (int)(addBookmarkButton.Image.Width * 1.5) : 0), e.Bounds.Y, e.Bounds.Width - RIGHT_MARGIN, e.Bounds.Height), Formater);

    //繪製頁碼
    Formater.Alignment = StringAlignment.Far;
    e.Graphics.DrawString((item.Ranges == "" ? "" : item.Ranges + " | ") 
        + string.Format(item.TotalPages>1 ? resources.GetString("Pages"): resources.GetString("Page"), item.TotalPages)
        , e.Font, Brushes.Gray, e.Bounds, Formater);
}

5.定義頁面尺寸

預設是原始尺寸（不做調整），可根據需要選擇為A4、A5、B4。

private void OnPageSizeChanged(object sender, EventArgs e)
{
    PageSizeButton.Tag = ((ToolStripMenuItem)sender).Tag;
    mnuPageSize_Original.Checked = sender == mnuPageSize_Original;
    mnuPageSize_A4.Checked = sender == mnuPageSize_A4;
    mnuPageSize_A5.Checked = sender == mnuPageSize_A5;
    mnuPageSize_B4.Checked = sender == mnuPageSize_B4;
    if (mnuPageSize_Original.Checked)
        PageSizeButton.Text = resources.GetString("PageSizeButton.Text");
    else
        PageSizeButton.Text = resources.GetString("PageSizeButton.Text") + ":" + ((ToolStripMenuItem)sender).Text;
}

6.PDF批次合併

這個比較長，有興趣的可以到https://github.com/kacarton/PDFBinder2下載原始碼自己看，以下摘錄核心部分。

private void combineButton_Click(object sender, EventArgs e)
{
    if (saveFileDialog.ShowDialog() == DialogResult.OK)
    {
        using (var combiner = new Combiner(saveFileDialog.FileName, (PDFBinder.PageSize)PageSizeButton.Tag))
        {
            progressBar.Visible = true;
            this.Enabled = false;

            for (int i = 0; i < FileListBox.Items.Count; i++)
            {
                if (FileListBox.Items[i] is BookmarkName)
                    //向PDF新增書籤
                    combiner.AddBookmark((string)FileListBox.Items[i]);
                else
                    //合併PDF
                    combiner.AddFile(((PdfInfo)FileListBox.Items[i]).Fullname, ((PdfInfo)FileListBox.Items[i]).Ranges);
                //重新整理進度
                progressBar.Value = (int)(((i + 1) / (double)FileListBox.Items.Count) * 100);
            }

            this.Enabled = true;
            progressBar.Visible = false;
        }

        System.Diagnostics.Process.Start(saveFileDialog.FileName);
    }
}

class Combiner : IDisposable
{
    public void AddFile(string fileName, string range)
    {
        var reader = new PdfReader(fileName);
        ....
        _document.NewPage();
                
        //新增書籤
        if (!string.IsNullOrEmpty(this.BookMarkName))
        { 
            Chapter _chapter = new Chapter("", 1);
            _chapter.BookmarkTitle = this.BookMarkName;
            _chapter.BookmarkOpen = true;
            _document.Add(_chapter);
            this.BookMarkName = null;
        }

        if (_newPageSize == PageSize.Original)
        {
            var page = _pdfCopy.GetImportedPage(reader, i);
            _pdfCopy.AddPage(page);
        }
        else
        {
            var page = _writer.GetImportedPage(reader, i);
            _document.Add(iTextSharp.text.Image.GetInstance(page));
        }

        reader.Close();
    }
}

7.其他

UI同步、檔案移除、上移、下移、排序、多語言支援這些比較簡單就不展開了。

四、程式碼開源

原始碼已釋出在github上，網址：PDFBinder2 https://github.com/kacarton/PDFBinder2，歡迎交流。

相關文章