PDF 構文 インタラクティブ 機能 [Form]

インタラクティブ フォーム(AcroForm とも呼ばれます)は、ユーザーからインタラクティブに情報を収集するためのフィールドの集まりです。
PDF文書にはページに表示される任意の数のフィールドを含めることができ、そのすべてが文書全体にわたる単一のグローバルなインタラクティブ フォームを構成します。
これらのフィールドの任意のサブセットを文書からインポートまたはエクスポートできます。

非インタラクティブ フォームは、フォーム フィールドの静的な表現です。
このフォームに元はインタラクティブなフィールド(テキストフィールドやラジオボタンなど)が含まれていたものが非インタラクティブなPDFファイルに変換された可能性があり、 フォーム フィールドや外部ソースから変換されたデータを表している可能性があります。

文書フォームの各フィールドは、Fieldディクショナリによって定義されます。 定義と命名のためにFieldを階層的に編成しField階層の祖先から属性を継承できます。 階層内のFieldの子にはページ内での外観(Appearance)を定義するWidget(ウィジェット)アノテーションを含めることができます。

Fieldの内で子を持つものを非終端フィールド(non-terminal field)といい、子を持たないものを終端フィールド(terminal field)といいます。

インタラクティブ フォームの終端フィールドには、ページ内での外観を定義するWidgetアノテーションである子を含める場合があります。

PDF Imager-LP（無償版）でPDF文書のフォント名を取得するソースコード

// 初期化
MlpInitialize("0-0GR8-HE1103E6R1G6");

// オープン
if (0 <= MlpOpenDoc("HelloWorld.pdf", "", ""))
{
    // 最初のフォーム データ
    MlpFormData res = MlpInterractiveFormFirstData();
    if (res.type > 0) {
        printf("*** FORM DATA ***\n");
        showData(&res);

        // ２番目以降のフォーム データ
        while(1) {
            res = MlpInterractiveFormNextData();
            if (res.type < 1) break;
            showData(&res);
        }
        printf("\n\n");
    }
    else
        printf("The document has not AcroForm\n\n");

    // クローズ
    MlpCloseDoc();
}

// 後始末
MlpUninitialize();

using (var mlp = new PdfImager()){

    // ライセンスキー
    mlp.Initialize("0-0GR8-HE1103E6R1G6");

    // オープン
    if (0 <= mlp.OpenDoc("HelloWorld.pdf"))
    {
        // PDF文書内のフォント総数
        Console.WriteLine("フォント総数: {0}", mlp.SimpleFontListLength());

        // 最初のフォームデータ
        FormData res = mlp.InterractiveFormFirstData();
        if (res.type > 0)
        {
            Console.WriteLine("*** FORM DATA ***");
            ShowData(res);

            // ２番目以降のフォームデータ
            while (true)
            {
                res = mlp.InterractiveFormNextData();
                if (res.type <= 0) break;
                ShowData(res);
            }
            Console.WriteLine("\n");
        }
        else
            Console.WriteLine("No Form Data");

        // クローズ
        mlp.CloseDoc();
    }
}

import PdfImagerLP

# インスタンス生成
mlp = PdfImagerLP.Mlp();

# 初期化
res = mlp.Initialize('0-0GR8-HE1103E6R1G6')
if res!=0:
    print('Bad License Key.')
    exit()

# オープン
if 0 <= mlp.OpenDoc('HelloWorld.pdf'):

    # 最初のフォーム データ
    d = mlp.InteractiveFormFirstData()
    if d.type > 0:
        print('*** FORM DATA ***')
        show_data(d)

        # ２番目以降のフォーム データ
        while(True):
            d = mlp.InteractiveFormNextData()
            if d.type < 1:
                break
            show_data(d)
    else:
        print('No Form')
    print()

    # クローズ
    mlp.CloseDoc()

# 後始末
mlp.Uninitialize()

文書のインタラクティブ フォーム のコンテンツとプロパティはインタラクティブ フォーム ディクショナリに定義されます。このディクショナリはドキュメント カタログであるカタログ ディクショナリ のAcroForm項目から参照されなければなりません。

インタラクティブ フォーム ディクショナリには、以下の項目が含まれます。

オブジェクトのタイプは「2.5オブジェクト」を参照してください。

上記のディクショナリのSigFlagエントリは文書レベルでの署名フィールド特性を以下のようにそのビット位置の値で定義します。

インタラクティブ フォームのそれぞれのField(フィールド)はこのFieldディクショナリで定義されます。
Fieldディクショナリは１つ以上のツリー構造で階層的に構成されます。
多くのField属性は継承できますので、特定のFieldで明示指定されていない場合その値はField階層内の親から取得します。

Fieldディクショナリには、以下の項目が含まれます。
このFieldが端末Fieldであった場合は、外観を定義するWidgetアノテーションの要素が含まれる場合があります。

オブジェクトのタイプは「2.5オブジェクト」を参照してください。

上記のディクショナリのFfエントリは、そのビット位置で以下の意味を持ちます。

14.3.1 Fieldの命名規則
FieldディクショナリのT要素では「部分的なField名」として文字列を記載します。完全な名称はPDF文書内に明示されていませんが、この部分名称と祖先から構築されます。 ただし、親のないFieldは部分名称と完全名称は同じです。
親を持つフィールドの完全名称は以下のようにピリオド(2Eh)で区切られた親の完全名称に子フィールドの部分名称を追加することによって構築されます。

parent’s_full_name.child’s_partial_name

ピリオドは完全名称の区切り文字として使用されるため、部分な名前名称にピリオド文字を含められません。

14.3.2 可変テキスト
Fieldの内容とプロパティが表示前にわかっていれば、その外観は指定されたAppearanceストリームによって表示できます。
しかしながら、表示の時点で確定していない値をもつFieldがあります。
この場合、PDF文書はFieldに表示内容としての静的なAppearanceストリームを提供できません。 その代わりとしてPDFプロセッサはAppearanceストリームを動的に構築しなければなりません。

以下の表はFieldの外観に対して一般的な情報を提供し、Fieldに含まれる特定のテキストと組み合わせてAppearanceストリームを構築するものです。

新しいAppearenceストリームはFieldのWidgetアノテーションに関連付けられたAppearenceディクショナリの「通常の外観(N:Normal)」になります。

Buttonタイプには以下の種類があります。

• プッシュボタン(push-button)
永続的な値を持たずユーザー入力に即応答する純粋にインタラクティブなコントロールです
• チェックボタン(check box)
オンとオフのいずれかの値を保持します
• ラジオボタン(radio button)
それぞれオンまたはオフにできる一連(グループ)の関連ボタンが含まれていて、通常、関連するラジオボタンは常にひとつしかオンにできず、いずれかのボタンを選択すると他のすべてのボタンが自動的に選択解除されます。

14.4.1 プッシュボタン
プッシュボタンのフィールド タイプは"Btn"であり、Pushbuttonフラグがオンに設定されます。
プッシュボタンは永続的な値を保持しないためFieldディクショナリのVおよびDV要素を使用しません。

14.4.2 チェックボタン
チェックボタンは利用者がマウスまたはキーボードで操作したときにオンとオフの2つの状態を切り替えられるボタンです。
このフィールド タイプは"Btn"であり、そのフィールドフラグはPushbuttonフラグおよびRadioフラグの両方がオフでなければなりません。
各状態は個別の外観(Annotation)を持つことができ、フィールドのWidget Annotationの外観ストリームによって定義されます。
オフ状態の外観はオプションですが、存在する場合は"Off"という名前で保存されます。

14.4.3 ラジオボタン
ラジオボタンは関連するボタンのセット(グループ)です。チェックボタンと同様に個々のラジオボタンにはオンとオフの2つの状態があります。
通常は、1つのラジオボタンを直接オフにすることはできませんが、別のボタンをオンにした結果としてオフにすることができます。 一連の(グループの)ラジオボタンは任意の時点で最大1つのボタンをオン状態にします。いずれかのボタンを選択すると、他のすべてのボタンが自動的に選択解除されます。
フィールド タイプはBtnで、Pushbuttonフラグがクオフで、Radioフラグがオンに設定されます。
ラジオボタンには追加のフラグNoToggleToOffがあります。このフラグがオンの場合はラジオボタンの1つだけが常に選択されることが指定され、現在選択されているボタンをクリックしても効果はありません。 NoToggleToOffフラグがオフの場合は選択したボタンをクリックすると選択が解除され、ボタンは選択されません。

サンプルPDF文書
ButtonタイプのサンプルPDF文書はこちらです。　サンプルPDF文書の内容はこちらです。
AcroFormはオブジェクト３（3 0 obj）に記載され、ButtonフォームのFieldはオブジェクト１１，１２，１３（11 0 obj, 12 0 obj, 13 0 obj）に記載されています。
テキスト フィールドの値を取得するサンプルでFormの内容を取得できます。

テキストフィールド(タイプは"Tx")は、通常は、キーボードから入力されるテキスト入力データ用のボックスまたは余白です。 フィールドディクショナリにおけるフィールドフラグのMultilineフラグ設定に応じてテキストは1行に制限されるか、複数行にまたがることが許可される場合があります。
以下はTextフィールド固有のフラグです。

フィールドのテキストは、フィールド ディクショナリのV(Value)要素にテキスト文字列で保持されます。
このテキスト文字列またはストリームの内容は、テキストフィールドを表示するためのAppearanceストリームを構築するために使用されます。 テキストは単一のスタイル(フォント、サイズ、色など)で表示されます。

テキストフィールドのフィールドディクショナリには、以下の追加要素が含まれる場合があります。

サンプルPDF文書
TextタイプのサンプルPDF文書はこちらです。　サンプルPDF文書の内容はこちらです。
AcroFormはオブジェクト３（3 0 obj）に記載され、TextフォームのFieldはオブジェクト１２，１３，１４（12 0 obj, 14 0 obj, 14 0 obj）に記載されています。
テキスト フィールドの値を取得するサンプルでFormの内容を取得できます。

Choiceフィールドはフィールドタイプ"Ch"であり、いくつかのテキスト項目を含み、そのうちの１つ以上がフィールドの値として選択されます。
アイテムは、次の2つの形式のいずれかで利用者に表示されます。

• スクロール可能なリストボックス
• ドロップダウンリストで構成されるコンボボックス
  コンボボックスでは、定義済みの選択肢や利用者が入力できる編集可能なテキストボックスが付随します。

以下は、Chiceフィールドに固有なフィールドディクショナリの構成要素です。

Opt配列は選択フィールドのオプションのリストを指定します。各要素は画面に表示されるテキスト文字列で表されます。
Opt配列の各要素にはこのテキスト文字列自体、または二要素配列のいずれかが含まれます。二要素配列の場合、最初の要素は表示される文字列で、2番目の要素は抽出されるテキスト文字列です。

サンプルPDF文書
ChoiceタイプのサンプルPDF文書はこちらです。　サンプルPDF文書の内容はこちらです。
AcroFormはオブジェクト３（3 0 obj）に記載され、ChoiceフォームのFieldはオブジェクト１１，１２，１３（11 0 obj, 12 0 obj, 13 0 obj）に記載されています。
テキスト フィールドの値を取得するサンプルでFormの内容を取得できます。