VintaSoft Imaging .NET SDK v8.6
Vintasoft.Imaging.Annotation Namespace / WebAnnotationViewControllerJS type / burnAnnotationCollection Method
WebImageJS object.
Indicates whether the changes must be saved in the source file. True - changes must be saved in the source file; False - changes must be saved in new file.
Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    • errorMessage (string): Error message.
    • blocked (boolean): Indicates that the requested action is blocked by another request.
    • sourceImage (object): WebImageJS object.
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
In This Topic
    burnAnnotationCollection Method
    In This Topic
    Burns annotation collection on image.
    Syntax
    var instance = new Vintasoft.Imaging.Annotation.WebAnnotationViewControllerJS(images);
    var value; // Type: any
    
    // Parameters
    var image; // Type:  object
    var changeSourceFile; // Type:  boolean
    var successFunc; // Type:  object
    var errorFunc; // Type:  object
    
    value = instance.burnAnnotationCollection(image, changeSourceFile, successFunc, errorFunc);
    function burnAnnotationCollection( 
       image : object,
       changeSourceFile : boolean,
       successFunc : object,
       errorFunc : object
    ) : any;

    Parameters

    image
    WebImageJS object.
    changeSourceFile
    Indicates whether the changes must be saved in the source file. True - changes must be saved in the source file; False - changes must be saved in new file.
    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:
    • imageInfo (object): Information about image (image ID and page index).
    • sourceImage (object): WebImageJS object, which represents image without annotations.
    • processedImage (object): WebImageJS object, which represents image with burned annotations.
    errorFunc
    Function that will be executed if request is failed.
    Here is function prototype "function __error(data)".
    The data parameter can be:
    1. An object with following properties:
      • errorMessage (string): Error message.
      • blocked (boolean): Indicates that the requested action is blocked by another request.
      • sourceImage (object): WebImageJS object.
      if exception is catched inside web service.
    2. Otherwise, jqXHR object.
    Browser Compatibility
    9
    5
    15
    5
    See Also