[]
        
(Showing Draft Content)

Wijmo_Grid_Xlsx.Flexgridxlsxconverter

FlexGridXlsxConverter クラス

このクラスは、FlexGrid コントロールがExcel xlsxファイルからのロード/保存を行うための静的なloadおよびsaveメソッドを提供します。

次の例では、FlexGridXlsxConverter を使用して FlexGrid コントロールの内容をXLSXにエクスポートする方法を示しています。

Example

階層

  • FlexGridXlsxConverter

メソッド

静的 cancelAsync

  • cancelAsync(done?: Object): void
  • FlexGridXlsxConverter.saveAsyncメソッドによって開始したタスクをキャンセルします。

    引数

    • オプション done: Object

      メソッドの実行が終了すると呼び出されるコールバック。

    戻り値 void

静的 load

  • xlsxファイルのコンテンツを含むWorkbook インスタンスまたはBlobオブジェクトをFlexGrid インスタンスにロードします。 このメソッドは、JSZip 2.5で動作します。

    次に例を示します。

    // このサンプルは、[ファイルを開く]ダイアログで選択したxlsxファイルを開き、
    
    // FlexGridにデータを挿入します。
    // sheet.
     
    // HTML
    <input type="file"
        id="importFile"
        accept="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
    />
    <div id="flexHost"></>
     
    // JavaScript
    var flexGrid = new wijmo.grid.FlexGrid("#flexHost"),
        importFile = document.getElementById('importFile');
     
    importFile.addEventListener('change', function () {
        loadWorkbook();
    });
     
    function loadWorkbook() {
        var reader,
            file = importFile.files[0];
        if (file) {
            reader = new FileReader();
            reader.onload = function (e) {
                wijmo.grid.xlsx.FlexGridXlsxConverter.load(flexGrid, reader.result,
                    { includeColumnHeaders: true });
            };
            reader.readAsArrayBuffer(file);
        }
    }

    引数

    戻り値 void

静的 loadAsync

  • xlsxファイルを表す Workbook またはBlobを FlexGrid に非同期にロードします。

    このメソッドにはJSZip 3.0が必要です。

    引数

    • grid: FlexGrid

      Workbook オブジェクトをロードする FlexGrid

    • workbook: any

      xlsxファイルコンテンツを表す Workbook、 Blob、base-64文字列、またはArrayBuffer。

    • オプション options: IFlexGridXlsxOptions

      ロードオプションを指定するIFlexGridXlsxOptions オブジェクト。

    • オプション onLoaded: Object

      メソッドの実行が終了すると呼び出されるコールバック。 このコールバックは、ロードされたワークブックへのアクセスを提供します。 これは、パラメータとしてコールバックに渡されます。

    • オプション onError: Object

      ファイル保存時にエラーがあると呼び出されるコールバック。 これは、パラメータとしてコールバックに渡されます。

      次に例を示します。

      wijmo.grid.xlsx.FlexGridXlsxConverter.loadAsync(grid, blob, null, function (workbook) {
           // このコールバックで、ユーザーはロードされたワークブックインスタンスにアクセスできます。
           var app = worksheet.application ;
           ...
      }, function (reason) {
           // このコールバックで、ユーザーは失敗理由を確認できます。
           console.log('The reason of save failure is ' + reason);
      });
      

    戻り値 void

静的 save

  • FlexGrid インスタンスをWorkbook インスタンスに保存します。 このメソッドは、JSZip 2.5で動作します。

    次に例を示します。

    // このサンプルは、ボタンのクリックで、FlexGridのコンテンツをxlsxファイルにエクスポートします。
    // クリック。
     
    // HTML
    <button
        onclick="saveXlsx('FlexGrid.xlsx')">
        Save
    </button>
     
    // JavaScript
    function saveXlsx(fileName) {
        // flexGridをxlsxファイルに保存します。
        wijmo.grid.xlsx.FlexGridXlsxConverter.save(flexGrid,
                { includeColumnHeaders: true }, fileName);
    }

    引数

    戻り値 mXlsx.Workbook

    A Workbook object that can be used to customize the workbook before saving it (with the Workbook.save method).

静的 saveAsync

  • saveAsync(grid: FlexGrid, options?: IFlexGridXlsxOptions, fileName?: string, onSaved?: Object, onError?: Object, onProgress?: Object): mXlsx.Workbook
  • FlexGrid のコンテンツをファイルに非同期に保存します。

    このメソッドにはJSZip 3.0が必要です。

    開始すると、グリッドの変更が検出される場合、タスクが自動的に再開されます。

    引数

    • grid: FlexGrid

      保存されるFlexGrid。

    • オプション options: IFlexGridXlsxOptions

      保存オプションを指定するIFlexGridXlsxOptions オブジェクト。

    • オプション fileName: string

      生成されるファイル名。

    • オプション onSaved: Object

      メソッドの実行が終了すると呼び出されるコールバック。 このコールバックは、保存されたワークブックのコンテンツへのアクセスを提供します。 これは、base64文字列としてエンコードされ、パラメータとしてコールバックに渡されます。

    • オプション onError: Object

      ファイルの保存中にエラーが発生したときに呼び出されるコールバック。エラーはパラメータとしてコールバックに渡されます。

    • オプション onProgress: Object

      タスクの進行状況についてフィードバックを提供するコールバック関数。 この関数は単一の引数、現在の進捗状況を0~100の数値を受け入れます。

      次に例を示します。

      wijmo.grid.xlsx.FlexGridXlsxConverter.saveAsync(flexGrid,
          { includeColumnHeaders: true }, // オプション
          'FlexGrid.xlsx', // filename
          function (base64) { // onSaved
              // このコールバックで、ユーザーはロードされたワークブックインスタンスにアクセスできます。
              document.getElementByID('export').href = 'data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;' + 'base64,' + base64;
          },
          function (reason) { // onError
              // このコールバックで、ユーザーは失敗理由を確認できます。
              console.log('The reason of save failure is ' + reason);
          }
       );

    戻り値 mXlsx.Workbook