1.0.0.0以上

説明

指定された一意のIDに対応するエントリの状態を変更する。

ローカルリソースは、アップロードが完了すると、statusの値が「DONE」に変更される。statusが「DONE」である対象は、再度アップロードができない。

ファイルのアップロードの操作がなく、すぐに「DONE」に変更するか、アップロードが完了した対象を「WAIT」状態に変更することができる。

// 指定された一意のIDに対応するエントリを「WAIT」状態に変更する。
dx.changeStatus(id, "WAIT");

形式

component.changeStatus(id, status);

パラメータ

1.0.0.0以上

説明

ローカルリソースのエントリを仮想ファイルに変更する。

ローカルリソースを仮想ファイルに変更して使用することもできる。

逆に、仮想ファイルをローカルファイルに変更する機能はありません。

// ローカルファイルのエントリを仮想ファイルのエントリに変更する。
dx.changeToVirtualFile(id, "http://.../...", "http://domain/path/...");
// ダウンロードあるいは展開URL情報せずに使用する場合は、空の文字列を入力します。
dx.changeToVirtualFile(id, "", "");

形式

component.changeToVirtualFile(id, openUrl, downUrl);

パラメータ

1.0.0.0以上

説明

すべての項目をチェック（または終了）状態に変更する。

// すべての項目をチェック状態に変更する。
dx.checkAll(true);

checkAllメソッドは、ファイルがリストに登録される過程中に使用をすると、エラーが発生する。仮想ファイルとローカルファイルの登録処理は、内部的には非同期である。ローカルファイルの場合には、ファイルの登録が完了すると、onDX5ItemsAddedコールバック関数が呼び出されるため、そのコールバック関数が実行された後にcheckAllを使用すると、され、仮想ファイルはaddVirtualFile、addVirtualFileListを使用して登録すると、checked：true属性を一緒に与えるチェックされた状態でリストに追加することができる。

形式

component.checkAll(allOrNot);

パラメータ

1.0.0.0以上

説明

指定された一意のIDに対応する項目をチェック（または終了）状態に変更する。

// 指定された一意のIDに対応する項目をチェック状態に変更する。
dx.checkById(id, true);
// 指定された一意のIDに対応する項目をチェック解除状態に変更する。
dx.checkById(id, false);

形式

component.checkById(id, checked);

パラメータ

1.0.0.0以上

説明

指定された順序に対応する項目をチェック（または終了）状態に変更する。

// 指定された順序に対応する項目をチェック状態に変更する。
dx.checkByIndex(index, true);
// 指定された順序に対応する項目をチェック解除状態に変更する。
dx.checkByIndex(index, false);

形式

component.checkByIndex(id, checked);

パラメータ

1.0.0.0以上

説明

重複チェックを実行するかどうかを設定する。

パラメータがtrueの場合、重複チェックを実行するので、重複を許可しない。

重複とは、同じパスのファイルを追加で登録することができる場合に発生する。

ブラウザでは、重複チェックは名前、サイズ、最終更新時間によってのみローカルリソースを比較することができる。

加えて、仮想ファイルは、重複検査対象ではない。

// 項目が追加されるたびに、重複チェックを行います。
dx.checkDuplication(true);

形式

component.checkDuplication(enable);

パラメータ

1.0.0.0以上

説明

エントリを削除する。

パラメータが決まってなければ、すべての項目を削除する。

DEXTUploadX5から「削除」と「削除」は、別の方法で区分する。

削除する対象が仮想ファイルである場合、仮想ファイルは削除がされず、内部的に削除された状態でのみ管理がされている。

clearItemsを使用すれば、管理せずに完全に除去がされる。

// ローカルファイルのエントリをすべて削除する。
dx.clearItems("FILE");
// すべてのエントリを削除する。
dx.clearItems();

形式

component.clearItems([flag]);

パラメータ

1.0.0.0以上

説明

指定された一意のIDに対応するエントリのメタデータを削除する。

項目は、「名前[区切り文字]の値 "の形式のメタデータを複数持つことができます。

メタデータは、アップロードがされるとき、サーバーに送信がされ、純粋なファイル以外の情報を一緒に伝達する目的で使用される。

仮想ファイルは、アップロードがされていないため、サーバーへのメタデータが配信されない。

メタデータを削除するには、メタデータの名前が必要である。

dx.setMetaDataById(id, "userid", "honggildong");
// "honggildong」が出力される。
console.log(dx.getMetaDataById(id, "userid"));
// メタデータを削除する。
dx.deleteMetaDataById(id, "userid");
						

形式

component.deleteMetaDataById(id, name);

パラメータ

1.0.0.0以上

説明

指定された順序に対応する項目のメタデータを削除する。

항項目は、「名前[区切り文字]の値 "の形式のメタデータを複数持つことができます。

メタデータは、アップロードがされるとき、サーバーに送信がされ、純粋なファイル以外の情報を一緒に伝達する目的で使用される。

仮想ファイルは、アップロードがされていないため、サーバーへのメタデータが配信されない。

メタデータを削除するには、メタデータの名前が必要である。

// 6番目の項目にメタデータを設定する。
dx.setMetaDataByindex(5, "userid", "honggildong");
// "honggildong」が出力される。
console.log(dx.getMetaDataByIndex(5, "userid"));
// メタデータを削除する。
dx.deleteMetaDataByIndex(5, "userid");
						

形式

component.deleteMetaDataByIndex(index, name);

パラメータ

1.0.0.0以上

説明

DEXTUploadX5マルチモジュールは、デスクトッププログラムの実行機能を提供しない。

代わりにブラウザで開くことができるファイルであれば、新しいウィンドウで対象を開くことができる。一般的に、ブラウザが開くことができるファイルは、画像のように限定的である。

熱気が可能なターゲットは、必ずopenUrl属性の値を持っている仮想ファイルべきである。

//openUrl属性にダウンロードウェブパスが存在しなければならない。
dx.addVirtualFile({ ... name: "bridge_509147.jpg", openUrl: "http://.../service/common-open.do?key=FID0001" });

スクリプトを使ってオブジェクトを開きたい場合は、executeItem関数を使う必要がある。

// 4番目の項目（仮想ファイル）を開きます。
dx.executeItem(3);

形式

component.executeItem(index);

パラメータ

1.0.0.0以上

説明

認証キーの文字列を返します。

認証キーは、dextuploadx5-configuration.jsファイルのauthkey属性に設定されている。

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 認証キーを出力する。
  console.log(dx.getAuthkey());
}

形式

authkey = component.getAuthkey();

リターンタ

認証キーの文字列

1.0.0.0以上

説明

自動整列方式を返します。

形式

stype = component.getAutoSortingType();

リターンタ

自動整列方式

1.0.0.0以上

説明

自動整列方式を設定する。

設定値が1、2の場合の項目が追加されるたびに自動的に並べ替えられる。

// 昇順に自動整列になるように設定する。
dx.setAutoSortingType(1);
// 自動整列方式を出力する。
console.log(dx.getAutoSortingType());

形式

component.setAutoSortingType(stype);

パラメータ

1.0.0.0以上

説明

チェック状態の項目の一意のID値を要素として持つ配列を返します。

パラメータの値がtrueの場合、仮想ファイルを除くローカル・リソースのみをカウントした値が返される。

// チェック項目の一意のID値を要素として持つ配列を得る。
ids = dx.getCheckedIds();
// チェックされたローカル・リソースの一意のIDを取得するにはパラメータをtrueに設定する。
ids = dx.getCheckedIds(true);

形式

ids = component.getCheckedIds([onlyLocal]);

パラメータ

リターンタ

チェック状態の項目の一意のID値を要素として持つ配列

1.0.0.0以上

説明

チェック状態の項目を要素に持つ配列を返します。

パラメータの値がtrueの場合、仮想ファイルを除くローカル・リソースのみをカウントした値が返される。

// チェック項目だけ配列で囲んで返します。
var checkeds = dx.getCheckedItems();

形式

items = component.getCheckedItems([onlyLocal]);

パラメータ

リターンタ

チェック状態の項目を要素に持つ配列

2.0.0.0以上

説明

指定されたユーザー定義のヘッダー名に対応する値を返します。

形式

value = component.getCustomHeader(name);

パラメータ

リターンタ

カスタムヘッダーの値。ない場合はnullを返します。

2.0.0.0以上

説明

カスタムヘッダを新たに設定するか、値を変更する。

DEXTUploadX5はファイルをアップロードしたり、ダウンロードしたときには、カスタムヘッダをHTTPリクエストに一緒に乗せて送信することができる。

setCustomHeaderメソッドを使用して、ユーザー定義のヘッダを設定することができ、getCustomHeaderメソッドを使用してヘッダーの値を確認することができる。

一度カスタムヘッダーが設定されると、以降のすべての要求にヘッダを含めて見るので、もしヘッダが必要としていない状況であれば、removeCustomHeaderメソッドを使用して、既に設定されたヘッダを削除することができる。

// ユーザー定義のヘッダを設定する。
dx.setCustomHeader("X-Third-Party-Name", "DEXTUploadX5");
// カスタムヘッダーの値を確認する。
value = dx.getCustomHeader("X-Third-Party-Name");
// 対象ヘッダを削除する。
dx.removeCustomHeader("X-Third-Party-Name")

ヘッダー名と値は、製品内部でエンコード処理をしていないので、エンコードが必要な状況であれば、直接処理しなければならない。

クロスドメイン要求をする状況であれば、CORS（Cross-Origin Resource Sharing）の設定かどうかに応じて、ユーザー定義のヘッダーをサーバー側で許可されないこともある。したがって、カスタムヘッダを正常に転送するためには、Access-Control-Allow-Headersレスポンスヘッダを利用して、ユーザー定義のヘッダを許可するか、サーバー（ウェブ）プラットフォームに合わせて設定をヘジュオヤする。

Amazon S3へのアップロードまたはダウンロード時にカスタムヘッダを渡さないでください。

形式

component.getCustomHeader(name, value);

パラメータ

1.0.0.0以上

説明

空白を代表する文字列を返します。

形式

splitter = component.getEmptyString();

リターンタ

空白の文字列、デフォルトは "[EMPTY]」である。

1.0.0.0以上

説明

空白の文字列を設定する。

現在使用されているところはない。

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 空白の文字をパイプライン文字（[e]）に設定する。
  dx.setEmptyString("[e]");
  // 空白の文字を出力する。
  console.log(dx.getEmptyString());
}

形式

component.setEmptyString(str);

パラメータ

1.0.0.0以上

説明

ヘッダのコラムをクリックすると、並べ替え機能が動作するかを返します。

形式

enable = component.getEnableColumnSorting();

リターンタ

ヘッダの並べ替えが可能な場合はtrue、なければfalse

1.0.0.0以上

説明

ヘッダのコラムをクリックすると、ソート機能が動作するようにするかを設定する。

// ヘッダカラムをクリックすると、ソートになるように設定する。
dx.setEnableColumnSorting(true);
// カラムをクリックすると、ソートがされている出力する。
console.log(dx.getEnableColumnSorting());

形式

component.setEnableColumnSorting(enable);

パラメータ

1.0.0.0以上

説明

拡張子フィルタリング処理のための文字列情報を返します。

形式

strFilter = component.getExtensionFilter([reverse]);

パラメータ

リターンタ

拡張子フィルタリング処理のための文字列

例: *.jpg;*.jpeg;*.gif;*.bmp;*.txt

1.0.0.0以上

説明

拡張子フィルタリング処理のための文字列情報を設定する。

DEXTUploadX5はファイルの拡張子に基づいてフィルタ処理が可能である。

拡張子ベースフィルタ処理は、大きく順フィルタと逆フィルタに分ける。

• 純フィルタ：フィルタに記載の拡張子を持つ対象のみを追加することができる。
• 逆フィルタ：フィルタに記載の拡張子を持つ対象は追加することができない。

function onDX5Created(id) {
    var dx = dx5.get(id);
    // 順フィルタ適用例
    dx.setExtensionFilter("*.jpg;*.jpeg;*.gif;*.bmp;*.txt");
    // 逆フィルタ適用例
    dx.setExtensionFilter("*.exe;*.dll;*.js;*.sh;*.com", true);
    // 設定された拡張子フィルタ情報を出力する。
    console.log("white => " + dx.getExtensionFilter());
    console.log("black => " + dx.getExtensionFilter(true));
}

setExtensionFilter関数を再呼び出すと、既存のフィルタ情報は削除され、新たに上書きします。

形式

component.setExtensionFilter(filterString [, reverse]);

パラメータ

3.8.0.0以上

説明

コンポーネントの ID を返します。

var id = dx.getId();
console.log(id);

形式

id = component.getId();

リターンタ

コンポーネントのID

1.0.0.0以上

説明

指定された一意のIDに対応するエントリを返します。

DEXTUploadX5が持つことができる項目は、ローカルファイル、仮想ファイルがあります。

すべての項目は、id属性を持っており、getItemById関数を使用して項目オブジェクトを得ることができる。

// アイテムを得る。
item = dx.getItemById(id);
// 項目の名前を出力する。
console.log(item.name);

形式

item = component.getItemById(id);

パラメータ

リターンタ

項目（コピー）

1.0.0.0以上

説明

指定された順序に対応する項目を返します。

DEXTUploadX5が持つことができる項目は、ローカルファイル、仮想ファイルがあります。

すべての項目は、相対的な順序を持っており、getItemByIndex関数を使用して項目オブジェクトを得ることができる。

// 6回目の項目を得る。
item = dx.getItemByIndex(5);
// 項目の名前を出力する。
console.log(item.name);

形式

item = component.getItemByIndex(index);

パラメータ

リターンタ

項目（コピー）

1.0.0.0以上

説明

指定された順序に対応する項目の一意のIDを返します。

// 4番目の項目の一意のID値を返します。
id = dx.getItemId(3);
// 3を返します。
index = dx.getItemIndex(id);

形式

id = component.getItemId(index);

パラメータ

リターンタ

指定された順序に対応する項目の一意のID

1.0.0.0以上

説明

すべての項目の一意のID値を要素として持つ配列を返します。

パラメータの値がtrueの場合、仮想ファイルを除くローカル・リソース（ファイル）のみカウントされた値が返される。

DEXTUploadX5が持つことができる項目は、ローカルファイル、仮想ファイルがあります。

// すべての項目の一意のID値を要素として持つ配列を得る。
ids = dx.getItemIds();
// ローカルリソースの一意のIDを取得するにはパラメータをtrueに設定する。
ids = dx.getItemIds(true);

形式

ids = component.getItemIds([onlyLocal]);

パラメータ

リターンタ

すべての項目の一意のID値を要素として持つ配列

1.0.0.0以上

説明

指定された一意のIDに対応する項目の順序を返します。

// 4番目の項目の一意のID値を返します。
id = dx.getItemId(3);
// 3を返します。
index = dx.getItemIndex(id);

形式

index = component.getItemIndex(id);

パラメータ

リターンタ

指定された一意のIDに対応する項目の順序

1.0.0.0以上

説明

項目を配列で返します。

DEXTUploadX5が持つことができる項目は、ローカルファイル、仮想ファイルがあります。

// すべての項目を持つ配列を返します。
var all = dx.getItems();
// ローカルエントリだけ持つ配列を返します。
var locals = dx.getItems(true);
// すべての元のアイテムを持つ配列を返します。（マルチモジュールのみ）
var origins = dx.getItems(false, true);

isOriginパラメータの値がtrueの場合、コピーではなく元のアイテム要素が返されます。

このオプションは、マルチコンポーネントアップロードでの使用がされ、それ以外の場合には、常にコピーを使用する必要がある。

形式

items = component.getItems([onlyLocal, isOrign]);

パラメータ

リターンタ

項目の配列

1.0.0.0以上

説明

コンポーネントに追加することができるファイルの最大数を返します。

形式

maxCount = component.getMaxFileCount();

リターンタ

コンポーネントに追加することができるファイルの最大数は、デフォルト値は-1である。

1.0.0.0以上

説明

コンポーネントに追加することができるファイルの最大数を設定する。

アップロードするファイルの数を制限するために追加することができるファイルの最大数を制限することができる。

値が-1の場合、制限をしない意味を持つ。

function onDX5Created(id) {
  var dx = dx5.get(id);
  // ファイルを最大10まで登録することができる。
  dx.setMaxFileCount(10);
  // もし仮想ファイルを含めて最大10まで登録するには、第二のパラメータの値をtrueに入力する。
  // つまり、ローカルファイルの数は、（10 -仮想ファイルの数）分だけ登録が可能である。
  dx.setMaxFileCount(10, true);
  // コンポーネントに追加することができるファイルの最大数を出力する。
  console.log(dx.getMaxFileCount());
}

形式

component.setMaxFileCount(count [, withVF]);

パラメータ

1.0.0.0以上

説明

コンポーネントに追加することができる個々のファイルの最大サイズを返します。

形式

maxSize = component.getMaxFileSize();

リターンタ

コンポーネントに追加することができる個々のファイルの最大サイズ（バイト）、デフォルトでは-1である。

1.0.0.0以上

説明

コンポーネントに追加することができる個々のファイルの最大サイズを設定します。

特定のサイズを超えるファイルを登録しないように設定することができる。

値が-1の場合、制限をしない意味を持つ。

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 100MBを超えるファイルは、登録することができない。
  dx.setMaxFileSize(1024 * 1024 * 100);
  // コンポーネントに追加することができる個々のファイルの最大サイズを出力する。
  console.log(dx.getMaxFileSize());
}

最大値をいくら高く取ってもサーバーから受け取ることができない大きさであれば、アップロードが失敗する。

OROF、ORAFアップロード方式の場合、個々のファイルは約2GBを超えない。

大きなファイルをアップロードすると、サーバーリソースのシェアが高まり、同時処理が必要にしていないことがあります。

一般的には、大きなファイルをアップロードする理由がないので、可能な容量を制限することをお勧めします。

形式

component.setMaxFileSize(size);

パラメータ

1.0.0.0以上

説明

コンポーネントに追加することができる、ファイル全体の最大許容サイズを返します。

形式

maxTotalSize = component.getMaxTotalSize();

リターンタ

ファイル全体の最大許容サイズ（バイト）、デフォルトでは-1である。

1.0.0.0以上

説明

コンポーネントに追加することができる、ファイル全体の最大許容サイズを設定する。

値が-1の場合、制限をしない意味を持つ。

function onDX5Created(id) {
  var dx = dx5.get(id);
  // ファイル全体の容量の合計が300MBを超える場合は、登録することができない。
  dx.setMaxTotalSize(1024 * 1024 * 300);
  // コンポーネントに追加することができるファイル全体許容サイズの最大値を出力する。
  console.log(dx.getMaxTotalSize());
}

最大値をいくら高く取ってもサーバーから受け取ることができない大きさであれば、アップロードが失敗する。

OROF、ORAFアップロード方式の場合、全体のファイルは許容サイズは約2GBを超えない。

アップロードするデータの量が大きくなると、サーバーリソースのシェアが高まり、同時処理が必要にしていないことがあります。

一般的には、大規模なデータをアップロードする理由がないので、可能な容量を制限することをお勧めします。

形式

component.setMaxTotalSize(tsize [, withVF]);

パラメータ

1.0.0.0以上

説明

指定された一意のIDに対応するエントリのメタデータの値を返します。

形式

metaValue = component.getMetaDataById(id, name);

パラメータ

リターンタ

与えられた名前が持つメタデータの値

1.0.0.0以上

説明

指定された一意のIDに対応するエントリのメタデータの値を設定します。

項目は、「名前[区切り文字]の値 "の形式のメタデータを複数持つことができます。

メタデータは、アップロードがされるとき、サーバーに送信がされ、純粋なファイル以外の情報を一緒に伝達する目的で使用される。

仮想ファイルは、アップロードがされていないため、サーバーへのメタデータが配信されない。

dx.setMetaDataById(id, "userid", "honggildong");
// "honggildong」が出力される。
console.log(dx.getMetaDataById(id, "userid"));

形式

component.setMetaDataById(id, name, value);

パラメータ

1.0.0.0以上

説明

指定された順序に対応する項目のメタデータの値を返します。

形式

metaValue = component.getMetaDataByIndex(index, name);

パラメータ

リターンタ

与えられた名前が持つメタデータの値

1.0.0.0以上

説明

指定された順序に対応する項目のメタデータの値を設定します。

項目は、「名前[区切り文字]の値 "の形式のメタデータを複数持つことができます。

メタデータは、アップロードがされるとき、サーバーに送信がされ、純粋なファイル以外の情報を一緒に伝達する目的で使用される。

仮想ファイルは、アップロードがされていないため、サーバーへのメタデータが配信されない。

// 6番目の項目にメタデータを設定する。
dx.setMetaDataByIndex(5, "userid", "honggildong");
// "honggildong」が出力される。
console.log(dx.getMetaDataByIndex(5, "userid"));

形式

component.setMetaDataByIndex(index, name, value);

パラメータ

1.0.0.0以上

説明

コンポーネントに追加することができ、個々のファイルの最小サイズを返します。

形式

minSize = component.getMinFileSize();

リターンタ

コンポーネントに追加することができ、個々のファイルの最小サイズ（バイト）、デフォルトでは-1である

1.0.0.0以上

説明

コンポーネントに追加することができ、個々のファイルの最小サイズを設定する。

特定のサイズ以下のファイルを登録しないように設定することができる。

値が-1の場合、制限をしない意味を持つ。

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 1MB未満のファイルは、登録することができない。
  dx.setMinFileSize(1024 * 1024);
  // コンポーネントに追加することができ、個々のファイルの最小サイズを出力する。
  console.log(dx.getMinFileSize());
}

形式

component.setMinFileSize(size);

パラメータ

1.2.0.0以上

説明

プレビュービューアの背景色を返します。

形式

color = component.getPreviewBackgroundColor();

リターンタ

プレビュービューアの背景色、文字列

1.2.0.0以上

説明

プレビュービューアの背景色を設定する。

背景色は、16進数表記（#FFFFFF）に続く。

// trueに設定すると、ビューアを使用することができる。
dx.setPreviewEnable(true);
// 背景色を設定する。
dx.setPreviewBackgroundColor("#ff0000");
// 内蔵ビューアを使用して、プレビューを実行するように設定する。（デフォルト1）
dx.setPreviewMethod(1);
// 最初のファイルがローカルの画像ファイルであれば、内蔵ビューアを実行する。
dx.preview(0);

形式

component.setPreviewBackgroundColor(color);

パラメータ

1.2.0.0以上

説明

プレビュー方法を返します。

形式

method = component.getPreviewMethod();

リターンタ

プレビュー方法。1であれば内蔵ビューア、2の場合、イベントの呼び出し方法

1.2.0.0以上

説明

プレビュー方法を設定する。

1であれば内蔵ビューアを使用して画像を画面に出力する。

2であり、イベントを呼び出す方法が提供され、この方法は、開発者が自分だけのプレビュー画面を構成する目的で使用することができる。

// trueに設定すると、ビューアを使用することができる。
dx.setPreviewEnable(true);
// 背景色を設定する。
dx.setPreviewBackgroundColor("#ff0000");
// イベント方式に設定する。
dx.setPreviewMethod(2);
// 最初のファイルがローカルの画像ファイルであれば、内蔵ビューアを実行する。
dx.preview(0);
// プレビューイベントが発生すると呼び出されるコールバック関数である。
function onDX5Preview(id, itemIndex, itemId, itemSource) {
  ...
  if (itemSource) {
    target.src = itemSource;
  }
}

形式

component.setPreviewMethod(method);

パラメータ

1.0.0.0以上

説明

指定された一意のIDに対応する削除状態の仮想ファイルを返します。

// 削除状態であるファイル（項目）を得る。
item = dx.getRemovedFileById(id);
// ファイルの名前を出力する。
console.log(item.name);

形式

item = component.getRemovedFileById(id);

パラメータ

リターンタ

削除状態の仮想ファイル（コピー）

1.0.0.0以上

説明

削除状態の仮想ファイルの一意のID値を要素として持つ配列を返します

仮想ファイルは削除がされるとき、完全に削除されずに削除された状態に変更されて保管される。

// 削除状態である仮想ファイルの一意のID値を要素として持つ配列を得る。
ids = dx.getRemovedFileIds();

形式

ids = component.getRemovedFileIds();

リターンタ

削除状態の仮想ファイルの一意のID値を要素として持つ配列

1.0.0.0以上

説明

削除状態の仮想ファイルを要素として持つ配列を返します。

仮想ファイルは削除がされるとき、完全に削除されずに削除された状態に変更されて保管される。

// 削除状態である仮想ファイルを要素として持つ配列を返します。
removeds = dx.getRemovedFiles();

形式

removeds = component.getRemovedFiles();

リターンタ

削除状態の仮想ファイルを要素として持つ配列

1.0.0.0以上

説明

アップロードした後、サーバーから受信した応答データを返す。

応答データは、onDX5UploadCompletedコールバック関数が呼び出された後に取得することができる。

ローカルリソースがアップロードがされると、サーバーは、応答データを記録し、すべてのアップロードが完了すると、onDX5UploadCompleted関数が呼び出されます。アップロードが完了したイベントが発生した後にgetResponses関数を使用して応答データを得ることができる。

応答データは、文字列である。

「ORAF」アップロード方式のときは、単一​​の文字列のみが返されるので、返される配列の長さは1である。

「OROF」、「EXTS」アップロード方式のときは、アップロードされたファイルの数だけを返すので、返される配列の長さは、ファイルの数と同じである。

パラメータが与えられた場合は、配列ではなく、パラメータの順序に対応する応答文字列を返します

function onDX5UploadCompleted(id) {
  // 最初の応答文字列を返します。
  var response = dx.getResponses(0);
  console.log(response);
}

形式

responses = component.getResponses([index]);

パラメータ

リターンタ

• パラメータが与えられた場合：指定された順序に対応する応答文字列
• パラメータが存在しない場合：すべての応答文字列を持つ配列

1.0.0.0以上

説明

選択された項目の数を返します。

パラメータの値がtrueの場合、仮想ファイルを除くローカル・リソースのみをカウントした値が返される。

// 選択された項目の数を得る。
count = dx.getSelectedCount();
// 選択されたローカル・リソースの数を取得するにはパラメータをtrueに設定する。
count = dx.getSelectedCount(true);

形式

count = component.getSelectedCount([onlyLocal]);

パラメータ

リターンタ

選択した項目の数

1.0.0.0以上

説明

選択された項目の順序の値を要素として持つ配列を返します。

パラメータの値がtrueの場合、仮想ファイルを除くローカル・リソースのみをカウントした値が返される。

// 選択された項目の順序の値を要素として持つ配列を得る。
indices = dx.getSelectedIndices();
// 選択されたローカル・リソースの順序を取得するにはパラメータをtrueに設定する。
indices = dx.getSelectedIndices(true);

形式

indices = component.getSelectedIndices([onlyLocal]);

パラメータ

リターンタ

選択された項目の順序の値を要素として持つ配列

1.0.0.0以上

説明

選択した項目の一意のID値を要素として持つ配列を返します。

パラメータの値がtrueの場合、仮想ファイルを除くローカル・リソースのみをカウントした値が返される。

// 選択された項目の一意のID値を要素として持つ配列を得る。
ids = dx.getSelectedItemIds();
// 選択されたローカル・リソースの一意のIDを取得するにはパラメータをtrueに設定する。
ids = dx.getSelectedItemIds(true);

形式

ids = component.getSelectedItemIds([onlyLocal]);

パラメータ

リターンタ

選択した項目の一意のID値を要素として持つ配列

1.0.0.0以上

説明

選択した項目を要素に持つ配列を返します。

パラメータの値がtrueの場合、仮想ファイルを除くローカル・リソースのみをカウントした値が返される。

// 選択された項目だけ配列で囲んで返します。
var selecteds = dx.getSelectedItems();

形式

items = component.getSelectedItems([onlyLocal]);

パラメータ

リターンタ

選択した項目を要素に持つ配列

1.0.0.0以上

説明

セパレータ文字列を返します。

形式

splitter = component.getSplitString();

リターンタ

セパレータ文字列、デフォルトは "[SPLT]」である。

1.0.0.0以上

説明

区切り文字の文字列を設定する。

DEXTUploadX5は、サーバーへのメタデータを送信するときに、区切り文字の文字列を含む文字列データを送信する。

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 区分版の文字をパイプライン文字（|）に設定する。
  dx.setSplitString("|");
  // 区分版の文字を出力する。
  console.log(dx.getSplitString());
}

形式

component.setSplitString(str);

パラメータ

1.0.0.0以上

説明

PHP環境をサポートするかどうかを返します。

形式

enable = component.getSupportPHP();

リターンタ

PHP環境をサポートするかどうか

1.0.0.0以上

説明

PHPサポートするかどうかを設定する。

DEXTUploadX5製品は、ファイルを「DEXTUploadX5_FileDataフォーム名に送信する。

ORAF伝送方式を使用している場合は、複数のファイルを同時にアップロードしてもフォームの名前は同じである。

しかし、PHPの場合は、同じフォーム名に複数のファイルを同時にアップロードするフォーム名を配列のように設定する必要がある。

つまり「DEXTUploadX5_FileData[]」のように配列形式でフォームの名前を作らなければならない。

function onDX5Created(id) {
  var dx = dx5.get(id);
  // PHPならtrueに設定する。
  dx.setSupportPHP(true);
}

デフォルトのアップロード方式であるORAFある場合は、PHPの環境であることを設定する必要がある。しかしOROF、EXTSアップロード方式は、要求に1つのファイル情報のみを伝達するので、setSupportPHP関数を使用する必要がない。

形式

component.setSupportPHP(enable);

パラメータ

1.0.0.0以上

説明

コンポーネントに追加されたファイルのサイズの合計値を返します。

パラメータの値がtrueの場合、仮想ファイルを除くローカル・リソースのみを計算された値が返される。

function onDX5Created(id) {
  var dx = dx5.get(id);
  // ファイル全体のサイズの合計を出力する。
  console.log(dx.getTotalFileSize());
}

形式

totalSize = component.getTotalFileSize([onlyLocal]);

パラメータ

リターンタ

ファイル全体のサイズの合計

1.0.0.0以上

説明

コンポーネントに追加された項目の数を返します。

パラメータの値がtrueの場合、仮想ファイルを除くローカル・リソースのみをカウントした値が返される。

// 項目の数を出力する。
console.log(dx.getTotalItemCount());

形式

count = component.getTotalItemCount([onlyLocal]);

パラメータ

リターンタ

現在の項目の数

1.0.0.0以上

説明

ローカルファイルの数を返します。

DEXTUploadX5が持つことができる項目は、ローカルファイル、仮想ファイルがあります。

ローカルファイルは、コンポーネントから得ることができるアイテムのtype属性が "FILE"である。

// ローカルファイルの数を出力する。
console.log(dx.getTotalLocalFileCount());

形式

count = component.getTotalLocalFileCount();

リターンタ

ローカルファイルの数

1.0.0.0以上

説明

削除状態の仮想ファイルの数を返します。

仮想ファイルは削除がされるとき、完全に削除されずに削除された状態に変更されて保管される。

// 削除状態である仮想ファイルの数を返します。
count = dx.getTotalRemovedFileCount();
console.log(count);

形式

count = component.getTotalRemovedFileCount();

リターンタ

削除状態の仮想ファイルの数

1.0.0.0以上

説明

削除状態の仮想ファイルのサイズ合計を返します。

仮想ファイルは削除がされるとき、完全に削除されずに削除された状態に変更されて保管される。

// 削除状態である仮想ファイルのサイズ合計を返します。
rsize = dx.getTotalRemovedFileSize();
console.log(rsize);

形式

rsize = component.getTotalRemovedFileSize();

リターンタ

削除状態の仮想ファイルのサイズ合計

1.0.0.0以上

説明

仮想ファイルの数を返します。

DEXTUploadX5が持つことができる項目は、ローカルファイル、仮想ファイルがあります。

仮想ファイルは、コンポーネントから得ることができるアイテムのtype属性が「VIRTUAL」である。

仮想ファイルはaddVirtualFile、addVirtualFileList関数を使用して追加することができる。

// 仮想ファイルの数を出力する。
console.log(dx.getTotalVirtualFileCount());

形式

count = component.getTotalVirtualFileCount();

リターンタ

仮想ファイルの数

1.0.0.0以上

説明

DEXTUploadX5コンポーネントのバージョンを返します。

function onDX5Created(id) {
  var dx = dx5.get(id);
  // バージョンを出力する。
  console.log(dx.getVersion());
}

形式

strVersion = component.getVersion();

リターンタ

バージョン文字列

1.0.0.0以上

説明

アップロードすることができる対象があるかを返します。

function upload(id) {
  var dx = dx5.get(id);
  // アップロードする対象があることを確認した後、アップロードを開始します。
  if (dx.hasUploadableItems()) {
    // アップロードを開始します。
  } else {
    alert("アップロードする対象がない。");
  }
}

形式

has = component.hasUploadableItems();

リターンタ

アップロードすることができる対象がある場合はtrue、なければfalse

1.0.0.0以上

説明

拡張子のないファイルを追加可能にするかどうかを返します。

形式

allow = component.isAllowNoExtension();

リターンタ

拡張子のないファイルを許可するtrue、またはfalse

1.0.0.0以上

説明

拡張子のないファイルを追加可能にするかどうかを設定する。

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 拡張子がないファイルを追加を妨げる。
  dx.setAllowNoExtension(false);
  // 拡張子がないファイルを追加可能にするかどうかを出力する。
  console.log(dx.isAllowNoExtension());
}

形式

component.setAllowNoExtension(allow);

パラメータ

1.0.0.0以上

説明

プレビュービューアを使用するかどうかを返します。

形式

enable = component.isPreviewEnable();

リターンタ

プレビュービューアを使用するかどうか

1.0.0.0以上

説明

プレビュービューアを使用するかどうかを設定する。

対象が画像ファイルであり、プレビューが可能な場合は、画面またはイベントにプレビュー機能を提供する。

サポートしているフォーマットは、次のとおりである。

• JPG、GIF、PNG、BMP

// trueに設定すると、ビューアを使用することができる。
dx.setPreviewEnable(true);
// 背景色を設定する。
dx.setPreviewBackgroundColor("#ff0000");
// 内蔵ビューアを使用して、プレビューを実行するように設定する。（デフォルト1）
dx.setPreviewMethod(1);
// 最初のファイルがローカルの画像ファイルであれば、内蔵ビューアを実行する。
dx.preview(0);

形式

component.setPreviewEnable(enable);

パラメータ

1.0.0.0以上

説明

指定された順序に対応する項目が選択状態であるかを返します。

// 6回目の項目を選択した状態に変更する。
dx.selectByIndex(5);
// 6回目の項目を選択した状態であることを出力する。
console.log(dx.isSelectedByIndex(5));

形式

selected = component.isSelectedByIndex(index);

パラメータ

リターンタ

選択状態ならtrue、なければfalse

1.0.0.0以上

説明

指定された一意のIDに対応するエントリをロック状態に変更する。

項目がロックさ対象を削除することができない。

// 対象をロック状態に変更する。
dx.lockById(id);
// 対象のロック状態を解除する。
dx.unlockById(id);

形式

component.lockById(id);

パラメータ

1.0.0.0以上

説明

指定された一意のIDに対応するエントリのロック状態を解除する。

項目がロックさ対象を削除することができない。

// 対象をロック状態に変更する。
dx.lockById(id);
// 対象のロック状態を解除する。
dx.unlockById(id);

形式

component.unlockById(id);

パラメータ

1.0.0.0以上

説明

指定された順序に対応する項目をロック状態に変更する。

項目がロックさ対象を削除することができない。

// 対象をロック状態に変更する。
dx.lockByIndex(5);
// 対象のロック状態を解除する。
dx.unlockByIndex(5);

形式

component.lockByIndex(index);

パラメータ

1.0.0.0以上

説明

指定された順序に対応する項目のロック状態を解除する。

項目がロックさ対象を削除することができない。

// 対象をロック状態に変更する。
dx.lockByIndex(5);
// 対象のロック状態を解除する。
dx.unlockByIndex(5);

形式

component.unlockByIndex(index);

パラメータ

1.2.0.0以上

説明

登録しようとするローカルファイルがイメージファイルである場合は、対象のファイルをプレビューできるビューアを提供する。

内蔵ビューアを使用している場合は、ブラウザを全画面表示にし、プレビュー領域を生成される。

これとは異なり、プレビュー方式をイベントの呼び出し方法で設定すれば、開発者が希望するプレビュー画面の構成が可能になる。

ローカルファイルのみプレビューが可能である。

// trueに設定すると、ビューアを使用することができる。
dx.setPreviewEnable(true);
// 背景色を設定する。
dx.setPreviewBackgroundColor("#ff0000");
// 内蔵ビューアを使用して、プレビューを実行するように設定する。（デフォルト1）
dx.setPreviewMethod(1);
// 最初のファイルがローカルの画像ファイルであれば、内蔵ビューアを実行する。
dx.preview(0);

形式

component.preview(index);

パラメータ

1.0.0.0以上

説明

指定された一意のIDに対応する仮想ファイルを削除する。

項目を削除するときに、対象と仮想ファイルであれば、すぐに削除せずに削除状態で保管する。

これとは異なり、ローカルのリソースは、状態を変更せず、完全に除去される。

このように、削除の状態で保管されている仮想ファイルはpurgeRemovedVirtual関数を使用して完全に除去が可能である。

// 指定された一意のIDに対応する仮想ファイルを削除する。
dx.purgeRemovedVirtual(id);

形式

component.purgeRemovedVirtual(id);

パラメータ

1.0.0.0以上

説明

すべての項目を削除する。

項目を削除するときに、対象と仮想ファイルであれば、すぐに削除せずに削除状態で保管する。

これとは異なり、ローカルのリソースは、状態を変更せず、完全に除去される。

// すべてのエントリを削除する。
dx.removeAll();
// すべての項目（仮想ファイルの場合でも、完全に削除）を削除する。
dx.removeAll(true);

形式

component.removeAll([perma[, fireEvent]]);

パラメータ

1.0.0.0以上

説明

指定された一意のIDに対応するエントリを削除する。

項目を削除するときに、対象と仮想ファイルであれば、すぐに削除せずに削除状態で保管する。

これとは異なり、ローカルのリソースは、状態を変更せず、完全に除去される。

// 指定された一意のIDに対応するエントリを削除する。
dx.removeById(id);
// 指定された一意のIDに対応するエントリを削除する（仮想ファイルの場合でも、完全に削除）する。
dx.removeById(id, true);

形式

component.removeById(id [, perma[, fireEvent]]);

パラメータ

1.0.0.0以上

説明

指定された順序に対応する項目を削除する。

項目を削除するときに、対象と仮想ファイルであれば、すぐに削除せずに削除状態で保管する。

これとは異なり、ローカルのリソースは、状態を変更せず、完全に除去される。

// 6回目の項目を削除する。
dx.removeByIndex(5);
// 6回目のエントリを削除（仮想ファイルの場合でも、完全に削除）する。
dx.removeByIndex(5, true);

形式

component.removeByIndex(index [, perma[, fireEvent]]);

パラメータ

1.0.0.0以上

説明

チェックされた項目のすべてを削除する。

項目を削除するときに、対象と仮想ファイルであれば、すぐに削除せずに削除状態で保管する。

これとは異なり、ローカルのリソースは、状態を変更せず、完全に除去される。

// チェックされた項目のすべてを削除する。
dx.removeChecked();
// チェック項目（仮想ファイルの場合でも、完全に削除）の両方を削除する。
dx.removeChecked(true);

形式

component.removeChecked([perma[, fireEvent]]);

パラメータ

2.0.0.0以上

説明

カスタムヘッダを削除する。

DEXTUploadX5はファイルをアップロードしたり、ダウンロードしたときには、カスタムヘッダをHTTPリクエストに一緒に乗せて送信することができる。

setCustomHeaderメソッドを使用して、ユーザー定義のヘッダを設定することができ、getCustomHeaderメソッドを使用してヘッダーの値を確認することができる。

一度カスタムヘッダーが設定されると、以降のすべての要求にヘッダを含めて見るので、もしヘッダが必要としていない状況であれば、removeCustomHeaderメソッドを使用して、既に設定されたヘッダを削除することができる。

// ユーザー定義のヘッダを設定する。
dx.setCustomHeader("X-Third-Party-Name", "DEXTUploadX5");
// カスタムヘッダーの値を確認する。
value = dx.getCustomHeader("X-Third-Party-Name");
// 対象ヘッダを削除する。
dx.removeCustomHeader("X-Third-Party-Name")

ヘッダー名と値は、製品内部でエンコード処理をしていないので、エンコードが必要な状況であれば、直接処理しなければならない。

クロスドメイン要求をする状況であれば、CORS（Cross-Origin Resource Sharing）の設定かどうかに応じて、ユーザー定義のヘッダーをサーバー側で許可されないこともある。したがって、カスタムヘッダを正常に転送するためには、Access-Control-Allow-Headersレスポンスヘッダを利用して、ユーザー定義のヘッダを許可するか、サーバー（ウェブ）プラットフォームに合わせて設定をヘジュオヤする。

形式

component.removeCustomHeader(name);

パラメータ

1.0.0.0以上

説明

選択した項目をすべて削除する。

項目を削除するときに、対象と仮想ファイルであれば、すぐに削除せずに削除状態で保管する。

これとは異なり、ローカルのリソースは、状態を変更せず、完全に除去される。

// 選択された項目のすべてを削除する。
dx.removeSelected();
// 選択された項目（仮想ファイルの場合でも、完全に削除）の両方を削除する。
dx.removeSelected(true);

形式

component.removeSelected([perma[, fireEvent]]);

パラメータ

1.0.0.0以上

説明

削除された仮想ファイルをすべて回復する。

項目を削除するときに、対象と仮想ファイルであれば、すぐに削除せずに削除状態で保管する。

これとは異なり、ローカルのリソースは、状態を変更せず、完全に除去される。

このように、削除の状態で保管されている仮想ファイルをすべて回復するには、revokeAllVirtualFiles関数を使用する。

// 削除された仮想ファイルをすべて回復する。
dx.revokeAllVirtualFiles();

形式

component.revokeAllVirtualFiles();

1.0.0.0以上

説明

指定された一意のIDに対応する削除された仮想ファイルを復元する。

目を削除するときに、対象と仮想ファイルであれば、すぐに削除せずに削除状態で保管する。

これとは異なり、ローカルのリソースは、状態を変更せず、完全に除去される。

このように、削除の状態で保管されている仮想ファイルを再修復するrevokeVirtualFile関数を使用する。

// 指定されたユーザ名に対応する削除された仮想ファイルを復元する。
dx.revokeVirtualFile(id);

形式

component.revokeVirtualFile(id);

パラメータ

1.0.0.0以上

説明

すべての項目を選択状態に変更する。

// すべての項目を選択状態に変更する。
dx.selectAll();
// すべての項目を選択解除状態に変更する。
dx.unselectAll();

形式

component.selectAll();

1.0.0.0以上

説明

すべての項目を選択解除状態に変更する。

// すべての項目を選択状態に変更する。
dx.selectAll();
// すべての項目を選択解除状態に変更する。
dx.unselectAll();

形式

component.unselectAll();

1.0.0.0以上

説明

指定された順序に対応する項目を選択した状態に変更する。

// 6回目の項目を選択した状態に変更する。
dx.selectByIndex(5);
// 6回目の項目を選択し失効状態に変更する。
dx.unselectByIndex(5);

形式

component.selectByIndex(index);

パラメータ

1.0.0.0以上

説明

指定された順序に対応する項目を選択し失効状態に変更する。

// 6回目の項目を選択した状態に変更する。
dx.selectByIndex(5);
// 6回目の項目を選択し失効状態に変更する。
dx.unselectByIndex(5);

形式

component.unselectByIndex(index);

パラメータ

1.0.0.0以上

説明

フィルタリングされたファイルを全部または部分ブロックするかを設定する。

ここでブロックとは、ファイルの追加を防ぐことをいう。

登録しようとするファイルが事前に定義されたフィルタに違反する場合には、対象はブロックされる。

もし全体のファイルサイズの制限が10MBであるとき、追加したいファイルが8MB、1MB、3MB、4MBであれば、8MB、1MBの両方のファイルを登録するかどうかを問い合わせている。

setFilterSilence関数をtrueに設定すると、このような質の過程なしファイルの追加のプロセスがすべてキャンセルされます。

function onDX5Created(id) {
  var dx = dx5.get(id);
  ...
  // フィルタ条件に基づいてフィルタリングされた場合には、部分許可なしにブロック（追加をしない）である。
  dx.setFilterSilence(true);
}

形式

component.setFilterSilence(enable);

パラメータ

1.1.0.0以上

説明

ソートを行うと、仮想ファイルを最優先にするかを設定する。

仮想ファイルを最優先とするならば、昇順、降順に関係なく、常に仮想ファイルが最初に位置する。

// ソートするとき、仮想ファイルを一番優先するようにする。
dx.setSortPriorityVirtualFile(true);

形式

component.setSortPriorityVirtualFile(enable);

パラメータ

1.0.0.0以上

説明

GUIスタイルを変更する。

setUIStyle関数スタイルのプロパティが指定されたjsonオブジェクトを設定すると、スタイルが変更される。

dx.setUIStyle({
 headerVisible: false, statusBarVisible: false, borderVisible: true
});

形式

component.setUIStyle({ /* UI 属性 */ });

パラメータ

1.0.0.0以上

説明

特定のコンポーネントが持つローカルのリソースを現在のコンポーネントに追加します。

DEXTUploadX5は、ファイル選択ダイアログ、フォルダ選択ダイアログだけを持って、ローカルリソースを追加することができるように設計されました。

しかし、コンポーネント同士の項目を与えなければならない状況では、ローカルのリソースデータを互いに共有しなければならない状況が発生する。

setUploadableFilesFrom関数は、スクリプトでローカル・リソースの項目を登録することができるように生成された関数であり、ひたすらコンポーネント同士の項目を送受信目的としてぴったりとします。

// マルチモジュールで、「dext5-uploader」コンポーネントが「dext5-a」、「dext5-b」コンポーネントのローカルリソース項目を代わりにアップロードする方法である。
var uploader = dx5.get("dext5-uploader");
			
uploader.clearItems();
// 最初のコンポーネントからアップロードをするためのファイル情報を得る。
uploader.setUploadableFilesFrom(dx5.get("dext5-a"));
// 二番目のコンポーネントからアップロードをするためのファイル情報を得る。
uploader.setUploadableFilesFrom(dx5.get("dext5-b"));
uploader.setUploadURL("アップロードパス");
uploader.upload("AUTO");

setUploadableFilesFromメソッドを使ってファイルを取得したコンポーネントはUIの変化がありません。

2.3.1.0より前のバージョンでは、関数名がsetUploableFilesFromだった。

3.4.0.0バージョンでは、ソートされた順序でアップロードする場合、対象コンポーネントのソートされた状態で項目情報を取得することができます。

var uploader = dx5.get("dext5-uploader");

uploader.clearItems();

// アップロード順序をソート順に設定します。
uploader.setUploadByOrder(true);

// ターゲットコンポーネントからアイテムをフェッチするときは、並べ替えられた順序でアイテムをフェッチします。
uploader.setUploadableFilesFrom(dx5.get("dext5-a"));
uploader.setUploadableFilesFrom(dx5.get("dext5-b"));

uploader.setUploadURL("アップロードパス");
uploader.upload("AUTO");

setUploableFilesFromを使用して登録されたアイテムは、setAutoSortingType、setEnableColumnSorting、およびsortColumnIndexの影響を受けません。

形式

component.setUploadableFilesFrom(otherComponent);

パラメータ

1.0.0.0以上

説明

大容量ファイルのアップロードを実行すると、アップロードの単位サイズを設定する。

DEXTUploadX5は大容量のファイルのアップロードを実行すると、ファイルを指定されたブロックサイズに分けて送信する。

100MBのファイルをアップロードするとき、ブロックサイズが10MBなら、メタデータ転送を含む、合計11回（ヘッダの転送1回+ファイル転送10回）リクエストが発生する。

setUploadBlockSize関数は、大容量アップロードのみ動作するため、「ORAF」、「OROF」、「AWSS3」転送では無視される。

function onDX5Created(id) {
  var dx = dx5.get(id);
  // 大容量アップロードの方法で使用する。
  dx.setUploadMode("EXTS");
  // アップロードブロック単位を10MBに設定します。
  dx.setUploadBlockSize(10 * 1024 * 1024);
}

形式

component.setUploadBlockSize(blockSize);

パラメータ

1.1.0.0以上

説明

指定されたコラムを基準に並べ替えをする。

仮想ファイルを最優先とするならば、昇順、降順に関係なく、常に仮想ファイルが最初に位置する。

// 1番目の列を基準に昇順の並べ替えをすぐ実行する。
dx.sortColumnIndex(1, false);

ファイル名でソートする場合は1、ファイルサイズでソートする場合は2をindex値として設定しなければならない。 もし、他の値の場合、ソート作業を行わない。

TILEスタイルの場合は、カラムの順番に関係なく、ファイル名を基準に無条件にソートを行います。

// ファイルのサイズを基準に昇順ソートを実行する。
// もしタイル形式であれば、ファイル名を基準に昇順ソートを実行する。
dx.sortColumnIndex(2, false);

形式

component.sortColumnIndex(index, ascending);

パラメータ

1.0.0.0以上

説明

DEXTUploadX5は、コンポーネント自体にアップロード停止するボタンやGUI要素がない。

代わりに、スクリプトを使用して停止することができるように関数を提供している。

<button type="button" onclick="stop('component-id');">停止</button>
<script>
function stop(id) {
  dx5.get(id).stopUploading();
}
</script>

コンポーネントの作成時にbtnStopUploading属性値を使用して自動的にバインドして使用することができる。

<button id="btn-stop-uploading" type="button">停止</button>
<script>
  dx5.create({
    ...,
    // アップロード停止機能が自動的に接続される。
    btnStopUploading: "btn-stop-uploading"
  });
</script>

形式

component.stopUploading();

1.0.0.0以上

説明

ファイルのアップロードを開始します。

• 「AUTO」：すべてのローカルエントリの中からstatusが「WAIT」のローカルリソースをすべてアップロードする。
• 「SELECTED」：選択されたローカル項目の中からstatusが「WAIT」のローカルリソースをすべてアップロードする。
• 「CHECKED」：チェックされたローカル項目の中からstatusが「WAIT」のローカルリソースをすべてアップロードする。

DEXTUploadX5は、コンポーネント自体にファイルをアップロードするボタンやGUI要素がない。

代わりに、スクリプトを使用してアップロードすることができるように関数を提供している。

<button type="button" onclick="upload('component-id');">アップロード</button>
<script>
function upload(id) {
  var dx = dx5.get(id);
  if (dx.hasUploadableItems()) {
    // アップロードを開始します。
    dx.upload("AUTO");
  } else {
    alert("アップロードする対象がない。");
  }
}
</script>

特別なコードを処理せずに「AUTO」のパラメータの値を持ってアップロードを処理しようとした場合、コンポーネントの作成時にbtnUploadAuto属性値を使用して自動的にバインドして使用することができる。

<button id="btn-upload" type="button">アップロード</button>
<script>
  dx5.create({
    ...,
    // ファイルのアップロード機能が自動的に接続される。
    btnUploadAuto: "btn-upload"
  });
</script>

btnUploadAuto属性のほかに、btnUploadSelected、btnUploadCheckedも使用することができる。

形式

component.upload(flag);

パラメータ

1.0.0.0以上

説明

製品で提供される独自の進行状況ウィンドウを使用するかを設定する。

DEXTUploadX5で基本的にサポートしている進行状況ウィンドウを使用しない場合はuseProgressDialog関数を使用することができる。

代わりにgetUploadStatus関数を使用してアップロードの進行情報をスクリプトで別々に得ることができる。

// メイン進行ウィンドウを使用していない。
dx.useProgressDialog(false);
// 進行ウィンドウ安保のでgetUploadStatus関数を使用してアップロードの進行情報を得る。
var status = dx.getUploadStatus();
// 名前: status.currentName 
// フルスピード: status.totalSpeed 
// アップロードが完了した数: status.completeCount
// 全体数: status.totalCount
// 現在のファイル転送速度: status.currentRate
// 現在のファイルの転送されたサイズ: status.currentSendSize
// 現在のファイルのサイズ: status.currentSize
// 現在のファイルの転送時間: status.currentTime
// 現在のファイルの残り時間: status.remainedCurrentTime
// ファイル全体レート: status.totalRate
// ファイル全体の送信されたサイズ: status.totalSendSize
// ファイル全体のサイズ: status.totalSize
// ファイル全体の転送時間: status.totalTime
// ファイル全体の残り時間: status.remainedTotalTime

形式

component.useProgressDialog(enable);

パラメータ

1.0.0.0以上

説明

指定された順序に対応する項目をリストの下に移動させる。

moveItemDown関数を使用して、ターゲットが移動するようにすると、ターゲットの順序は変更される。

// 6回目の項目を7番目に移動する。
dx.moveItemDown(5);

形式

component.moveItemDown(index);

パラメータ

1.0.0.0以上

説明

指定された順序に対応する項目をリストの上に移動させる。

moveItemUp関数を使用して、ターゲットが移動するようにすると、ターゲットの順序は変更される。

// 6回目の項目を5番目に移動する。
dx.moveItemUp(5);

形式

component.moveItemUp(index);

パラメータ