Skip to content

Canvas::Annotate method

The Annotate method draws the given annotation onto the current page. The annotation is delivered as a string of JSON text. The schema for Annotations can be found in the Document Filters installation directory in “Annotation-Schema.json”.

Overloads

Annotate(string) Add an annotation from a JSON.
Annotate(Annotation) Add an annotation from am object.

Annotate(string)

Prototype

void Annotate(string annotation)

void Annotate(string annotation) throws IGRException;

def Annotate(self, annotation: string) -> void

void Annotate(const std::wstring& annotation)

Parameters

annotation: string : JSON representation of an annotation.

Annotate(Annotation)

Prototype

void Annotate(Annotation annotation)

void Annotate(Annotation annotation) throws IGRException;

def Annotate(self, annotation: Annotation) -> void

void Annotate(Annotation annotation)

Parameters

annotation: Annotation : Object representation of an annotation.

Sample Code

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
using Hyland.DocumentFilters;

var api = new Hyland.DocumentFilters.Api();
api.Initialize("License Code", ".");

using var canvas = api.MakeOutputCanvas("barcode.png", CanvasType.PNG);
canvas.BlankPage(400, 400);
canvas.Annotate(new Hyland.DocumentFilters.Annotations.QrCode {
    Caption = "Hello World",
    Text = "http://www.hyland.com",
    Rect = System.Drawing.Rectangle.FromLTRB(20, 20, 380, 380)
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
import com.perceptive.documentfilters.*;

public class GenerateQRCode {
    public static void main(String[] args) {
        try {
            // Initialize the API
            Api api = new Api();
            api.Initialize("License Code", ".");

            // Create an output canvas
            try (Canvas canvas = api.MakeOutputCanvas("barcode.png", CanvasType.PNG.swigValue())) {
                // Create a blank page
                canvas.BlankPage(400, 400);

                // Create and configure the QR code annotation
                AnnotationQrCode qrCode = new AnnotationQrCode();
                qrCode.setCaption("Hello World");
                qrCode.setContent("http://www.hyland.com");
                qrCode.setRect(new AnnotationRect(20, 20, 380, 380));

                // Annotate the canvas
                canvas.Annotate(qrCode);
            }
        } catch (IGRException e) {
            System.err.println("Error: " + e.getMessage());
        }
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
from DocumentFilters import *

api = DocumentFilters()
api.Initialize("License Code", ".")

with api.MakeOutputCanvas("barcode.png", IGR_DEVICE_IMAGE_PNG) as canvas:
    canvas.BlankPage(400, 400)

    anno = AnnotationQrCode()
    anno.Caption = "Hello World"
    anno.Content = "http://www.hyland.com"
    anno.Margin = 8
    anno.ErrorCorrectionLevel = 3
    anno.Rect = AnnotationRect.FromLTRB(20, 20, 380, 380)
    canvas.Annotate(anno)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
#include "DocumentFiltersObjects.h"

int main() {
    try {
        // Create and initialize the API object
        Hyland::DocFilters::Api api;
        api.Initialize("License Code", ".");

        // Create the output canvas 
        Hyland::DocFilters::Canvas canvas = api.MakeOutputCanvas("barcode.png", Hyland::DocFilters::CanvasType::PNG);

        // Set up a blank page
        canvas.BlankPage(400, 400);

        // Create and configure the QR code annotation
        Hyland::DocFilters::AnnotationQrCode qrCode;
        qrCode.setCaption(L"Hello World");
        qrCode.setText(L"http://www.hyland.com");
        qrCode.setRect(Hyland::DocFilters::RectI32::ltrb(20, 20, 380, 380));

        // Add the QR code to the canvas
        canvas.Annotate(qrCode);

        // Close the canvas (ensures the image is saved)
        canvas.Close(); 

    } catch (const std::exception& e) {
        std::cerr << "Error: " << e.what() << std::endl;
        return 1; // Indicate an error
    }

    return 0; // Successful execution
}