Version 1.0.0.0 or later

Explanation

Add the virtual file.

A virtual file is a fake file that does not exist on the user's local PC and has no substance. In general, virtual files are used to keep information about already uploaded files. That is, it is used as an indication that the file exists in the server. It is not a file to upload because it is not actually locally present.

To add a virtual file, use the addVirtualFile function or the addVirtualFileList function.

function onDX5Created(id) {
    // The virtual file is usually added at the time the component is created.
    var dx = dx5.get(id);
    // When adding individually
    dx.addVirtualFile({ vindex: "IDX0001", name: "virtual_file.txt", size: 12345 });
    dx.addVirtualFile({ vindex: "IDX0002", name: "virtual_file_lock.txt", size: 45678, lock: true });
    dx.addVirtualFile({ vindex: "IDX0003", name: "cosmos.jpg", size: 195779 });
    // When adding at once
    dx.addVirtualFileList([
        { vindex: "IDX0004", name: "virtual_file.txt", size: 12345 },
        { vindex: "IDX0005", name: "virtual_file_lock.txt", size: 45678, lock: true },
        { vindex: "IDX0006", name: "cosmos.jpg", size: 195779 }
    ]);
}

When the virtual file is added, the onDX5BeforeItemsAdd, onDX5BeforeItemAdding, and onDX5ItemsAdded callback functions are not called.

Uses

component.addVirtualFile(vf);

Parameters

Version 1.0.0.0 or later

Explanation

Add the virtual files at once using the array.

A virtual file is a fake file that does not exist on the user's local PC and has no substance.

In general, virtual files are used to keep information about already uploaded files. That is, it is used as an indication that the file exists in the server.

It is not a file to upload because it is not actually locally present.

To add a virtual file, use the addVirtualFile function or the addVirtualFileList function.

function onDX5Created(id) {
  // The virtual file is usually added at the time the component is created.
  var dx = dx5.get(id);
  // When adding individually
  dx.addVirtualFile({ vindex: "IDX0001", name: "virtual_file.txt", size: 12345 });
  dx.addVirtualFile({ vindex: "IDX0002", name: "virtual_file_lock.txt", size: 45678, lock: true });
  dx.addVirtualFile({ vindex: "IDX0003", name: "cosmos.jpg", size: 195779 });
  // When adding at once
  dx.addVirtualFileList([
    { vindex: "IDX0004", name: "virtual_file.txt", size: 12345 },
    { vindex: "IDX0005", name: "virtual_file_lock.txt", size: 45678, lock: true },
    { vindex: "IDX0006", name: "cosmos.jpg", size: 195779 }
  ]);
}

When the virtual file is added, the onDX5BeforeItemsAdd, onDX5BeforeItemAdding, and onDX5ItemsAdded callback functions are not called.

Uses

component.addVirtualFileList(vfs);

Parameters

Version 1.0.0.0 or later

Explanation

Opens a file selection dialog for adding files to be uploaded.

DEXTUploadX5 has no buttons or GUI elements to add files to the component itself.

Instead, it provides a function that allows you to add files using a script.

If there is a target selected in the file selection dialog window, the window is closed and it returns true.

<button type="button" onclick="addFiles();">Button</button>
<script>
function addFiles() {
  var dx = dx5.get("component-id");
  dx.openFileDialog();
}
</script>

If there is no code to handle the return value of the openFileDialog function, it can be automatically binded using the value of the btnFile property at the time of component creation.

<button id="btn-add-files" type="button">Button</button>
<script>
  dx5.create({
    ...,
    // the file add function is automatically binded.
    btnFile: "btn-add-files"
  });
</script>

Uses

component.openFileDialog();

Mutlti-module version 3.6.0.0 later

Explanation

Opens the folder dialog window to add files and folder to upload.

DEXTUploadX5 has no buttons or GUI elements to add folders to the component itself. Instead, it provides a function that lets you add a folder using a script.

<button type="button" onclick="addFolder();">Button</button>
<script>
function addFolder() {
    var dx = dx5.get("component-id");
    dx.openFolderDialog();
}
</script>

It can be automatically binded to a button by using the 'btnFolder' property at the time of component creation.

<button id="btn-add-folder" type="button">Button</button>
<script>
    dx5.create({
        ...,
        // The adding folder function is automatically binded 
        btnFolder: "btn-add-folder"
    });
</script>

Uses

component.openFolderDialog();