OEM販売のご相談
ご相談ください!

PDF Tool APIサンプルコード:テキスト検索とハイライト注釈追加(注釈追加の位置指定処理)

機能イメージ

テキスト検索してハイライト注釈を追加します。(注釈追加の位置指定処理)

概要

サンプルコードの概要

指定したテキストで検索し、該当箇所の矩形座標を取得します。
このサンプルでは、その座標を使ってハイライト注釈を追加しています。
「座標の取得」と「注釈の追加」が独立しているため、ハイライト注釈以外にも応用ができます。
テキストの検索と注釈の追加を自動で行う「自動処理でハイライト注釈を追加する」関数もあります。

  • PtlParamSearchText: コンテント内のテキストを検索する為のパラメータを表現したクラス
  • PtlPDFDocument.searchText(): テキスト検索
  • PtlPage.searchText(): テキスト検索
  • PtlSearchTextResults: searchText関数で取得されるテキスト検索結果のコンテナを表現するクラス
  • PtlSearchTextResults.get(): テキスト検索結果を取得
  • PtlSearchTextResult: searchText関数で取得されるテキスト検索結果を表現したクラス
  • PtlSearchTextResults.getResultDetails(): テキスト検索結果の詳細コンテナを取得
  • PtlSearchTextResultDetails: テキスト検索結果の詳細のコンテナを表現するクラス
  • PtlSearchTextResultDetails.get(): テキスト検索結果の詳細を取得
  • PtlSearchTextResultDetail: テキスト検索結果の詳細を表現したクラス
  • PtlSearchTextResultDetail.getQuadPoint(): テキスト検索でヒットした文字のQuadPointを取得

サンプルコード

/*
	Antenna House PDF Tool API V8.0
	C++ Interface sample program

	概要:テキスト検索してハイライト注釈

	Copyright 2018-2026 Antenna House, Inc.
*/

#include < PdfTk.h >
#include < stdio.h >

using namespace PdfTk;

int main(int argc, char* argv[])
{
	if (argc < 4) {
		printf("usage: SearchTextAndHighlight.exe in-pdf-file out-pdf-file keyword\n");
		return 1;
	}
	try
	{
		PtlParamInput input(argv[1]);
		PtlParamOutput output(argv[2]);
		PtlParamString keyword(argv[3]);

		PtlPDFDocument doc;

		// PDFファイルをロードします。
		doc.load(input);

		PtlPages& pages = doc.getPages();

		// ハイライト注釈の色
		PtlColorDeviceRGB colorRed(1.0f, 0.0f, 0.0f);

		// 検索の為のパラメータ
		PtlParamSearchText paramSearchText;

		paramSearchText.appendText(keyword);
		paramSearchText.setTextType(PtlParamSearchText::TEXT_RAW);

		// 検索実行して検索結果コンテナ取得
		PtlSearchTextResults results = doc.searchText(paramSearchText);
		int numResults = results.getCount();
		for (int i=0; i < numResults; ++i) {
			// 検索結果取得
			PtlSearchTextResult& result = results.get(i);
			// 検索に使用したキーワード
			PtlParamString keyword = result.getKeyword();

			// ヒットしたページ番号
			int pageNumber = result.getPageNumber();
			PtlPage page = pages.get(pageNumber);
			PtlAnnots& annots = page.getAnnots();

			// 検索結果詳細コンテナ取得
			PtlSearchTextResultDetails& details = result.getResultDetails();
			int numDetails = details.getCount();
			for (int j=0; j < numDetails; ++j) {
				// 検索結果詳細取得
				PtlSearchTextResultDetail& resultDetail = details.get(j);
				// 検索に使用したキーワードの部分文字列
				PtlParamString keyword = resultDetail.getKeyword();
				//const char* keywordC = keyword.c_str();
				// 検索に使用したキーワードの部分文字列を囲むQuadPoint
				PtlQuadPoint quad = resultDetail.getQuadPoint();
				// 検索に使用したキーワードの部分文字列が縦書きか
				bool verticalWriting = resultDetail.isVerticalWriting();

				// 文字列にハイライト注釈を付ける
				PtlAnnotHighlight annot;
				PtlQuadPoints& quads = annot.getQuadPoints();
				quads.append(quad);
				annot.setVerticalDirection(verticalWriting);
				annot.setColor(colorRed);
				annot.setMarkUpCA(0.5f);

				annots.append(annot);
			}
		}

		// ファイルに保存します。
		doc.save(output);

		printf("完了!\n");
	}
	catch (const PtlException &e)
	{
		fprintf(stderr, "Error code : %d\n %s\n", e.getErrorCode(), e.getErrorMessage().c_str());
		return 1;
	}	
	return 0;
}


            
/*
    Antenna House PDF Tool API V8.0
    Java Interface sample program

    概要:テキスト検索してハイライト注釈

    Copyright 2018-2026 Antenna House, Inc.
*/

package Sample;

import jp.co.antenna.ptl.*;

public class SearchTextAndHighlight {

    /**
     * @param args the command line arguments
     */
    public static void main(String[] args) {
        if (args.length < 3)
        {
            System.out.println("usage: java SearchTextAndHighlight in-pdf-file out-pdf-file keyword");
            return;
        }

        try (PtlParamInput inputFile = new PtlParamInput(args[0]);
             PtlParamOutput outputFile = new PtlParamOutput(args[1]);
             PtlPDFDocument doc = new PtlPDFDocument())
        {
            // PDFファイルをロード
            doc.load(inputFile);

            try (PtlPages pages = doc.getPages()) // ページコンテナの取得
            {
                // ページコンテナが空かどうか
                if (pages.isEmpty())
                {
                    System.out.println("ページコンテナが空\n");
                    return;
                }

                try (PtlParamSearchText paramSearchText = new PtlParamSearchText();
                     PtlColorDeviceRGB colorRed = new PtlColorDeviceRGB(1.0f, 0.0f, 0.0f))
                {
                    // 検索設定
                    paramSearchText.appendText(args[2]);

                    // 検索実行して検索結果コンテナ取得
                    try (PtlSearchTextResults results = doc.searchText(paramSearchText))
                    {
                        int numResults = results.getCount();
                        for (int i = 0; i < numResults; ++i)
                        {
                            // 検索結果取得
                            try (PtlSearchTextResult result = results.get(i))
                            {
                                // 検索に使用したキーワード
                                String keyword = result.getKeyword();

                                // ヒットしたページ番号
                                int pageNumber = result.getPageNumber();
                                try (PtlPage page = pages.get(pageNumber);
                                     PtlAnnots annots = page.getAnnots();
                                    // 検索結果詳細コンテナ取得
                            		PtlSearchTextResultDetails details = result.getResultDetails())
                                {
                                    int numDetails = details.getCount();
                                    for (int j = 0; j < numDetails; ++j)
                                    {
                                        // 検索結果詳細取得
                                        try (PtlSearchTextResultDetail resultDetail = details.get(j))
                                        {
                                            // 検索に使用したキーワードの部分文字列
                                            String keywordD = resultDetail.getKeyword();

                                            try (PtlAnnotHighlight annot = new PtlAnnotHighlight();
                                                 PtlQuadPoints quads = annot.getQuadPoints())
                                            {
                                                // 検索に使用したキーワードの部分文字列を囲むQuadPoint
                                                try (PtlQuadPoint quad = resultDetail.getQuadPoint())
                                                {
                                                    quads.append(quad);
                                                }
                                                // 検索に使用したキーワードの部分文字列が縦書きか
                                                boolean verticalWriting = resultDetail.isVerticalWriting();
                                                annot.setVerticalDirection(verticalWriting);

                                                annot.setColor(colorRed);
                                                annot.setMarkUpCA(0.5f);

                                                annots.append(annot);
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }

            // ファイルに保存します。
            doc.save(outputFile);
        }
        catch (PtlException pex) {
             System.out.println("PtlException : ErrorCode = " + pex.getErrorCode() + "\n  " + pex.getErrorMessage());
        }
        catch (Exception ex) {
            System.out.println(ex.getMessage());
            ex.printStackTrace();
        }
        catch (Error ex) {
            System.out.println(ex.getMessage());
            ex.printStackTrace();
        }
        finally {
            System.out.println("-- 完了 --");
        }
    }
}

            
/*
	Antenna House PDF Tool API V8.0
	.NET Interface sample program

	概要:テキスト検索してハイライト注釈

	Copyright 2018-2026 Antenna House, Inc.
*/

using System;
using PdfTkNet;

namespace SearchTextAndHighlight
{
    class Program
    {
        static void Main(string[] args)
        {
            if (args.Length < 3)
            {
                Console.WriteLine("usage: SearchTextAndHighlight.exe in-pdf-file out-pdf-file keyword");
                return;
            }

            try
            {
                using (PtlParamInput inputFile = new PtlParamInput(args[0]))
                using (PtlParamOutput outputFile = new PtlParamOutput(args[1]))
                using (PtlPDFDocument doc = new PtlPDFDocument())
                {
                    // PDFファイルをロードします。
                    doc.load(inputFile);

                    // ページコンテナの取得
                    using (PtlPages pages = doc.getPages())
                    {
                        // ページコンテナが空かどうか
                        if (pages.isEmpty())
                        {
                            Console.WriteLine("ページコンテナが空");
                            return;
                        }
                        using (PtlParamSearchText paramSearchText = new PtlParamSearchText())  // 検索の為のパラメータ
                        using (PtlColorDeviceRGB colorRed = new PtlColorDeviceRGB(1.0f, 0.0f, 0.0f))
                        {
                            // 検索設定
                            paramSearchText.appendText(args[2]);

                            // 検索実行して検索結果コンテナ取得
                            using (PtlSearchTextResults results = doc.searchText(paramSearchText))
                            {
                                int numResults = results.getCount();
                                for (int i = 0; i < numResults; ++i)
                                {
                                    // 検索結果取得
                                    using (PtlSearchTextResult result = results.get(i))
                                    {
                                        // 検索に使用したキーワード
                                        String keyword = result.getKeyword();
                                        // ヒットしたページ番号
                                        int pageNumber = result.getPageNumber();
                                        using (PtlPage page = pages.get(pageNumber))
                                        using (PtlAnnots annots = page.getAnnots())
                                        // 検索結果詳細コンテナ取得
                                        using (PtlSearchTextResultDetails details = result.getResultDetails())
                                        {
                                            int numDetails = details.getCount();
                                            for (int j = 0; j < numDetails; ++j)
                                            {
                                                // 検索結果詳細取得
                                                using (PtlSearchTextResultDetail resultDetail = details.get(j))
                                                {
                                                    // 検索に使用したキーワードの部分文字列
                                                    String keywordD = resultDetail.getKeyword();
                                                    // 文字列にハイライト注釈を付ける
                                                    using (PtlAnnotHighlight annot = new PtlAnnotHighlight())
                                                    using (PtlQuadPoints quads = annot.getQuadPoints())
                                                    {
                                                        // 検索に使用したキーワードの部分文字列を囲むQuadPoint
                                                        using (PtlQuadPoint quad = resultDetail.getQuadPoint())
                                                        {
                                                            quads.append(quad);
                                                        }
                                                        // 検索に使用したキーワードの部分文字列が縦書きか
                                                        bool verticalWriting = resultDetail.isVerticalWriting();
                                                        annot.setVerticalDirection(verticalWriting);

                                                        annot.setColor(colorRed);
                                                        annot.setMarkUpCA(0.5f);

                                                        annots.append(annot);
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }

                    // ファイルに保存します。
                    doc.save(outputFile);
                }
            }
            catch (PtlException pex)
            {
                Console.WriteLine(pex.getErrorCode() + " : " + pex.getErrorMessageJP());
                pex.Dispose();
            }
            catch (Exception ex)
            {
                Console.WriteLine(ex.Message);
            }
            finally
            {
                Console.WriteLine("-- 完了 --");
            }
        }
    }
}

            

サンプルコードのダウンロードはこちら

実行例

コマンドラインでの実行例

SearchTextAndHighlight.exe C:\in\gon.pdf C:\sav\outSearchTextAndHighlight.pdf "「ごん、お前《まい》だったのか。いつも栗をくれたのは」"
完了!
java -jar SearchTextAndHighlight.jar C:\in\gon.pdf C:\sav\outSearchTextAndHighlight.pdf "「ごん、お前《まい》だったのか。いつも栗をくれたのは」"
-- 完了 --
SearchTextAndHighlight.exe C:\in\gon.pdf C:\sav\outSearchTextAndHighlight.pdf "「ごん、お前《まい》だったのか。いつも栗をくれたのは」"

出力結果イメージ

このサンプルでは検索のキーワードの矩形の四隅の座標を取得し、それを利用してハイライト注釈を追加します。
出力されたPDFでは"「ごん、お前《まい》だったのか。いつも栗をくれたのは」"の箇所にハイライト注釈が表示されます。

出力イメージ

サンプルコードのダウンロード

サンプルコード

サンプルで使用した入出力PDF