ASP.NET MVC コントロールヘルプ
FlexGridXlsxConverter クラス
ファイル
wijmo.grid.xlsx.js
モジュール
wijmo.grid.xlsx

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

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

{@sample Grid/ImportExportPrint/Excel/Async/purejs デモ}

メソッド

メソッド

Static cancelAsync

cancelAsync(done?: ()): void

saveAsyncメソッドによって開始したタスクをキャンセルします。

パラメーター
  • done: () Optional

    Callback invoked when the method finishes executing.

戻り値
void

Static load

load(grid: FlexGrid, workbook: Workbook, options?: IFlexGridXlsxOptions): void

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

Static loadAsync

loadAsync(grid: FlexGrid, workbook: string | ArrayBuffer | Blob | wijmo.xlsx.Workbook, options?: IFlexGridXlsxOptions, onLoaded?: Workbook), onError?: (reason?: any)): void

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

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

パラメーター
  • grid: FlexGrid

    FlexGrid that loads the Workbook object.

  • workbook: string | ArrayBuffer | Blob | wijmo.xlsx.Workbook

    Workbook, Blob, base-64 string, or ArrayBuffer representing the xlsx file content.

  • options: IFlexGridXlsxOptions Optional

    IFlexGridXlsxOptions object specifying the load options.

  • onLoaded: (workbook: wijmo.xlsx.Workbook) Optional

    Callback invoked when the method finishes executing. The callback provides access to the workbook that was loaded (passed as a parameter to the callback).

  • onError: (reason?: any) Optional

    Callback invoked when there are errors saving the file. The error is passed as a parameter to the callback.

    For example:

    wijmo.grid.xlsx.FlexGridXlsxConverter.loadAsync(grid, blob, null, function (workbook) {
    
         // user can access the loaded workbook instance in this callback.
         var app = worksheet.application ;
         ...
    }, function (reason) {
    
         // User can catch the failure reason in this callback.
         console.log('The reason of save failure is ' + reason);
    });
    
戻り値
void

Static save

save(grid: FlexGrid, options?: IFlexGridXlsxOptions, fileName?: string): Workbook

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);
}
パラメーター
戻り値
Workbook

Static saveAsync

saveAsync(grid: FlexGrid, options?: IFlexGridXlsxOptions, fileName?: string, onSaved?: (base64: string, workbook?: Workbook), onError?: (reason?: any), onProgress?: (value: number), asyncWorkbook?: boolean): Workbook

FlexGrid のコンテンツをファイルに非同期に保存します。

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

戻り値は、asyncWorkbookパラメータによって異なります。false(デフォルト)の場合、メソッドはWorkbookインスタンスを返します。trueの場合、メソッドはnull値を返し、またonSavedコールバックでWorkbookインスタンスが取得されます。

asyncWorkbookパラメータがtrueの場合、 グリッドでの変更が検出されたときにタスクが自動的に再開されます。

パラメーター
  • grid: FlexGrid

    FlexGrid that will be saved.

  • options: IFlexGridXlsxOptions Optional

    IFlexGridXlsxOptions object specifying the save options.

  • fileName: string Optional

    Name of the file that will be generated.

  • onSaved: (base64: string Optional

    Callback invoked when the method finishes executing. The callback provides access to the content of the saved workbook (encoded as a base-64 string and passed as a parameter to the callback).

  • workbook: wijmo.xlsx.Workbook) Optional
  • onError: (reason?: any) Optional

    Callback invoked when there are errors saving the file. The error is passed as a parameter to the callback.

  • onProgress: (value: number) Optional

    Callback function that gives feedback about the progress of a task. The function accepts a single argument, the current progress as a number between 0 and 100. Can be used only if the asyncWorkbook parameter is set to true.

  • asyncWorkbook: boolean Optional

    Indicates whether Workbook genaration should be performed asynchronously or not. The default value is false.

    For example:

    wijmo.grid.xlsx.FlexGridXlsxConverter.saveAsync(flexGrid,
        { includeColumnHeaders: true }, // options
        'FlexGrid.xlsx', // filename
        function (base64) { // onSaved
            // User can access the base64 string in this callback.
            document.getElementByID('export').href = 'data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;' + 'base64,' + base64;
        },
        function (reason) { // onError
            // User can catch the failure reason in this callback.
            console.log('The reason of save failure is ' + reason);
        }
     );
    
戻り値
Workbook