ONLYOFFICE’s diary

OSSドキュメントエディタの使い方やヒントをご紹介します

ONLYOFFICEマクロでCSVやTXTのデータを記入可能なコンボボックスに変換する方法

ONLYOFFICE製品は、デジタル時代のすべての要求をカバーする非常に強力なソリューションです。バージョン7.0から、ONLYOFFICEエキスパートチームは、ONLYOFFICEフォームによってエディタの機能を拡張しました。

電子文書での作業を容易にするために設計されたONLYOFFICEフォームは、多くの日常的なタスクを軽減することができます。その良い例の一つが、販売契約書のテンプレートを作成するために、記入可能なフォームを使用することです。しかし、顧客情報を別々のCSV/TXTファイルに保存している場合はどうでしょうか？

このブログ記事では、CSVやTXTのデータを取り込んで、記入可能なコンボボックスに変換するマクロの作り方をご紹介します。

https://www.onlyoffice.com/blog/wp-content/uploads/2022/12/Illyustratsiya-v-blog-ONLYOFFICE-Convert-CSV-and-TXT-data-into-a-fillable-combo-1.jpg

ONLYOFFICEフォームについて

拡張された機能により、ユーザーが文書内で記入可能なフォームを楽に作成し、操作することができるフォーマットを提供します。DOCXF形式は、DOCXをベースにしたファイル拡張子で、フォームの作成と編集のための幅広いツールを提供します。ゼロから、または既存のDOCXファイルからフォームを作成することができます。OFORMは、オンラインですぐに記入可能なフォームのためのOOXML拡張機能です。これは、フォームのテンプレートを記入可能にし、他のユーザーによる編集を制限します。

ONLYOFFICEフォームは、テキストドキュメントの構造を継承し、いくつかの主要なクラスを含んでいます。

これらのクラスには、テキストフィールド、複合フィールド、コンボボックス、ドロップダウンリスト、ラジオボタン、画像フォーム、電話番号やメールアドレスなどのフィールドを作成するためのメソッドが組み込まれています。

今回のマクロでは、コンボボックスクラスを使用します。コンボボックス要素には、外部CSV/TXTファイルからインポートする値のドロップダウン・リストが組み込まれています。

https://www.onlyoffice.com/blog/wp-content/uploads/2022/12/text-to-OFORM.png

マクロの構築

APIドキュメントのFormセクションには、Api.CreateComboBoxFormメソッドがあります。これは、指定されたパラメータでコンボボックスを作成します。

 var oComboBoxForm = Api.CreateComboBoxForm({"key": "Personal information", "tip": "Choose your country", "required": true, "placeholder": "Country", "editable": false, "autoFit": false, "items": ["Latvia", "USA", "UK"]});

itemsパラメータには、ドロップダウンリストに表示される値の配列が格納されています。そこで、この配列を、外部のCSV/TXTファイルから取得した値の配列に置き換えるというのが、今回の方針です。

しかし、まずは、外部ファイルを取得し、データを処理する必要があります。CSV/TXTデータ取り込みマクロでも、同様の作戦をとりました。ONLYOFFICEのマクロはJavaScriptベースなので、非常に汎用性が高く、AJAXリクエストを使用することができます。

function LoadFile() {
        $.ajax({
            url: 'file:///C:/Users/LEOPARD/Desktop/Book1.csv',
            dataType: 'text',https://www.onlyoffice.com/blog/wp-admin/post-new.php?lang=en#
        }).done(successFunction);
    }
        LoadFile();

さて、ファイルを取り出したので、この生データを処理してフォーマットする必要があります。そこで、succesFunctionを追加します。これはデータを受け取り、テキストを行ごとのアイテムの配列に分割します。

 function successFunction(data) {
      var arrAllItems = data.split(/\r?\n|\r/);
}

次に、アクティブなドキュメントを対象とし、items パラメータに arrAllItems 配列を指定してコンボボックスを作成します。

 var oDocument = Api.GetDocument();
 var oComboBoxForm = Api.CreateComboBoxForm({ "key": "Personal information1", "tip": "Choose your country", "required": true, "placeholder": "Country", "editable": false, "autoFit": false, "items": arrAllItems });

その後、段落を作成し、そこにコンボボックスを追加します。

  var oParagraph = Api.CreateParagraph();
oParagraph.AddElement(oComboBoxForm);

ここで、コンボボックスを文書に挿入する必要があります。この作業を行うにはいくつかの方法がありますが、ここではInsertContentメソッドを使用することをお勧めします。これは、カーソルが置かれている場所に要素を挿入するものです。また、パラメータでテキストと段落のプロパティを指定することをお勧めします。これにより、起こりうるミスやマクロの誤動作を防ぐことができます。

oDocument.InsertContent([oParagraph], { "KeepTextOnly": true });

マクロのコード全体は以下の通りです。

(function()
{
   function LoadFile() {
      $.ajax({
          url: 'file:///filePath,
          dataType: 'text',
      }).done(successFunction);
    }
        LoadFile();

   function successFunction(data) {
        var arrAllItems = data.split(/\r?\n|\r/);
        var oDocument = Api.GetDocument();
        var oComboBoxForm = Api.CreateComboBoxForm({ "key": "Personal information", "tip": "Choose your option", "required": true, "placeholder": "Option", "editable": false, "autoFit": false, "items": arrAllItems });
        var oParagraph = Api.CreateParagraph();
oParagraph.AddElement(oComboBoxForm);
oDocument.InsertContent([oParagraph], { "KeepTextOnly": true });
    }
})();

ご注意！

コンボボックスを挿入するには、マクロを実行した後にスペースを押してください。 複数のコンボボックスをドキュメントに挿入するには、Api.CreateComboBoxFormメソッドの異なるキーパラメータを使用します。 このマクロは、APIメソッドを実装することでできることの多くの例の一つに過ぎません。ぜひ、この記事を参考に、独自のマクロを作成してみてください。

私たちのマクロはJavaScriptベースなので、非常に汎用的で実用的です。ご質問やアイデアの共有はご遠慮なくどうぞ。私たちは、議論と協力にオープンです。

お役立ちリンク