API version 4

- ‐

ExtractInfo

文書情報を取得した際に発生します。

このイベントの発生時点で、以下のプロパティに文書情報が確定して格納されています(イベントオブジェクト自体にはプロパティは追加されません)。値はイベント発生前は未定です。ただし、PrintStreamDocumentの pageCount はExtractInfoイベント発生時点では未確定です。

型	名前	説明
integer	status	データの取得状況。 status プロパティを参照
integer	paperSize	用紙サイズ。 paperSize プロパティを参照
integer	orientation	用紙の向き。 orientation プロパティを参照
integer	width	用紙の幅(0.1mm単位)。 width プロパティを参照
integer	height	用紙の高さ(0.1mm単位)。 height プロパティを参照
integer	marginLeft	印刷時の左マージン(0.1mm単位)。 marginLeft プロパティを参照
integer	marginTop	印刷時の上マージン(0.1mm単位)。 marginTop プロパティを参照
integer	pageCount	総ページ数。PrintStreamDocumentではExtractInfoイベント発生時点では未確定です。 pageCount プロパティを参照

なお、pageCount の確定するタイミングは、PrintableDocumentの派生クラスによって異なります。

• PrintFormDocumentでは、printDocument メソッドの呼び出し時に全ページのデータが一括生成されるため、生成されたPrintFormDocumentの pageCount は確定しています。PrintFormDocumentでは、ExtractInfoイベントは発生しません。

• PrintStreamDocumentでは、PSSファイルをページ単位で逐次取得・展開するため、ExtractInfoイベント発生時点では pageCount は未確定です。この時点では通常 0 です。ページの取得に伴ってExtractPageイベントが発生し、pageCount は取得済みページ数を示します。全ページの取得が完了し、ExtractFinishedイベントが発生した時点で、pageCount に総ページ数が確定して格納されます。

PrintStreamDocumentで確定した総ページ数を使用する場合は、ExtractFinishedイベントで pageCount を参照してください。

使用例 CRSダウンロード ダウンロード(00000001.pss) ダウンロード(00000002.pss)

Form formPrintableDocument {
   x = 0; y = 0; width = 800; height = 600;

   PrintStreamDocument pssDoc {
           function onExtractInfo(e) {
                   print("PrintStreamDocument.onExtractInfo, status=", status);
                   print("paperSize=", paperSize);
                   print("orientation=", orientation);
                   print("width=", width);
                   print("height=", height);
                   print("marginLeft=", marginLeft);
                   print("marginTop=", marginTop);
           }
           function onExtractPage(e) {
                   print("PrintStreamDocument.onExtractPage page=", e.page, ", status=", status);
                   print("pageCount=", pageCount);
           }
           function onExtractFinished(e) {
                   print("PrintStreamDocument.onExtractFinished, status=", status);
                   print("pageCount=", pageCount);
           }
           function onExtractFailed(e) {
                   print("PrintStreamDocument.onExtractFailed, status=", status);
           }
   }

   PrintPreview preview {
           x = 8; y = 40; width = 784; height = 552;
   }

   TextBox textUrl {
           x = 8; y = 8; width = 448; height = 24;
           value = "./";
   }

   Button buttonGet {
           x = 464; y = 8; width = 160; height = 24;
           title = "PrintStreamDocument.get";
           function onTouch(e) {
                   ^.preview.clearPages();
                   ^.preview.document = ^.pssDoc;
                   var retryCount = 3;
                   var waitTime = 4.0;
                   var waitScale = 2.0;
                   ^.pssDoc.get(^.textUrl.value, retryCount, waitTime, waitScale);
           }
   }

   Button buttonLoad {
           x = 632; y = 8; width = 160; height = 24;
           title = "PrintableDocument.load";
           function onTouch(e) {
                   var doc = PrintableDocument.load(^.textbox2.value);
                   if (doc) {
                           ^.preview.clearPages();
                           ^.preview.document = doc;
                   }
           }
   }

}