exportFile(Vintasoft.Imaging.WebExportFileSettingsJS,function,function) Method
In This Topic
Exports images (with annotations), which are loaded in web image viewer, to a file.
Syntax
var instance = new Vintasoft.Imaging.DocumentViewer.WebDocumentViewerJS(settings);
var value; // Type: any
// Parameters
var exportFileSettings; // Type: WebExportFileSettingsJS
var successFunc; // Type: function
var errorFunc; // Type: function
value = instance.exportFile(exportFileSettings, successFunc, errorFunc);
function exportFile(
: WebExportFileSettingsJS,
: Function,
: Function
) : any;
Parameters
- exportFileSettings
- An instance of WebExportFileSettingsJS clas that defines the export file settings.
- successFunc
- Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
- imageInfos (object): Information about images in image file.
- isAuthenticationRequired (boolean): A value indicating whether current image file requres authentication.
- images (object): An array of WebImageJS objects created using imageInfos property.
- errorFunc
- Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
- An object with following properties:
- errorMessage (string): Error message.
- blocked (boolean): Indicates that the requested action is blocked by another request.
if exception is catched inside web service. - Otherwise, jqXHR object.
Exceptions
| Exception | Description |
|---|
| Thrown if argument has wrong type. |
Example
ThisJavaScriptcodeshowshowtosaveimageswithannotationtoafile:
// create the export file settings
var exportFileSettings = new Vintasoft.Imaging.WebExportFileSettingsJS();
// specify the indexes of images, which must be saved
exportFileSettings.set_ImageIndexes([ 0, 2, 0, 1 ]);
// specify the name of the file, where images must be saved
exportFileSettings.set_FileId("document.pdf");
// specify that annotations must be saved with images
exportFileSettings.set_SaveAnnotations(true);
// export images to a file
docViewer1.exportFile(
exportFileSettings,
function(data) {
console.log("File is exported successfully.");
},
function(data) {
console.log("File is not exported.");
}
);
Browser Compatibility
See Also
