VintaSoft Imaging .NET SDK 14.0: Documentation for Web developer
Vintasoft.Imaging.Pdf Namespace / WebPdfDocumentJS type / applyRedactionMarks Property
Syntax Exceptions Remarks BrowserCompatibility SeeAlso
In This Topic
    applyRedactionMarks Method
    In This Topic
    Sends an asynchronous request for applying of redaction marks to PDF document.
    Syntax
    var instance = new Vintasoft.Imaging.Pdf.WebPdfDocumentJS(id, service, pdfDocumentEditorControl);
    
    var value; // Type: any
    
    // Parameters
    var redactionMarks; // Type: WebPdfPageRedactionMarkJS[]
    var redactionMarksAppearance; // Type: WebPdfRedactionMarkAppearanceJS
    var successFunc; // Type: function
    var errorFunc; // Type: function
    
    value = instance.applyRedactionMarks(redactionMarks, redactionMarksAppearance, successFunc, errorFunc);
    
    
    function applyRedactionMarks(
    redactionMarks
    Array of WebPdfPageRedactionMarkJS objects.
    : WebPdfPageRedactionMarkJS[],
    redactionMarksAppearance
    Appearance of the redaction marks OR null.
    : WebPdfRedactionMarkAppearanceJS,
    successFunc
    Function that will be executed if request is executed successfully. Here is function prototype "function __success(data)".
    : Function,
    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.
      if exception is catched inside web service.
    2. Otherwise, jqXHR object.
    : Function
    ) : any;

    Parameters

    redactionMarks
    Array of WebPdfPageRedactionMarkJS objects.
    redactionMarksAppearance
    Appearance of the redaction marks OR null.
    successFunc
    Function that will be executed if request is executed successfully. Here is function prototype "function __success(data)".
    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.
      if exception is catched inside web service.
    2. Otherwise, jqXHR object.
    Exceptions
    ExceptionDescription
    Thrown if arguments have wrong types.
    Thrown if redactionMarks contains redaction mark associated with PDF page from other PDF document.
    Remarks

    Important: If you are working with PDF interactive form in the code, call the "WebPdfDocumentJS.requestInteractiveForm" method for refreshing information about PDF interactive form because all previously requested information about PDF interactive form will be disposed after call of this method.
    If you are working with PDF interactive form using WebPdfInteractiveFormToolJS class, class will refresh information about PDF interactive form automatically.

    Browser Compatibility
    56+
    45+
    11
    See Also