Overview - Hyland Document Filters v24.3 Docs

Hyland Document Filters v24.3

Implementation Guide

August 2024

Table of contents

81. Getting started

81.1 Getting started with Document Filters

91.2 Getting Started with .NET

121.3 Getting Stated with Python

151.4 Getting Started with Java

181.5 Getting Started with C

241.6 Getting Started with C++

271.7 Getting Started with COM

281.8 Language-specic integration examples

291.9 About multithreading

301.10 About fonts

371.11 About multi-part archives

391.12 About custom streams and extended streams

411.13 About Optical Character Recognition (OCR)

461.14 About conversion proles

471.15 About accessibility info extraction

481.16 Common use cases

481.16.1 How do I open a document from disk?

511.16.2 How do I open a document from memory?

551.16.3 How do I extract metadata from a document?

581.16.4 How do I extract text and metadata from a document?

611.16.5 How do I extract sub-documents from documents and archives?

641.16.6 How do I convert a document to Classic HTML?

661.16.7 How do I convert a document to paginated HiDef HTML?

691.16.8 How do I convert a document to PNG images?

721.16.9 How do I convert a document to a PDF le?

751.16.10 How do I convert a document to Structured XML?

781.16.11 How do I create a barcode?

Document Filters Implementation Guide Table of contents

- 2/1268 -

791.16.12 How do I localize metadata?

841.16.13 How do I compare documents?

872. Reference

872.1 Overview

882.2 C reference

882.2.1 C reference

1052.2.2 Functions

3402.2.3 Structures

3902.2.4 Constants

4742.3 Object reference

4742.3.1 Overview

4752.3.2 Getting started

4782.3.3 Objects

9262.4 Structured XML

9262.4.1 Overview

9272.4.2 <doc> element

9282.4.3 <head> element

9292.4.4 <meta> element

9302.4.5 <page> element

9332.4.6 <header>/<footer> elements

9352.4.7 <section> element

9362.4.8 <column> element

9382.4.9 <p> element

9412.4.10 <line> element

9422.4.11 <run> element

9452.4.12 <word> element

9462.4.13 <oat> element

9492.4.14 <img> element

9502.4.15 <table> element

9522.4.16 <tr> element

Document Filters Implementation Guide Table of contents

- 3/1268 -

9542.4.17 <td> element

9563. Tech Info

9563.1 Supported platforms

9573.2 Platform Requirements

9573.2.1 Windows

9573.2.2 Linux

9583.2.3 Alpine Linux

9593.2.4 FreeBSD

9603.2.5 Solaris

9613.2.6 macOS

9623.2.7 IBM AIX

9643.3 Platform Dierences

9653.4 Supported File Formats

9653.4.1 Archive

9663.4.2 CAD

9673.4.3 Database

9683.4.4 Email and Messaging

9693.4.5 Multimedia

9703.4.6 Other

9723.4.7 Presentation

9733.4.8 Raster Image

9753.4.9 Spreadsheets

9763.4.10 Text and Markup

9783.4.11 Vector Image

9793.4.12 Word Processor and Oce

9833.5 Document format codes

9953.6 Processing Options

10263.7 Third-Party Libraries

10843.8 Known Issues

Document Filters Implementation Guide Table of contents

- 4/1268 -

10864. Releases

10864.1 Releases

10894.2 Document Filters 24.3.0 (Aug 2024)

10924.3 Document Filters24.2.0 (May 2024)

10954.4 Document Filters24.1.0 (Feb 2024)

10994.5 Document Filters23.3.0 (Sep 2023)

11034.6 Document Filters23.2.0 (May 2023)

11054.7 Document Filters23.1.0 (Feb 2023)

11094.8 Document Filters22.4.0 (Nov 2022)

11124.9 Document Filters22.3.0 (Aug 2022)

11154.10 Document Filters22.2.0 (May 2022)

11184.11 Document Filters22.1.0 (Feb 2022)

11204.12 Document Filters21.11.0 (Nov 2021)

11234.13 Document Filters21.8.0 (Aug 2021)

11254.14 Document Filters21.5.0 (May 2021)

11284.15 Document Filters21.2.0 (Feb 2021)

11314.16 Document Filters11.4.20 (Nov 2020)

11334.17 Document Filters11.4.19 (Jul 2020)

11364.18 Document Filters11.4.18 (May 2020)

11384.19 Document Filters11.4.17 (Feb 2020)

11404.20 Document Filters 11.4.16 (December 2019)

11424.21 Document Filters 11.4.15 (September 2019)

11454.22 Document Filters 11.4.14 (June 2019)

11474.23 Document Filters 11.4.13 (March 2019)

11494.24 Document Filters 11.4 Build 3054 (November 2018)

11514.25 Document Filters 11.4 Build 2990 (September 2018)

11524.26 Document Filters 11.4 Build 2934 (July 2018)

11544.27 Document Filters 11.4 Build 2878 (May 2018)

11564.28 Document Filters 11.4 Build 2822 (March 2018)

11584.29 Document Filters 11.4 Build 2766 (January 2018)

Document Filters Implementation Guide Table of contents

- 5/1268 -

11594.30 Document Filters 11.4 Build 2710 (November 2017)

11624.31 Document Filters 11.4 Build 2647 (September 2017)

11644.32 Document Filters 11.4 Build 2600 (August 2017)

11654.33 Document Filters 11.4 Build 2581 (July 2017)

11664.34 Document Filters 11.4 Build 2543 (June 2017)

11674.35 Document Filters 11.4 Build 2452 (March 2017)

11704.36 Document Filters 11.4 Build 2480 (April 2017)

11724.37 Document Filters 11.3 Build 2400 (January 2017)

11744.38 Document Filters 11.3 Build 2356 (December 2016)

11764.39 Document Filters 11.3 Build 2322 (November 2016)

11794.40 Document Filters 11.3 Build 2228 (August 2016)

11824.41 Document Filters 11.3 Build 2172 (June 2016)

11874.42 Document Filters 11.3 Build 2116 (April 2016)

11914.43 Document Filters 11.3 Build 2074 (March 2016)

11944.44 Document Filters 11.3 Build 2040 (January 2016)

11974.45 Document Filters 11.3 Build 1998 (December 2015)

11994.46 Document Filters 11.2 Build 1962 (November 2015)

12024.47 Document Filters 11.2 Build 1914 (September 2015)

12044.48 Document Filters 11.2 Build 1884 (September 2015)

12084.49 Document Filters 11.2 Build 1858 (August 2015)

12104.50 Document Filters 11.2 Build 1808 (June 2015)

12144.51 Document Filters 11.2 Build 1766 (May 2015)

12174.52 Document Filters 11.2 Build 1732 (March 2015)

12224.53 Document Filters 11.2 Build 1666 (January 2015)

12264.54 Document Filters 11.2 (November 2014)

12344.55 Document Filters 11.1 Build 1546 (October 2014)

12394.56 Document Filters 11.1 Build 1464 (July 2014)

12434.57 Document Filters 11.1 Build 1394 (April 2014)

12474.58 Document Filters 11.1 Build 1333 (March 2014)

12504.59 Document Filters 11.1 Build 1262 (December 2013)

Document Filters Implementation Guide Table of contents

- 6/1268 -

12544.60 Document Filters 11.1 (October 2013)

12584.61 Document Filters 11.0 (July 2013)

Document Filters Implementation Guide Table of contents

- 7/1268 -

1. Getting started

1.1 Getting started with Document Filters

Document Filters is an all-in-one SDK that helps software developers embed le identication, data

extraction, document transformation, and format conversion capabilities into their applications.

Document Filters is implemented as a set of Dynamic Link Libraries (DLLs) on Windows and Shared

Objects (SOs) on UNIX-based systems. Document Filters allows an application developer to perform the

following actions:

Identify almost any type of le

Extract text and metadata from hundreds of dierent document formats

Extract sub-documents and attachments from many document and archive formats, including MS

Oce documents, Zips, RARs, 7-Zips, ISOs, CABs, PSTs, & OSTs

Convert the most popular document formats to High-Denition output (with styles, layout and images).

Supported modes include several image types, HTML, PDF, TIFF and Structured XML

Apply Canvas and Drawing functions to achieve document markup, permanent annotations and

redaction

Sample code and header denitions are available in C++, C#, HTML, Java, and Python at https://

github.com/Hyland/DocumentFilters.

•

Document Filters Implementation Guide 1. Getting started

- 8/1268 -

1.2 Getting Started with .NET

The following list describes the minimum set of function calls or methods to create a working application.

Add reference to Hyland.DocumentFilters

Add reference to Hyland.DocumentFilters NuGet project; or

Import Hyland.DocumentFilters project from the samples

Create a Hyland.DocumentFilters.Api object.

Call DocumentFilters.Initialize .

Call DocumentFilters.GetExtractor for one or more documents.

Call Extractor.GetText to retrieve a document’s text.

Call Extractor.Close when nished with each document.

Note: Previous versions used Perceptive.DocumentFilters as a pre-compiled project, which is still

included in the package. A project can be updated to use Hyland.DocumentFilters by updating the

project reference, and changing the namespace.

Yes, Hyland.DocumentFilters is published to NuGet.

DocumentFilters DLLs are tied to a single architecture. If your application target's AnyCPU, the

architecture can be selected at runtime, meaning that both 32-bit and 64-bit versions of the DocFilters

DLLs must be available.

When using the NuGet package and targeting .NET Core, the process of selecting the appropriate DLLs

is automated. If targeting .NET Framework, you will need to ensure the DLLs are discoverable using the

rules of Default Probing rules for Unmanaged (native) libraries.

1.2.1 Installing the Bindings

The .NET bindings are provided as source in the samples directory, under samples/csharp/

Hyland.DocumentFilters . Although the bindings are written in C#, then can be consumed by an .NET

language.

•

Can I use NuGet?

Note

Document Filters Implementation Guide 1.2 Getting Started with .NET

- 9/1268 -

To use in your application, copy the Hyland.DocumentFilters directory into a convenient location to

add to your application. Then add the Hyland.DocumentFilters.csproj project to your solution.

1.2.2 Initializing and calling Document Filters

The preceding code loads the DocumentFilters package into global scope, then creates a new Api

singleton and Initialize s it with a license code.

The second argument controls where DocFilters should look for resources, such as conguration les and

fonts. The . tells it to look in the same directory as the DocFilter's shared libraries.

Note: ISYSdf11.dll must be either in same folder as the currently executing Assembly or found by

Default Probing rules for Unmanaged (native) libraries.

1.2.3 Extracting Text

The preceding code loads the le filename.doc into an extractor doc . By using a scoped using

block, the extractor will be closed when doc goes out of scope.

It then opens the extractor with BodyAndMeta indicating that we want to extract both the text (body)

and the metadata of the document.

Finally, it loops over calling GetText until the extractor reports EndOfStream .

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta)

9 while (!doc.EndOfStream)

10 {

11 var text = doc.GetText(4096);

12 Console.Out.WriteLine(text);

13 }

Document Filters Implementation Guide 1.2.2 Initializing and calling Document Filters

- 10/1268 -

1.2.4 Converting a Document

The preceding code loads the le filename.doc into an extractor doc . By using a scoped using

block, the extractor will be closed when doc goes out of scope.

It also creates a new canvas object of type CanvasType.PDF and stores it as canvas . The canvas will

also be automatically closed when it goes out of scope.

It then opens the extractor with FormatImage indicating that we want to convert the le to an image

based output. This triggers the le to be paginated.

Finally, it calls RenderPages to output every page from doc into the canvas . You could also manually

iterate of over the pages and call RenderPages .

You can render more than one document to a canvas. If you want to stitch multiple les together,

simply load each document into it's own Extractor , then call RenderPage/s onto a single canvas.

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 using var canvas = api.MakeOutputCanvas("output.pdf", Hyland.DocumentFilters.CanvasType.PDF);

9 doc.Open(Hyland.DocumentFilters.OpenType.FormatImage)

11 canvas.RenderPages(doc);

Did you know?

Document Filters Implementation Guide 1.2.4 Converting a Document

- 11/1268 -

1.3 Getting Stated with Python

The following list describes the minimum set of function calls or methods to create a working application.

Congure your system’s DLL or SO search path to include

The folder containing ISYS11df [.dll | .so | .dylib] and the other related shared libraries.

Install the DocumentFilters package from the samples directory

Run python setup.py install from samples/python . Note, this must be done for each version

of python you want to support.

In your Python source, import DocumentFilters.

Create a global "DocumentFilters" object.

Call DocumentFilters.Initialize.

Call DocumentFilters.GetExtractor for one or more documents.

Call Extractor.GetText to retrieve a document’s text.

Wrap calls to DocumentFilters.GetExtractor using a with directive, or call Extractor.Close when

nished with each document.

Note: previous versions of Document Filters used shared object packages to support Python, where 22.2

uses a python c-type package. The previous method is still supported up to Python 3.3.

1.3.1 Installing the Bindings

The Python bindings are provided as source in the samples directory. The easiest way to work with them

is to install them as a system package, however you can also include them within your application by

copying the directory.

1.3.2 Initializing and calling Document Filters

Once the package is installed, we can start consuming it.

Python

•

cd samples/python

python setup.sh install

from DocumentFilters import *

df = Api()

df.Initialize("License Code", ".")

Document Filters Implementation Guide 1.3 Getting Stated with Python

- 12/1268 -

The preceding code loads the DocumentFilters package into global scope, then creates a new Api

singleton and Initialize s it with a license code.

The second argument controls where DocFilters should look for resources, such as conguration les and

fonts. The . tells it to look in the same directory as the DocFilter's shared libraries.

1.3.3 Extracting Text

Python

The preceding code loads the le filename.doc into an extractor doc . By using a scoped with block,

the extractor will be closed when doc goes out of scope.

It then opens the extractor with IGR_BODY_AND_META indicating that we want to extract both the text

(body) and the metadata of the document.

Finally, it loops over calling GetText until the extractor reports EOF (End of File).

1.3.4 Converting a Document

Python

from DocumentFilters import *

df = Api()

df.Initialize("License Code", ".")

with df.GetExtractor("filename.doc") as doc:

doc.Open(IGR_BODY_AND_META)

while not doc.EOF:

text = doc.GetText(4096, True)

print(text)

from DocumentFilters import *

df = Api()

df.Initialize("License Code", ".")

with df.GetExtractor("filename.doc") as doc:

with df.MakeOutputCanvas("output.pdf", IGR_DEVICE_IMAGE_PDF) as canvas:

doc.Open(IGR_FORMAT_IMAGE)

canvas.RenderPages(doc)

Document Filters Implementation Guide 1.3.3 Extracting Text

- 13/1268 -

The preceding code loads the le filename.doc into an extractor doc . By using a scoped with block,

the extractor will be closed when doc goes out of scope.

It also creates a new canvas object of type IGR_DEVICE_IMAGE_PDF and stores it as canvas . The

canvas will also be automatically closed when it goes out of scope.

It then opens the extractor with IGR_FORMAT_IMAGE indicating that we want to convert the le to an

image based output. This triggers the le to be paginated.

Finally, it calls RenderPages to output every page from doc into the canvas . You could also manually

iterate of over the pages and call RenderPages .

Did you know? You can render more than one document to a canvas. If you want to stitch multiple les

together, simply load each document into it's own Extractor , then call RenderPage/s onto a single

canvas.

1.3.5 Troubleshooting

libISYS11df.so: cannot open shared object file: No such file or directory

If you see an error similar to above, it means that Python was unable to locate the Document Filters

Shared Libraries. Standard dlopen rules are used to locate the libraries.

This can often be worked around by adding the path containing the libraries to the LD_LIBRARY_PATH

environment variable.

Document Filters Implementation Guide 1.3.5 Troubleshooting

- 14/1268 -

1.4 Getting Started with Java

The following list describes the minimum set of function calls or methods to create a working application.

Add the ISYS11df.jar package to your project and ensure that ISYS11dfJava.dll /

libISYS11dfJava.so are in the application, system or library path.

Add the "com.perceptive.doclters" namespace to your imports.

Create a global "DocumentFilters" object.

Call DocumentFilters.Initialize.

Call DocumentFilters.GetExtractor for one or more documents.

Call Extractor.GetText to retrieve a document’s text.

Call Extractor.Close when nished with each document.

1.4.1 Installing the Bindings

The Java bindings are provided as a JAR le called ISYS11df.jar in the installation bin directory. This

JAR le must be included on the classpath to calls to both javac and java .

1.4.2 Initializing and calling Document Filters

Java

The preceding code loads the DocumentFilters package into global scope, then creates a new Api

singleton and Initializes it with a license code.

The second argument controls where DocFilters should look for resources, such as conguration les and

fonts. The . tells it to look in the same directory as the DocFilter's shared libraries.

Note: ISYS11df.(dll/so/dylib) will be loaded by a call to System.loadLibrary("ISYS11df") See

System.LoadLibrary for more information

•

import com.perceptive.documentfilters.*;

public class App {

private static String LICENSE_KEY = "DOCUMENT FILTERS LICENSE CODE";

public static void main(String[] args) throws Exception {

var api = new DocumentFilters();

api.Initialize(LICENSE_KEY, ".");

}

Document Filters Implementation Guide 1.4 Getting Started with Java

- 15/1268 -

1.4.3 Extracting Text

Java

The preceding code loads the le filename.doc into an extractor doc . We use a try/finally to

ensure the extractor is unloaded, even if an exception is thrown.

It then opens the extractor with IGR_BODY_AND_META indicating that we want to extract both the text

(body) and the metadata of the document.

Finally, it loops over calling GetText until the extractor reports getEOF() .

1.4.4 Converting a Document

Java

import com.perceptive.documentfilters.*;

public class App {

private static String LICENSE_KEY = "DOCUMENT FILTERS LICENSE CODE";

public static void main(String[] args) throws Exception {

var api = new DocumentFilters();

api.Initialize(LICENSE_KEY, ".");

var doc = api.GetExtractor("filename.doc");

try {

doc.Open(isys_docfilters.IGR_BODY_AND_META);

while (!doc.getEOF()) {

String text = doc.GetText(4096);

System.out.println(text);

}

} finally {

doc.Close();

}

import com.perceptive.documentfilters.*;

public class App {

private static String LICENSE_KEY = "DOCUMENT FILTERS LICENSE CODE";

public static void main(String[] args) throws Exception {

var api = new DocumentFilters();

api.Initialize(LICENSE_KEY, ".");

var doc = api.GetExtractor("filename.doc");

try {

doc.Open(isys_docfilters.IGR_FORMAT_IMAGE);

var canvas = api.MakeOutputCanvas("output.pdf", isys_docfilters.IGR_DEVICE_IMAGE_PDF, "");

Document Filters Implementation Guide 1.4.3 Extracting Text

- 16/1268 -

The preceding code loads the le filename.doc into an extractor doc . We use a try/finally to

ensure the extractor is unloaded, even if an exception is thrown.

It also creates a new canvas object of type CanvasType.PDF and stores it as canvas . We need to also

unload it when done, so introduce another try/finally .

It then opens the extractor with IGR_FORMAT_IMAGE indicating that we want to convert the le to an

image based output. This triggers the le to be paginated.

Finally, it iterates and opens every page of the document and passes it to the canvas' RenderPage .

try {

for (int page_index = 0, page_count = doc.GetPageCount(); page_index < page_count; +

+page_index) {

var page = doc.GetPage(page_index);

try {

canvas.RenderPage(page);

} finally {

page.Close();

}

} finally {

canvas.Close();

}

} finally {

doc.Close();

}

Document Filters Implementation Guide 1.4.4 Converting a Document

- 17/1268 -

1.5 Getting Started with C

The following list describes the minimum steps to create a working application.

Include DocumentFilters.h

Call Init_Instance to initialize Document Filters.

Call IGR_Open_File to open one or more documents.

Call IGR_Get_Text to extract blocks of text.

Call IGR_Close_File to release system resources.

Call Close_Instance to release Document Filters.

1.5.1 Installing the Bindings

The C bindings are provided as a header file in the samples directory as samples/cpp/

DocumentFilters.h .

Depending on your platform, the header maybe all you need. If you are on Windows using Visual Studio,

you will also need the ISYS11df.lib in the bin directory to add to the Linker conguration.

Is this C++?

The DocumentFilters.h is callable from C or C++.

1.5.2 Initializing and calling Document Filters

The preceding code initializes the global Document Filters library. This is only required once in the

application.

•

1 #include <stdio.h>

2 #include "DocumentFilters.h"

4 int main(int argc, char** argv)

5 {

6 Instance_Status_Block isb;

7 Error_Control_Block ecb;

8 SHORT inst;

10 strncpy_s(isb.Licensee_ID1, "licensecode", sizeof(isb.Licensee_ID1) - 1);

11 Init_Instance(0, ".", &isb, &inst, &ecb);

12 if (ecb.Msg[0])

13 return 1;

15 return 1;

16 }

Document Filters Implementation Guide 1.5 Getting Started with C

- 18/1268 -

The second argument controls where DocFilters should look for resources, such as conguration les and

fonts. The . tells it to look in the same directory as the DocFilter's shared libraries.

Document Filters Implementation Guide 1.5.2 Initializing and calling Document Filters

- 19/1268 -

1.5.3 Extracting Text

1 #include <stdio.h>

2 #include <string.h>

3 #include "DocumentFilters.h"

5 const char LICENSE_KEY[] = "MY LICENSE";

6 const char SOURCE_FILE[] = "filename.doc";

8 int main(int argc, char** argv)

9 {

10 Instance_Status_Block isb = { 0 };

11 Error_Control_Block ecb = { 0 };

12 SHORT inst = 0;

14 strncpy(isb.Licensee_ID1, LICENSE_KEY, sizeof(isb.Licensee_ID1) - 1);

15 Init_Instance(0, ".", &isb, &inst, &ecb);

16 if (ecb.Msg[0])

17 {

18 printf("%s\n", ecb.Msg);

19 return 1;

20 }

22 IGR_UCS2 source_file[255] = { 0 };

23 IGR_UCS2 canvas_file[255] = { 0 };

24 IGR_UCS2 body_text[1024] = { 0 };

25 IGR_LONG caps = 0, filetype = 0, handle = 0, body_size = sizeof(body_text) / sizeof(body_text[0]) - 1;

26 char ascii_body_text[2048] = { 0 };

28 UTF8_to_Widechar_Ex(SOURCE_FILE, sizeof(SOURCE_FILE) - 1, source_file, sizeof(source_file) /

sizeof(source_file[0]));

30 if (IGR_Open_File_Ex(source_file, IGR_BODY_AND_META, NULL, &caps, &filetype, &handle, &ecb) != IGR_OK)

31 goto bad;

33 while (IGR_Get_Text(handle, body_text, &body_size, &ecb) == IGR_OK)

34 {

35 // convert the buffer from UTF-16 into UTF-8 for printing

36 Widechar_to_UTF8_Ex(body_text, body_size, ascii_body_text, sizeof(ascii_body_text)-1);

38 // replace DF markers

39 for (size_t i = 0; i < sizeof(ascii_body_text) && ascii_body_text[i]; ++i)

40 {

41 if (ascii_body_text[i] == IGR_CHAR_PARA_BREAK)

42 ascii_body_text[i] = '\n';

43 }

44 printf("%s", ascii_body_text);

45 body_size = sizeof(body_text) / sizeof(body_text[0]) - 1;

46 }

48 bad:

49 if (ecb.Msg[0])

50 printf("%s\n", ecb.Msg);

51 if (handle)

52 IGR_Close_File(handle, &ecb);

53 }

Document Filters Implementation Guide 1.5.3 Extracting Text

- 20/1268 -

The preceding code loads the le filename.doc using IGR_Open_File_Ex into a df object

referenceable by handle . Note: the DocFilters API passes strings as UCS2/UTF-16, so all input and

output is translated into UTF-8.

It loops over calling IGR_Get_Text until it returns an error condition.

Finally, any error messages are printed and the document handle is then disposed of using

IGR_Close_File .

Document Filters Implementation Guide 1.5.3 Extracting Text

- 21/1268 -

1.5.4 Converting a Document

1 #include <stdio.h>

2 #include <string.h>

3 #include "DocumentFilters.h"

5 const char LICENSE_KEY[] = "MY LICENSE";

6 const char SOURCE_FILE[] = "filename.doc";

7 const char CANVAS_FILE[] = "output.pdf";

9 int main(int argc, char** argv)

10 {

11 Instance_Status_Block isb = { 0 };

12 Error_Control_Block ecb = { 0 };

13 SHORT inst = 0;

15 strncpy(isb.Licensee_ID1, LICENSE_KEY, sizeof(isb.Licensee_ID1) - 1);

16 Init_Instance(0, ".", &isb, &inst, &ecb);

17 if (ecb.Msg[0])

18 {

19 printf("%s\n", ecb.Msg);

20 return 1;

21 }

23 IGR_UCS2 source_file[255] = { 0 };

24 IGR_UCS2 canvas_file[255] = { 0 };

25 IGR_UCS2 body_text[1024] = { 0 };

26 IGR_LONG caps = 0, filetype = 0, doc_handle = 0, page_count = 0;

27 HCANVAS canvas_handle = 0;

28 HPAGE page_handle = 0;

30 UTF8_to_Widechar_Ex(SOURCE_FILE, sizeof(SOURCE_FILE) - 1, source_file, sizeof(source_file) /

sizeof(source_file[0]));

31 UTF8_to_Widechar_Ex(CANVAS_FILE, sizeof(CANVAS_FILE) - 1, canvas_file, sizeof(canvas_file) /

sizeof(canvas_file[0]));

33 if (IGR_Open_File_Ex(source_file, IGR_FORMAT_IMAGE, NULL, &caps, &filetype, &doc_handle, &ecb) !=

IGR_OK)

34 goto bad;

36 if (IGR_Make_Output_Canvas(IGR_DEVICE_PDF, canvas_file, NULL, &canvas_handle, &ecb) != IGR_OK)

37 goto bad;

39 if (IGR_Get_Page_Count(doc_handle, &page_count, &ecb) != IGR_OK)

40 goto bad;

42 for (IGR_LONG page_index = 0; page_index < page_count; ++page_index)

43 {

44 if (IGR_Open_Page(doc_handle, page_index, &page_handle, &ecb) == IGR_OK)

45 {

46 IGR_Render_Page(page_handle, canvas_handle, &ecb);

47 IGR_Close_Page(page_handle, &ecb);

48 }

49 }

51 bad:

52 if (ecb.Msg[0])

53 printf("%s\n", ecb.Msg);

Document Filters Implementation Guide 1.5.4 Converting a Document

- 22/1268 -

The preceding code loads the le filename.doc using IGR_Open_File_Ex into a df object

referenceable by doc_handle . The le is opened in IGR_FORMAT_IMAGE indicating that we want to

convert the le to an image based output. This triggers the le to be paginated.

Note: the DocFilters API passes strings as UCS2/UTF-16, so all input and output is translated into UTF-8.

It then creates a new PDF canvas by calling IGR_Make_Output_Canvas passing IGR_DEVICE_PDF .

Finally, it enumerates all the pages from doc by calling IGR_Open_Page for each page, and passing the

returned handle to IGR_Render_Page .

1.5.5 Troubleshooting

libISYS11df.so: cannot open shared object file: No such file or directory

If you see an error similar to above, it means that the app was unable to locate the Document Filters

Shared Libraries. Standard dlopen rules are used to locate the libraries.

This can often be worked around by adding the path containing the libraries to the LD_LIBRARY_PATH

environment variable.

54 if (canvas_handle)

55 IGR_Close_Canvas(canvas_handle, &ecb);

56 if (doc_handle)

57 IGR_Close_File(doc_handle, &ecb);

58 }

Document Filters Implementation Guide 1.5.5 Troubleshooting

- 23/1268 -

1.6 Getting Started with C++

The following list describes the minimum steps to create a working application.

Include DocumentFiltersObjects.h.

Create a global "DocumentFilters" object.

Call DocumentFilters::Initialize.

Call DocumentFilters::GetExtractor for one or more documents.

Call Extractor::GetText or Extractor::GetTextW to retrieve a document’s text.

Call Extractor::Close when nished with each document.

Call DocumentFilters::Uninitialize when nished.

1.6.1 Installing the Bindings

The C++ bindings are provided as source in the samples directory, under samples/cpp as

DocumentFiltersObjects.cpp and .h .

These two les must be added to your C++ solution.

Note: you can also call the C API directly from C++ code.

1.6.2 Initializing and calling Document Filters

C++

The preceding code loads the DocumentFilters objects and adds the Perceptive namespace into

global scope, then creates a new Api singleton and Initializes it with a license code.

The second argument controls where DocFilters should look for resources, such as conguration les and

fonts. The . tells it to look in the same directory as the DocFilter's shared libraries.

•

#include <iostream>

#include <memory>

#include "DocumentFiltersObjects.h"

static const char* LICENSE_KEY = "MY LICENSE KEY";

using namespace Perceptive;

int main(int, char**) {

DocumentFilters api;

api.Initialize(LICENSE_KEY, ".");

}

Document Filters Implementation Guide 1.6 Getting Started with C++

- 24/1268 -

1.6.3 Extracting Text

C++

The preceding code loads the le filename.doc into an extractor doc. By using a unique_ptr to store

the object, the extractor will be closed when doc goes out of scope.

It then opens the extractor with IGR_BODY_AND_META indicating that we want to extract both the text

(body) and the metadata of the document.

Finally, it loops over calling GetText until the extractor reports getEOF .

1.6.4 Converting a Document

C++

#include <iostream>

#include <memory>

#include "DocumentFiltersObjects.h"

static const char* LICENSE_KEY = "MY LICENSE KEY";

using namespace Perceptive;

int main(int, char**) {

DocumentFilters api;

api.Initialize(LICENSE_KEY, ".");

std::unique_ptr<Extractor> doc(api.GetExtractor("filename.doc"));

std::unique_ptr<Canvas> canvas(api.MakeOutputCanvas("result.pdf", IGR_DEVICE_IMAGE_PDF, ""));

doc->Open(IGR_BODY_AND_META);

while (!doc->getEOF())

{

std::string text = doc->GetText();

std::cout << text << std::endl;

}

#include <iostream>

#include <memory>

#include "DocumentFiltersObjects.h"

static const char* LICENSE_KEY = "MY LICENSE KEY";

using namespace Perceptive;

int main(int, char**) {

DocumentFilters api;

api.Initialize(LICENSE_KEY, ".");

std::unique_ptr<Extractor> doc(api.GetExtractor("filename.doc"));

std::unique_ptr<Canvas> canvas(api.MakeOutputCanvas("result.pdf", IGR_DEVICE_IMAGE_PDF, ""));

doc->Open(IGR_FORMAT_IMAGE);

Document Filters Implementation Guide 1.6.3 Extracting Text

- 25/1268 -

The preceding code loads the le filename.doc into an extractor doc. By using a unique_ptr to store

the object, the extractor will be closed when doc goes out of scope.

It also creates a new canvas object of type IGR_DEVICE_IMAGE_PDF and stores it as canvas. The

canvas will also be automatically closed when it goes out of scope.

It then opens the extractor with IGR_FORMAT_IMAGE indicating that we want to convert the le to an

image based output. This triggers the le to be paginated.

Finally, for each page in the document, the canvas RenderPage is called.

for (int page_index = 0, page_count = doc->getPageCount(); page_index < page_count; ++page_index)

{

std::unique_ptr<Page> page(doc->GetPage(page_index));

canvas->RenderPage(page.get());

}

Document Filters Implementation Guide 1.6.4 Converting a Document

- 26/1268 -

1.7 Getting Started with COM

Create a "Hyland.DocumentFilters.11" object.

Call DocumentFilters.Initialize .

Call DocumentFilters.GetExtractor for one or more documents.

Call Extractor.GetText to retrieve a document’s text.

Call Extractor.Close when nished with each document.

•

Document Filters Implementation Guide 1.7 Getting Started with COM

- 27/1268 -

1.8 Language-specific integration examples

Dierent languages require specic techniques for integrating Document Filters into your applications.

Language Example Solutions

C# Refer to “samples/csharp” and see the “Document Filters Samples.sln”

solution.

VB.net Refer to “samples/vb.net” and see the “Document Filters Samples.sln"

solution.

C and C++ Refer to “samples/cpp” and see the “Document Filters Samples.sln” solution.

Alternatively, see the “BuildWindows.bat” or the “BuildUNIX.sh” on Windows

and non-Windows systems respectively.

Java Refer to “samples/java” and see the “BuildWindows.bat” or the

“BuildUNIX.sh” on Windows and non-Windows systems respectively.

Python Refer to “samples/python”.

Other You will need to use this manual and/or the above les to help construct

object or function denitions to be used with your language.

Document Filters Implementation Guide 1.8 Language-specic integration examples

- 28/1268 -

1.9 About multithreading

Document Filters may be run in a multithreaded application with minimal eort. There are a basic set of

rules that must be followed.

A document/extractor MUST be processed in a single thread only.

A document can move between threads, but the caller is responsible for ensuring that only a single

thread is calling an API for any given handle.

These rules also apply to sub-les, unless the suble is saved to le or stream rst, and then loaded as

a new document.

•

Document Filters Implementation Guide 1.9 About multithreading

- 29/1268 -

1.10 About fonts

1.10.1 About fonts

To be able to render a document into a HD format, Document Filters must have access to fonts to be able

to correctly represent each character on the page. Fonts contain the visual representation of each

character, but also size and measurement information required to accurately position content on the

page.

The highest quality renditions are produced when the fonts used to create the document are also

present on the machine doing the conversion, however this is not always possible, and substitutions may

be used. Additionally, fonts do not contain all Unicode characters (144,697 as of Unicode 14), but there

is an expectation that text will render correctly, even if the selected font is unable to render the

character.

Document Filters uses several techniques to attempt to render documents, independent of format and

international writing systems.

Font Substitution is the ability to replace a requested font that is not available into one that is

available. Document Filters will attempt to resolve a font in the following order:

Requested font - as stored in the original document.

Font aliases - registered in Font Mappings (see below).

Format dependent mappings - some le types store extra information to aid in nding substitutes.

Unicode Fallback Font.

Font Fallback is the ability to render a character/glyph, even if it is not present in the requested fonts.

Very few fonts support more than a handful of alphabets, yet from a usability standpoint, we do not

expect users to know exactly which fonts support which characters. For example, a user selects the Arial

font to enter some text rst in English, next in Hebrew, and then in Thai. Arial has support for Latin and

Hebrew characters but does not contain any Thai glyphs. Although Arial does not know how to render

Thai, a fallback is found automatically, saving the user from manual intervention. Document Filters

attempts to resolve a glyph in the following order:

The requested font, or it's substitute as determined above.

The visually closest font that reports to support the requested glyph.

The Unicode Fallback Font.

The "missing character" symbol.

•

Document Filters Implementation Guide 1.10 About fonts

- 30/1268 -

Some operating systems may ship with few or no fonts, which may produce a less exact rendition. To

help mitigate this problem, Document Filters provides a font directory with a base set of royalty free,

open source fonts from the Liberation Fonts and Google Noto Fonts projects.

The Google Noto Fonts project is particularly useful for providing fonts that render a large variety of

Unicode characters. Document Filters does not ship with the full set of Noto fonts as they can be large. If

you are deploying your application to low-font environments, you may want to consider copying the full

set.

https://github.com/googlefonts/noto-fonts

https://github.com/googlefonts/noto-cjk

•

Document Filters Implementation Guide 1.10.1 About fonts

- 31/1268 -

1.10.2 Configuring fonts

Document Filters' uses an INI le called "fonts.ini" for handling font specic congurations. This le is

loaded oncewhen the library is rst initialized.

The fonts.ini will be search for in the following locations

$ISYS_FONTS/fonts.ini

$ISYS_INIT_PATH/fonts.ini        i.e. the path used in the call to Init_Instance

$ISYS_INIT_PATH/fonts/fonts.ini

$ISYS_DLL_PATH/fonts.ini        i.e. the path where the DLL/shared libraries are loaded

$ISYS_DLL_PATH/fonts/fonts.ini

•

Document Filters Implementation Guide 1.10.2 Conguring fonts

- 32/1268 -

1.10.3 Finding or adding fonts

Document Filters looks for system fonts by scanning common font directories on the host system,

looking for OpenType Fonts (OTF, TTF and TTC).

$USERPROFILE\AppData\Local\Microsoft\Windows\Fonts

$SystemRoot\Fonts

/usr/share/fonts/truetype

/usr/share/fonts/opentype

Additionally, you can also supply fonts alongside your application that do not need to be installed into a

system location. Document Filters will also look for fonts in a directory called "fonts" that exists in the

same directory as the Document Filters' DLLs, or in the same directory as your application; if these are

the same location, it will only be scanned once.

$ISYS_INIT_PATH/fonts

$ISYS_DLL_PATH/fonts

You can add new fonts in few ways.

Install the font using the operating system preferred approach

Copy the font into the application's "font" directory

Add the font directory to the [FontLocations] section of the fonts.ini

The directories specied will be scanned in order. If a font exists in more than one location, the rst will be used. Names starting with a $

are considered environment variables and will be substituted at load time.

To recursively load a directory, add ** to the end of the path.

•

[FontLocations]

# Locations to scan for fonts (additional paths may be added here)

$ISYS_INIT_PATH/fonts

$ISYS_DLL_PATH/fonts

$SystemRoot\\Fonts\\**

$USERPROFILE\\AppData\\Local\\Microsoft\\Windows\\Fonts

/usr/share/fonts/truetype/**

/usr/share/fonts/opentype/**

/opt/path-to-more-fonts/***

Document Filters Implementation Guide 1.10.3 Finding or adding fonts

- 33/1268 -

1.10.4 Font mappings and aliases

Document Filters will attempt to render with an exact match for any referenced font. If the font does not

exist on the system, it may fall back to a dierent font, or be aliased to another font.

Font mappings may be added to, or edited by, modifying the [FontMappings] section of the fonts.ini.

To add a new font mapping, add a line with:

OriginalFontName[;SecondaryFontName]=FontAlias1[;FontAlias2;FontAlias3;FontAliasN]

Document Filters will create an alias from OriginalFontName to the rst font alias that is found.

There is a special alias installed called $ISYS_FONTS_SANS_UNICODE; this font is used to render Unicode

text if the selected font does not support Unicode characters.

[FontMappings]

# Canonical font types (each in order of preference)

$ISYS_FONTS_SANS_SERIF=Arial;Liberation Sans;Droid Sans

$ISYS_FONTS_SERIF=Times New Roman;Liberation Serif;Droid Serif

$ISYS_FONTS_MONO=Courier New;Liberation Mono;Droid Mono

$ISYS_FONTS_SANS_UNICODE=Arial Unicode;Arial Unicode MS;Droid Sans Fallback;Unifont

$ISYS_FONTS_SYMBOL=Symbol;OpenSymbol

# Font substitutions (if exact font is not available on system)

Arial;Helvetica=$ISYS_FONTS_SANS_SERIF

Times;Times New Roman=$ISYS_FONTS_SERIF

Courier;CourierPS;Courier New=$ISYS_FONTS_MONO

Arial Unicode;Arial Unicode MS=$ISYS_FONTS_SANS_UNICODE

Symbol=$ISYS_FONTS_SYMBOL

Document Filters Implementation Guide 1.10.4 Font mappings and aliases

- 34/1268 -

1.10.5 Character mapping

If an original font is not available, characters can be mapped to their Unicode equivalent. This is most

apparent for symbol-based fonts, such as WingDings and Symbol. If a full Unicode font is available and

it's listed as ISYS_FONTS_SANS_UNICODE in the FONTS.INI le, the fallback/substitution will happen

automatically.

Automatic mapping is provided for WingDings and WingDings 2, and to a lesser extent, WebDings.

To build a character mapping table, modify the FONTS.INI le to add a [CharMappings] section, with one

line per mapping in the form of "FontName:CodePoint=UnicodeCodePoint". For example:

[CharMappings]

Symbol:183=8226

Symbol:167=9827

Document Filters Implementation Guide 1.10.5 Character mapping

- 35/1268 -

1.10.6 Diagnostics

Document Filters provides diagnostics to display what fonts are loaded and their locations, and what font

fallback and aliasing takes place when rendering a document.

The diagnostics are enabled by setting an environment variable “ISYS_FONTS_DIAG” to a numeric value:

1 - Prints all fonts that are loaded, including name, style, and lename.

2 - Prints font loading (as above), and font aliasing/fallbacks.

Result The information is printed to ‘Standard Out.’

•

Document Filters Implementation Guide 1.10.6 Diagnostics

- 36/1268 -

1.11 About multi-part archives

1.11.1 About multi-part archives

Document Filters supports multi-part archive les, such as certain ZIP and RAR items, where a single

archive is comprised of two or more les. To process a multi-part archive, the API user needs only to

submit the rst le to Document Filters and then extract children les from it as if it were an ordinary

single-part archive. When reading multi-part archives from an ordinary le system on disk, the second

and later les process automatically without any additional eort from the API user.

However, later parts of the archive do not process automatically if the les are not directly stored on an

ordinary le system because Document Filters does not make assumptions about where it can nd those

les. For example, a multi-part ZIP le attached to an email is not directly on a le system and is not

automatically processed. The same applies to multi-part archives within another archive, as the parts are

treated as individual les.

In order to process multi-part archives that are not directly on a le system, it is necessary to create an

Extended Stream to assist Document Filters in nding the later parts. If the API user tries to process

secondary parts of a multi-part archive directly, these parts are only identied and will not trigger further

processing of the archive.

Document Filters Implementation Guide 1.11 About multi-part archives

- 37/1268 -

1.11.2 Multi-part archives and extended streams

When processing multi-part archives using an Extended Stream, Document Filters invokes the nominated

callback function whenever a later part is required.In this case, the callback function will receive

parameters where actionID = IGR_ACTION_GET_STREAM_PART actionData = a struct of type

IGR_T_ACTION_GET_STREAM_PART.

See IGR_T_ACTION_GET_STREAM_PART Data Type.

Document Filters Implementation Guide 1.11.2 Multi-part archives and extended streams

- 38/1268 -

1.12 About custom streams and extended streams

1.12.1 About custom streams and extended streams

Document Filters supports the notion of customizable streams. You can use a custom stream to read

from a storage system that is not recognized by Document Filters. For example, you may wish to read

les directly from a database or from an FTP site. You can also use a special kind of custom stream called

an Extended Stream to assist Document Filters in nding extra information about your stream when

needed. An Extended Stream can perform functions like responding to a request for later parts of a

multi-part archive.

1.12.2 About custom streams in C and C++

In C and C++, you can customize streams by providing an IGR_Stream struct populated with pointers to

functions such as Read, Seek, and Write. See IGR_Stream Data Type.

However, if you wish to provide certain customizations that require handling callbacks, like reading

multi-part archives from a custom stream, then you will need to provide an Extended Stream. An

Extended Stream is just like an ordinary stream except that it includes a user-provided callback for when

more information is required, or when the user needs to perform some kind of action. See

IGR_Extend_Stream.

1.12.3 About custom streams in C#, Java, and Python

In C#, Java, and Python, your custom stream class must inherit from IGRStream.Custom Streams in

these languages are Extended Streams by default.

Java

class CIGRStream

{

public virtual uint Read(uint Size, IGRStream_Data Dest);

public virtual uint Seek(long Offset, int Origin);

public virtual uint Write(byte[] bytes, uint size);

public virtual IGRStream GetStreamPart(string partName, string partFullName,

int partIndex);

}

class CIGRStream

{

public long Read(long Size, IGRStream_Data Dest);

public long Seek(long Offset, int Origin);

public long Write(byte[] bytes);

Document Filters Implementation Guide 1.12 About custom streams and extended streams

- 39/1268 -

Python

Read

You should read up to size bytes from your datasource. Write the bytes you read into dest _calling _data-

>write (char* byteArray, long len). Return the number of bytes that was read.

Seek

Move your le pointer as indicated by Oset. Origin indicates how the pointer should move as shown

below.

Write

You only need to implement Write for a datasource that you intend to write to. You must write all the

bytes given and return the current position of the le pointer after the write operation.

GetStreamPart

GetStreamPart is a request for you to provide a stream of the specied le. This enables Document

Filters to open the second and later parts of multi-part archives. partName represents the lename of

the required le, if known, without path information. partFullName represents the lename and its full

path, if known. partIndex is the only item that is guaranteed to be populated, representing the part

number of the le being requested. You should create and return a new instance of a stream object for

the given partIndex.

public IGRStream GetStreamPart(String partName, String partFullName, int partIndex);

}

class IGRStream:

def Read(self, size, igr_stream_data_dest)

def Seek(self, offset, origin)

def Write(self, bytes)

def GetStreamPart(self, partName, partFullName, partIndex)

0 Absolute from the beginning

1 Relative to the current position

2 Absolute from the end

Document Filters Implementation Guide 1.12.3 About custom streams in C#, Java, and Python

- 40/1268 -

1.13 About Optical Character Recognition (OCR)

Document Filters integrates with the Tesseract OCR engine 3.02.02 to provide OCR as an optional

processing step to extract text from document image formats.

You can enable the functionality by passing the OCR=ON option as a parameter of the IGR_Open_File_Ex

or Extractor::Open method. This option is available for both text-mode and high-denition outputs.

Invoking the OCR=ON option will have no eect on formats that are not supported.

BMP, BRK, CALS, CGM, CUR, DCX, EMF, EPS, GEM, GIF, ICO, IFF, IMNET, JEDICS, JPG, JPK, JXR,

MACPAINT, MDI, MSPAINT, NCR, PBM, PCX, PICT, PNG, PSP, SCANNED PDFS, SVM, TGA, TIFF, WBMP,

WEBP, WMF, WPG, XBM, XPM, XWD.

When processing a PDF le, only pages that do not contain a text layer will be processed by the OCR

engine.

The Tesseract OCR engine requires dictionaries for the languages of the documents you are processing.

Document Filters ships with the English language dictionary. However, additional languages may be

installed.

The dictionary les can be downloaded from the Tesseract OCR project site. It is important to download

the language les that match the version of tesseract used, the provided version is 3.02.02 . To install a

dictionary le, place the .traineddata into your application directory.

When OCRing a document in another language, you can select the language by specifying

OCR_LANGUAGE=xyz , where xyz is the 3-digit language code. For example:

English = eng

French = fra

German = deu

The quality of the input image plays an important part in the accuracy of the outputted text. For best

results, use images with 300 dpi and a font size no smaller than 10pt. You can pass images with a lower

resolution, however the results are less accurate.

Document Filters attempts to detect images that have too low a resolution for OCR. Any image with a

width of less than 1,000 pixels will be skipped. To adjust this number, specify OCR_MIN_WIDTH in the

document open ags.

Supported Graphic Types

•

Document Filters Implementation Guide 1.13 About Optical Character Recognition (OCR)

- 41/1268 -

Document Filters uses an unaltered version of the Tesseract OCR engine source code and makes no

claims or warranties as to the accuracy of the resulting recognized text or to the performance of it, or

any other OCR engine.

The most recent version of Tesseract that is compatible with all the platforms supported by Document

Filters is Tesseract 3.02. To ensure optimal support and consistent output across all platforms, the

embedded Tesseract version is set to this specic release.

Nevertheless, you have the option to congure your Document Filters to utilize a system-installed

version of Tesseract.

1.13.1 Using a different version of Tesseract

As mentioned earlier, the version of Tesseract bundled with Document Filters is 3.02. You have the

exibility to set up Document Filters to utilize a locally installed version of Tesseract on the host system.

When opting for the host system's Tesseract, ensure it aligns with your application or environment's

architecture (e.g., 32-bit, 64-bit) and is supplied as a Shared Library or DLL.

The installation process for Tesseract depends on your operating system. Refer to the Tesseract

Installation Documentation for details.

To setup Document Filters to support dierent versions of Tesseract, you must create congure it with

the details of the alternate OCR engine. This can be done through either INI le or Environment

Variables.

Before you start, you will need to know the name and path of the shared library. This can be found by

running find /usr -iname "*tesseract*.so" . For example, Ubuntu 20.04 reports as /usr/lib/

x86_64-linux-gnu/libtesseract.so .

You can either replace the default OCR engine with the system version, or add a new "named" OCR

engine, which can then be specied with the OCR_ENGINE=name setting. The approach to registering the

engine is identical, and is keyed o of the name. Naming your engine TESSERACT will replace the

default engine.

Note

Why Tesseract 3.02.02

Document Filters Implementation Guide 1.13.1 Using a dierent version of Tesseract

- 42/1268 -

Document Filters includes a convenient pass-through integration with the open-source Tesseract OCR

engine as an ancillary service. While we provide this integration to streamline your experience,

Tesseract OCR remains an unaltered, third-party engine and is not a native component of Document

Filters. Document Filters makes no claims or warranties regarding the accuracy of the recognized text

or the performance of Tesseract OCR, or any other OCR engine. Document Filters users are welcome to

integrate any OCR engine of their choice to suit their specic needs.

Registering via INI file

OCR engine registration via the ISYS11df.ini le is the easiest way to permanently setup the engine

for the host, in a format that is easy to manage.

OCR engines are registered in a section with an OCR: prex, for example [OCR:tesseract5] .

The values within the section are:

Registering via Environment Variables

OCR engine registration via Environment Variables provides convenience when using Containers, or for

testing dierent congurations.

Disclaimer

[OCR:tesseract5]

enabled=true

tesseract_lib=libtesseract.so.5

tesseract_dll=tesseract53.dll

tesseract_properties=textord_min_blobs_in_row=4 textord_spline_minblobs=8

Name Description

enabled Indicates if the OCR engine can be used.

tesseract_lib The name of the tesseract shared library. This can be a fully

qualied path, or relative to use standard shared library discovery

rules.

tesseract_dll The name of the tesseract Windows DLL. This can be a fully

qualied path, or relative to use standard DLL discovery rules.

tesseract_properties A space separated list of options to pass to tesseract on

initialization.

Document Filters Implementation Guide 1.13.1 Using a dierent version of Tesseract

- 43/1268 -

The pattern for the variable names must be prexed with DOCFILTERS_OCR_{NAME}__{PROPERTY} .

Where {NAME} is the engine name, and {PROPERTY} is the name from the INI le. Both {NAME} and

{PROPERTY} must be upper case. Note the double underscore __ between the {NAME} and the

property.

1.13.2 Using a different OCR engine

Document Filters can also integrate with alternate OCR engines by calling out to another process. For

Document Filters to interact with an OCR engine, the engine must be able to:

read PNG les from disk

write HOCR output to disk

Registering an external OCR engine uses the same conguration as a Tesseract engine, but with the

following additional options:

The args value can include the following variables, which will be expanded before execution:

Name Description

DOCFILTERS_OCR_{NAME}

__ENABLED

Indicates if the OCR engine can be used.

DOCFILTERS_OCR_{NAME}

__TESSERACT_LIB

The name of the tesseract shared library. This can

be a fully qualied path, or relative to use standard

shared library discovery rules.

DOCFILTERS_OCR_{NAME}

__TESSERACT_DLL

The name of the tesseract Windows DLL. This can be

a fully qualied path, or relative to use standard DLL

discovery rules.

DOCFILTERS_OCR_{NAME}

__TESSERACT_PROPERTIES

A space separated list of options to pass to tesseract

on initialization.

•

Name Description

exe The Process name to use on Windows.

proc The Process name to use on all other platforms.

args The Arguments to pass to the process.

output_ext The optional extension that is added to the output name.

Document Filters Implementation Guide 1.13.2 Using a dierent OCR engine

- 44/1268 -

For example, to congure an OCR engine that uses the Tesseract CLI instead of a Shared Library, the

conguration might look like this:

Passing -c "tessedit_create_hocr=1" and -c "hocr_font_info=1" to the command line enables

HOCR output. The Tesseract CLI tool always adds a .hocr sux to the output lename. Therefore, we

specify output_ext=.hocr in our conguration.

To use this external engine, you can pass OCR=on;OCR_ENGINE=tesseract_cli .

Variable Description

${inputFile}

The lename of the temporary le that contains the image to be

processed.

${outputFile}

The lename of a temporary le where the output is to be written.

${language}

The OCR language as passed from the user.

[OCR:tesseract_cli]

enabled=true

exe=tesseract.exe

proc=/usr/bin/tesseract

args=-c "tessedit_create_hocr=1" -c "hocr_font_info=1" -l "${language}" "${inputFile}" "${outputFile}"

output_ext=.hocr

Document Filters Implementation Guide 1.13.2 Using a dierent OCR engine

- 45/1268 -

1.14 About conversion profiles

You may specify default conversion options via a le named ISYS11df.ini.

If this le is present in the executable folder, the options contained therein will be used during

processing, unless the particular option is specied (i.e. overridden) by the application in the Open or

Canvas methods.

Conversion proles allow for dierent options to be specied based on (1) the type of input le or

document, (2) the desired conversion mode (text, classic HTML or HD) and (3) the desired output format.

This is convenient, for example, if dierent options are needed for inputs that are bitmaps versus

documents.

See the comments in ISYS11df.ini for full details and example usage.

Document Filters Implementation Guide 1.14 About conversion proles

- 46/1268 -

1.15 About accessibility info extraction

Document Filters supports the extraction of accessibility information from MS Oce documents, aiding in

the development of accessible products. The extracted "alt text" labels include images, drawings,

objects, word art, smart art, charts, icons, shapes, and text boxes across Word (DOC and DOCX),

PowerPoint (PPT and PPTX), Excel (XLS and XLSX), and Visio (VSDX) les. The extracted alt text is

surfaced in various output formats -- HTML5, Classic HTML, XML, and PDF -- when the appropriate

options for creating accessible output are provided.

1.15.1 Output format specifics

HTML5 / Classic HTML

When creating HTML5 output or Classic HTML output, you can surface alt text in the output by passing

the HDHTML_ACCESSIBILITY=ON option as a parameter of the IGR_Open_File_Ex or Extractor::Open

method.

The alt text is surfaced as: * alt attribute on <img> tags * aria-label attribute on other tags (e.g.

\<div> or \<span>)

XML

When creating XML output, no additional options are required to surface alt text.

The alt text is surfaced as alt-text attributes in the XML.

PDF

When creating PDF output, alt text is surfaced in the output if the PDF_VERSION=PDFA1A or

PDF_TAGGED=ON option is provided as a parameter of the IGR_Open_File_Ex or Extractor::Open method.

Alt text is written into the PDF with an /Alt entry in the property list for a Tag.

1.15.2 Using Page Elements Style API

Alt text is also surfaced as the "altText" style on page elements.

You can see this by using IGR_Get_Page_Element_Style to get the "altText" style on a page element

acquired with IGR_Enum_Page_Elements.

Document Filters Implementation Guide 1.15 About accessibility info extraction

- 47/1268 -

1.16 Common use cases

1.16.1 How do I open a document from disk?

This table outlines the steps to open a document from disk for the supported languages.

Samples

Language Option Refer to Function/Method

C A IGR_Open_File

B IGR_Open_File_Ex

C IGR_Make_Stream_From_File then IGR_Open_Stream

D IGR_Make_Stream_From_File then

IGR_Open_Stream_Ex

E IGR_Open_Ex

.NET A DocumentFilters.GetExtractor(Filename)

B DocumentFilters.OpenExtractor(Filename)

Java, Python,

COM

DocumentFilters.GetExtractor(Filename)

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 while (!doc.EndOfStream)

10 {

11 var text = doc.GetText(4096);

12 Console.Out.WriteLine(text);

13 }

15 doc.Close();

Document Filters Implementation Guide 1.16 Common use cases

- 48/1268 -

Java

Python

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize("License Code", ".");

10 try (Extractor doc = df.GetExtractor("filename.doc")) {

11 doc.Open(isys_docfilters.IGR_BODY_AND_META);

13 while (!doc.getEOF()) {

14 string text = doc.GetText(4096);

15 System.out.println(text);

16 }

17 }

18 }

19 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.GetExtractor("filename.doc") as doc:

7 doc.Open(IGR_BODY_AND_META, "")

9 while not doc.getEOF():

10 output.write(doc.GetText(MaxCharsPerGetText, stripControlCodes=True))

Document Filters Implementation Guide 1.16.1 How do I open a document from disk?

- 49/1268 -

C++

1 #include <DocumentFilters.h>

2 #include <codecvt>

3 #include <fstream>

4 #include <iostream>

5 #include <locale>

6 #include <string.h>

7 #include <string>

8 #include <vector>

10 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

12 std::wstring u16_to_wstring(const std::u16string &str)

13 {

14 std::wstring_convert<std::codecvt_utf16<wchar_t, 0x10ffff, std::little_endian>, wchar_t> conv;

16 return conv.from_bytes(reinterpret_cast<const char *>(&str[0]), reinterpret_cast<const char *>(&str[0]

+ str.size()));

17 }

19 int main(int argc, char **argv)

20 {

21 Instance_Status_Block isb = {0};

22 Error_Control_Block ecb = {0};

23 IGR_SHORT df;

24 IGR_LONG caps, type, docHandle, canvasHandle, pageHandle, res, pageCount = 0;

25 IGR_Stream *stream;

26 std::vector<char> bytes;

28 // Initialization

29 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

30 Init_Instance(0, ".", &isb, &df, &ecb);

32 if ((res = IGR_Open_File(UCS2(u"filename.doc"), IGR_BODY_AND_META, &caps, &type, &docHandle, &ecb)) ==

IGR_OK)

33 {

34 std::vector<IGR_UCS2> buffer(4096);

35 IGR_LONG bufferSize = buffer.size();

37 while (IGR_Get_Text(docHandle, &buffer[0], &bufferSize, &ecb) == 0)

38 {

39 std::wcout << u16_to_wstring(std::u16string(reinterpret_cast<const char16_t *>(&buffer[0],

bufferSize)));

41 bufferSize = buffer.size();

42 }

43 IGR_Close_File(docHandle, &ecb);

44 }

45 }

Document Filters Implementation Guide 1.16.1 How do I open a document from disk?

- 50/1268 -

1.16.2 How do I open a document from memory?

This table outlines the steps to open a document from an existing memory buer.

Samples

Language Option Refer to Function/Method

C A IGR_Make_Stream_From_Memory then

IGR_Open_Stream

B IGR_Make_Stream_From_Memory then

IGR_Open_Stream_Ex

.NET, Java,

Python

DocumentFilters.GetExtractor(Memory)

COM DocumentFilters.GetExtractorFromMemory

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 var fileBytes = File.ReadAllBytes("filename.doc")

8 using var doc = api.GetExtractor(fileBytes);

9 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

11 while (!doc.EndOfStream)

12 {

13 var text = doc.GetText(4096);

14 Console.Out.WriteLine(text);

15 }

Document Filters Implementation Guide 1.16.2 How do I open a document from memory?

- 51/1268 -

Java

Python

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

6 private static byte[] readAllBytes(String filename) throws Exception {

7 RandomAccessFile f = new RandomAccessFile(filename, "r");

8 byte[] fileArray = new byte[(int) f.length()];

9 f.readFully(fileArray);

10 f.close();

11 return fileArray;

12 }

14 public static void main(String[] args) throws Exception

15 {

16 DocumentFilters df = new DocumentFilters();

17 df.Initialize("License Code", ".");

19 byte[] fileBytes = readAllBytes("filename.doc")

21 try (Extractor doc = df.GetExtractor(fileBytes)) {

22 doc.Open(isys_docfilters.IGR_BODY_AND_META);

24 while (!doc.getEOF()) {

25 string text = doc.GetText(4096);

26 System.out.println(text);

27 }

28 }

29 }

30 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with open(self._resolve_file('filename.doc'), 'rb') as src:

7 file_bytes = src.read()

9 with api.GetExtractor(bytes = file_bytes) as doc:

10 doc.Open(IGR_BODY_AND_META, "")

12 while not doc.getEOF():

13 output.write(doc.GetText(MaxCharsPerGetText, stripControlCodes=True))

Document Filters Implementation Guide 1.16.2 How do I open a document from memory?

- 52/1268 -

C++

1 #include <DocumentFilters.h>

2 #include <codecvt>

3 #include <fstream>

4 #include <iostream>

5 #include <locale>

6 #include <string.h>

7 #include <string>

8 #include <vector>

10 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

12 std::wstring u16_to_wstring(const std::u16string &str)

13 {

14 std::wstring_convert<std::codecvt_utf16<wchar_t, 0x10ffff, std::little_endian>, wchar_t> conv;

16 return conv.from_bytes(reinterpret_cast<const char *>(&str[0]), reinterpret_cast<const char *>(&str[0]

+ str.size()));

17 }

19 int main(int argc, char **argv)

20 {

21 Instance_Status_Block isb = {0};

22 Error_Control_Block ecb = {0};

23 IGR_SHORT df;

24 IGR_LONG caps, type, docHandle, canvasHandle, pageHandle, res, pageCount = 0;

25 IGR_Stream *stream;

26 std::vector<char> bytes;

28 // Initialization

29 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

30 Init_Instance(0, ".", &isb, &df, &ecb);

32 // Read the source file into memory

33 std::ifstream input("filename.doc", std::ios::binary | std::ios::ate);

34 bytes.resize(input.tellg());

35 if (bytes.empty())

36 return 1;

37 input.seekg(0, std::ios::beg);

38 input.read(&bytes[0], bytes.size());

39 input.close();

41 // Create a stream from the vector

42 if ((res = IGR_Make_Stream_From_Memory(&bytes[0], bytes.size(), NULL, &stream, &ecb)) == IGR_OK)

43 {

44 // Process the stream

45 if ((res = IGR_Open_Stream(stream, IGR_BODY_AND_META, &caps, &type, &docHandle, &ecb)) == IGR_OK)

46 {

47 std::vector<IGR_UCS2> buffer(4096);

48 IGR_LONG bufferSize = buffer.size();

50 while (IGR_Get_Text(docHandle, &buffer[0], &bufferSize, &ecb) == 0)

51 {

52 std::wcout << u16_to_wstring(std::u16string(reinterpret_cast<const char16_t *>(&buffer[0],

bufferSize)));

54 bufferSize = buffer.size();

55 }

56 IGR_Close_File(docHandle, &ecb);

Document Filters Implementation Guide 1.16.2 How do I open a document from memory?

- 53/1268 -

57 }

59 stream->Close(stream);

60 }

61 }

Document Filters Implementation Guide 1.16.2 How do I open a document from memory?

- 54/1268 -

1.16.3 How do I extract metadata from a document?

This table outlines the steps to extract metadata from a document.

Samples

Java

Language Refer to Function/Method

All Open a Document with IGR_META_ONLY Flags

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.MetaOnly);

9 while (!doc.EndOfStream)

10 {

11 var text = doc.GetText(4096);

12 Console.Out.WriteLine(text);

13 }

15 doc.Close();

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize("License Code", ".");

10 try (Extractor doc = df.GetExtractor("filename.doc")) {

11 doc.Open(isys_docfilters.IGR_META_ONLY);

13 while (!doc.getEOF()) {

14 string text = doc.GetText(4096);

15 System.out.println(text);

16 }

17 }

18 }

19 }

Document Filters Implementation Guide 1.16.3 How do I extract metadata from a document?

- 55/1268 -

Python

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.GetExtractor("filename.doc") as doc:

7 doc.Open(IGR_META_ONLY, "")

9 while not doc.getEOF():

10 output.write(doc.GetText(MaxCharsPerGetText, stripControlCodes=True))

Document Filters Implementation Guide 1.16.3 How do I extract metadata from a document?

- 56/1268 -

C++

1 #include <DocumentFilters.h>

2 #include <codecvt>

3 #include <fstream>

4 #include <iostream>

5 #include <locale>

6 #include <string.h>

7 #include <string>

8 #include <vector>

10 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

12 std::wstring u16_to_wstring(const std::u16string &str)

13 {

14 std::wstring_convert<std::codecvt_utf16<wchar_t, 0x10ffff, std::little_endian>, wchar_t> conv;

16 return conv.from_bytes(reinterpret_cast<const char *>(&str[0]), reinterpret_cast<const char *>(&str[0]

+ str.size()));

17 }

19 int main(int argc, char **argv)

20 {

21 Instance_Status_Block isb = {0};

22 Error_Control_Block ecb = {0};

23 IGR_SHORT df;

24 IGR_LONG caps, type, docHandle, canvasHandle, pageHandle, res, pageCount = 0;

25 IGR_Stream *stream;

26 std::vector<char> bytes;

28 // Initialization

29 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

30 Init_Instance(0, ".", &isb, &df, &ecb);

32 if ((res = IGR_Open_File(UCS2(u"filename.doc"), IGR_META_ONLY, &caps, &type, &docHandle, &ecb)) ==

IGR_OK)

33 {

34 std::vector<IGR_UCS2> buffer(4096);

35 IGR_LONG bufferSize = buffer.size();

37 while (IGR_Get_Text(docHandle, &buffer[0], &bufferSize, &ecb) == 0)

38 {

39 std::wcout << u16_to_wstring(std::u16string(reinterpret_cast<const char16_t *>(&buffer[0],

bufferSize)));

41 bufferSize = buffer.size();

42 }

43 IGR_Close_File(docHandle, &ecb);

44 }

45 }

Document Filters Implementation Guide 1.16.3 How do I extract metadata from a document?

- 57/1268 -

1.16.4 How do I extract text and metadata from a document?

This table outlines the steps to extract text and metadata from a document.

Samples

Java

Language Refer to Function/Method

All Opening a Document with IGR_BODY_AND_META Flags

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 while (!doc.EndOfStream)

10 {

11 var text = doc.GetText(4096);

12 Console.Out.WriteLine(text);

13 }

15 doc.Close();

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize("License Code", ".");

10 try (Extractor doc = df.GetExtractor("filename.doc")) {

11 doc.Open(isys_docfilters.IGR_BODY_AND_META);

13 while (!doc.getEOF()) {

14 string text = doc.GetText(4096);

15 System.out.println(text);

16 }

17 }

18 }

19 }

Document Filters Implementation Guide 1.16.4 How do I extract text and metadata from a document?

- 58/1268 -

Python

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.GetExtractor("filename.doc") as doc:

7 doc.Open(IGR_BODY_AND_META, "")

9 while not doc.getEOF():

10 output.write(doc.GetText(MaxCharsPerGetText, stripControlCodes=True))

Document Filters Implementation Guide 1.16.4 How do I extract text and metadata from a document?

- 59/1268 -

C++

1 #include <DocumentFilters.h>

2 #include <codecvt>

3 #include <fstream>

4 #include <iostream>

5 #include <locale>

6 #include <string.h>

7 #include <string>

8 #include <vector>

10 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

12 std::wstring u16_to_wstring(const std::u16string &str)

13 {

14 std::wstring_convert<std::codecvt_utf16<wchar_t, 0x10ffff, std::little_endian>, wchar_t> conv;

16 return conv.from_bytes(reinterpret_cast<const char *>(&str[0]), reinterpret_cast<const char *>(&str[0]

+ str.size()));

17 }

19 int main(int argc, char **argv)

20 {

21 Instance_Status_Block isb = {0};

22 Error_Control_Block ecb = {0};

23 IGR_SHORT df;

24 IGR_LONG caps, type, docHandle, canvasHandle, pageHandle, res, pageCount = 0;

25 IGR_Stream *stream;

26 std::vector<char> bytes;

28 // Initialization

29 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

30 Init_Instance(0, ".", &isb, &df, &ecb);

32 if ((res = IGR_Open_File(UCS2(u"filename.doc"), IGR_BODY_AND_META, &caps, &type, &docHandle, &ecb)) ==

IGR_OK)

33 {

34 std::vector<IGR_UCS2> buffer(4096);

35 IGR_LONG bufferSize = buffer.size();

37 while (IGR_Get_Text(docHandle, &buffer[0], &bufferSize, &ecb) == 0)

38 {

39 std::wcout << u16_to_wstring(std::u16string(reinterpret_cast<const char16_t *>(&buffer[0],

bufferSize)));

41 bufferSize = buffer.size();

42 }

43 IGR_Close_File(docHandle, &ecb);

44 }

45 }

Document Filters Implementation Guide 1.16.4 How do I extract text and metadata from a document?

- 60/1268 -

1.16.5 How do I extract sub-documents from documents and archives?

This table outlines the steps to extract sub-documents from documents and archives for supported

languages.

Samples

Language Option Refer to Function/Method

C A Open a Document, then IGR_Get_Suble_Entry and IGR_Extract_Suble

B Open a Document, then IGR_Get_Suble_Entry and IGR_Extract_Suble_Stream

.NET,

Python,

COM

Open a Document, then Extractor.SupportsSubFiles, Extractor.GetFirstSubFile,

Extractor.GetNextSubFile and Extractor.GetSubFile

Java Open a Document, then Extractor.getSupportsSubFiles, Extractor.GetFirstSubFile,

Extractor.GetNextSubFile and Extractor.GetSubFile

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 foreach (var subfile in doc.SubFiles)

10 {

11 using (subfile)

12 {

13 // act on subfile

14 Console.Out.WriteLine("Name: " + subFile.Name);

15 Console.Out.WriteLine("ID: " + subFile.ID);

16 Console.Out.WriteLine("Date: " + subFile.FileDate);

17 Console.Out.WriteLine("Size: " + subFile.FileSize);

18 }

19 }

Document Filters Implementation Guide 1.16.5 How do I extract sub-documents from documents and archives?

- 61/1268 -

Java

Python

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize("License Code", ".");

10 try (Extractor doc = df.GetExtractor("filename.doc")) {

11 doc.Open(isys_docfilters.IGR_BODY_AND_META);

13 for (SubFile subfile = doc.GetFirstSubFile(); subfile != null; subfile = doc.GetNextSubFile())

14 {

15 try (subfile) {

16 // act on subfile

17 }

18 }

19 }

20 }

21 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.GetExtractor("filename.doc") as doc:

7 doc.Open(IGR_BODY_AND_META, "")

9 for subfile in doc.SubFiles:

10 with subfile:

11 # act on subfile

Document Filters Implementation Guide 1.16.5 How do I extract sub-documents from documents and archives?

- 62/1268 -

C++

1 #include <DocumentFilters.h>

2 #include <iostream>

4 int main(int argc, char** argv)

5 {

6 IGR_SHORT df;

7 Instance_Status_Block isb = { 0 };

8 Error_Control_Block ecb = { 0 };

9 IGR_LONG caps, docType, docHandle;

11 strncpy(ISB.Licensee_ID1, "License Code", 40);

12 Init_Instance(0, ".", &isb, &df, &ecb);

14 IGR_LONG res = IGR_Open_File(_UCS2("TEST.DOC"), IGR_BODY_AND_META, &caps, &docType, &docHandle, &ecb);

15 if (RC == IGR_OK)

16 {

17 std::vector<IGR_UCS2> file_id(2048);

18 std::vector<IGR_UCS2> file_name(4096);

19 int64_t file_size = 0, file_date = 0;

21 while (IGR_Get_Subfile_Entry(docHandle, &file_id[0], &file_name[0], &file_date, &file_size, &ecb)

== 0)

22 {

23 // act on subfile

24 }

26 IGR_Close_File(docHandle, &ecb);

27 }

29 return 0;

30 }

Document Filters Implementation Guide 1.16.5 How do I extract sub-documents from documents and archives?

- 63/1268 -

1.16.6 How do I convert a document to Classic HTML?

This table outlines the steps to convert a document to Classic HTML for the supported languages.

Samples

Language Option Refer to Function/Method

C A Opening a Document in classic-html mode, then

IGR_Get_Image_Entry and IGR_Extract_Image

B Opening a Document in classic-html mode, then

IGR_Get_Image_Entry and IGR_Extract_Image_Stream

C IGR_Convert_File

.NET, Java,

Python,

COM

Opening a Document in classic-html mode, then

Extractor.GetFirstImage, Extractor.GetNextImage and

Extractor.CopyTo

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(OpenMode.ClassicHTML, OpenType.BodyAndMeta)

9 var destDir = ".";

11 // save the body

12 var htmlBody = "";

13 while (!doc.EndOfStream)

14 body += doc.GetText(4096);

16 // save the images

17 foreach (var image in doc.Images)

18 {

19 using (image)

20 {

21 image.CopyTo(System.IO.Path.Combine(destDir, image.getName()));

22 }

23 }

Document Filters Implementation Guide 1.16.6 How do I convert a document to Classic HTML?

- 64/1268 -

Java

Python

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize("License Code", ".");

10 try (Extractor doc = df.GetExtractor("filename.doc")) {

11 doc.Open(isys_docfilters.IGR_FORMAT_HTML);

13 // Extract the text and return it to stdout

14 while (!doc.getEOF())

15 {

16 String t = item.GetText(4096).replace('\u000E', '\n').replace('\r', '\n');

17 System.out.print(t);

18 }

20 for (SubFile image = doc.GetFirstImage(); image != null; image = doc.GetNextImage())

21 {

22 try (image) {

23 // act on image

24 }

25 }

26 }

27 }

28 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.GetExtractor("filename.doc") as doc:

7 doc.Open(IGR_FORMAT_HTML, "")

9 while not doc.getEOF():

10 output.write(doc.GetText(MaxCharsPerGetText, stripControlCodes=True))

12 for image in doc.Images:

13 with image:

14 # act on image

Document Filters Implementation Guide 1.16.6 How do I convert a document to Classic HTML?

- 65/1268 -

1.16.7 How do I convert a document to paginated HiDef HTML?

This table outlines the steps to convert a document to paginated HiDef HTML for the supported

languages.

Samples

Language Option Refer to Function/Method

C IGR_Open_File_Ex with IGR_FORMAT_IMAGE, then

IGR_Make_Output_Canvas(IGR_DEVICE_HTML), IGR_Open_Page

and IGR_Render_Page

COM/.net DocumentFilters.GetExtractor, then Extractor.Open with

IGR_FORMAT_IMAGE, DocumentFilters.MakeOutputCanvas with

IGR_DEVICE_HTML, Extractor.GetPage and Canvas.RenderPage

Java,

Python

DocumentFilters.GetExtractor, then Extractor.Open with

IGR_FORMAT_IMAGE, DocumentFilters.MakeOutputCanvas with

IGR_DEVICE_HTML, Extractor.GetPage and Canvas.RenderPage

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.OpenExtractor("filename.doc", OpenMode.Paginated);

7 using var canvas = api.MakeOutputCanvas("filename.html", CanvasType.HTML);

9 canvas.RenderPages(doc);

Document Filters Implementation Guide 1.16.7 How do I convert a document to paginated HiDef HTML?

- 66/1268 -

Java

Python

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize(("License Code"), ".");

10 try (Extractor doc = df.GetExtractor("filename.doc"))

11 {

12 try (Canvas canvas = df.MakeOutputCanvas("filename.html",

isys_docfiltersConstants.IGR_DEVICE_HTML, ""))

13 {

14 doc.Open(isys_docfiltersConstants.IGR_FORMAT_IMAGE, "");

16 for (int i = 0, c = doc.GetPageCount(); i < c; ++i)

17 {

18 try (Page page = doc.GetPage(i)) {

19 canvas.RenderPage(page);

20 }

21 }

22 }

23 }

24 }

25 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.OpenExtractor("filename.doc", mode=IGR_FORMAT_IMAGE) as doc:

7 with api.MakeOutputCanvas("filename.html", canvasType=IGR_DEVICE_HTML) as canvas:

8 canvas.RenderPages(doc)

Document Filters Implementation Guide 1.16.7 How do I convert a document to paginated HiDef HTML?

- 67/1268 -

C++

1 #include <DocumentFilters.h>

2 #include <string.h>

3 #include <string>

5 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

7 int main(int argc, char **argv)

8 {

9 Instance_Status_Block isb = {0};

10 Error_Control_Block ecb = {0};

11 IGR_SHORT df;

12 IGR_LONG caps, type, docHandle, canvasHandle, pageHandle, res, pageCount = 0;

14 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

15 Init_Instance(0, ".", &isb, &df, &ecb);

17 if ((res = IGR_Open_File_Ex(UCS2(u"filename.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&docHandle, &ecb)) == IGR_OK)

18 {

19 if ((res = IGR_Make_Output_Canvas(IGR_DEVICE_HTML, UCS2(u"filename.html"),

UCS2(u"HTML_INLINE_IMAGES=on"), &canvasHandle, &ecb)) == IGR_OK)

20 {

21 IGR_Get_Page_Count(docHandle, &pageCount, &ecb);

23 for (IGR_LONG i = 0; i < pageCount; ++i)

24 {

25 if ((res = IGR_Open_Page(docHandle, i, &pageHandle, &ecb)) == IGR_OK)

26 {

27 IGR_Render_Page(pageHandle, canvasHandle, &ecb);

28 IGR_Close_Page(pageHandle, &ecb);

29 }

30 }

31 }

33 IGR_Close_File(docHandle, &ecb);

34 }

35 }

Document Filters Implementation Guide 1.16.7 How do I convert a document to paginated HiDef HTML?

- 68/1268 -

1.16.8 How do I convert a document to PNG images?

This table outlines the steps to convert a document to PNG images for the supported languages.

Samples

Language Refer to Function/Method

C IGR_Open_File_Ex with IGR_FORMAT_IMAGE, then IGR_Open_Page,

IGR_Make_Output_Canvas with IGR_DEVICE_IMAGE_PNG and

IGR_Render_Page

.NET, Java,

Python,

COM

DocumentFilters.GetExtractor, then Extractor.Open with

IGR_FORMAT_IMAGE, Extractor.GetPage, DocumentFilters.MakeOutputCanvas

with IGR_DEVICE_IMAGE_PNG and Canvas.RenderPage

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.OpenExtractor("filename.doc", OpenMode.Paginated);

8 foreach (var page in doc.Pages)

9 {

10 using (page)

11 {

12 using var canvas = api.MakeOutputCanvas($"page-{page.Index+1}.png", CanvasType.PNG);

13 canvas.RenderPage(page);

14 }

15 }

Document Filters Implementation Guide 1.16.8 How do I convert a document to PNG images?

- 69/1268 -

Java

Python

1 import com.perceptive.documentfilters.*;

3 public class App {

4 public static void main(String[] args) throws Exception {

5 DocumentFilters df = new DocumentFilters();

6 df.Initialize(("License Code"), ".");

8 try (Extractor doc = df.GetExtractor("filename.doc")) {

9 doc.Open(isys_docfiltersConstants.IGR_FORMAT_IMAGE, "");

11 for (int i = 0, c = doc.GetPageCount(); i < c; ++i) {

12 try (Page page = doc.GetPage(i)) {

13 try (Canvas canvas = df.MakeOutputCanvas(String.format("page-%d.png", i+1),

isys_docfiltersConstants.IGR_DEVICE_IMAGE_PNG, "")) {

14 canvas.RenderPage(page);

15 }

16 }

17 }

18 }

19 }

20 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.OpenExtractor("filename.doc", mode=IGR_FORMAT_IMAGE) as doc:

7 for page in doc.Pages:

8 with page:

9 with api.MakeOutputCanvas(f"page-{page.PageIndex+1}.png", canvasType=IGR_DEVICE_IMAGE_PNG) as

canvas:

10 canvas.RenderPages(doc)

Document Filters Implementation Guide 1.16.8 How do I convert a document to PNG images?

- 70/1268 -

C++

1 #include <DocumentFilters.h>

2 #include <codecvt>

3 #include <fstream>

4 #include <iostream>

5 #include <locale>

6 #include <string.h>

7 #include <string>

8 #include <sstream>

9 #include <vector>

11 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

13 std::u16string To_UTF16(const std::string& s)

14 {

15 std::wstring_convert<std::codecvt_utf8_utf16<char16_t>, char16_t> conv;

16 return conv.from_bytes(s);

17 }

19 int main(int argc, char **argv)

20 {

21 Instance_Status_Block isb = {0};

22 Error_Control_Block ecb = {0};

23 IGR_SHORT df;

24 IGR_LONG caps, type, docHandle, canvasHandle, pageHandle, res, pageCount = 0;

26 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

27 Init_Instance(0, ".", &isb, &df, &ecb);

29 if ((res = IGR_Open_File_Ex(UCS2(u"filename.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&docHandle, &ecb)) == IGR_OK)

30 {

31 IGR_Get_Page_Count(docHandle, &pageCount, &ecb);

33 for (IGR_LONG i = 0; i < pageCount; ++i)

34 {

35 std::string page_filename = "page_" + std::to_string(i+1) + ".png";

37 if ((res = IGR_Make_Output_Canvas(IGR_DEVICE_IMAGE_PNG, UCS2(To_UTF16(page_filename)),

UCS2(u""), &canvasHandle, &ecb)) == IGR_OK)

38 {

39 if ((res = IGR_Open_Page(docHandle, i, &pageHandle, &ecb)) == IGR_OK)

40 {

41 IGR_Render_Page(pageHandle, canvasHandle, &ecb);

42 IGR_Close_Page(pageHandle, &ecb);

43 }

44 }

45 }

47 IGR_Close_File(docHandle, &ecb);

48 }

49 }

Document Filters Implementation Guide 1.16.8 How do I convert a document to PNG images?

- 71/1268 -

1.16.9 How do I convert a document to a PDF file?

This table outlines the steps to convert document to a PDF le for the supported languages.

Samples

Language Refer to Function/Method

C IGR_Open_File_Ex with IGR_FORMAT_IMAGE, then

IGR_Make_Output_Canvas with IGR_DEVICE_IMAGE_PDF, IGR_Open_Page

and IGR_Render_Page

.NET, Java,

Python, COM

DocumentFilters.GetExtractor, then Extractor.Open with

IGR_FORMAT_IMAGE, DocumentFilters.MakeOutputCanvas with

IGR_DEVICE_IMAGE_PDF, Extractor.GetPage and Canvas.RenderPage

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.OpenExtractor("filename.doc", OpenMode.Paginated);

7 using var canvas = api.MakeOutputCanvas("filename.pdf", CanvasType.PDF);

9 canvas.RenderPages(doc);

Document Filters Implementation Guide 1.16.9 How do I convert a document to a PDF le?

- 72/1268 -

Java

Python

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize(("License Code"), ".");

10 try (Extractor doc = df.GetExtractor("filename.doc"))

11 {

12 try (Canvas canvas = df.MakeOutputCanvas("filename.pdf",

isys_docfiltersConstants.IGR_DEVICE_PDF, ""))

13 {

14 doc.Open(isys_docfiltersConstants.IGR_FORMAT_IMAGE, "");

16 for (int i = 0, c = doc.GetPageCount(); i < c; ++i)

17 {

18 try (Page page = doc.GetPage(i)) {

19 canvas.RenderPage(page);

20 }

21 }

22 }

23 }

24 }

25 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.OpenExtractor("filename.doc", mode=IGR_FORMAT_IMAGE) as doc:

7 with api.MakeOutputCanvas("filename.pdf", canvasType=IGR_DEVICE_PDF) as canvas:

8 canvas.RenderPages(doc)

Document Filters Implementation Guide 1.16.9 How do I convert a document to a PDF le?

- 73/1268 -

C++

1 #include <DocumentFilters.h>

2 #include <string.h>

3 #include <string>

5 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

7 int main(int argc, char **argv)

8 {

9 Instance_Status_Block isb = {0};

10 Error_Control_Block ecb = {0};

11 IGR_SHORT df;

12 IGR_LONG caps, type, docHandle, canvasHandle, pageHandle, res, pageCount = 0;

14 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

15 Init_Instance(0, ".", &isb, &df, &ecb);

17 if ((res = IGR_Open_File_Ex(UCS2(u"filename.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&docHandle, &ecb)) == IGR_OK)

18 {

19 if ((res = IGR_Make_Output_Canvas(IGR_DEVICE_PDF, UCS2(u"filename.pdf"), UCS2(u""), &canvasHandle,

&ecb)) == IGR_OK)

20 {

21 IGR_Get_Page_Count(docHandle, &pageCount, &ecb);

23 for (IGR_LONG i = 0; i < pageCount; ++i)

24 {

25 if ((res = IGR_Open_Page(docHandle, i, &pageHandle, &ecb)) == IGR_OK)

26 {

27 IGR_Render_Page(pageHandle, canvasHandle, &ecb);

28 IGR_Close_Page(pageHandle, &ecb);

29 }

30 }

31 }

33 IGR_Close_File(docHandle, &ecb);

34 }

35 }

Document Filters Implementation Guide 1.16.9 How do I convert a document to a PDF le?

- 74/1268 -

1.16.10 How do I convert a document to Structured XML?

This table outlines the steps to convert a document to Structured XML for the supported languages.

Samples

Language Refer to Function/Method

C IGR_Open_File_Ex with IGR_FORMAT_IMAGE, then IGR_Make_Output_Canvas

with IGR_DEVICE_XML, IGR_Open_Page and IGR_Render_Page

COM/.net DocumentFilters.GetExtractor, then Extractor.Open with

IGR_FORMAT_IMAGE, DocumentFilters.MakeOutputCanvas with

IGR_DEVICE_XML, Extractor.GetPage and Canvas.RenderPage

Java,

Python

DocumentFilters.GetExtractor, then Extractor.Open with

IGR_FORMAT_IMAGE, DocumentFilters.MakeOutputCanvas with

IGR_DEVICE_XML, Extractor.GetPage and Canvas.RenderPage

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.OpenExtractor("filename.doc", OpenMode.Paginated);

7 using var canvas = api.MakeOutputCanvas("filename.xml", CanvasType.XML);

9 canvas.RenderPages(doc);

Document Filters Implementation Guide 1.16.10 How do I convert a document to Structured XML?

- 75/1268 -

Java

Python

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize(("License Code"), ".");

10 try (Extractor doc = df.GetExtractor("filename.doc"))

11 {

12 try (Canvas canvas = df.MakeOutputCanvas("filename.xml",

isys_docfiltersConstants.IGR_DEVICE_XML, ""))

13 {

14 doc.Open(isys_docfiltersConstants.IGR_FORMAT_IMAGE, "");

16 for (int i = 0, c = doc.GetPageCount(); i < c; ++i)

17 {

18 try (Page page = doc.GetPage(i)) {

19 canvas.RenderPage(page);

20 }

21 }

22 }

23 }

24 }

25 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.OpenExtractor("filename.doc", mode=IGR_FORMAT_IMAGE) as doc:

7 with api.MakeOutputCanvas("filename.xml", canvasType=IGR_DEVICE_XML) as canvas:

8 canvas.RenderPages(doc)

Document Filters Implementation Guide 1.16.10 How do I convert a document to Structured XML?

- 76/1268 -

C++

1 #include <DocumentFilters.h>

2 #include <string.h>

3 #include <string>

5 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

7 int main(int argc, char **argv)

8 {

9 Instance_Status_Block isb = {0};

10 Error_Control_Block ecb = {0};

11 IGR_SHORT df;

12 IGR_LONG caps, type, docHandle, canvasHandle, pageHandle, res, pageCount = 0;

14 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

15 Init_Instance(0, ".", &isb, &df, &ecb);

17 if ((res = IGR_Open_File_Ex(UCS2(u"filename.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&docHandle, &ecb)) == IGR_OK)

18 {

19 if ((res = IGR_Make_Output_Canvas(IGR_DEVICE_XML, UCS2(u"filename.xml"), UCS2(u""), &canvasHandle,

&ecb)) == IGR_OK)

20 {

21 IGR_Get_Page_Count(docHandle, &pageCount, &ecb);

23 for (IGR_LONG i = 0; i < pageCount; ++i)

24 {

25 if ((res = IGR_Open_Page(docHandle, i, &pageHandle, &ecb)) == IGR_OK)

26 {

27 IGR_Render_Page(pageHandle, canvasHandle, &ecb);

28 IGR_Close_Page(pageHandle, &ecb);

29 }

30 }

31 }

33 IGR_Close_File(docHandle, &ecb);

34 }

35 }

Document Filters Implementation Guide 1.16.10 How do I convert a document to Structured XML?

- 77/1268 -

1.16.11 How do I create a barcode?

This table outlines the steps to create a barcode in the supported languages.

Samples

Python

Language Refer to Function/Method

C IGR_Make_Output_Canvas, then IGR_Render_Page or

IGR_Canvas_Blank_Page, and then IGR_Canvas_Annotate_JSON

.NET, Java,

Python, COM

DocumentFilters.MakeOutputCanvas, then Canvas.RenderPage or

Canvas.BlankPage, and then Canvas.Annotate

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var canvas = api.MakeOutputCanvas("barcode.png", CanvasType.PNG);

7 canvas.BlankPage(400, 400);

8 canvas.Annotate(new Hyland.DocumentFilters.Annotations.QrCode {

9 Caption = "Hello World",

10 Text = "http://www.hyland.com",

11 Rect = System.Drawing.Rectangle.FromLTRB(20, 20, 380, 380)

12 });

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

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

7 canvas.BlankPage(400, 400)

9 anno = AnnotationQrCode()

10 anno.Caption = "Hello World"

11 anno.Content = "http://www.hyland.com"

12 anno.Margin = 8

13 anno.ErrorCorrectionLevel = 3

14 anno.Rect = AnnotationRect.FromLTRB(20, 20, 380, 380)

15 canvas.Annotate(anno)

Document Filters Implementation Guide 1.16.11 How do I create a barcode?

- 78/1268 -

1.16.12 How do I localize metadata?

This table outlines the steps to convert a document to PDF with localized metadata for each of the

supported languages.

Language Option Refer to Function/Method

C Create an IGR_OPEN_CALLBACK callback, IGR_Open_Ex(…,

IGR_FORMAT_IMAGE), then IGR_Make_Output_Canvas

(IGR_DEVICE_XML), IGR_Open_Page and IGR_Render_Page

.NET, Java,

Python

A DocumentFilters.GetExtractor, then Extractor.Localize and

then Extractor.Open (IGR_FORMAT_IMAGE),

DocumentFilters.MakeOutputCanvas (IGR_DEVICE_XML),

Extractor.GetPage and Canvas.RenderPage

.NET,

Python

B DocumentFilters.GetExtractor, then Extractor.Open

(IGR_FORMAT_IMAGE) passing an OpenCallback method,

DocumentFilters.MakeOutputCanvas (IGR_DEVICE_XML),

Extractor.GetPage and Canvas.RenderPage

Java B DocumentFilters.GetExtractor, implement a class extending

OpenCallback , then Extractor.Open (IGR_FORMAT_IMAGE),

DocumentFilters.MakeOutputCanvas (IGR_DEVICE_XML),

Extractor.GetPage and Canvas.RenderPage

Document Filters Implementation Guide 1.16.12 How do I localize metadata?

- 79/1268 -

Samples

Java

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using (var doc = api.GetExtractor("outlook.msg"))

7 {

8 doc.Localize["Subject"] = "Objet";

9 doc.Localize["To"] = "À";

10 doc.Localize["From"] = "De";

11 doc.Localize["Bcc"] = "Cci";

12 doc.Localize["Sent"] = "Envoyé";

13 doc.Open(IGR_FORMAT_IMAGE);

15 using (var canvas = api.MakeOutputCanvas("output.pdf", CanvasType.PDF))

16 {

17 canvas.RenderPages(doc);

18 }

19 }

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize(("License Code"), ".");

10 try (Extractor doc = df.GetExtractor("outlook.msg"))

11 {

12 doc.GetLocalize().set("Subject", "Objet");

13 doc.GetLocalize().set("To", "À");

14 doc.GetLocalize().set("From", "De");

15 doc.GetLocalize().set("Bcc", "Cci");

16 doc.GetLocalize().set("Sent", "Envoyé");

17 doc.Open(isys_docfiltersConstants.IGR_FORMAT_IMAGE);

19 try (Canvas canvas = df.MakeOutputCanvas("filename.pdf",

isys_docfiltersConstants.IGR_DEVICE_PDF, ""))

20 {

21 for (int i = 0, c = doc.GetPageCount(); i < c; ++i)

22 {

23 try (Page page = doc.GetPage(i)) {

24 canvas.RenderPage(page);

25 }

26 }

27 }

28 }

29 }

30 }

Document Filters Implementation Guide 1.16.12 How do I localize metadata?

- 80/1268 -

Python

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.GetExtractor("outlook.msg") as doc:

7 doc.Localize["Subject"] = "Objet"

8 doc.Localize["To"] = "À"

9 doc.Localize["From"] = "De"

10 doc.Localize["Bcc"] = "Cci"

11 doc.Localize["Sent"] = "Envoyé"

12 doc.Open(IGR_FORMAT_IMAGE)

14 with api.MakeOutputCanvas("filename.pdf", canvasType=IGR_DEVICE_PDF) as canvas:

15 canvas.RenderPages(doc)

Document Filters Implementation Guide 1.16.12 How do I localize metadata?

- 81/1268 -

C++

1 #include <DocumentFilters.h>

2 #include <string.h>

3 #include <string>

5 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

7 IGR_LONG IGR_EXPORT open_callback(IGR_OPEN_CALLBACK_ACTION action, void* payload, void* context)

8 {

9 if (action == IGR_OPEN_CALLBACK_ACTION_LOCALIZE)

10 {

11 IGR_Open_Callback_Action_Localize* req = static_cast<IGR_Open_Callback_Action_Localize*>(payload);

13 std::u16string src(reinterpret_cast<const std::u16string::value_type*>(req->original));

14 std::u16string res;

15 if (src == u"Subject")

16 res = u"Objet";

17 else if (src == u"To")

18 res = u"À";

19 else if (src == u"From")

20 res = u"De";

21 else if (src == u"Bcc")

22 res = u"Cci";

23 else if (src == u"Sent")

24 res = u"Envoyé";

25 else

26 return IGR_E_ERROR;

28 req->replacement[res.copy(reinterpret_cast<std::u16string::value_type*>(req->replacement), 0,

(sizeof(req->replacement) / sizeof(req->replacement[0]) - 1))] = 0;

29 return IGR_OK;

30 }

31 return IGR_OK;

32 }

34 int main(int argc, char **argv)

35 {

36 Instance_Status_Block isb = {0};

37 Error_Control_Block ecb = {0};

38 IGR_SHORT df;

39 IGR_LONG caps, type, docHandle, canvasHandle, pageHandle, res, pageCount = 0;

41 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

42 Init_Instance(0, ".", &isb, &df, &ecb);

44 if ((res = IGR_Open_Ex(IGR_OPEN_FROM_FILENAME_UTF16, UCS2(u"filename.doc"), IGR_FORMAT_IMAGE,

UCS2(u""), &caps, &type, NULL, open_callback, NULL, &docHandle, &ecb)) == IGR_OK)

45 {

46 if ((res = IGR_Make_Output_Canvas(IGR_DEVICE_PDF, UCS2(u"filename.pdf"), UCS2(u""), &canvasHandle,

&ecb)) == IGR_OK)

47 {

48 IGR_Get_Page_Count(docHandle, &pageCount, &ecb);

50 for (IGR_LONG i = 0; i < pageCount; ++i)

51 {

52 if ((res = IGR_Open_Page(docHandle, i, &pageHandle, &ecb)) == IGR_OK)

53 {

54 IGR_Render_Page(pageHandle, canvasHandle, &ecb);

55 IGR_Close_Page(pageHandle, &ecb);

Document Filters Implementation Guide 1.16.12 How do I localize metadata?

- 82/1268 -

56 }

57 }

58 }

60 IGR_Close_File(docHandle, &ecb);

61 }

62 }

Document Filters Implementation Guide 1.16.12 How do I localize metadata?

- 83/1268 -

1.16.13 How do I compare documents?

Overview

Comparing documents presents a multifaceted challenge due to the dynamic nature of content.

Documents can undergo various changes such as additions, deletions, modications, reformatting, and

even movement across pages. These alterations not only impact the visual appearance but also the

underlying structure and semantics of the content.

One of the critical challenges arises from elements like headers, footers, elds (common in applications

like Microsoft Word), and Table of Contents. These elements often contain metadata or navigational

information that may change between document versions. For instance, page numbers in headers or

footers may dier, yet these changes are typically not relevant to the content itself and should be

excluded from the comparison.

Handling these intricacies is crucial for accurate document comparison, ensuring that only meaningful

content dierences are identied while disregarding irrelevant variations caused by formatting or

metadata alterations.

DOCUMENT-LEVEL, PAGE-LEVEL, AND ELEMENT-LEVEL DIFFING

The API empowers developers with the exibility to perform comparisons at dierent granularities,

including document-level, page-level, and element-level ding. This granularity ensures that

comparisons can be tailored to specic requirements, whether it's assessing entire document revisions,

individual page modications, or detailed analysis of specic elements such as paragraphs, tables, or

images.

EFFICIENT HANDLING OF LARGE DOCUMENTS

Moreover, the Document Filters API excels in handling large documents eciently. Its ability to load

content on demand minimizes memory footprint and enhances performance, particularly when dealing

with extensive documents. This capability ensures smooth and responsive processing, even when

dealing with substantial volumes of content, thereby enhancing productivity and user experience.

Process

This table outlines the steps to compare 2 documents.

Language Option Refer to Function/Method

C 1. Open the two documents to be compared

IGR_Open_Ex(…, IGR_FORMAT_IMAGE)

2. Create a new IGR_Text_Compare_Documents passing

Document Filters Implementation Guide 1.16.13 How do I compare documents?

- 84/1268 -

Samples

Language Option Refer to Function/Method

the doc handles.

3. Call IGR_Text_Compare_Next until the return code is

not IGR_OK.

.NET, Java,

Python

A 1. Open the two documents to be compared

DocumentFilters.GetExtractor in paginated mode.

2. Call Extractor.Compare on doc1, passing in doc2.

3. Call CompareResults.GetNext until null is returned.

.NET, Java,

Python

B 1. Open the two documents to be compared

DocumentFilters.GetExtractor in paginated mode.

2. Call Extractor.GetPage on the pages to compare.

3. Call Page.Compare on doc1's page, passing in doc2's

page.

4. Call CompareResults.GetNext until null is returned.

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using (var doc1 = api.OpenExtractor(GetTestFilename("original.docx"), OpenMode.Paginated))

7 using (var doc2 = api.OpenExtractor(GetTestFilename("revision.docx"), OpenMode.Paginated))

8 using (var compare = doc1.Compare(doc2))

9 {

10 while (compare.MoveNext())

11 {

12 var diff = compare.Current;

13 // work with diff...

14 }

15 }

Document Filters Implementation Guide 1.16.13 How do I compare documents?

- 85/1268 -

C++

1 #include <DocumentFilters.h>

2 #include <string.h>

3 #include <string>

5 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

7 int main(int argc, char **argv)

8 {

9 Instance_Status_Block isb = {0};

10 Error_Control_Block ecb = {0};

11 IGR_LONG caps, type, pageCount = 0;

12 IGR_HDOC doc1_handle = 0, doc2_handle = 0;

13 IGR_HPAGE doc1_page1_handle = 0, doc2_page1_handle = 0;

14 IGR_HTEXTCOMPARE compare = 0;

16 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

17 Init_Instance(0, ".", &isb, &df, &ecb);

19 if ((res = IGR_Open_File_Ex(UCS2(u"original.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&doc1_handle, &ecb)) == IGR_OK

20 && (res = IGR_Open_File_Ex(UCS2(u"revised.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&doc2_handle, &ecb)) == IGR_OK)

21 {

22 IGR_Text_Compare_Settings settings = { sizeof(IGR_Text_Compare_Settings) };

23 IGR_Text_Compare_Document_Source doc1_source = { sizeof(IGR_Text_Compare_Document_Source) };

24 IGR_Text_Compare_Document_Source doc2_source = { sizeof(IGR_Text_Compare_Document_Source) };

25 IGR_Compare_Documents_Difference diff = { sizeof(IGR_Compare_Documents_Difference) };

27 doc1_source.doc_handle = doc1;

28 doc1_source.doc_first_page = 0;

30 doc2_source.doc_handle = doc2;

31 doc2.doc_first_page = 0;

33 if ((ret = IGR_Text_Compare_Documents(&doc1_source, &doc2_source, &settings, &compare, &ecb)) ==

IGR_OK)

34 {

35 while (IGR_Text_Compare_Next(compare, &diff, &ecb) == IGR_OK)

36 {

37 // ... work with diff object

39 IGR_Text_Compare_Difference_Dispose(&diff, &ecb);

40 }

42 IGR_Text_Compare_Close(compare, &ecb);

43 }

44 }

46 if (doc1_handle)

47 IGR_Close_File(doc1_handle, &ecb);

48 if (doc2_handle)

49 IGR_Close_File(doc2_handle, &ecb);

51 return 0;

52 }

Document Filters Implementation Guide 1.16.13 How do I compare documents?

- 86/1268 -

2. Reference

2.1 Overview

C reference The “C” API is implemented as a DLL or Shared Library, depending on the

platform. These functions are designed for procedural languages and are callable

from C and other languages, such as Delphi and Visual Basic.

Object

reference

Document Filters provides an object API that can be called from dierent Object-

oriented languages, such as C++, C#, VB.NET, Java, Python, and COM.

Structured

XML

Structured XML is a hierarchical Document Object Model (DOM) that represents

the paginated view of a document. Most nodes have two distinct sections:

Document Filters Implementation Guide 2. Reference

- 87/1268 -

2.2 C reference

2.2.1 C reference

The “C” API is implemented as a DLL or Shared Library, depending on the platform. These functions are

designed for procedural languages and are callable from C and other languages, such as Delphi and

Visual Basic.

Functions

Init_Instance Init_Instance initializes the Document Filters engine

and authenticates the license. Init_Instance must

always be the rst call made by any application to the

Document Filters library.

Close_Instance Close_Instance advises the Document Filters engine

that the program is nished.

IGR_Calculate_MD5 IGR_Calculate_MD5 will calculate the MD5 hash of an

input stream for unique document identication.

IGR_Calculate_SHA1 IGR_Calculate_SHA1 will calculate the SHA1 hash of

an input stream for unique document identication.

IGR_Canvas_Annotate_JSON IGR_Canvas_Annotate_JSON 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”.

IGR_Canvas_Arc Draws an arc on the image along the perimeter of the

ellipse bounded by the specied rectangle, with the

current pen.

IGR_Canvas_Blank_Page Inserts a blank page of the specied size into the

Canvas. This can be useful when constructing

documents, where you need to insert constructed

pages created with the drawing or markup APIs.

IGR_Canvas_Bookmarks_Append Append a single bookmark to the canvas. Bookmarks

are added one at a time and the level parameter in

Document Filters Implementation Guide 2.2 C reference

- 88/1268 -

the IGR_Bookmark determines the hierarchy.

Bookmarks in a hierarchy must be added in order and

a bookmark’s level cannot be more than one more

level deep than the previous bookmark.

IGR_Canvas_Bookmarks_Clear Remove existing bookmarks from the canvas.

IGR_Canvas_Chord Draws a closed gure represented by the intersection

of a line and an ellipse, with the current pen. The

ellipse is bisected by a line that runs between X3,Y3

and X4,Y4.

IGR_Canvas_DrawImage Renders the image specied by the ImageData

parameter on the canvas at the given location given

by the X and Y coordinates.

IGR_Canvas_DrawScaleImage Renders the image specied by the ImageData

parameter on the canvas at the given location given

by the X and Y coordinates, scaling the output to

width and height.

IGR_Canvas_Ellipse Draws an ellipse dened by a bounding rectangle on

the canvas, outlined with the current pen and lled

with the current brush.

IGR_Canvas_LineTo Draws a line on the canvas from the current pen

position to the point specied by X and Y, and sets

the pen position to (X, Y).

IGR_Canvas_MeasureText Returns the width and height in pixels, of a string if

rendered with the current font.

IGR_Canvas_MoveTo Changes the current drawing position to the point

(X,Y).

IGR_Canvas_Pie Draws a pie-shaped section of the ellipse bounded by

the rectangle (X1, Y1) and (X2, Y2) on the canvas.

IGR_Canvas_Rect Draws a rectangle using the current brush and pen of

the canvas to ll and draw the border.

IGR_Canvas_Reset IGR_Canvas_Reset restores the canvas object back to

the default set of options, including opacity, rotation,

pens, and brushes.

Document Filters Implementation Guide 2.2.1 C reference

- 89/1268 -

IGR_Canvas_Rotation IGR_Canvas_Rotation sets the rotation to be applied

for subsequent drawing methods.

IGR_Canvas_RoundRect Draws a rectangle with rounded corners, outlined with

the current pen and lled with the current brush, on

the canvas.

IGR_Canvas_SetBrush Updates the current brush on the canvas with the

given color and style; brushes are used when drawing

rectangles, shapes and text.

IGR_Canvas_SetFont Species the font to use when drawing text to the

canvas. All subsequent calls to TextOut and

MeasureText will use this font.

IGR_Canvas_SetOpacity Set the opacity/transparency for future drawing

routines.

IGR_Canvas_SetPen Updates the canvas pen on the canvas with the

specic color, width and style.

IGR_Canvas_TextOut Writes a string on the canvas, starting at X and Y, and

then updates the pen position to the end of the string.

The text is written with the current font, and lled

with the current brush.

IGR_Canvas_TextRect Writes a string inside a clipping rectangle, using the

current brush and font.

IGR_Close_Canvas IGR_Close_Canvas releases the resources associated

with the canvas handle. It must be called for every

canvas opened by IGR_Make_Output_Canvas or

IGR_Make_Output_Canvas_On, and must be called

before closing the document with IGR_Close_File.

IGR_Close_File IGR_Close_File releases the resources associated with

the le handle. It must be called for every document

opened by IGR_Open_File.

IGR_Close_Page IGR_Close_Page releases the resources associated

with the page handle. It must be called for every page

opened by IGR_Open_Page, and must be called before

closing the document with IGR_Close_File.

Document Filters Implementation Guide 2.2.1 C reference

- 90/1268 -

IGR_Convert_File IGR_Convert_File converts the specied document

into a plain text or HTML le, without the need to call

IGR_Open_File and IGR_Get_Text.

IGR_Enum_Bookmarks Enumerate all bookmarks, up-to recurse_depth, to an

application-dened callback function.

IGR_Enum_Page_Elements IGR_Enum_Page_Elements recursively walks the page

elements of source calling the user-supplied

callback .

IGR_Extend_Stream IGR_Extend_Stream allows the C / C++ API user to

create a custom stream that accepts callbacks from

Document Filters. The callbacks allow the passing of

Additional information about the stream.

IGR_Extract_Image IGR_Extract_Image extracts an image to disk from a

document opened with HTML or Image conversion in

aect.

IGR_Extract_Image_Stream IGR_Extract_Image_Stream extracts an image to a

stream from a document, given the ID of the image.

IGR_Extract_Page_Image

IGR_Extract_Page_Image extracts the embedded

image referenced by id to the le specied by

destination .

IGR_Extract_Page_Image_Stream

IGR_Extract_Page_Image_Stream extracts the

embedded image referenced by id as an IGRStream.

IGR_Extract_Suble IGR_Extract_Suble extracts a sub-document to disk

from a compound document, given the ID of the sub-

document.

IGR_Extract_Suble_Stream IGR_Extract_Suble_Stream extracts a sub-document

to a stream from a compound document, given the ID

of the sub-document.

IGR_Free_Page_Pixels The IGR_Free_Page_Pixels method is used to dispose

of page pixels extracted with IGR_Get_Page_Pixels.

Document Filters Implementation Guide 2.2.1 C reference

- 91/1268 -

IGR_Get_Bookmark_First_Child IGR_Get_Bookmark_First_Child returns the rst child

bookmark of the provided bookmark, or NULL if the

current item has no children.

IGR_Get_Bookmark_First_Child IGR_Get_Bookmark_First_Child returns the rst child

bookmark of the provided bookmark, or NULL if the

current item has no children.

IGR_Get_Bookmark_Next_Sibling IGR_Get_Bookmark_Next_Sibling returns the peer/

sibling of the provided bookmark, or NULL if the

current item is the last in it’s chain.

IGR_Get_Bookmark_Root IGR_Get_Bookmark_Root provides access to the top-

level root node of the bookmark hierarchy.

IGR_Get_File_Type IGR_Get_File_Type gets the type and the capabilities

of a given document.

IGR_Get_Format_Attribute IGR_Get_Format_Attribute returns information about

the supported le type.

IGR_Get_Handle_File_Type IGR_Get_Handle_File_Type gets the type and the

capabilities of an open document.

IGR_Get_Image_Entry IGR_Get_Image_Entry enumerates the set of images,

when HTML or Image conversion is in aect.

IGR_Get_Images_Enumerator IGR_Get_Images_Enumerator returns a new

enumerator for the set of images, when HTML

conversion is in eect as set by the Open Document

Flags, contained in a previously opened document

IGR_Get_Memory_Status IGR_Get_Memory_Status is a Windows-only memory

diagnostic.

IGR_Get_Option_Attribute IGR_Get_Option_Attribute returns information about

each published option value.

IGR_Get_Page_Annotation_Count IGR_Get_Page_Annotation_Count returns the number

of annotations that are contained on the page. For

Oce documents, comments are extracted and

included in the annotation count. For comments

spanning multiple pages, the OFFICE_COMMENT_PAGE

open document option determines if the rst, last or

Document Filters Implementation Guide 2.2.1 C reference

- 92/1268 -

all pages containing the comments should return an

annotation.

IGR_Get_Page_Annotation_Long IGR_Get_Page_Annotation_Long copies an integer

value from a given property of an existing annotation

into the user supplied buer.

IGR_Get_Page_Annotation_Str IGR_Get_Page_Annotation_Str copies a string value

from a given property of an existing annotation into

the user supplied buer.

IGR_Get_Page_Annotations IGR_Get_Page_Annotations copies references of page

annotations into the user supplied array. The caller

can iterate over all the page annotations by

incrementing the Index parameter. For Oce

documents, comments will be extracted and returned

in the page annotations array. For comments

spanning multiple pages, the OFFICE_COMMENT_PAGE

open document option determines if the rst, last or

all pages containing the comments should return an

annotation.

IGR_Get_Page_Attribute IGR_Get_Page_Attribute returns style or properties of

an open page; see <page> under Structured XML for

a full list of options.

IGR_Get_Page_Count IGR_Get_Page_Count returns the number of pages

generated for an open document. This method only

works on functions opened with IGR_FORMAT_IMAGE.

IGR_Get_Page_Dimensions IGR_Get_Page_Dimensions returns the size of the

given page in pixels.

IGR_Get_Page_Element_First_Child

IGR_Get_Page_Element_First_Child lls dest with the

rst child of the parent element.

IGR_Get_Page_Element_Next_Sibling

IGR_Get_Page_Element_Next_Sibling lls dest with

the next sibling node of element element.

IGR_Get_Page_Element_Root IGR_Get_Page_Element_Root lls {dest} with the root

element of the page.

Document Filters Implementation Guide 2.2.1 C reference

- 93/1268 -

IGR_Get_Page_Element_Style IGR_Get_Page_Element_Style returns the named style

value from the page element.

IGR_Get_Page_Element_Styles

IGR_Get_Page_Element_Styles calls the callback

with each style for the given source element.

IGR_Get_Page_Element_Text IGR_Get_Page_Element_Text returns any text

associated with the page element.

IGR_Get_Page_Elements

IGR_Get_Page_Elements lls the dest buer with

dest_count page elements from the parent object,

starting from the first index. If parent is NULL, the

root element is copied into dest .

IGR_Get_Page_Form_Element_Count IGR_Get_Page_Form_Element_Count returns the

number of form elements that are contained on the

page.

IGR_Get_Page_Form_Element_Option_Str IGR_Get_Page_Form_Element_Option_Str copies string

information from an existing form element’s option

into the user supplied buer.

IGR_Get_Page_Form_Element_Str IGR_Get_Page_Form_Element_Str copies string

information from an existing form element into the

user supplied buer.

IGR_Get_Page_Form_Elements IGR_Get_Page_Form_Elements copies references of

page form elements into the user supplied array. The

caller can iterate over all the page form elements by

incrementing the Index parameter.

IGR_Get_Page_Handle_File_Type IGR_Get_Page_Handle_File_Type gets the type and the

capabilities of an open page.

IGR_Get_Page_Hyperlink_Count IGR_Get_Page_Hyperlink_Count returns the number of

hyperlinks that are contained on the page.

IGR_Get_Page_Hyperlink_Str IGR_Get_Page_Hyperlink_Str copies string information

from an existing hyperlink into the user supplied

buer.

IGR_Get_Page_Hyperlinks IGR_Get_Page_Hyperlinks copies references of page

hyperlinks into the user supplied array. The caller can

Document Filters Implementation Guide 2.2.1 C reference

- 94/1268 -

iterate over all the page hyperlinks by incrementing

the Index parameter.

IGR_Get_Page_Image_Entry IGR_Get_Page_Image_Entry enumerates the set of

images on an open page.

IGR_Get_Page_Images_Enumerator

IGR_Get_Page_Images_Enumerator creates a new

enumerator for page images. Unlike

IGR_Get_Page_Image_Entry , it facilitates the

creation of multiple enumerators, enabling the

reprocessing of images within an open page.

Remember to free a suble enumerator by calling

IGR_Subfiles_Close once it is no longer needed.

IGR_Get_Page_Pixels The IGR_Get_Page_Pixels method provides low-level

access to a rectangular portion of the page and

provides a temporary buer that you can use to read

the pixel data in a specied format.

IGR_Get_Page_Text IGR_Get_Page_Text extracts the text of a previously

opened page of a document.

IGR_Get_Page_Word_Count IGR_Get_Page_Word_Count returns the number of

words of the given page.

IGR_Get_Page_Words IGR_Get_Page_Words copies references of page words

into the user supplied array. The caller can iterate

over all the page words by incrementing the Index

parameter.

IGR_Get_Stream_Type IGR_Get_Stream_Type gets the type and the

capabilities of a given stream object.

IGR_Get_Suble_Entry IGR_Get_Suble_Entry enumerates the sub-

documents contained in a previously opened

compound document, such as message documents

(MSG) or archive documents (ZIP).

IGR_Get_Suble_Entry_Ex IGR_Get_Suble_Entry_Ex enumerates the sub-

documents contained in a previously opened

compound document, such as message documents

(MSG) or archive documents (ZIP).

Document Filters Implementation Guide 2.2.1 C reference

- 95/1268 -

IGR_Get_Subles_Enumerator

IGR_Get_Subfiles_Enumerator creates a new

enumerator for subles. Unlike

IGR_Get_Subfile_Entry , it facilitates the creation of

multiple enumerators, enabling the reprocessing of

subles within an open document. Remember to free

a suble enumerator by calling IGR_Subfiles_Close

once it is no longer needed.

IGR_Get_Text IGR_Get_Text extracts the text of previously opened

document.

IGR_Make_Output_Canvas IGR_Make_Output_Canvas creates a new canvas that

is used for rendering page content. The output data

will be written to the le specied in Filename. To

write to memory or stream, see

IGR_Make_Output_Canvas_On.

IGR_Make_Output_Canvas_On IGR_Make_Output_Canvas_On creates a new canvas

that is used for rendering page content, the output

data will be written to the stream specied. The

Stream must be a caller created IGR_Writable_Stream

derivative.

IGR_Make_Stream_From_File IGR_Make_Stream_From_File creates a stream based

on a le for use with the document stream functions.

IGR_Make_Stream_From_Functions IGR_MAKE_STREAM_FROM_FUNCTIONS creates a new

IGR stream based o the context and functions. This

is functionally identical to constructing the

IGR_Stream structure by hand; this function can be

used by languages that do not have precise control

over memory layout.

IGR_Make_Stream_From_Memory IGR_Make_Stream_From_Memory creates a stream

based on a memory buer for use with the document

stream functions.

IGR_Multiplex The IGR_Multiplex function is used to supply

extensible functionality to the Document Filters API. It

is used as a general purpose extension mechanism to

avoid disturbing the published Document Filters API.

Document Filters Implementation Guide 2.2.1 C reference

- 96/1268 -

IGR_Open_DDB Opens a document from an OS based, device-

dependant bitmap (Windows-Only).

IGR_Open_DIB IGR_Open_DIB opens a document for content

extraction or enumeration of sub-documents from an

existing in-memory image.

IGR_Open_Ex IGR_Open_Ex opens a document for text extraction or

enumeration of sub-documents, and takes an

IGR_OPEN_CALLBACK parameter that allows for

interaction with the API user during API calls.

IGR_Open_File IGR_Open_File opens a document for content

extraction or enumeration of sub-documents.

IGR_Open_File_Ex IGR_Open_File_Ex opens a document for content

extraction or enumeration of sub-documents and

controls the output format, including converting the

source document to HTML.

IGR_Open_Page IGR_Open_Page gives access to page specic content

for documents opened using the IGR_FORMAT_IMAGE

ag, including page words, images, and structured

XML.

IGR_Open_Stream IGR_Open_Stream opens a document from a stream

object for content extraction or enumeration of

contained sub-documents.

IGR_Open_Stream_Ex IGR_Open_Stream_Ex opens a document from a

stream object for content extraction or enumeration

of contained sub-documents and controls the output

format.

IGR_Redact_Page_Text IGR_Redact_Page_Text removes the words and blacks

out the location for the specied range from the page.

IGR_Render_Page IGR_Render_Page draws the page content into the

specied output canvas.

IGR_Render_Page_Ex IGR_Render_Page_Ex draws the page content into the

specied output canvas

Document Filters Implementation Guide 2.2.1 C reference

- 97/1268 -

IGR_Subles_Close

IGR_Subfiles_Close releases the resources

associated with an enumeration generated by

IGR_Get_Subfiles_Enumerator or a similar

function. It is imperative to free enumerators before

closing the owning document.

IGR_Subles_Next

IGR_Subfiles_Next iterates through the sub-

documents within a suble enumeration obtained

from IGR_Get_Subfiles_Enumerator or a similar

function.

IGR_Subles_Next_Ex

IGR_Subfiles_Next_Ex iterates through the sub-

documents within a suble enumeration obtained

from IGR_Get_Subfiles_Enumerator or a similar

function.

IGR_Subles_Reset

IGR_Subfiles_Reset resets an enumeration to its

initial state, positioning it at the beginning.

Subsequently, invoke IGR_Subfiles_Next to

commence reprocessing the document. Notably,

invoking IGR_Subfiles_Reset is unnecessary for the

initial iteration.

IGR_Text_Compare_Close Closes the text comparison enumerator and frees

associated resources.

IGR_Text_Compare_Dierence_Dispose Disposes of a dierence result returned by the text

comparison enumerator.

IGR_Text_Compare_Documents Compares two documents and returns an enumerator

for iterating through the dierences.

IGR_Text_Compare_Elements Compares elements within pages of documents and

returns an enumerator for iterating through the

dierences.

IGR_Text_Compare_Next Retrieves the next dierence from the text

comparison enumerator.

IGR_Text_Compare_Pages Compares two pages within documents and returns

an enumerator for iterating through the dierences.

IGR_Text_Compare_Reset

Document Filters Implementation Guide 2.2.1 C reference

- 98/1268 -

Structures

Resets the text comparison enumerator to its initial

state.

UTF8_to_Widechar UTF8_to_Widechar converts a UTF-8 string into a

UCS2 string.

UTF8_to_Widechar_Ex UTF8_to_Widechar converts a UTF-8 string into a

UCS2 string.

Widechar_to_UTF8 Widechar_to_UTF8 converts a UCS2 string into UTF-8.

Widechar_to_UTF8_Ex Widechar_to_UTF8 converts a UCS2 string into UTF-8

Error_Control_Block data type Used to return error messages from the C API.

IGR_Annotation data type The IGR_Annotation structure is used by the

IGR_Get_Page_Annotations, IGR_Get_Page_Annotation_Long,

and IGR_Get_Page_Annotation_Str methods to return

information such as annotation type, position, and dimensions

for annotations on a given page.

IGR_Bookmark data type The IGR_Bookmark structure is used by the

IGR_Get_Bookmarks_Root method to return information about

the hierarchical navigation of a document.

IGR_CALLBACK data type The IGR_CALLBACK data type represents the function

signature of a callback from Document Filters.

IGR_Compare_Documents_Callback_Context

data type

Context structure for the callback functions used in document

comparison.

IGR_Compare_Documents_Dierence data

type

Structure representing a dierence between compared

documents.

IGR_Compare_Documents_Dierence_Item

data type

Structure representing a dierence item in a compared

document.

IGR_FRect data type Structure representing a rectangle with oating-point

coordinates. The coordinates are dened by the left, top, right,

and bottom edges.

Document Filters Implementation Guide 2.2.1 C reference

- 99/1268 -

IGR_Hyperlink data type The IGR_Hyperlink structure is used by the 
IGR_Get_Page_Hyperlinks method to return information such
as position and destination for hyperlinks on a given page.
IGR_OPEN_CALLBACK data type The IGR_OPEN_CALLBACK data type represents the function
signature of a callback passed to IGR_Open_Ex.
IGR_Open_Callback_Action_Heartbeat data
type
The IGR_Open_Callback_Action_Heartbeat structure is the
payload argument for IGR_OPEN_CALLBACK when the action
argument is IGR_OPEN_CALLBACK_ACTION_HEARTBEAT.
IGR_Open_Callback_Action_Localize data
type
The IGR_Open_Callback_Action_Localize structure is the
payload argument for IGR_OPEN_CALLBACK when the action
argument is IGR_OPEN_CALLBACK_ACTION_LOCALIZE.
IGR_Open_Callback_Action_Password data
type
The IGR_Open_Callback_Action_Password structure is the
payload argument for IGR_OPEN_CALLBACK when the action
argument is IGR_OPEN_CALLBACK_ACTION_PASSWORD.
IGR_Open_DIB_Info data type Structure representing information about an open Device
Independent Bitmap (DIB). It includes details such as size,
ags, width, height, stride, pixel format, pixel data, palette
information, and palette count.
IGR_Page_Element data type IGR_Open_DIB_Info is used by IGR_Get_Page_Elements and
related functions to enumerate the elements on a page.
IGR_Page_Form_Element data type The IGR_Page_Form_Element structure is used by the 
IGR_Get_Page_Form_Elements method to return information
such as position, dimensions, and text about the form items
on a given page.
IGR_Page_Pixels data type The IGR_Page_Pixels structure is used by IGR_Get_Page_Pixels
to retrieve the pixel data for a given page.
IGR_Page_Word data type The IGR_Page_Word structure is used by the 
IGR_Get_Page_Words method to return information such as
position, dimensions, and text about the words on a given
page.
IGR_Rect data type The IGR_Rect structure is used to specify the position of a
rectangle.
Document Filters Implementation Guide 2.2.1 C reference
- 100/1268 -
© 2024 Hyland Software, Inc. and its ailiates. All rights reserved.

IGR_Render_Page_Form_Values data type The IGR_Render_Page_Form_Values structure is used within

IGR_Render_Page_Properties to specify new values for form

values.

IGR_Render_Page_Properties data type The IGR_Render_Page_Properties structure is used by the

IGR_Render_Page_Ex method and provides additional

information for rendering a page to a canvas.

IGR_Render_Page_Redactions data type Structure representing a redaction area for rendering on a

page. The redaction area is dened by its position (x, y) and

size (width, height), along with the color to use for rendering

and additional reserved data.

IGR_SRect data type Structure representing a rectangle with signed integer

coordinates. The coordinates are dened by the left, top, right,

and bottom edges.

IGR_Size data type The IGR_Size structure is used to specify the size of a

rectangle.

IGR_Stream data type The IGR_Stream data type allows for the creation of custom

input streams.

IGR_Suble_Info data type Used to return suble information from the

IGR_Get_Suble_Entry_Ex C API.

IGR_T_ACTION_GET_STREAM_PART data

type

When a second or later part of a multi-part archive is required

as part of processing an Extended Stream, a callback will

request this structure to be populated with a new stream

instance.

IGR_Text_Compare_Document_Source data

type

Structure representing a source document for text

comparison.

IGR_Text_Compare_Settings data type Settings structure for text comparison operations.

IGR_Writable_Stream data type Similar to the IGR_Stream, the IGR_Writable_Stream data type

allows for the creation of custom output streams. It’s

important to note, all methods must be implemented, not just

the Write.

Document Filters Implementation Guide 2.2.1 C reference

- 101/1268 -

Constants

Instance_Status_Block data type The Instance_Status_Block data type is a control block

returned by Init_Instance with information about the installed

Document Filters engine.

IGR_RETURN_CODE Indicates the success or failure of a call.

IGR_ANNOTATION_FLAGS_TYPE Contains the annotation ags.

IGR_ANNOTATION_TYPE Contains the annotation type.

IGR_BRUSH_STYLE Contains the brush types available when

calling IGR_Canvas_SetBrush or

Canvas.SetBrush .

IGR_CANVAS_TYPE Canvas Types specify the type of output

to create when rendering a page. They

are passed to the

IGR_Make_Output_Canvas and

DocumentFilters::MakeOutputCanvas

functions.

IGR_CAPABILITY Document Capabilities are a bitmask

representing the operations that may be

performed on a document.

IGR_CHAR_CODE These character codes are output by

Document Filters when using the

IGR_Get_Text function and

Extractor.GetText.

IGR_COMPARE_DOCUMENTS_COMPARE_TYPE Contains the list of document

comparison types.

IGR_COMPARE_DOCUMENTS_DIFFERENCE_SOURCE_TYPE Contains the list of comparison

dierence source types.

IGR_COMPARE_DOCUMENTS_DIFFERENCE_TYPE Contains the list of comparison

dierence types.

IGR_COMPARE_DOCUMENTS_FLAGS_TYPE Contains the list of comparison ags.

Document Filters Implementation Guide 2.2.1 C reference

- 102/1268 -

IGR_FILETYPE_CATEGORY The File Type Category provides extra

classication of a le type. It is returned

by calls to IGR_Get_Format_Attribute.

IGR_FONT_STYLE These font styles are used with the

IGR_Canvas_SetFont method.

IGR_GET_PAGE_PIXELS_FLAGS_TYPE Contains the ags available when calling

IGR_Page_Get_Pixels .

IGR_OPEN_BITMAP_FLAGS_TYPE IGR_OPEN_BITMAP_FLAGS_TYPE is used

by IGR_Open_DIB_Info and

IGR_Open_DIB when creating a

Document Filters document from an

existing in-memory image.

IGR_OPEN_BITMAP_PIXEL_TYPE IGR_OPEN_BITMAP_PIXEL_TYPE is used

by IGR_Open_DIB_Info and

IGR_Open_DIB when creating a

Document Filters document from an

existing in-memory image; or

IGR_Get_Page_Pixels when accessing

pixels of a page.

IGR_OPEN_CALLBACK_ACTION IGR_OPEN_CALLBACK_ACTION is used by

IGR_OPEN_CALLBACK and IGR_Open_Ex

when opening a document for text

extraction or enumeration of sub-

documents.

IGR_OPEN_FLAGS Open Document Flags specify the type

of content that is to be retrieved from

the document. The ags are a bitwise

combination of the values below.

IGR_OPEN_FROM IGR_OPEN_FROM is used by

IGR_Open_Ex when opening a document

for text extraction or enumeration of

sub-documents.

IGR_PAGE_ELEMENT_TYPE Contains the list of form element types.

IGR_PAGE_FORM_ELEMENT_FLAG_TYPE Contains the form element type ags.

Document Filters Implementation Guide 2.2.1 C reference

- 103/1268 -

IGR_PAGE_FORM_ELEMENT_GET_TYPE Contains the options when requesting

form element data.

IGR_PAGE_FORM_ELEMENT_TYPE Contains the form element type ags.

IGR_PEN_STYLE Contains the pen types available when

calling IGR_Canvas_SetPen or

Canvas.SetPen .

IGR_STRING_ID Contains the list of strings that can be

localized.

IGR_SUBFILE_INFO_FLAG_TYPE Contains the suble ag information.

IGR_TEXT_STYLE Contains the text style types available

when calling IGR_Canvas_DrawText or

Canvas.DrawText .

Document Filters Implementation Guide 2.2.1 C reference

- 104/1268 -

2.2.2 Functions

Overview

Init_Instance Init_Instance initializes the Document Filters engine

and authenticates the license. Init_Instance must

always be the rst call made by any application to the

Document Filters library.

Close_Instance Close_Instance advises the Document Filters engine

that the program is nished.

IGR_Calculate_MD5 IGR_Calculate_MD5 will calculate the MD5 hash of an

input stream for unique document identication.

IGR_Calculate_SHA1 IGR_Calculate_SHA1 will calculate the SHA1 hash of

an input stream for unique document identication.

IGR_Canvas_Annotate_JSON IGR_Canvas_Annotate_JSON 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”.

IGR_Canvas_Arc Draws an arc on the image along the perimeter of the

ellipse bounded by the specied rectangle, with the

current pen.

IGR_Canvas_Blank_Page Inserts a blank page of the specied size into the

Canvas. This can be useful when constructing

documents, where you need to insert constructed

pages created with the drawing or markup APIs.

IGR_Canvas_Bookmarks_Append Append a single bookmark to the canvas. Bookmarks

are added one at a time and the level parameter in

the IGR_Bookmark determines the hierarchy.

Bookmarks in a hierarchy must be added in order and

a bookmark’s level cannot be more than one more

level deep than the previous bookmark.

IGR_Canvas_Bookmarks_Clear Remove existing bookmarks from the canvas.

Document Filters Implementation Guide 2.2.2 Functions

- 105/1268 -

IGR_Canvas_Chord Draws a closed gure represented by the intersection

of a line and an ellipse, with the current pen. The

ellipse is bisected by a line that runs between X3,Y3

and X4,Y4.

IGR_Canvas_DrawImage Renders the image specied by the ImageData

parameter on the canvas at the given location given

by the X and Y coordinates.

IGR_Canvas_DrawScaleImage Renders the image specied by the ImageData

parameter on the canvas at the given location given

by the X and Y coordinates, scaling the output to

width and height.

IGR_Canvas_Ellipse Draws an ellipse dened by a bounding rectangle on

the canvas, outlined with the current pen and lled

with the current brush.

IGR_Canvas_LineTo Draws a line on the canvas from the current pen

position to the point specied by X and Y, and sets

the pen position to (X, Y).

IGR_Canvas_MeasureText Returns the width and height in pixels, of a string if

rendered with the current font.

IGR_Canvas_MoveTo Changes the current drawing position to the point

(X,Y).

IGR_Canvas_Pie Draws a pie-shaped section of the ellipse bounded by

the rectangle (X1, Y1) and (X2, Y2) on the canvas.

IGR_Canvas_Rect Draws a rectangle using the current brush and pen of

the canvas to ll and draw the border.

IGR_Canvas_Reset IGR_Canvas_Reset restores the canvas object back to

the default set of options, including opacity, rotation,

pens, and brushes.

IGR_Canvas_Rotation IGR_Canvas_Rotation sets the rotation to be applied

for subsequent drawing methods.

Document Filters Implementation Guide 2.2.2 Functions

- 106/1268 -

IGR_Canvas_RoundRect Draws a rectangle with rounded corners, outlined with

the current pen and lled with the current brush, on

the canvas.

IGR_Canvas_SetBrush Updates the current brush on the canvas with the

given color and style; brushes are used when drawing

rectangles, shapes and text.

IGR_Canvas_SetFont Species the font to use when drawing text to the

canvas. All subsequent calls to TextOut and

MeasureText will use this font.

IGR_Canvas_SetOpacity Set the opacity/transparency for future drawing

routines.

IGR_Canvas_SetPen Updates the canvas pen on the canvas with the

specic color, width and style.

IGR_Canvas_TextOut Writes a string on the canvas, starting at X and Y, and

then updates the pen position to the end of the string.

The text is written with the current font, and lled

with the current brush.

IGR_Canvas_TextRect Writes a string inside a clipping rectangle, using the

current brush and font.

IGR_Close_Canvas IGR_Close_Canvas releases the resources associated

with the canvas handle. It must be called for every

canvas opened by IGR_Make_Output_Canvas or

IGR_Make_Output_Canvas_On, and must be called

before closing the document with IGR_Close_File.

IGR_Close_File IGR_Close_File releases the resources associated with

the le handle. It must be called for every document

opened by IGR_Open_File.

IGR_Close_Page IGR_Close_Page releases the resources associated

with the page handle. It must be called for every page

opened by IGR_Open_Page, and must be called before

closing the document with IGR_Close_File.

IGR_Convert_File

Document Filters Implementation Guide 2.2.2 Functions

- 107/1268 -

IGR_Convert_File converts the specied document

into a plain text or HTML le, without the need to call

IGR_Open_File and IGR_Get_Text.

IGR_Enum_Bookmarks Enumerate all bookmarks, up-to recurse_depth, to an

application-dened callback function.

IGR_Enum_Page_Elements IGR_Enum_Page_Elements recursively walks the page

elements of source calling the user-supplied

callback .

IGR_Extend_Stream IGR_Extend_Stream allows the C / C++ API user to

create a custom stream that accepts callbacks from

Document Filters. The callbacks allow the passing of

Additional information about the stream.

IGR_Extract_Image IGR_Extract_Image extracts an image to disk from a

document opened with HTML or Image conversion in

aect.

IGR_Extract_Image_Stream IGR_Extract_Image_Stream extracts an image to a

stream from a document, given the ID of the image.

IGR_Extract_Page_Image

IGR_Extract_Page_Image extracts the embedded

image referenced by id to the le specied by

destination .

IGR_Extract_Page_Image_Stream

IGR_Extract_Page_Image_Stream extracts the

embedded image referenced by id as an IGRStream.

IGR_Extract_Suble IGR_Extract_Suble extracts a sub-document to disk

from a compound document, given the ID of the sub-

document.

IGR_Extract_Suble_Stream IGR_Extract_Suble_Stream extracts a sub-document

to a stream from a compound document, given the ID

of the sub-document.

IGR_Free_Page_Pixels The IGR_Free_Page_Pixels method is used to dispose

of page pixels extracted with IGR_Get_Page_Pixels.

IGR_Get_Bookmark_First_Child IGR_Get_Bookmark_First_Child returns the rst child

bookmark of the provided bookmark, or NULL if the

current item has no children.

Document Filters Implementation Guide 2.2.2 Functions

- 108/1268 -

IGR_Get_Bookmark_First_Child IGR_Get_Bookmark_First_Child returns the rst child

bookmark of the provided bookmark, or NULL if the

current item has no children.

IGR_Get_Bookmark_Next_Sibling IGR_Get_Bookmark_Next_Sibling returns the peer/

sibling of the provided bookmark, or NULL if the

current item is the last in it’s chain.

IGR_Get_Bookmark_Root IGR_Get_Bookmark_Root provides access to the top-

level root node of the bookmark hierarchy.

IGR_Get_File_Type IGR_Get_File_Type gets the type and the capabilities

of a given document.

IGR_Get_Format_Attribute IGR_Get_Format_Attribute returns information about

the supported le type.

IGR_Get_Handle_File_Type IGR_Get_Handle_File_Type gets the type and the

capabilities of an open document.

IGR_Get_Image_Entry IGR_Get_Image_Entry enumerates the set of images,

when HTML or Image conversion is in aect.

IGR_Get_Images_Enumerator IGR_Get_Images_Enumerator returns a new

enumerator for the set of images, when HTML

conversion is in eect as set by the Open Document

Flags, contained in a previously opened document

IGR_Get_Memory_Status IGR_Get_Memory_Status is a Windows-only memory

diagnostic.

IGR_Get_Option_Attribute IGR_Get_Option_Attribute returns information about

each published option value.

IGR_Get_Page_Annotation_Count IGR_Get_Page_Annotation_Count returns the number

of annotations that are contained on the page. For

Oce documents, comments are extracted and

included in the annotation count. For comments

spanning multiple pages, the OFFICE_COMMENT_PAGE

open document option determines if the rst, last or

all pages containing the comments should return an

annotation.

Document Filters Implementation Guide 2.2.2 Functions

- 109/1268 -

IGR_Get_Page_Annotation_Long IGR_Get_Page_Annotation_Long copies an integer

value from a given property of an existing annotation

into the user supplied buer.

IGR_Get_Page_Annotation_Str IGR_Get_Page_Annotation_Str copies a string value

from a given property of an existing annotation into

the user supplied buer.

IGR_Get_Page_Annotations IGR_Get_Page_Annotations copies references of page

annotations into the user supplied array. The caller

can iterate over all the page annotations by

incrementing the Index parameter. For Oce

documents, comments will be extracted and returned

in the page annotations array. For comments

spanning multiple pages, the OFFICE_COMMENT_PAGE

open document option determines if the rst, last or

all pages containing the comments should return an

annotation.

IGR_Get_Page_Attribute IGR_Get_Page_Attribute returns style or properties of

an open page; see <page> under Structured XML for

a full list of options.

IGR_Get_Page_Count IGR_Get_Page_Count returns the number of pages

generated for an open document. This method only

works on functions opened with IGR_FORMAT_IMAGE.

IGR_Get_Page_Dimensions IGR_Get_Page_Dimensions returns the size of the

given page in pixels.

IGR_Get_Page_Element_First_Child

IGR_Get_Page_Element_First_Child lls dest with the

rst child of the parent element.

IGR_Get_Page_Element_Next_Sibling

IGR_Get_Page_Element_Next_Sibling lls dest with

the next sibling node of element element.

IGR_Get_Page_Element_Root IGR_Get_Page_Element_Root lls {dest} with the root

element of the page.

IGR_Get_Page_Element_Style IGR_Get_Page_Element_Style returns the named style

value from the page element.

IGR_Get_Page_Element_Styles

Document Filters Implementation Guide 2.2.2 Functions

- 110/1268 -

IGR_Get_Page_Element_Styles calls the callback

with each style for the given source element.

IGR_Get_Page_Element_Text IGR_Get_Page_Element_Text returns any text

associated with the page element.

IGR_Get_Page_Elements

IGR_Get_Page_Elements lls the dest buer with

dest_count page elements from the parent object,

starting from the first index. If parent is NULL, the

root element is copied into dest .

IGR_Get_Page_Form_Element_Count IGR_Get_Page_Form_Element_Count returns the

number of form elements that are contained on the

page.

IGR_Get_Page_Form_Element_Option_Str IGR_Get_Page_Form_Element_Option_Str copies string

information from an existing form element’s option

into the user supplied buer.

IGR_Get_Page_Form_Element_Str IGR_Get_Page_Form_Element_Str copies string

information from an existing form element into the

user supplied buer.

IGR_Get_Page_Form_Elements IGR_Get_Page_Form_Elements copies references of

page form elements into the user supplied array. The

caller can iterate over all the page form elements by

incrementing the Index parameter.

IGR_Get_Page_Handle_File_Type IGR_Get_Page_Handle_File_Type gets the type and the

capabilities of an open page.

IGR_Get_Page_Hyperlink_Count IGR_Get_Page_Hyperlink_Count returns the number of

hyperlinks that are contained on the page.

IGR_Get_Page_Hyperlink_Str IGR_Get_Page_Hyperlink_Str copies string information

from an existing hyperlink into the user supplied

buer.

IGR_Get_Page_Hyperlinks IGR_Get_Page_Hyperlinks copies references of page

hyperlinks into the user supplied array. The caller can

iterate over all the page hyperlinks by incrementing

the Index parameter.

IGR_Get_Page_Image_Entry

Document Filters Implementation Guide 2.2.2 Functions

- 111/1268 -

IGR_Get_Page_Image_Entry enumerates the set of

images on an open page.

IGR_Get_Page_Images_Enumerator

IGR_Get_Page_Images_Enumerator creates a new

enumerator for page images. Unlike

IGR_Get_Page_Image_Entry , it facilitates the

creation of multiple enumerators, enabling the

reprocessing of images within an open page.

Remember to free a suble enumerator by calling

IGR_Subfiles_Close once it is no longer needed.

IGR_Get_Page_Pixels The IGR_Get_Page_Pixels method provides low-level

access to a rectangular portion of the page and

provides a temporary buer that you can use to read

the pixel data in a specied format.

IGR_Get_Page_Text IGR_Get_Page_Text extracts the text of a previously

opened page of a document.

IGR_Get_Page_Word_Count IGR_Get_Page_Word_Count returns the number of

words of the given page.

IGR_Get_Page_Words IGR_Get_Page_Words copies references of page words

into the user supplied array. The caller can iterate

over all the page words by incrementing the Index

parameter.

IGR_Get_Stream_Type IGR_Get_Stream_Type gets the type and the

capabilities of a given stream object.

IGR_Get_Suble_Entry IGR_Get_Suble_Entry enumerates the sub-

documents contained in a previously opened

compound document, such as message documents

(MSG) or archive documents (ZIP).

IGR_Get_Suble_Entry_Ex IGR_Get_Suble_Entry_Ex enumerates the sub-

documents contained in a previously opened

compound document, such as message documents

(MSG) or archive documents (ZIP).

IGR_Get_Subles_Enumerator

IGR_Get_Subfiles_Enumerator creates a new

enumerator for subles. Unlike

IGR_Get_Subfile_Entry , it facilitates the creation of

Document Filters Implementation Guide 2.2.2 Functions

- 112/1268 -

multiple enumerators, enabling the reprocessing of

subles within an open document. Remember to free

a suble enumerator by calling IGR_Subfiles_Close

once it is no longer needed.

IGR_Get_Text IGR_Get_Text extracts the text of previously opened

document.

IGR_Make_Output_Canvas IGR_Make_Output_Canvas creates a new canvas that

is used for rendering page content. The output data

will be written to the le specied in Filename. To

write to memory or stream, see

IGR_Make_Output_Canvas_On.

IGR_Make_Output_Canvas_On IGR_Make_Output_Canvas_On creates a new canvas

that is used for rendering page content, the output

data will be written to the stream specied. The

Stream must be a caller created IGR_Writable_Stream

derivative.

IGR_Make_Stream_From_File IGR_Make_Stream_From_File creates a stream based

on a le for use with the document stream functions.

IGR_Make_Stream_From_Functions IGR_MAKE_STREAM_FROM_FUNCTIONS creates a new

IGR stream based o the context and functions. This

is functionally identical to constructing the

IGR_Stream structure by hand; this function can be

used by languages that do not have precise control

over memory layout.

IGR_Make_Stream_From_Memory IGR_Make_Stream_From_Memory creates a stream

based on a memory buer for use with the document

stream functions.

IGR_Multiplex The IGR_Multiplex function is used to supply

extensible functionality to the Document Filters API. It

is used as a general purpose extension mechanism to

avoid disturbing the published Document Filters API.

IGR_Open_DDB Opens a document from an OS based, device-

dependant bitmap (Windows-Only).

IGR_Open_DIB

Document Filters Implementation Guide 2.2.2 Functions

- 113/1268 -

IGR_Open_DIB opens a document for content

extraction or enumeration of sub-documents from an

existing in-memory image.

IGR_Open_Ex IGR_Open_Ex opens a document for text extraction or

enumeration of sub-documents, and takes an

IGR_OPEN_CALLBACK parameter that allows for

interaction with the API user during API calls.

IGR_Open_File IGR_Open_File opens a document for content

extraction or enumeration of sub-documents.

IGR_Open_File_Ex IGR_Open_File_Ex opens a document for content

extraction or enumeration of sub-documents and

controls the output format, including converting the

source document to HTML.

IGR_Open_Page IGR_Open_Page gives access to page specic content

for documents opened using the IGR_FORMAT_IMAGE

ag, including page words, images, and structured

XML.

IGR_Open_Stream IGR_Open_Stream opens a document from a stream

object for content extraction or enumeration of

contained sub-documents.

IGR_Open_Stream_Ex IGR_Open_Stream_Ex opens a document from a

stream object for content extraction or enumeration

of contained sub-documents and controls the output

format.

IGR_Redact_Page_Text IGR_Redact_Page_Text removes the words and blacks

out the location for the specied range from the page.

IGR_Render_Page IGR_Render_Page draws the page content into the

specied output canvas.

IGR_Render_Page_Ex IGR_Render_Page_Ex draws the page content into the

specied output canvas

IGR_Subles_Close

IGR_Subfiles_Close releases the resources

associated with an enumeration generated by

IGR_Get_Subfiles_Enumerator or a similar

Document Filters Implementation Guide 2.2.2 Functions

- 114/1268 -

function. It is imperative to free enumerators before

closing the owning document.

IGR_Subles_Next

IGR_Subfiles_Next iterates through the sub-

documents within a suble enumeration obtained

from IGR_Get_Subfiles_Enumerator or a similar

function.

IGR_Subles_Next_Ex

IGR_Subfiles_Next_Ex iterates through the sub-

documents within a suble enumeration obtained

from IGR_Get_Subfiles_Enumerator or a similar

function.

IGR_Subles_Reset

IGR_Subfiles_Reset resets an enumeration to its

initial state, positioning it at the beginning.

Subsequently, invoke IGR_Subfiles_Next to

commence reprocessing the document. Notably,

invoking IGR_Subfiles_Reset is unnecessary for the

initial iteration.

IGR_Text_Compare_Close Closes the text comparison enumerator and frees

associated resources.

IGR_Text_Compare_Dierence_Dispose Disposes of a dierence result returned by the text

comparison enumerator.

IGR_Text_Compare_Documents Compares two documents and returns an enumerator

for iterating through the dierences.

IGR_Text_Compare_Elements Compares elements within pages of documents and

returns an enumerator for iterating through the

dierences.

IGR_Text_Compare_Next Retrieves the next dierence from the text

comparison enumerator.

IGR_Text_Compare_Pages Compares two pages within documents and returns

an enumerator for iterating through the dierences.

IGR_Text_Compare_Reset Resets the text comparison enumerator to its initial

state.

UTF8_to_Widechar UTF8_to_Widechar converts a UTF-8 string into a

UCS2 string.

Document Filters Implementation Guide 2.2.2 Functions

- 115/1268 -

UTF8_to_Widechar_Ex UTF8_to_Widechar converts a UTF-8 string into a

UCS2 string.

Widechar_to_UTF8 Widechar_to_UTF8 converts a UCS2 string into UTF-8.

Widechar_to_UTF8_Ex Widechar_to_UTF8 converts a UCS2 string into UTF-8

Document Filters Implementation Guide 2.2.2 Functions

- 116/1268 -

Init_Instance

Init_Instance initializes the Document Filters engine and authenticates the license. Init_Instance must

always be the rst call made by any application to the Document Filters library.

PROTOTYPE

C/C++

PARAMETERS

Reserved: IGR_LONG

Reserved. Must be 0.

InstallPath: ANSI string

Path to installed executables and data les.

InstanceBlock: Pointer to Instance_Status_Block

Prior to the call: Contains your application License Code.

After the call: Returns your licensee information.

InstanceHandle: Pointer to IGR_SHORT

Returns an instance handle.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

None

SAMPLE CODE

C/C++

void Init_Instance(

IGR_LONG Reserved,

const char* InstallPath,

Instance_Status_Block* InstanceBlock,

IGR_SHORT* InstanceHandle,

Error_Control_Block* ISYSError);

Error_Control_Block ISYSError;

IGR_SHORT DocumentFilters;

Instance_Status_Block ISB;

Document Filters Implementation Guide 2.2.2 Functions

- 117/1268 -

ADDITIONAL INFORMATION

The application must call Close_Instance when nished.

SEE ALSO

Close_Instance

strncpy(ISB.Licensee_ID1, "Your License Key Here", 40);

Init_Instance(0, "Your Document Filters Executables Path Here", &ISB,

&DocumentFilters, &ISYSError);

// Process documents...

Close_Instance(&ISYSError);

•

Document Filters Implementation Guide 2.2.2 Functions

- 118/1268 -

Close_Instance

Close_Instance advises the Document Filters engine that the program is nished.

PROTOTYPE

C/C++

PARAMETERS

ISYSError: Pointer to Error_Control_Block

ISYSError

RETURN VALUE

None

SAMPLE CODE

C/C++

void Close_Instance(

Error_Control_Block* ISYSError)

Error_Control_Block ISYSError;

Close_Instance(&ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 119/1268 -

IGR_Calculate_MD5

IGR_Calculate_MD5 will calculate the MD5 hash of an input stream for unique document identication.

PROTOTYPE

C/C++

PARAMETERS

Stream: IGR_Stream **

An open IGR_Stream.

Name: Unicode string (UCS2)

A buer to receive the null-terminated MD5 hash (as a Unicode string). Must be allocated by the caller

and be able to hold at least 33 UCS2 characters.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Calculate_MD5(

IGR_Stream *Stream,

IGR_UCS2* Name,

Error_Control_Block* ISYSError);

IGR_UCS2 strHexOut[ISYS_SZ_MD5_HEX_LEN];

Error_Control_Block ISYSError;

IGR_LONG RC = IGR_Calculate_MD5(pStream, strHexOut, &ISYSError);

if (RC == IGR_OK)

// strHexOut will now contain a MD5 hash for the stream expressed as

// hexadecimal characters

Document Filters Implementation Guide 2.2.2 Functions

- 120/1268 -

IGR_Calculate_SHA1

IGR_Calculate_SHA1 will calculate the SHA1 hash of an input stream for unique document identication.

PROTOTYPE

C/C++

PARAMETERS

Stream: IGR_Stream **

An open IGR_Stream.

Name: Unicode string (UCS2)

A buer to receive the null-terminated SHA1 hash (as a Unicode string). Must be allocated by the caller

and be able to hold at least 41 UCS2 characters.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Calculate_SHA1(

IGR_Stream *Stream,

IGR_UCS2* Name,

Error_Control_Block* ISYSError);

IGR_UCS2 strHexOut[ISYS_SZ_SHA1_HEX_LEN];

Error_Control_Block ISYSError;

IGR_LONG RC = IGR_Calculate_SHA1(pStream, strHexOut, &ISYSError);

if (RC == IGR_OK)

// strHexOut will now contain a SHA1 hash for the stream expressed as

// hexadecimal characters

Document Filters Implementation Guide 2.2.2 Functions

- 121/1268 -

ADDITIONAL INFORMATION

The stream must be created by one of the IGR stream creation functions or a custom IGR stream that

has been opened.

Document Filters Implementation Guide 2.2.2 Functions

- 122/1268 -

IGR_Canvas_Annotate_JSON

IGR_Canvas_Annotate_JSON 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”.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

Json: Unicode string (UCS2)

The json payload of the annotation to render to output of the canvas. The string must be NULL

terminated.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Note Annotations are supported for bitmap, PDF and HTML canvas, however are only end-user

interactive in PDF output. For other output types, the annotation is attened/rastered into the output

IGR_LONG IGR_Canvas_Annotation_JSON(

HCANVAS Canvas,

const IGR_UCS2* Json,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 123/1268 -

IGR_Canvas_Arc

Draws an arc on the image along the perimeter of the ellipse bounded by the specied rectangle, with

the current pen.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

X: IGR_LONG

Left-most coordinate of the bounding box.

Y: IGR_LONG

Top-most coordinate of the bounding box.

X2: IGR_LONG

Right-most coordinate of the bounding box.

Y2: IGR_LONG

Bottom-most coordinate of the bounding box.

X3: IGR_LONG

X coordinate of the start point.

Y3: IGR_LONG

Y coordinate of the start point.

IGR_LONG IGR_Canvas_Arc(

HCANVAS canvas,

IGR_LONG x,

IGR_LONG y,

IGR_LONG x2,

IGR_LONG y2,

IGR_LONG x3,

IGR_LONG y3,

IGR_LONG x4,

IGR_LONG y4,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 124/1268 -

X4: IGR_LONG

X coordinate of the end point.

Y4: IGR_LONG

Y coordinate of the end point.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Use IGR_Canvas_Arc to draw a curved line with the current Pen onto the canvas. The arc follows the

perimeter of the ellipse that is bounded by X, Y, X2 and Y2. The arc will follow the perimeter of the

ellipse from the starting point to the ending point.

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

SEE ALSO

IGR_Canvas_SetPen•

Document Filters Implementation Guide 2.2.2 Functions

- 125/1268 -

IGR_Canvas_Blank_Page

Inserts a blank page of the specied size into the Canvas. This can be useful when constructing

documents, where you need to insert constructed pages created with the drawing or markup APIs.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

Options: const IGR_UCS2*

Option string providing any extended processing options.

Width: IGR_LONG

Width of the page to insert, in pixels.

Height: IGR_LONG

Height of the page to insert, in pixels.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: LONG

Returns IGR_OK.

Failure: LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Canvas_Blank_Page(

HCANVAS canvas,

const IGR_UCS2* options,

IGR_LONG width,

IGR_LONG height,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 126/1268 -

IGR_Canvas_Bookmarks_Append

Append a single bookmark to the canvas. Bookmarks are added one at a time and the level parameter in

the IGR_Bookmark determines the hierarchy. Bookmarks in a hierarchy must be added in order and a

bookmark’s level cannot be more than one more level deep than the previous bookmark.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

Bookmark: Pointer to IGR_Bookmark

Pointer to bookmark data to add.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: LONG

Returns IGR_OK.

Failure: LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Canvas_Bookmarks_Append (

HCANVAS canvas,

const struct IGR_Bookmark* bookmark,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 127/1268 -

IGR_Canvas_Bookmarks_Clear

Remove existing bookmarks from the canvas.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: LONG

Returns IGR_OK.

Failure: LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Canvas_Bookmarks_Clear (

HCANVAS canvas,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 128/1268 -

IGR_Canvas_Chord

Draws a closed gure represented by the intersection of a line and an ellipse, with the current pen. The

ellipse is bisected by a line that runs between X3,Y3 and X4,Y4.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

X: IGR_LONG

Left-most coordinate of the bounding box.

Y: IGR_LONG

Top-most coordinate of the bounding box.

X2: IGR_LONG

Right-most coordinate of the bounding box.

Y2: IGR_LONG

Bottom-most coordinate of the bounding box.

X3: IGR_LONG

X coordinate of the start point.

Y3: IGR_LONG

Y coordinate of the start point.

IGR_LONG IGR_Canvas_Chord(

HCANVAS canvas,

IGR_LONG x,

IGR_LONG y,

IGR_LONG x2,

IGR_LONG y2,

IGR_LONG x3,

IGR_LONG y3,

IGR_LONG x4,

IGR_LONG y4,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 129/1268 -

X4: IGR_LONG

X coordinate of the end point.

Y4: IGR_LONG

Y coordinate of the end point.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: LONG

Returns IGR_OK.

Failure: LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Use IGR_Canvas_Chord to a shape that is an arc and a line that joins the endpoints of the arc. The chord

consists of a portion of an ellipse that is bounded by X1, Y1, X2 and Y2. The ellipse is bisected by a line

that runs between X3,Y3 and X4,Y4.

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

SEE ALSO

IGR_Canvas_SetPen

IGR_Canvas_SetBrush

•

Document Filters Implementation Guide 2.2.2 Functions

- 130/1268 -

IGR_Canvas_DrawImage

Renders the image specied by the ImageData parameter on the canvas at the given location given by

the X and Y coordinates.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

X: IGR_LONG

The X coordinate where the image is to be drawn.

Y: IGR_LONG

The Y coordinate where the image is to be drawn.

ImageData: Pointer to Bytes

Pointer to the image data loaded into memory.

ImageSize: IGR_LONG

The size of the buer pointed to by ImageData.

MimeType: Pointer to Unicode String

A Unicode string indicating the MIME type of ImageData. Accepted values are:

image/jpg; image/jpeg; image/bmp; image/png

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

IGR_LONG IGR_Canvas_DrawImage(

HCANVAS canvas,

IGR_LONG x,

IGR_LONG y,

void* imagedata,

size_t imagesize,

const IGR_UCS2* mimetype,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 131/1268 -

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

Document Filters Implementation Guide 2.2.2 Functions

- 132/1268 -

IGR_Canvas_DrawScaleImage

Renders the image specied by the ImageData parameter on the canvas at the given location given by

the X and Y coordinates, scaling the output to width and height.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

X: IGR_LONG

The X coordinate where the image is to be drawn.

Y: IGR_LONG

The Y coordinate where the image is to be drawn.

Width: IGR_LONG

The width that the image should be drawn.

Height: IGR_LONG

The height that the image should be drawn.

ImageData: Pointer to Bytes

Pointer to the image data loaded into memory.

ImageSize: IGR_LONG

The size of the buer pointed to by ImageData.

IGR_LONG IGR_Canvas_DrawScaleImage(

HCANVAS canvas,

IGR_LONG x,

IGR_LONG y,

IGR_LONG width,

IGR_LONG height,

void* imagedata,

size_t imagesize,

const IGR_UCS2* mimetype,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 133/1268 -

MimeType: Pointer to Unicode String

A Unicode string indicating the MIME type of ImageData. Accepted values are:

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

image/jpg or image/jpeg

image/bmp

image/png

Document Filters Implementation Guide 2.2.2 Functions

- 134/1268 -

IGR_Canvas_Ellipse

Draws an ellipse dened by a bounding rectangle on the canvas, outlined with the current pen and lled

with the current brush.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

X: IGR_LONG

Left-most coordinate of the bounding box.

Y: IGR_LONG

Top-most coordinate of the bounding box.

X2: IGR_LONG

Right-most coordinate of the bounding box.

Y2: IGR_LONG

Bottom-most coordinate of the bounding box.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

IGR_LONG IGR_Canvas_Ellipse(

HCANVAS canvas,

IGR_LONG x,

IGR_LONG y,

IGR_LONG x2,

IGR_LONG y2,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 135/1268 -

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

SEE ALSO

IGR_Canvas_SetPen

IGR_Canvas_SetBrush

•

Document Filters Implementation Guide 2.2.2 Functions

- 136/1268 -

IGR_Canvas_LineTo

Draws a line on the canvas from the current pen position to the point specied by X and Y, and sets the

pen position to (X, Y).

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

X: IGR_LONG

The X coordinate of the end point.

Y: IGR_LONG

The Y coordinate of the end point.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Use IGR_Canvas_LineTo to draw a line from the current pen position to the new coordinates. The pen

position will be updated to the new coordinates.

IGR_LONG IGR_Canvas_LineTo(

HCANVAS canvas,

IGR_LONG x,

IGR_LONG y,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 137/1268 -

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

SEE ALSO

IGR_Canvas_SetPen

IGR_Canvas_MoveTo

•

Document Filters Implementation Guide 2.2.2 Functions

- 138/1268 -

IGR_Canvas_MeasureText

Returns the width and height in pixels, of a string if rendered with the current font.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

Text: Pointer to Unicode String

Pointer to a NULL terminated Unicode string to be measured.

Width: Pointer to an IGR_LONG

Pointer to an integer that is populated with the calculated width.

Height: Pointer to an IGR_LONG

Pointer to an integer that is populated with the calculated height.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Canvas_MeasureText(

HCANVAS canvas,

const IGR_UCS2* text,

IGR_LONG* width,

IGR_LONG* height,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 139/1268 -

ADDITIONAL INFORMATION

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

SEE ALSO

IGR_Canvas_SetFont•

Document Filters Implementation Guide 2.2.2 Functions

- 140/1268 -

IGR_Canvas_MoveTo

Changes the current drawing position to the point (X,Y).

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

X: IGR_LONG

The X coordinate for the new pen position.

Y: IGR_LONG

The Y coordinate for the new pen position.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Use IGR_Canvas_MoveTo to move the current pen position, without drawing onto the canvas.

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

IGR_LONG IGR_Canvas_MoveTo(

HCANVAS canvas,

IGR_LONG x,

IGR_LONG y,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 141/1268 -

SEE ALSO

IGR_Canvas_LineTo•

Document Filters Implementation Guide 2.2.2 Functions

- 142/1268 -

IGR_Canvas_Pie

Draws a pie-shaped section of the ellipse bounded by the rectangle (X1, Y1) and (X2, Y2) on the canvas.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

X: IGR_LONG

Left-most coordinate of the bounding box.

Y: IGR_LONG

Top-most coordinate of the bounding box.

X2: IGR_LONG

Right-most coordinate of the bounding box.

Y2: IGR_LONG

Bottom-most coordinate of the bounding box.

X3: IGR_LONG

X coordinate of the start point.

Y3: IGR_LONG

Y coordinate of the start point.

IGR_LONG IGR_Canvas_Pie(

HCANVAS canvas,

IGR_LONG x,

IGR_LONG y,

IGR_LONG x2,

IGR_LONG y2,

IGR_LONG x3,

IGR_LONG y3,

IGR_LONG x4,

IGR_LONG y4,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 143/1268 -

X4: IGR_LONG

X coordinate of the end point.

Y4: IGR_LONG

Y coordinate of the end point.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Use IGR_Canvas_Pie to draw a pie-shaped wedge on the image. The wedge is dened by the ellipse

bounded by the rectangle determined by X, Y, X2 and Y2. The section drawn is determined by two lines

radiating from the center of the ellipse through X3, Y3 and X4, Y4. The wedge is outlined using Pen, and

lled using Brush.

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

SEE ALSO

IGR_Canvas_SetPen

IGR_Canvas_SetBrush

•

Document Filters Implementation Guide 2.2.2 Functions

- 144/1268 -

IGR_Canvas_Rect

Draws a rectangle using the current brush and pen of the canvas to ll and draw the border.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas.

X: IGR_LONG

Left-most coordinate of the bounding box.

Y: IGR_LONG

Top-most coordinate of the bounding box.

X2: IGR_LONG

Right-most coordinate of the bounding box.

Y2: IGR_LONG

Bottom-most coordinate of the bounding box.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

IGR_LONG IGR_Canvas_Rect(

HCANVAS canvas,

IGR_LONG x,

IGR_LONG y,

IGR_LONG x2,

IGR_LONG y2,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 145/1268 -

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

SEE ALSO

IGR_Canvas_SetPen

IGR_Canvas_SetBrush

IGR_Canvas_RoundRect

•

Document Filters Implementation Guide 2.2.2 Functions

- 146/1268 -

IGR_Canvas_Reset

IGR_Canvas_Reset restores the canvas object back to the default set of options, including opacity,

rotation, pens, and brushes.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

IGR_LONG IGR_Canvas_Reset(

HCANVAS canvas,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 147/1268 -

IGR_Canvas_Rotation

IGR_Canvas_Rotation sets the rotation to be applied for subsequent drawing methods.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

Degrees: IGR_LONG

The rotation angle to be applied, in radians.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

IGR_LONG IGR_Canvas_Rotation(

HCANVAS canvas,

IGR_LONG degrees,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 148/1268 -

IGR_Canvas_RoundRect

Draws a rectangle with rounded corners, outlined with the current pen and lled with the current brush,

on the canvas.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas.

X: IGR_LONG

Left-most coordinate of the bounding box.

Y: IGR_LONG

Top-most coordinate of the bounding box.

X2: IGR_LONG

Right-most coordinate of the bounding box.

Y2: IGR_LONG

Bottom-most coordinate of the bounding box.

Radius: IGR_LONG

The radius to use for the rounded corner.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

IGR_LONG IGR_Canvas_RoundRect(

HCANVAS canvas,

IGR_LONG x,

IGR_LONG y,

IGR_LONG x2,

IGR_LONG y2,

IGR_LONG radius,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 149/1268 -

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

SEE ALSO

IGR_Canvas_SetPen

IGR_Canvas_SetBrush

IGR_Canvas_Rect

•

Document Filters Implementation Guide 2.2.2 Functions

- 150/1268 -

IGR_Canvas_SetBrush

Updates the current brush on the canvas with the given color and style; brushes are used when drawing

rectangles, shapes and text.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

Color: IGR_LONG

The color expressed as a 32-bit integer.

Style: IGR_LONG

The brush style used when drawing. See Brush Styles.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Color is expressed as a 32-bit integer, where the 4 bytes represent Alpha, Red, Green and Blue

components.

IGR_LONG IGR_Canvas_SetBrush(

HCANVAS canvas,

IGR_LONG color,

IGR_LONG style,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 151/1268 -

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

SEE ALSO

IGR_Canvas_SetFont•

Document Filters Implementation Guide 2.2.2 Functions

- 152/1268 -

IGR_Canvas_SetFont

Species the font to use when drawing text to the canvas. All subsequent calls to TextOut and

MeasureText will use this font.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

FontFamily: Pointer to Unicode String

The font family (or typeface) of the font.

Size: IGR_LONG

The size, in points, of the font.

Style: IGR_LONG

A bitmask of style information, can be zero or more of the following:

IGR_LONG IGR_Canvas_SetFont(

HCANVAS canvas,

const IGR_UCS2* fontFamily,

IGR_LONG size,

IGR_LONG style,

Error_Control_Block* error);

Character Value Description

0x01 FONT_STYLE_BOLD

0x02 FONT_STYLE_ITALICS

0x04 FONT_STYLE_UNDERLINE

0x08 FONT_STYLE_STRIKEOUT

0x10 FONT_STYLE_SERIF

0x20 FONT_STYLE_MONO

0x40 FONT_STYLE_RTL

Document Filters Implementation Guide 2.2.2 Functions

- 153/1268 -

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

SEE ALSO

IGR_Canvas_TextOut

IGR_Canvas_TextRect

IGR_Canvas_MeasureText

Font Styles

•

Document Filters Implementation Guide 2.2.2 Functions

- 154/1268 -

IGR_Canvas_SetOpacity

Set the opacity/transparency for future drawing routines.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

Opacity: BYTE

Indicates the opacity value between 0 and 255, where 255 is opaque.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

The opacity is expressed as a number between 0 and 255. 255 indicates that that there is no

transparency and 0 indicates full transparency.

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

IGR_LONG IGR_Canvas_SetOpacity(

HCANVAS canvas,

BYTE opacity,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 155/1268 -

IGR_Canvas_SetPen

Updates the canvas pen on the canvas with the specic color, width and style.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

Color: IGR_LONG

The color expressed as a 32-bit integer.

Width: IGR_LONG

The width of the pen, expressed in points.

Style: IGR_LONG

The pen style used when drawing. See Pen Styles.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Canvas_SetPen(

HCANVAS canvas,

IGR_LONG color,

IGR_LONG width,

IGR_LONG style,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 156/1268 -

ADDITIONAL INFORMATION

Color is expressed as a 32-bit integer, where the 4 bytes represent Alpha, Red, Green and Blue

components.

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

SEE ALSO

IGR_Canvas_SetBrush•

Document Filters Implementation Guide 2.2.2 Functions

- 157/1268 -

IGR_Canvas_TextOut

Writes a string on the canvas, starting at X and Y, and then updates the pen position to the end of the

string. The text is written with the current font, and lled with the current brush.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

X: IGR_LONG

Left-most coordinate of the bounding box.

Y: IGR_LONG

Top-most coordinate of the bounding box.

Text: Unicode string (UCS2)

The text to output to the canvas. The string must be NULL terminated.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Canvas_TextOut(

HCANVAS canvas,

IGR_LONG x,

IGR_LONG y,

const IGR_UCS2* text,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 158/1268 -

ADDITIONAL INFORMATION

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

SEE ALSO

IGR_Canvas_SetPen

IGR_Canvas_SetBrush

•

Document Filters Implementation Guide 2.2.2 Functions

- 159/1268 -

IGR_Canvas_TextRect

Writes a string inside a clipping rectangle, using the current brush and font.

PROTOTYPE

C/C++

PARAMETERS

Canvas: HCANVAS

Handle to a canvas.

X: IGR_LONG

Left-most coordinate of the bounding box.

Y: IGR_LONG

Top-most coordinate of the bounding box.

X2: IGR_LONG

Right-most coordinate of the bounding box.

Y2: IGR_LONG

Bottom-most coordinate of the bounding box.

Text: Pointer to Unicode String

The text to output to the canvas.The string must be NULL terminated.

Flags: IGR_LONG

Reserved for future use.

Error: Pointer to Error_Control_Block

IGR_LONG IGR_Canvas_TextRect(

HCANVAS canvas,

IGR_LONG x,

IGR_LONG y,

IGR_LONG x2,

IGR_LONG y2,

const IGR_UCS2* text,

IGR_LONG flags,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 160/1268 -

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

Document Filters Implementation Guide 2.2.2 Functions

- 161/1268 -

IGR_Close_Canvas

IGR_Close_Canvas releases the resources associated with the canvas handle. It must be called for every

canvas opened by IGR_Make_Output_Canvas or IGR_Make_Output_Canvas_On, and must be called before

closing the document with IGR_Close_File.

PROTOTYPE

C/C++

PARAMETERS

CanvasHandle: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas or IGR_Make_Output_Canvas_On.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Close_Canvas(

HCANVAS CanvasHandle,

Error_Control_Block* Error);

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle, PageCount;

HPAGE PageHandle;

IGR_LONG RC = IGR_Open_Stream(pStream, IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle, &ISYSError);

if (RC == IGR_OK)

{

if (IGR_Get_Page_Count(DocHandle, &PageCount, &ISYSError) == IGR_OK)

{

for (IGR_LONG PageIndex = 0; PageIndex < PageCount; PageIndex++)

{

if (IGR_Open_Page(DocHandle, PageIndex, &PageHandle, &ISYSError) == IGR_OK)

{

HCANVAS CanvasHandle;

Document Filters Implementation Guide 2.2.2 Functions

- 162/1268 -

SEE ALSO

IGR_Make_Output_Canvas

IGR_Make_Output_Canvas_On

if (IGR_Make_Output_Canvas(IGR_DEVICE_IMAGE_PNG, L"page.png",

&CanvasHandle, &ISYSError) == IGR_OK)

{

IGR_Render_Page(PageHandle, CanvasHandle, &ISYSError);

IGR_Close_Canvas(CanvasHandle, &ISYSError);

}

IGR_Close_Page(PageHandle, &ISYSError);

}

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 163/1268 -

IGR_Close_File

DESCRIPTION

IGR_Close_File releases the resources associated with the le handle. It must be called for every

document opened by IGR_Open_File.

PROTOTYPE

C/C++

PARAMETERS

DocHandle: IGR_LONG

Handle to a document, opened by a call to IGR_Open_File, IGR_Open_File_Ex, IGR_Open_Stream or

IGR_Open_Stream_Ex.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Close_File(

IGR_LONG DocHandle,

Error_Control_Block* ISYSError);

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle;

IGR_LONG RC = IGR_Open_File(_UCS2("TEST.DOC"), IGR_BODY_AND_META, &Capabilities, &DocType, &DocHandle,

&ISYSError);

if (RC == IGR_OK)

{

// Extract document text or sub-documents...

IGR_Close_File(DocHandle, &ISYSError);

}

Document Filters Implementation Guide 2.2.2 Functions

- 164/1268 -

ADDITIONAL INFORMATION

The stream must be created by one of the IGR stream creation functions or a custom IGR stream that

has been opened.

Document Filters Implementation Guide 2.2.2 Functions

- 165/1268 -

IGR_Close_Page

IGR_Close_Page releases the resources associated with the page handle. It must be called for every page

opened by IGR_Open_Page, and must be called before closing the document with IGR_Close_File.

PROTOTYPE

C/C++

PARAMETERS

PageHandle: HPAGE

Handle to a page opened by IGR_Open_Page.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Close_Page(

HPAGE PageHandle,

Error_Control_Block* Error);

Error_Control_Block ISYSError;

IGR_LONG Caps, DocType, DocHandle, PageCount;

HPAGE PageHandle;

IGR_LONG RC = IGR_Open_Stream(pStream, IGR_FORMAT_IMAGE, &Caps, &DocType, &DocHandle, &ISYSError);

if (RC == IGR_OK)

{

if (IGR_Get_Page_Count(DocHandle, &PageCount, &ISYSError) == IGR_OK)

{

for (IGR_LONG PageIndex = 0; PageIndex < PageCount; PageIndex++)

{

if (IGR_Open_Page(DocHandle, PageIndex, &PageHandle, &ISYSError) == IGR_OK)

{

// Process Page Element

IGR_Close_Page(PageHandle, &ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 166/1268 -

}

IGR_Close_File(DocHandle, &ISYSError);

}

Document Filters Implementation Guide 2.2.2 Functions

- 167/1268 -

IGR_Convert_File

IGR_Convert_File converts the specied document into a plain text or HTML le, without the need to call

IGR_Open_File and IGR_Get_Text.

PROTOTYPE

C/C++

PARAMETERS

FileName: Unicode string (UCS2)

Path to the document to be converted.

Flags: IGR_LONG

Species processing options controlling the output. See Open Document Flags on page .

Note: IGR_Convert_File supports Text and Classic HTML modes only.

Options: Unicode string (UCS2)

Extended processing options used when converting the document to HTML. The Open Document Options

are expressed as Name=Value with a semicolon delimiter.

OutputFilename: Unicode string (UCS2)

The lename where the output document is to be saved.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

IGR_LONG IGR_Convert_File(

const IGR_UCS2* FileName,

IGR_LONG Flags,

const IGR_UCS2* Options,

const IGR_UCS2* OutputFilename

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 168/1268 -

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

Error_Control_Block ISYSError;

IGR_LONG RC;

if (IGR_OK == IGR_Convert_File(_UCS2("TEST.DOC"), IGR_BODY_AND_META | IGR_FORMAT_HTML, _UCS2("IMAGEPATH=C:\

\Temp"), _UCS2("C:\\Temp\TEST.HTML"), &ISYSError)) { … }

Document Filters Implementation Guide 2.2.2 Functions

- 169/1268 -

IGR_Enum_Bookmarks

Enumerate all bookmarks, up-to recurse_depth, to an application-dened callback function.

PROTOTYPE

C/C++

PARAMETERS

docHandle: IGR_LONG

Handle to a HD document.

root: Pointer to IGR_Bookmark

Optional bookmark value to enumerate, or NULL to enumerate from root.

recurse_depth: IGR_LONG

Maximum depth to scan.

callback: IGR_CALLBACK_BOOKMARK

A pointer to an application-dened callback function.

context: Pointer to void

An application-dened value to be passed to the callback function.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

IGR_RETURN_CODE IGR_Enum_Bookmarks(

IGR_LONG docHandle,

const struct IGR_Bookmark* root,

IGR_LONG recurse_depth,

IGR_CALLBACK_BOOKMARK callback,

void* context,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 170/1268 -

Returns one of the possible IGR_E error codes.

Document Filters Implementation Guide 2.2.2 Functions

- 171/1268 -

IGR_Enum_Page_Elements

IGR_Enum_Page_Elements recursively walks the page elements of source calling the user-supplied

callback .

PROTOTYPE

C/C++

PARAMETERS

page: IGR_HPAGE

Page element containing the page elements to extract.

source: Pointer to IGR_Page_Element

The element of the element where the styles should be extracted.

flags: IGR_ULONG

Reserved for future use.

max_depth: IGR_ULONG

The maximum depth of page elements to walk.

callback: IGR_PAGE_ELEMENT_CALLBACK

User supplied callback where the element information is to be sent.

context: Pointer to void

User supplied callback context to pass when calling {callback}.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

IGR_RETURN_CODE IGR_Enum_Page_Elements(

IGR_HPAGE page,

const struct IGR_Page_Element* source,

IGR_ULONG flags,

IGR_ULONG max_depth,

IGR_PAGE_ELEMENT_CALLBACK callback,

void* context,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 172/1268 -

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SEE ALSO

Document Filters Implementation Guide 2.2.2 Functions

- 173/1268 -

IGR_Extend_Stream

IGR_Extend_Stream allows the C / C++ API user to create a custom stream that accepts callbacks from

Document Filters. The callbacks allow the passing of Additional information about the stream.

PROTOTYPE

C/C++

PARAMETERS

Stream: Pointer to IGR_Stream

A valid IGR_Stream instance.

Callback: Pointer to callback function

Pointer to the API user’s function to handle callback generated while processing the stream.

Context: void Pointer

API user-supplied context information.

ExtStream: Pointer to IGR_Stream pointer

The extended stream which should be used instead of the original stream. See notes below.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Extend_Stream(

IGR_Stream* Stream,

IGR_CALLBACK Callback,

void* Context,

IGR_Stream** ExtStream,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 174/1268 -

SAMPLE CODE

C/C++

ADDITIONAL INFORMATION

To create and use an Extended Stream, complete the following steps.

Get or create an instance of an ordinary stream.

Call IGR_Extend_Stream.

Use the returned Extended Stream instead of the original stream.

Once you have successfully created an Extended Stream, do not use the original stream pointer any

further, and do not close or release it. When you are nished with the Extended Stream, call Close on the

Extended Stream directly and the original stream closes automatically.

IGR_LONG HandleCallback(int actionID, void* actionData, void* context)

{

MyFileInfoStruct* pFileInfo;

IGR_T_ACTION_GET_STREAM_PART* pStreamPartInfo;

// Process the action...

pFileInfo = (MyFileInfoStruct*)context;

if (actionID == IGR_ACTION_GET_STREAM_PART)

{

pStreamPartInfo = (IGR_T_ACTION_GET_STREAM_PART*) actionData;

// Open a new stream based on the stream part info…

// The new stream does not need to be an extended stream.

}

return 0; // OK

}

void ProcessFile()

{

Error_Control_Block ISYSError;

IGR_Stream *pStream;

IGR_Stream* pExtendedStream;

MyFileInfoStruct fileInfo;

SetFileInfoName(fileInfo, "TEST.RAR");

if (IGR_Make_Stream_From_File(_UCS2(fileInfo.name), 0, &pStream,

&ISYSError) == IGR_OK)

{

if (IGR_Extend_Stream(pStream, &HandleCallback, &fileInfo, &pExtendedStream,

&ISYSError))

{

// Process the file using pExtendedStream only...

IGR_Open_Stream(pExtendedStream, ...);

// ...

pExtendedStream->Close(pExtendedStream);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 175/1268 -

SEE ALSO

Multi-Part Archives

Custom Streams

IGR_CALLBACK Data Type

IGR_Make_Stream_From_File

IGR_Stream

•

Document Filters Implementation Guide 2.2.2 Functions

- 176/1268 -

IGR_Extract_Image

IGR_Extract_Image extracts an image to disk from a document opened with HTML or Image conversion in

aect.

The image ID is obtained previously by IGR_Get_Image_Entry from the document.

PROTOTYPE

C/C++

PARAMETERS

DocHandle: IGR_LONG

Is a handle to a le, opened by a call to IGR_Open_File.

ID: Unicode string (UCS2)

Unique ID of the sub-document to be extracted, obtained by a call to IGR_Get_Image_Entry.

Destination: Unicode string (UCS2)

Path to a le on disk, where the binary the sub-document will be written.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Extract_Image(

IGR_LONG DocHandle,

const IGR_UCS2* ID,

const IGR_UCS2* Destination,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 177/1268 -

SEE ALSO

IGR_Get_Image_Entry

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle;

IGR_UCS2 ID[4096], Name[1024];

INT64 FileDate, FileSize;

IGR_LONG RC = IGR_Open_File_Ex(_UCS2("TEST.DOC"), IGR_BODY_AND_META | IGR_FORMAT_HTML, _UCS2(""),

&Capabilities, &DocType, &DocHandle, &ISYSError);

if (RC == IGR_OK)

{

// Extract document HTML via IGR_Get_Text first, then...

while (true)

{

rc = IGR_Get_Image_Entry(DocHandle, ID, Name, &FileDate, &FileSize, &ISYSError);

if (rc != IGR_OK)

{

if (rc != IGR_NO_MORE)

// ReportError(rc);

break;

}

rc = IGR_Extract_Image(DocHandle, ID, ID, &ISYSError);

if (rc != IGR_OK)

// ReportError(rc);

}

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 178/1268 -

IGR_Extract_Image_Stream

IGR_Extract_Image_Stream extracts an image to a stream from a document, given the ID of the image.

The image ID is obtained previously by IGR_Get_Image_Entry from the document, after being opened by

IGR_Open_File or IGR_Open_Stream with the HTML conversion Open Document Flags set.

PROTOTYPE

C/C++

PARAMETERS

DocHandle: IGR_LONG

Handle to a document, opened by a call to IGR_Open_File, IGR_Open_File_Ex, IGR_Open_Stream or

IGR_Open_Stream_Ex.

ID: Unicode string (UCS2)

Unique ID of the sub-document to be extracted, obtained by a call to IGR_Get_Image_Entry.

Stream: IGR_Stream **

A pointer to a system allocated memory stream will be returned.

It is the caller’s responsibility to free the stream object by calling Stream->Close() .

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Extract_Image_Stream(

IGR_LONG DocHandle,

const IGR_UCS2* ID,

IGR_Stream **Stream,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 179/1268 -

SAMPLE CODE

C/C++

SEE ALSO

IGR_Get_Image_Entry

Error_Control_Block ISYSError;

IGR_Stream *Stream;

IGR_UCS2 ID[4096], Name[1024];

INT64 FileDate, FileSize;

while (true)

{

IGR_LONG rc = IGR_Get_Image_Entry(DocHandle, ID, Name, &FileDate, &FileSize, &ISYSError);

if (rc != IGR_OK)

{

if (rc != IGR_NO_MORE)

// ReportError(rc);

break;

}

rc = IGR_Extract_Image_Stream(DocHandle, ID, &Stream, &ISYSError);

if (rc != IGR_OK)

// ReportError(rc);

else

// DoSomethingWithTheStream(Stream);

Stream->close();

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 180/1268 -

IGR_Extract_Page_Image

IGR_Extract_Page_Image extracts the embedded image referenced by id to the le specied by

destination .

PROTOTYPE

C/C++

PARAMETERS

pageHandle: HPAGE

Handle to a page, opened by a call to IGR_Open_Page.

id: Pointer to IGR_UCS2

Unique ID of the sub-document to be extracted, obtained by a call to IGR_Get_Image_Entry.

destination: Pointer to IGR_UCS2

Path to a le on disk, where the binary the sub-document will be written.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SEE ALSO

IGR_RETURN_CODE IGR_Extract_Page_Image(

HPAGE pageHandle,

const IGR_UCS2* id,

const IGR_UCS2* destination,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 181/1268 -

IGR_Extract_Page_Image_Stream

IGR_Extract_Page_Image_Stream extracts the embedded image referenced by id as an IGRStream.

PROTOTYPE

C/C++

PARAMETERS

pageHandle: HPAGE

Handle to a page, opened by a call to IGR_Open_Page.

id: Pointer to IGR_UCS2

Unique ID of the sub-document to be extracted, obtained by a call to IGR_Get_Image_Entry.

stream: Pointer to IGR_Stream

A pointer to a system allocated memory stream will be returned.

It is the caller’s responsibility to free the stream object by calling Stream->Close() .

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SEE ALSO

IGR_RETURN_CODE IGR_Extract_Page_Image_Stream(

HPAGE pageHandle,

const IGR_UCS2* id,

IGR_Stream** stream,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 182/1268 -

IGR_Extract_Subfile

IGR_Extract_Suble extracts a sub-document to disk from a compound document, given the ID of the

sub-document.

The sub-document ID is obtained previously by IGR_Get_Suble_Entry from the compound document,

after being opened by IGR_Open_File.

PROTOTYPE

C/C++

PARAMETERS

DocHandle: IGR_LONG

Is a handle to a le, opened by a call to IGR_Open_File.

ID: Unicode string (UCS2)

Unique ID of the sub-document to be extracted, obtained by a call to IGR_Get_Suble_Entry.

Destination: Unicode string (UCS2)

Path to a le on disk, where the binary the sub-document will be written.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Extract_Subfile(

IGR_LONG DocHandle,

const IGR_UCS2* ID,

const IGR_UCS2* Destination,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 183/1268 -

SEE ALSO

IGR_Get_Suble_Entry

Error_Control_Block ISYSError;

IGR_UCS2 ID[4096], Name[1024];

INT64 FileDate, FileSize;

while (true)

{

IGR_LONG rc = IGR_Get_Subfile_Entry(DocHandle, ID, Name, &FileDate, &FileSize,

&ISYSError);

if (rc != IGR_OK)

{

if (rc != IGR_NO_MORE)

// ReportError(rc);

break;

}

rc = IGR_Extract_Subfile(DocHandle, ID, _UCS2("TEMP.DAT"), &ISYSError);

if (rc != IGR_OK)

// ReportError(rc);

else

// DoSomethingWithTheFile("TEMP.DAT", ID, Name);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 184/1268 -

IGR_Extract_Subfile_Stream

IGR_Extract_Suble_Stream extracts a sub-document to a stream from a compound document, given the

ID of the sub-document.

The sub-document ID is obtained previously by IGR_Get_Suble_Entry from the compound document,

after being opened by IGR_Open_File or IGR_Open_Stream.

PROTOTYPE

C/C++

PARAMETERS

DocHandle: IGR_LONG

Handle to a document, opened by a call to IGR_Open_File, IGR_Open_File_Ex, IGR_Open_Stream or

IGR_Open_Stream_Ex.

ID: Unicode string (UCS2)

Unique ID of the sub-document to be extracted, obtained by a call to IGR_Get_Suble_Entry.

Stream: Pointer to an IGR_Stream pointer

A pointer to a system allocated memory stream will be returned.

It is the caller’s responsibility to free the stream object by calling

Stream->Close()

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

IGR_LONG IGR_Extract_Subfile_Stream(

IGR_LONG DocHandle,

const IGR_UCS2* ID,

IGR_Stream **Stream,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 185/1268 -

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

SEE ALSO

IGR_Get_Suble_Entry

IGR_Stream

Error_Control_Block ISYSError;

IGR_Stream *Stream;

IGR_UCS2 ID[4096], Name[1024];

INT64 FileDate, FileSize;

while (true)

{

IGR_LONG rc = IGR_Get_Subfile_Entry(DocHandle, ID, Name, &FileDate, &FileSize,

&ISYSError);

if (rc != IGR_OK)

{

if (rc != IGR_NO_MORE)

// ReportError(rc);

break;

}

rc = IGR_Extract_Subfile_Stream(DocHandle, ID, &Stream, &ISYSError);

if (rc != IGR_OK)

// ReportError(rc);

else

// DoSomethingWithTheStream(Stream);

Stream->close();

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 186/1268 -

IGR_Free_Page_Pixels

The IGR_Free_Page_Pixels method is used to dispose of page pixels extracted with IGR_Get_Page_Pixels.

PROTOTYPE

C/C++

PARAMETERS

pixel_data: Pointer to IGR_Page_Pixels

Pointer to an IGR_Page_Pixels populated by a called to IGR_Get_Page_Pixels.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SEE ALSO

IGR_Get_Page_Pixels

IGR_Page_Pixels

IGR_LONG IGR_Free_Page_Pixels(

struct IGR_Page_Pixels* pixel_data,

Error_Control_Block* error);

•

Document Filters Implementation Guide 2.2.2 Functions

- 187/1268 -

IGR_Get_Bookmark_First_Child

IGR_Get_Bookmark_First_Child returns the rst child bookmark of the provided bookmark, or NULL if the

current item has no children.

PROTOTYPE

C/C++

PARAMETERS

DocHandle: IGR_LONG

Handle to a document, opened by a call to IGR_Open_File, IGR_Open_File_Ex, IGR_Open_Stream or

IGR_Open_Stream_Ex.

Source: Pointer to IGR_Bookmark

Pointer to an IGR_Bookmark returned from a previous call to IGR_Get_Bookmark_Root,

IGR_Get_Bookmark_First_Child, or IGR_Get_Bookmark_Next_Sibling.

Dest: Pointer to IGR_Bookmark

Pointer to a user-supplied IGR_Bookmark that will be populated enabling supplementary calls to

bookmark methods.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Get_Bookmark_First_Child (

IGR_LONG DocHandle,

const IGR_Bookmark *Source,

IGR_Bookmark *Dest,

Error_Control_Block* Error);

Document Filters Implementation Guide 2.2.2 Functions

- 188/1268 -

SEE ALSO

IGR_Bookmark

IGR_Get_Bookmark_Next_Sibling

Error_Control_Block Err;

IGR_LONG Capabilities, DocType, DocHandle, PageCount;

HPAGE PageHandle;

IGR_LONG RC = IGR_Open_Stream(pStream, IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle, &Err);

if (RC == IGR_OK)

{

IGR_Bookmark Bookmarks, Child;

if (IGR_Get_Bookmark_Root(DocHandle, &Bookmarks, &Err) == IGR_OK

&& IGR_Get_Bookmark_First_Child(DocHandle, &Bookmarks, &Child, &Err) == IGR_OK)

{

// …

} while (IGR_Get_Bookmark_Next_Sibling(DocHandle, &Child, &Child, &Err)==IGR_OK);

}

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 189/1268 -

IGR_Get_Bookmark_Next_Sibling

IGR_Get_Bookmark_Next_Sibling returns the peer/sibling of the provided bookmark, or NULL if the

current item is the last in it’s chain.

PROTOTYPE

C/C++

PARAMETERS

DocHandle: IGR_LONG

Handle to a document, opened by a call to IGR_Open_File, IGR_Open_File_Ex, IGR_Open_Stream or

IGR_Open_Stream_Ex.

Source: Pointer to IGR_Bookmark

Pointer to an IGR_Bookmark returned from a previous call to IGR_Get_Bookmark_Root,

IGR_Get_Bookmark_First_Child, or IGR_Get_Bookmark_Next_Sibling.

Dest: Pointer to IGR_Bookmark

Pointer to a user-supplied IGR_Bookmark that will be populated enabling supplementary calls to

bookmark methods.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Get_Bookmark_Next_Sibling(

IGR_LONG DocHandle,

const IGR_Bookmark *Source,

IGR_Bookmark *Dest,

Error_Control_Block* Error);

Document Filters Implementation Guide 2.2.2 Functions

- 190/1268 -

SEE ALSO

IGR_Bookmark

IGR_Get_Bookmark_First_Child

Error_Control_Block Err;

IGR_LONG Capabilities, DocType, DocHandle, PageCount;

HPAGE PageHandle;

IGR_LONG RC = IGR_Open_Stream(pStream, IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle, &Err);

if (RC == IGR_OK)

{

IGR_Bookmark Bookmarks, Child;

if (IGR_Get_Bookmark_Root(DocHandle, &Bookmarks, &Err) == IGR_OK

&& IGR_Get_Bookmark_First_Child(DocHandle, &Bookmarks, &Child, &Err) == IGR_OK)

{

// …

} while (IGR_Get_Bookmark_Next_Sibling(DocHandle, &Child, &Child, &Err)==IGR_OK);

}

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 191/1268 -

IGR_Get_Bookmark_Root

IGR_Get_Bookmark_Root provides access to the top-level root node of the bookmark hierarchy.

PROTOTYPE

C/C++

PARAMETERS

DocHandle: IGR_LONG

Handle to a document, opened by a call to IGR_Open_File, IGR_Open_File_Ex, IGR_Open_Stream or

IGR_Open_Stream_Ex.

Dest: Pointer to IGR_Bookmark

Pointer to a user-supplied IGR_Bookmark that will be populated enabling supplementary calls to

bookmark methods.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Get_Bookmark_Root(

IGR_LONG DocHandle,

IGR_Bookmark *Dest,

Error_Control_Block* Error);

Error_Control_Block Err;

IGR_LONG Capabilities, DocType, DocHandle, PageCount;

HPAGE PageHandle;

IGR_LONG RC = IGR_Open_Stream(pStream, IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle, &Err);

if (RC == IGR_OK)

{

IGR_Bookmark Bookmarks, Child;

Document Filters Implementation Guide 2.2.2 Functions

- 192/1268 -

SEE ALSO

IGR_Bookmark

IGR_Get_Bookmark_First_Child

IGR_Get_Bookmark_Next_Sibling

if (IGR_Get_Bookmark_Root(DocHandle, &Bookmarks, &Err) == IGR_OK

&& IGR_Get_Bookmark_First_Child(DocHandle, &Bookmarks, &Child, &Err) == IGR_OK)

{

// …

} while (IGR_Get_Bookmark_Next_Sibling(DocHandle, &Child, &Child, &Err)==IGR_OK);

}

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 193/1268 -

IGR_Get_File_Type

IGR_Get_File_Type gets the type and the capabilities of a given document.

PROTOTYPE

C/C++

PARAMETERS

FileName: Unicode string (UCS2)

Path to the document to be opened.

Capabilities: Pointer to IGR_LONG

Returns the Document Capabilities as a bit eld.

DocType: Pointer to IGR_LONG

Returns the Document Format Code of the document.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Get_File_Type(

const IGR_UCS2* FileName,

IGR_LONG* Capabilities,

IGR_LONG* DocType,

Error_Control_Block* ISYSError);

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType;

IGR_LONG rc = IGR_Get_File_Type(_UCS2("TEST.TXT"), &Capabilities, &DocType, &ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 194/1268 -

ADDITIONAL INFORMATION

If the document has the IGR_FILE_SUPPORTS_TEXT capability, text may be directly extracted from the

document by calling IGR_Get_Text (e.g. a Word document).

If the document has the IGR_FILE_SUPPORTS_SUBFILES capability, then it is a container for other

documents and it is valid to enumerate and/or extract its sub-documents.

It is valid for a document to have both capabilities (for example email message documents have their

own text and also can have attached documents).

Document Filters also has the ability to identify certain document formats, without being able to extract

content. In this situation, the capabilities will be returned as 0. See Document Format Codes for a list of

these formats on page .

The compound documents can include other compound documents, for example an MSG with a ZIP

attachment, which contains ZIPs and MSGs. The calling application can navigate as far down as needed.

Document Filters Implementation Guide 2.2.2 Functions

- 195/1268 -

IGR_Get_Format_Attribute

IGR_Get_Format_Attribute returns information about the supported le type.

PROTOTYPE

C/C++

PARAMETERS

formatid: Integer

The format id, as returned by IGR_Get_File_Type.

what: Integer

Indicates the information to return, can be one of:

buffer: Pointer to an Ansi string

The buer must be at least 255 bytes, it will be populated based on the value of ‘what’.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

IGR_LONG IGR_Get_Format_Attribute(

int formatid,

int what,

char* buffer,

Error_Control_Block* error);;

Value Description

0 copy the long form of the format name

1 copy the short form of the format name

2 copy the cong le form of the format name (as it would appear in an

Enterprise Search cong le)

3 copy the class of the format

4 indicate if the format is a legacy format

5 default MIME type for le format

6 string representation of the IGR_FILETYPE_CATEGORY

Document Filters Implementation Guide 2.2.2 Functions

- 196/1268 -

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SEE ALSO

IGR_FILETYPE_CATEGORY•

Document Filters Implementation Guide 2.2.2 Functions

- 197/1268 -

IGR_Get_Handle_File_Type

IGR_Get_Handle_File_Type gets the type and the capabilities of an open document.

PROTOTYPE

C/C++

PARAMETERS

handle: IGR_HDOC

Handle to an open document.

capabilities: Pointer to IGR_LONG

Returns the Document Capabilities as a bit eld.

filetype: Pointer to IGR_LONG

Returns the Document Format Code of the document.

error: Pointer to Error_Control_Block

Contains any error text.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SEE ALSO

IGR_Get_Page_Handle_File_Type

Document Format Codes

Document Capability Codes

IGR_RETURN_CODE IGR_Get_Handle_File_Type(

IGR_HDOC handle,

IGR_LONG* capabilities,

IGR_LONG* filetype,

Error_Control_Block* error

)

•

Document Filters Implementation Guide 2.2.2 Functions

- 198/1268 -

IGR_Get_Image_Entry

IGR_Get_Image_Entry enumerates the set of images, when HTML or Image conversion is in aect.

PROTOTYPE

C/C++

PARAMETERS

DocHandle: IGR_LONG

Is a handle to a le, opened by a call to IGR_Open_File.

ID: Unicode string (UCS2)

Application allocated memory block of 8192 bytes that will be lled with up to 4096 Unicode characters

that specify the unique ID of the next sub-document.

Name: Unicode string (UCS2)

Application allocated memory block of 2048 bytes that will be lled with up to 1024 Unicode characters

that specify the name of the sub-document.

FileDate: Pointer to INT64

Returns the date and time of the sub-document in FILETIME format.

FileSize: Pointer to INT64

Returns the size in bytes of the sub-document.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

IGR_LONG IGR_Get_Image_Entry(

IGR_LONG DocHandle,

IGR_UCS2* ID,

IGR_UCS2* Name,

LONGLONG* FileDate,

LONGLONG* FileSize,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 199/1268 -

Success and the end of the document was reached: IGR_LONG

Returns IGR_NO_MORE.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

ADDITIONAL INFORMATION

The previously opened document must have the IGR_FILE_SUPPORTS_HDHTML capability.

After a successful call to IGR_Open_File / Stream, each call to IGR_Get_Image_Entry will retrieve

information about the images contained in the document, referenced by DocHandle. To traverse all the

images, the application will need to call this method in a loop until IGR_NO_MORE is returned.

Note that the null-terminating character will also be copied to the ID and Name parameters. If the

function succeeds, the ID is guaranteed not to be empty and will be unique among all traversed images

retrieved from the document. The returned ID can be used in a call to IGR_Extract_Image to save the

binary content of the image to disk.

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle;

IGR_UCS2 ID[4096], Name[1024];

INT64 FileDate, FileSize;

IGR_LONG RC = IGR_Open_File_Ex(_UCS2("TEST.DOC"), IGR_BODY_AND_META | IGR_FORMAT_HTML, _UCS2(""),

&Capabilities, &DocType, &DocHandle, &ISYSError);

if (RC == IGR_OK)

{

// Extract document HTML via IGR_Get_Text first, then...

while (true)

{

rc = IGR_Get_Image_Entry(DocHandle, ID, Name, &FileDate, &FileSize, &ISYSError);

if (rc != IGR_OK)

{

if (rc != IGR_NO_MORE)

// ReportError(rc);

break;

}

rc = IGR_Extract_Image(DocHandle, ID, ID, &ISYSError);

if (rc != IGR_OK)

// ReportError(rc);

}

IGR_Close_File(DocHandle, &ISYSError);

}

Document Filters Implementation Guide 2.2.2 Functions

- 200/1268 -

IGR_Get_Images_Enumerator

IGR_Get_Images_Enumerator returns a new enumerator for the set of images, when HTML conversion is

in eect as set by the Open Document Flags, contained in a previously opened document

PROTOTYPE

C/C++

PARAMETERS

docHandle: IGR_LONG

Handle to a document, opened by a call to IGR_Open_File, IGR_Open_Stream, IGR_Open_File_Ex or

IGR_Open_Stream_Ex.

enumerator: Pointer to HSUBFILES

Populated with handle to new enumerator, which can be passed to the enumeration functions.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_RETURN_CODE IGR_Get_Images_Enumerator(

IGR_LONG docHandle,

HSUBFILES* enumerator,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 201/1268 -

IGR_Get_Memory_Status

IGR_Get_Memory_Status is a Windows-only memory diagnostic.

PROTOTYPE

C/C++

PARAMETERS

buffer: Pointer to char

Pointer to a buer that will be populated with process memory details.

len: size_t

The size of the buer.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

size_t IGR_Get_Memory_Status(

char* buffer,

size_t len

)

Document Filters Implementation Guide 2.2.2 Functions

- 202/1268 -

IGR_Get_Option_Attribute

IGR_Get_Option_Attribute returns information about each published option value.

PROTOTYPE

C/C++

PARAMETERS

option_index: Integer

0-based index of the option to fetch.

what: Integer

Indicates the information to return, can be one of:

buffer: Pointer to an Ansi string

The buer that will be populated based on the value of ‘what’.

bufferSize: Size_t

The size of the provided buer

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

IGR_LONG IGR_Get_Option_Attribute(

int option_index,

int what,

char* buffer,

Error_Control_Block* error);;

Value Description

0 copy the display name of the option

1 copy the English description. Localized versions are not available.

2 copy the default value

3 copy the option ags

Document Filters Implementation Guide 2.2.2 Functions

- 203/1268 -

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

Document Filters Implementation Guide 2.2.2 Functions

- 204/1268 -

IGR_Get_Page_Annotation_Count

IGR_Get_Page_Annotation_Count returns the number of annotations that are contained on the page. For

Oce documents, comments are extracted and included in the annotation count. For comments

spanning multiple pages, the OFFICE_COMMENT_PAGE open document option determines if the rst, last

or all pages containing the comments should return an annotation.

PROTOTYPE

C/C++

PARAMETERS

Page: Handle to Page

The handle to a page that was opened using IGR_Open_Page.

Count: Pointer to IGR_LONG

Returns the number of annotations on the page on success.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Get_Page_Annotation_Count (

HPAGE Page,

IGR_LONG* Count,

Error_Control_Block* Error);

Error_Control_Block Error;

IGR_LONG Capabilities, DocType, DocHandle, PageHandle;

IGR_LONG RC = IGR_Open_File(_UCS2("TEST.DOC"), IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle,

&Error);

Document Filters Implementation Guide 2.2.2 Functions

- 205/1268 -

SEE ALSO

IGR_Annotation

IGR_Get_Page_Annotations

IGR_Get_Page_Annotation_Long

IGR_Get_Page_Annotation_Str

if (RC == IGR_OK)

{

IGR_LONG PageCount;

if (IGR_Get_Page_Count(DocHandle, &PageCount, &Error) == IGR_OK)

{

for (IGR_LONG i = 0; i < PageCount; i++)

{

if (IGR_Open_Page(DocHandle, i, &PageHandle, &Error) == IGR_OK)

{

IGR_LONG AnnotationCount = 0;

IGR_Get_Page_Annotation_Count(PageHandle, &AnnotationCount, &Error);

for (IGR_LONG j = 0; j < AnnotationCount; j++)

{

IGR_LONG read = 1;

IGR_Annotation annotation;

if (IGR_Get_Page_Annotations(PageHandle, j, &read, &annotation,

&Error) == IGR_OK)

{

// ….

}

IGR_Close_Page(PageHandle, &Error);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 206/1268 -

IGR_Get_Page_Annotation_Long

IGR_Get_Page_Annotation_Long copies an integer value from a given property of an existing annotation

into the user supplied buer.

Path is a JSON string adhering to the Annotation schema that can be found in the Document Filters

installation directory in “Annotation-Schema.json”; additionally, adding “.length” to the path of any given

property that is an Array will return the number of elements in the Array.

PROTOTYPE

C/C++

PARAMETERS

Item: Pointer to IGR_Annotation

Pointer to a annotation returned by a call to IGR_Get_Page_Annotations.

Path: Pointer to IGR_UCS2

JSON string specifying the annotation property to be extracted, following the schema dened in

“Annotation-Schema.json” in the Document Filters installation directory; adding “.length” to the path of

any given property that is an Array will return the number of elements in the Array.

Buffer: Pointer to IGR_LONG

Returns the integer value of the property specied by Path for the given Item.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Get_Page_Annotation_Long (

const struct IGR_Annotation* Item,

const IGR_UCS2* Path,

IGR_LONG* Buffer,

Error_Control_Block* Error);

Document Filters Implementation Guide 2.2.2 Functions

- 207/1268 -

SAMPLE CODE

C/C++

SEE ALSO

IGR_Annotation

IGR_Get_Page_Annotations

IGR_Get_Page_Annotation_Count

IGR_Get_Page_Annotation_Str

Error_Control_Block Error;

IGR_LONG Capabilities, DocType, DocHandle, PageHandle;

IGR_LONG RC = IGR_Open_File(_UCS2("TEST.DOC"), IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle,

&Error);

if (RC == IGR_OK)

{

IGR_LONG PageCount;

if (IGR_Get_Page_Count(DocHandle, &PageCount, &Error) == IGR_OK)

{

for (IGR_LONG i = 0; i < PageCount; i++)

{

if (IGR_Open_Page(DocHandle, i, &PageHandle, &Error) == IGR_OK)

{

IGR_LONG AnnotationCount = 0;

IGR_Get_Page_Annotation_Count(PageHandle, &AnnotationCount, &Error);

for (IGR_LONG j = 0; j < AnnotationCount; j++)

{

IGR_LONG read = 1;

IGR_Annotation annotation;

if (IGR_Get_Page_Annotations(PageHandle, j, &read, &annotation,

&Error) == IGR_OK)

{

IGR_LONG value;

IGR_Get_Page_Annotation_Long(&annotation,

_UCS2("rect.left"),

&value,

&Error);

}

IGR_Close_Page(PageHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 208/1268 -

IGR_Get_Page_Annotation_Str

IGR_Get_Page_Annotation_Str copies a string value from a given property of an existing annotation into

the user supplied buer.

Path is a JSON string adhering to the Annotation schema that can be found in the Document Filters

installation directory in “Annotation-Schema.json”; additionally, adding “.length” to the path of any given

property that is an Array will return the number of elements in the Array.

PROTOTYPE

C/C++

PARAMETERS

Item: Pointer to IGR_Annotation

Pointer to a annotation returned by a call to IGR_Get_Page_Annotations.

Path: Pointer to IGR_UCS2

JSON string specifying the annotation property to be extracted, following the schema dened in

“Annotation-Schema.json” in the Document Filters installation directory; adding “.length” to the path of

any given property that is an Array will return the number of elements in the Array.

CharCount: Pointer to IGR_LONG

Prior to the call: The size in Unicode (UCS2) characters of the buer.

After the call: The actual number of Unicode (UCS2) characters extracted.

Buffer: Pointer to IGR_UCS2

Returns the string value of the property specied by Path for the given Item.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

IGR_LONG IGR_Get_Page_Annotation_Str (

const struct IGR_Annotation* Item,

const IGR_UCS2* Path,

IGR_LONG* CharCount,

IGR_UCS2* Buffer,

Error_Control_Block* Error);

Document Filters Implementation Guide 2.2.2 Functions

- 209/1268 -

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

Error_Control_Block Error;

IGR_LONG Capabilities, DocType, DocHandle, PageHandle;

IGR_LONG RC = IGR_Open_File(_UCS2("TEST.DOC"), IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle,

&Error);

if (RC == IGR_OK)

{

IGR_LONG PageCount;

if (IGR_Get_Page_Count(DocHandle, &PageCount, &Error) == IGR_OK)

{

for (IGR_LONG i = 0; i < PageCount; i++)

{

if (IGR_Open_Page(DocHandle, i, &PageHandle, &Error) == IGR_OK)

{

IGR_LONG AnnotationCount = 0;

IGR_Get_Page_Annotation_Count(PageHandle, &AnnotationCount, &Error);

for (IGR_LONG j = 0; j < AnnotationCount; j++)

{

IGR_LONG read = 1;

IGR_Annotation annotation;

if (IGR_Get_Page_Annotations(PageHandle, j, &read, &annotation,

&Error) == IGR_OK)

{

IGR_LONG charCount = 255;

IGR_UCS2 value[charCount];

IGR_Get_Page_Annotation_Str(&annotation,

_UCS2("title"),

&charCount,

&value[0],

&Error);

}

IGR_Close_Page(PageHandle, &ISYSError);

}

Document Filters Implementation Guide 2.2.2 Functions

- 210/1268 -

SEE ALSO

IGR_Annotation

IGR_Get_Page_Annotations

IGR_Get_Page_Annotation_Count

IGR_Get_Page_Annotation_Long

•

Document Filters Implementation Guide 2.2.2 Functions

- 211/1268 -

IGR_Get_Page_Annotations

IGR_Get_Page_Annotations copies references of page annotations into the user supplied array. The caller

can iterate over all the page annotations by incrementing the Index parameter. For Oce documents,

comments will be extracted and returned in the page annotations array. For comments spanning multiple

pages, the OFFICE_COMMENT_PAGE open document option determines if the rst, last or all pages

containing the comments should return an annotation.

PROTOTYPE

C/C++

PARAMETERS

PageHandle: HPAGE

Handle to a page, opened by a call to IGR_Open_File.

Index: IGR_LONG

Oset of the rst form element to return, 0 based.

Count: Pointer to IGR_LONG

Prior to the call: Set to the number of IGR_Annotation structures pointed to by the Items buer.

After the call: Returns the number of items copied into the Items buer.

Items: Pointer to IGR_Annotation

Pointer to a user allocated array of IGR_Annotation structures to be lled.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

IGR_LONG IGR_Get_Page_Annotations (

HPAGE Page,

IGR_LONG Index,

IGR_LONG* Count,

IGR_Annotation* Items,

Error_Control_Block* Error);

Document Filters Implementation Guide 2.2.2 Functions

- 212/1268 -

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

SEE ALSO

Annotation interface

IGR_Annotation

IGR_Get_Page_Annotation_Count

IGR_Get_Page_Annotation_Long

IGR_Get_Page_Annotation_Str

Error_Control_Block Error;

IGR_LONG Capabilities, DocType, DocHandle, PageHandle;

IGR_LONG RC = IGR_Open_File(_UCS2("TEST.DOC"), IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle,

&Error);

if (RC == IGR_OK)

{

IGR_LONG PageCount;

if (IGR_Get_Page_Count(DocHandle, &PageCount, &Error) == IGR_OK)

{

for (IGR_LONG i = 0; i < PageCount; i++)

{

if (IGR_Open_Page(DocHandle, i, &PageHandle, &Error) == IGR_OK)

{

IGR_LONG AnnotationCount = 0;

IGR_Get_Page_Annotation_Count(PageHandle, &AnnotationCount, &Error);

for (IGR_LONG j = 0; j < AnnotationCount; j++)

{

IGR_LONG read = 1;

IGR_Annotation annotation;

if (IGR_Get_Page_Annotations(PageHandle, j, &read, &annotation,

&Error) == IGR_OK)

{

// ….

}

IGR_Close_Page(PageHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 213/1268 -

IGR_Get_Page_Attribute

IGR_Get_Page_Attribute returns style or properties of an open page; see <page> under Structured XML

for a full list of options.

PROTOTYPE

C/C++

PARAMETERS

Page: Handle to Page

The handle to a page that was opened using IGR_Open_Page.

Name: Unicode string (UCS2)

The name of the attribute to be extracted, see <page> under Structured XML for a full list of options.

Buffer: Unicode string (UCS2)

Application allocated memory block that will be lled with the next portion of text.

BufferSize: Pointer to IGR_LONG

Prior to the call: The size in Unicode (UCS2) characters of the buer.

After the call: The actual number of Unicode (UCS2) characters extracted.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Get_Page_Attribute(

HPAGE Page,

const IGR_UCS2* Name,

IGR_UCS2* Buffer,

IGR_LONG* BufferSize,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 214/1268 -

SAMPLE CODE

C/C++

SEE ALSO

Page::GetAttribute method

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle, PageHandle;

IGR_LONG RC = IGR_Open_File(_UCS2("TEST.DOC"), IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle,

&ISYSError);

if (RC == IGR_OK)

{

IGR_LONG PageCount;

if (IGR_Get_Page_Count(DocHandle, &PageCount, &ISYSError) == IGR_OK)

{

for (IGR_LONG I = i; i <= PageCount; i++)

{

if (IGR_Open_Page(DocHandle, i, &PageHandle, &ISYSError) == IGR_OK)

{

IGR_UCS2 Buffer[255];

IGR_LONG BufferSize = 254;

if (IGR_Get_Page_Attribute(PageHandle, _UCS2("SourceDpiX"), Buffer,

BufferSize, &ISYSError) == IGR_OK)

{

// - Buffer contains the value for SourceDpiX

}

IGR_Close_Page(PageHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 215/1268 -

IGR_Get_Page_Count

IGR_Get_Page_Count returns the number of pages generated for an open document. This method only

works on functions opened with IGR_FORMAT_IMAGE.

PROTOTYPE

C/C++

PARAMETERS

DocHandle: Unicode string (UCS2)

Handle to a document, opened by a call to IGR_Open_File, IGR_Open_File_Ex, IGR_Open_Stream or

IGR_Open_Stream_Ex.

PageCount: Pointer to IGR_LONG

Set to the number of pages contained within the document.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Get_Page_Count(

IGR_LONG DocHandle,

IGR_LONG* PageCount,

Error_Control_Block* Error);

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle, PageCount;

HPAGE PageHandle;

IGR_LONG RC = IGR_Open_Stream(pStream, IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle, &ISYSError);

if (RC == IGR_OK)

{

if (IGR_Get_Page_Count(DocHandle, &PageCount, &ISYSError) == IGR_OK)

Document Filters Implementation Guide 2.2.2 Functions

- 216/1268 -

SEE ALSO

IGR_Open_Page

{

for (IGR_LONG PageIndex = 0; PageIndex < PageCount; PageIndex++)

{

if (IGR_Open_Page(DocHandle, PageIndex, &PageHandle, &ISYSError) == IGR_OK)

{

// Process Page Element

IGR_Close_Page(PageHandle, &ISYSError);

}

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 217/1268 -

IGR_Get_Page_Dimensions

IGR_Get_Page_Dimensions returns the size of the given page in pixels.

PROTOTYPE

C/C++

PARAMETERS

PageHandle: HPAGE

Handle to a page, opened by a call to IGR_Open_Page.

Width: Pointer to IGR_LONG

Returns the width of the page in pixels.

Height: Pointer to IGR_LONG

Returns the height of the page in pixels.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Get_Page_Dimensions(

HPAGE pageHandle,

IGR_LONG* width,

IGR_LONG* height,

Error_Control_Block* error);

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle, PageCount, WordCount;

HPAGE PageHandle;

IGR_LONG RC = IGR_Open_Stream(pStream, IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle, &ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 218/1268 -

if (RC == IGR_OK)

{

if (IGR_Get_Page_Count(DocHandle, &PageCount, &ISYSError) == IGR_OK)

{

for (IGR_LONG PageIndex = 0; PageIndex < PageCount; PageIndex++)

{

if (IGR_Open_Page(DocHandle, PageIndex, &PageHandle, &ISYSError) == IGR_OK)

{

IGR_LONG Width(0), Height(0);

IGR_Get_Page_Dimensions(PageHandle, &Width, &Height, &ISYSError);

}

IGR_Close_File(DocHandle, &ISYSError);

}

Document Filters Implementation Guide 2.2.2 Functions

- 219/1268 -

IGR_Get_Page_Element_First_Child

IGR_Get_Page_Element_First_Child lls dest with the rst child of the parent element.

PROTOTYPE

C/C++

PARAMETERS

page: IGR_HPAGE

Page element containing the page elements to extract.

parent: Pointer to IGR_Page_Element

Optional parent element from which the children elements are to be extracted.

dest: Pointer to IGR_Page_Element

Pointer an IGR_Page_Element. On input, the elements struct_size must be set. On output, the struct is

lled with element data.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_RETURN_CODE IGR_Get_Page_Element_First_Child(

IGR_HPAGE page,

const struct IGR_Page_Element* parent,

struct IGR_Page_Element* dest,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 220/1268 -

IGR_Get_Page_Element_Next_Sibling

IGR_Get_Page_Element_Next_Sibling lls dest with the next sibling node of element element.

PROTOTYPE

C/C++

PARAMETERS

page: IGR_HPAGE

Page element containing the page elements to extract.

element: Pointer to IGR_Page_Element

The element of the element where the sibling should be extracted.

dest: Pointer to IGR_Page_Element

Pointer an IGR_Page_Element. On input, the elements struct_size must be set. On output, the struct is

lled with element data.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_RETURN_CODE IGR_Get_Page_Element_Next_Sibling(

IGR_HPAGE page,

const struct IGR_Page_Element* element,

struct IGR_Page_Element* dest,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 221/1268 -

IGR_Get_Page_Element_Root

IGR_Get_Page_Element_Root lls {dest} with the root element of the page.

PROTOTYPE

C/C++

PARAMETERS

page: IGR_HPAGE

Page element containing the page elements to extract.

dest: Pointer to IGR_Page_Element

Pointer an IGR_Page_Element. On input, the elements struct_size must be set. On output, the struct is

lled with element data.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_RETURN_CODE IGR_Get_Page_Element_Root(

IGR_HPAGE page,

struct IGR_Page_Element* dest,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 222/1268 -

IGR_Get_Page_Element_Style

IGR_Get_Page_Element_Style returns the named style value from the page element.

PROTOTYPE

C/C++

PARAMETERS

page: IGR_HPAGE

Page element containing the page elements to extract.

source: Pointer to IGR_Page_Element

The element of the element where the text should be extracted.

The name of the style to extractor.

char_count: Pointer to IGR_ULONG

On input, contains the number of elements in the {dest} array. On output, is set to the number of

elements copied.

buffer: Pointer to IGR_UCS2

Pointer an IGR_UCS2 array.

error: Pointer to Error_Control_Block

Contains any error text.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

IGR_RETURN_CODE IGR_Get_Page_Element_Style(

IGR_HPAGE page,

const struct IGR_Page_Element* source,

const IGR_UCS2* name,

IGR_ULONG* char_count,

IGR_UCS2* buffer,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 223/1268 -

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SEE ALSO

IGR_Get_Page_Element_Styles•

Document Filters Implementation Guide 2.2.2 Functions

- 224/1268 -

IGR_Get_Page_Element_Styles

IGR_Get_Page_Element_Styles calls the callback with each style for the given source element.

PROTOTYPE

C/C++

PARAMETERS

page: IGR_HPAGE

Page element containing the page elements to extract.

source: Pointer to IGR_Page_Element

The element of the element where the styles should be extracted.

callback: IGR_PAGE_ELEMENT_STYLES_CALLBACK

User supplied callback where the style information is to be sent.

context: Pointer to void

User supplied callback context to pass when calling {callback}.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_RETURN_CODE IGR_Get_Page_Element_Styles(

IGR_HPAGE page,

const struct IGR_Page_Element* source,

IGR_PAGE_ELEMENT_STYLES_CALLBACK callback,

void* context,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 225/1268 -

IGR_Get_Page_Element_Text

IGR_Get_Page_Element_Text returns any text associated with the page element.

PROTOTYPE

C/C++

PARAMETERS

page: IGR_HPAGE

Page element containing the page elements to extract.

source: Pointer to IGR_Page_Element

The element of the element where the text should be extracted.

char_count: Pointer to IGR_ULONG

On input, contains the number of elements in the {dest} array. On output, is set to the number of

elements copied.

buffer: Pointer to IGR_UCS2

Pointer an IGR_UCS2 array.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SEE ALSO

IGR_RETURN_CODE IGR_Get_Page_Element_Text(

IGR_HPAGE page,

const struct IGR_Page_Element* source,

IGR_ULONG* char_count,

IGR_UCS2* buffer,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 226/1268 -

IGR_Get_Page_Elements

IGR_Get_Page_Elements lls the dest buer with dest_count page elements from the parent object,

starting from the first index. If parent is NULL, the root element is copied into dest .

PROTOTYPE

C/C++

PARAMETERS

page: HPAGE

Handle to a page, opened by a call to IGR_Open_Page.

parent: *IGR_Page_Element

Pointer to parent element, or NULL to retrieve elements for the root of the page.

first: IGR_ULONG

Index of rst element to extract.

dest_count: *IGR_ULONG

Must set to size of dest array when calling. Will be set to number of elements populated on return.

dest: *IGR_Page_Element

Pointer to dest_count array of IGR_Page_Element . On input, the rst elements struct_size must be

set. On output, the structures are lled with element data.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

IGR_RETURN_CODE IGR_Get_Page_Elements(

IGR_HPAGE page,

const struct IGR_Page_Element* parent,

IGR_ULONG first,

IGR_ULONG* dest_count,

struct IGR_Page_Element* dest,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 227/1268 -

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SEE ALSO

IGR_Page_Element Struct

IGR_PAGE_ELEMENT_TYPE

•

Document Filters Implementation Guide 2.2.2 Functions

- 228/1268 -

IGR_Get_Page_Form_Element_Count

IGR_Get_Page_Form_Element_Count returns the number of form elements that are contained on the

page.

PROTOTYPE

C/C++

PARAMETERS

Page: Handle to Page

The handle to a page that was opened using IGR_Open_Page.

Count: Pointer to IGR_LONG

Returns the number of form elements on the page on success.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Get_Page_Form_Element_Count (

HPAGE Page,

IGR_LONG* Count,

Error_Control_Block* ISYSError);

Error_Control_Block Error;

IGR_LONG Capabilities, DocType, DocHandle, PageHandle;

IGR_LONG RC = IGR_Open_File(_UCS2("TEST.DOC"), IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle,

&ISYSError);

if (RC == IGR_OK)

{

IGR_LONG PageCount;

Document Filters Implementation Guide 2.2.2 Functions

- 229/1268 -

SEE ALSO

FormElement interface

IGR_Get_Page_Form_Elements

IGR_Get_Page_Form_Element_Option_Str

IGR_Get_Page_Form_Element_Str

if (IGR_Get_Page_Count(DocHandle, &PageCount, &Error) == IGR_OK)

{

for (IGR_LONG i = 0; i < PageCount; i++)

{

if (IGR_Open_Page(DocHandle, i, &PageHandle, &Error) == IGR_OK)

{

IGR_LONG ElementCount = 0;

IGR_Get_Page_Form_Element_Count(PageHandle, &ElementCount, &Error);

for (IGR_LONG j = 0; j < ElementCount; j++)

{

IGR_LONG read = 1;

IGR_Page_Form_Element FormElement;

if (IGR_Get_Page_Form_Elements(PageHandle, j, &read, &FormElement,

&Error) == IGR_OK)

{

// ….

}

IGR_Close_Page(PageHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 230/1268 -

IGR_Get_Page_Form_Element_Option_Str

IGR_Get_Page_Form_Element_Option_Str copies string information from an existing form element’s

option into the user supplied buer.

PROTOTYPE

C/C++

PARAMETERS

Item: Pointer to IGR_Page_Form_Element

Pointer to a form element returned by a call to IHandle to a page, opened by a call to

IGR_Get_Page_Form_Elements.

ValueType: IGR_LONG

Indicates the type of value being requested, can be one of the following:

OptionIndex: IGR_LONG

Indicates the 0-based option the value is being request for.

CharCount: IGR_LONG

Set to the number of characters pointed to by Buer.

Items: Pointer to IGR_UCS2

Pointer to a user allocated array of IGR_UCS2 to be lled.

IGR_LONG IGR_Get_Page_Form_Element_Option_Str(

const struct IGR_Page_Form_Element* Item,

IGR_LONG ValueType,

IGR_LONG OptionIndex,

IGR_LONG CharCount,

IGR_UCS2* Buffer,

Error_Control_Block* ISYSError);

Name Value

IGR_PAGE_FORM_ELEMENT_GET_NAME 0

IGR_PAGE_FORM_ELEMENT_GET_VALUE 1

IGR_PAGE_FORM_ELEMENT_GET_SELECTED 5

Document Filters Implementation Guide 2.2.2 Functions

- 231/1268 -

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

Error_Control_Block Error;

IGR_LONG Capabilities, DocType, DocHandle, PageHandle;

IGR_LONG RC = IGR_Open_File(_UCS2("TEST.DOC"), IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle,

&ISYSError);

if (RC == IGR_OK)

{

IGR_LONG PageCount;

if (IGR_Get_Page_Count(DocHandle, &PageCount, &Error) == IGR_OK)

{

for (IGR_LONG i = 0; i < PageCount; i++)

{

if (IGR_Open_Page(DocHandle, i, &PageHandle, &Error) == IGR_OK)

{

IGR_LONG ElementCount = 0;

IGR_Get_Page_Form_Element_Count(PageHandle, &ElementCount, &Error);

for (IGR_LONG j = 0; j < ElementCount; j++)

{

IGR_LONG read = 1;

IGR_Page_Form_Element FormElement;

if (IGR_Get_Page_Form_Elements(PageHandle, j, &read, &FormElement,

&Error) == IGR_OK)

{

const IGR_LONG valueSize = 255;

IGR_UCS2 value[valueSize];

IGR_Get_Page_Form_Element_Str(&FormElement,

IGR_PAGE_FORM_ELEMENT_GET_VALUE,

valueSize,

&value[0],

&Error);

}

IGR_Close_Page(PageHandle, &ISYSError);

}

Document Filters Implementation Guide 2.2.2 Functions

- 232/1268 -

SEE ALSO

IGR_Get_Page_Form_Elements

IGR_Get_Page_Form_Element_Count

IGR_Get_Page_Form_Element_Str

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 233/1268 -

IGR_Get_Page_Form_Element_Str

IGR_Get_Page_Form_Element_Str copies string information from an existing form element into the user

supplied buer.

PROTOTYPE

C/C++

PARAMETERS

Item: Pointer to IGR_Page_Form_Element

Pointer to a form element returned by a call to IHandle to a page, opened by a call to

IGR_Get_Page_Form_Elements.

ValueType: IGR_LONG

Indicates the type of value being requested, can be one of the following:

CharCount: IGR_LONG

Set to the number of characters pointed to by Buer.

Buffer: Pointer to IGR_UCS2

IGR_LONG IGR_Get_Page_Form_Element_Str (

const struct IGR_Page_Form_Element* Item,

IGR_LONG ValueType,

IGR_LONG CharCount,

IGR_UCS2* Buffer,

Error_Control_Block* ISYSError);

Name Value

IGR_PAGE_FORM_ELEMENT_GET_NAME 0

IGR_PAGE_FORM_ELEMENT_GET_VALUE 1

IGR_PAGE_FORM_ELEMENT_GET_CAPTION 2

IGR_PAGE_FORM_ELEMENT_GET_ACTION 3

IGR_PAGE_FORM_ELEMENT_GET_ACTION_DEST 4

IGR_PAGE_FORM_ELEMENT_GET_SELECTED 5

IGR_PAGE_FORM_ELEMENT_GET_FONT_NAME 6

Document Filters Implementation Guide 2.2.2 Functions

- 234/1268 -

Pointer to a user allocated array of IGR_UCS2 to be lled.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

Error_Control_Block Error;

IGR_LONG Capabilities, DocType, DocHandle, PageHandle;

IGR_LONG RC = IGR_Open_File(_UCS2("TEST.DOC"), IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle,

&ISYSError);

if (RC == IGR_OK)

{

IGR_LONG PageCount;

if (IGR_Get_Page_Count(DocHandle, &PageCount, &Error) == IGR_OK)

{

for (IGR_LONG i = 0; i < PageCount; i++)

{

if (IGR_Open_Page(DocHandle, i, &PageHandle, &Error) == IGR_OK)

{

IGR_LONG ElementCount = 0;

IGR_Get_Page_Form_Element_Count(PageHandle, &ElementCount, &Error);

for (IGR_LONG j = 0; j < ElementCount; j++)

{

IGR_LONG read = 1;

IGR_Page_Form_Element FormElement;

if (IGR_Get_Page_Form_Elements(PageHandle, j, &read, &FormElement,

&Error) == IGR_OK)

{

const IGR_LONG valueSize = 255;

IGR_UCS2 value[valueSize];

IGR_Get_Page_Form_Element_Str(&FormElement,

IGR_PAGE_FORM_ELEMENT_GET_VALUE,

valueSize,

&value[0],

&Error);

}

Document Filters Implementation Guide 2.2.2 Functions

- 235/1268 -

SEE ALSO

IGR_Get_Page_Form_Elements

IGR_Get_Page_Form_Element_Count

IGR_Get_Page_Form_Element_Option_Str

IGR_Close_Page(PageHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 236/1268 -

IGR_Get_Page_Form_Elements

IGR_Get_Page_Form_Elements copies references of page form elements into the user supplied array. The

caller can iterate over all the page form elements by incrementing the Index parameter.

PROTOTYPE

C/C++

PARAMETERS

PageHandle: HPAGE

Handle to a page, opened by a call to IGR_Open_File.

Index: IGR_LONG

Oset of the rst form element to return, 0 based.

Count: Pointer to IGR_LONG

Prior to the call: Set to the number of IGR_Page_Form_Element structures pointed to by the Items buer.

After the call: Returns the number of items copied into the Items buer.

Items: Pointer to IGR_Page_Form_Element

Pointer to a user allocated array of IGR_Page_Form_Element structures to be lled.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Get_Page_Form_Elements (

HPAGE Page,

IGR_LONG Index,

IGR_LONG* Count,

IGR_Page_Form_Element* Items,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 237/1268 -

SAMPLE CODE

C/C++

SEE ALSO

FormElement interface

IGR_Page_Form_Element

IGR_Get_Page_Form_Element_Count

IGR_Get_Page_Form_Element_Option_Str

IGR_Get_Page_Form_Element_Str

Error_Control_Block Error;

IGR_LONG Capabilities, DocType, DocHandle, PageHandle;

IGR_LONG RC = IGR_Open_File(_UCS2("TEST.DOC"), IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle,

&ISYSError);

if (RC == IGR_OK)

{

IGR_LONG PageCount;

if (IGR_Get_Page_Count(DocHandle, &PageCount, &Error) == IGR_OK)

{

for (IGR_LONG i = 0; i < PageCount; i++)

{

if (IGR_Open_Page(DocHandle, i, &PageHandle, &Error) == IGR_OK)

{

IGR_LONG ElementCount = 0;

IGR_Get_Page_Form_Element_Count(PageHandle, &ElementCount, &Error);

for (IGR_LONG j = 0; j < ElementCount; j++)

{

IGR_LONG read = 1;

IGR_Page_Form_Element FormElement;

if (IGR_Get_Page_Form_Elements(PageHandle, j, &read, &FormElement,

&Error) == IGR_OK)

{

// ….

}

IGR_Close_Page(PageHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 238/1268 -

IGR_Get_Page_Handle_File_Type

IGR_Get_Page_Handle_File_Type gets the type and the capabilities of an open page.

PROTOTYPE

C/C++

PARAMETERS

handle: IGR_HPAGE

Handle to an open document.

capabilities: Pointer to IGR_LONG

Returns the Document Capabilities as a bit eld.

filetype: Pointer to IGR_LONG

Returns the Document Format Code of the document.

error: Pointer to Error_Control_Block

Contains any error text.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SEE ALSO

IGR_Get_Handle_File_Type

Document Format Codes

Document Capability Codes

IGR_RETURN_CODE IGR_Get_Page_Handle_File_Type(

IGR_HPAGE handle,

IGR_LONG* capabilities,

IGR_LONG* filetype,

Error_Control_Block* error

)

•

Document Filters Implementation Guide 2.2.2 Functions

- 239/1268 -

IGR_Get_Page_Hyperlink_Count

IGR_Get_Page_Hyperlink_Count returns the number of hyperlinks that are contained on the page.

PROTOTYPE

C/C++

PARAMETERS

Page: Handle to Page

The handle to a page that was opened using IGR_Open_Page.

Count: Pointer to IGR_LONG

Returns the number of hyperlinks on the page on success.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Get_Page_Hyperlink_Count (

HPAGE Page,

IGR_LONG* Count,

Error_Control_Block* ISYSError);

Error_Control_Block Error;

IGR_LONG Capabilities, DocType, DocHandle, PageHandle;

IGR_LONG RC = IGR_Open_File(_UCS2("TEST.DOC"), IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle,

&ISYSError);

if (RC == IGR_OK)

{

IGR_LONG PageCount;

if (IGR_Get_Page_Count(DocHandle, &PageCount, &Error) == IGR_OK)

{

Document Filters Implementation Guide 2.2.2 Functions

- 240/1268 -

SEE ALSO

IGR_Hyperlink

for (IGR_LONG i = 0; i < PageCount; i++)

{

if (IGR_Open_Page(DocHandle, i, &PageHandle, &Error) == IGR_OK)

{

IGR_LONG HyperlinkCount = 0;

IGR_Get_Page_Hyperlink_Count(PageHandle, &HyperlinkCount, &Error);

for (IGR_LONG j = 0; j < HyperlinkCount; j++)

{

IGR_LONG read = 1;

IGR_Hyperlink hyperlink;

if (IGR_Get_Page_Hyperlinks(PageHandle, j, &read, &hyperlink,

&Error) == IGR_OK)

{

// ….

}

IGR_Close_Page(PageHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 241/1268 -

IGR_Get_Page_Hyperlink_Str

IGR_Get_Page_Hyperlink_Str copies string information from an existing hyperlink into the user supplied

buer.

PROTOTYPE

C/C++

PARAMETERS

Item: Pointer to IGR_Hyperlink

Pointer to a hyperlink returned by a call to IGR_Get_Page_Hyperlinks.

ValueType: IGR_LONG

Indicates the type of value being requested, can be one of the following:

IGR_HYPERLINK_GET_VALUE_REF 0

IGR_HYPERLINK_GET_VALUE_URI 1

CharCount: IGR_LONG

Set to the number of characters pointed to by Buer.

Buffer: Pointer to IGR_UCS2

Pointer to a user allocated array of IGR_UCS2 to be lled.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

IGR_LONG IGR_Get_Page_Hyperlink_Str (

const struct IGR_Hyperlink* Item,

IGR_LONG ValueType,

IGR_LONG CharCount,

IGR_UCS2* Buffer,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 242/1268 -

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

SEE ALSO

IGR_Hyperlink

Error_Control_Block Error;

IGR_LONG Capabilities, DocType, DocHandle, PageHandle;

IGR_LONG RC = IGR_Open_File(_UCS2("TEST.DOC"), IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle,

&ISYSError);

if (RC == IGR_OK)

{

IGR_LONG PageCount;

if (IGR_Get_Page_Count(DocHandle, &PageCount, &Error) == IGR_OK)

{

for (IGR_LONG i = 0; i < PageCount; i++)

{

if (IGR_Open_Page(DocHandle, i, &PageHandle, &Error) == IGR_OK)

{

IGR_LONG HyperlinkCount = 0;

IGR_Get_Page_Form_Element_Count(PageHandle, &HyperlinkCount, &Error);

for (IGR_LONG j = 0; j < HyperlinkCount; j++)

{

IGR_LONG read = 1;

IGR_Hyperlink hyperlink;

if (IGR_Get_Page_Hyperlinks(PageHandle, j, &read, &hyperlink,

&Error) == IGR_OK)

{

const IGR_LONG valueSize = 255;

IGR_UCS2 value[valueSize];

IGR_Get_Page_Hyperlink_Str(&hyperlink,

IGR_HYPERLINK_GET_VALUE_URI,

valueSize,

&value[0],

&Error);

}

IGR_Close_Page(PageHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 243/1268 -

IGR_Get_Page_Hyperlinks

IGR_Get_Page_Hyperlinks copies references of page hyperlinks into the user supplied array. The caller

can iterate over all the page hyperlinks by incrementing the Index parameter.

PROTOTYPE

C/C++

PARAMETERS

PageHandle: HPAGE

Handle to a page, opened by a call to IGR_Open_File.

Index: IGR_LONG

Oset of the hyperlink to return, 0 based.

Count: Pointer to IGR_LONG

Prior to the call: Set to the number of IGR_Hyperlink structures pointed to by the Items buer.

After the call: Returns the number of items copied into the Items buer.

Items: Pointer to IGR_Hyperlink

Pointer to a user allocated array of IGR_Hyperlink structures to be lled.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Get_Page_Hyperlinks (

HPAGE Page,

IGR_LONG Index,

IGR_LONG* Count,

IGR_Hyperlink* Items,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 244/1268 -

SAMPLE CODE

C/C++

SEE ALSO

IGR_Hyperlink

Error_Control_Block Error;

IGR_LONG Capabilities, DocType, DocHandle, PageHandle;

IGR_LONG RC = IGR_Open_File(_UCS2("TEST.DOC"), IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle,

&ISYSError);

if (RC == IGR_OK)

{

IGR_LONG PageCount;

if (IGR_Get_Page_Count(DocHandle, &PageCount, &Error) == IGR_OK)

{

for (IGR_LONG i = 0; i < PageCount; i++)

{

if (IGR_Open_Page(DocHandle, i, &PageHandle, &Error) == IGR_OK)

{

IGR_LONG HyperlinkCount = 0;

IGR_Get_Page_Hyperlink_Count(PageHandle, &HyperlinkCount, &Error);

for (IGR_LONG j = 0; j < HyperlinkCount; j++)

{

IGR_LONG read = 1;

IGR_Hyperlink hyperlink;

if (IGR_Get_Page_Hyperlink(PageHandle, j, &read, &hyperlink,

&Error) == IGR_OK)

{

// ….

}

IGR_Close_Page(PageHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 245/1268 -

IGR_Get_Page_Image_Entry

IGR_Get_Page_Image_Entry enumerates the set of images on an open page.

PROTOTYPE

C/C++

PARAMETERS

pageHandle: HPAGE

Handle to a page, opened by a call to IGR_Open_File.

id: Pointer to IGR_UCS2

Application allocated memory block of 8192 bytes that will be lled with up to 4096 Unicode characters

that specify the unique ID of the next sub-document.

Application allocated memory block of 2048 bytes that will be lled with up to 1024 Unicode characters

that specify the name of the sub-document.

date: Pointer to IGR_LONGLONG

Returns the date and time of the sub-document in FILETIME format.

size: Pointer to IGR_LONGLONG

Returns the size in bytes of the sub-document.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

IGR_RETURN_CODE IGR_Get_Page_Image_Entry(

HPAGE pageHandle,

IGR_UCS2* id,

IGR_UCS2* name,

IGR_LONGLONG* date,

IGR_LONGLONG* size,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 246/1268 -

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

Document Filters Implementation Guide 2.2.2 Functions

- 247/1268 -

IGR_Get_Page_Images_Enumerator

IGR_Get_Page_Images_Enumerator creates a new enumerator for page images. Unlike

IGR_Get_Page_Image_Entry , it facilitates the creation of multiple enumerators, enabling the

reprocessing of images within an open page. Remember to free a suble enumerator by calling

IGR_Subfiles_Close once it is no longer needed.

PROTOTYPE

C/C++

PARAMETERS

docHandle: IGR_LONG

Is a handle to a le, opened by a call to IGR_Open_File , IGR_Open_Stream or equivalent.

enumerator: Pointer to HSUBFILES

Returns a handle to be used in subsequent enumerator calls.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_RETURN_CODE IGR_Get_Page_Images_Enumerator(

IGR_LONG docHandle,

HSUBFILES* enumerator,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 248/1268 -

IGR_Get_Page_Pixels

The IGR_Get_Page_Pixels method provides low-level access to a rectangular portion of the page and

provides a temporary buer that you can use to read the pixel data in a specied format.

The caller must call IGR_Free_Page_Pixels when done processing the pixel data.

PROTOTYPE

C/C++

PARAMETERS

pageHandle: HPAGE

Handle to a page opened by a call to IGR_Open_Page.

sourceRect: Pointer to IGR_Rect

Pointer to a rectangle that species the section of the page to copy.

May be NULL to copy the entire page.

destSize: Pointer to IGR_Size

Pointer to a size that species the requested output size for the copied pixels.

flags: IGR_LONG

A set of ags that indicate processing options.

IGR_GET_PAGE_PIXELS_BUFFER_ALLOCATED: indicates that (name) buer is preallocated by the caller

and should be lled.

options: Pointer to Unicode String

Extended processing options as name=value, semicolon separated.

pixel_format: IGR_OPEN_BITMAP_PIXEL_TYPE

IGR_LONG IGR_Get_Page_Pixels (

HPAGE pageHandle,

const struct IGR_Rect* sourceRect,

const struct IGR_Size* destSize,

IGR_ULONG flags,

const IGR_UCS2* options,

IGR_OPEN_BITMAP_PIXEL_TYPE pixel_format,

struct IGR_Page_Pixels* pixel_data,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 249/1268 -

Integer that species the format of the pixel data in the temporary buer. The pixel format of the

temporary buer does not have to be the same as the pixel format as the page.

pixel_data: Pointer to IGR_Page_Pixels

If IGR_GET_PAGE_PIXELS_BUFFER_ALLOCATED is not set, pixel_data serves only as an output parameter.

The scanline0 data member is set to a pointer to a temporary buer, which is lled with the requested

pixel data.

If IGR_GET_PAGE_PIXELS_BUFFER_ALLOCATED is set, the caller must initial the width, height, stride and

scanline0 members of the struct with the details of the pre-allocated buer.

error: Pointer to Error_Control_Block

Returns error details if the call fail.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SEE ALSO

IGR_Free_Page_Pixels

IGR_Page_Pixels

•

Document Filters Implementation Guide 2.2.2 Functions

- 250/1268 -

IGR_Get_Page_Text

IGR_Get_Page_Text extracts the text of a previously opened page of a document.

PROTOTYPE

C/C++

PARAMETERS

PageHandle: HPAGE

Handle to a page, opened by a call to IGR_Open_Page.

Buffer: Unicode string (UCS2)

Application allocated memory block that is to be populated with the next portion of text.

Size: Pointer to IGR_LONG

Prior to the call: The size in Unicode characters of the buer.

After the call: The actual number of Unicode characters extracted.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Success and the end of the document was reached: IGR_LONG

Returns IGR_NO_MORE.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Get_Page_Text(

HPAGE PageHandle,

IGR_UCS2* Buffer,

IGR_LONG* Size,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 251/1268 -

ADDITIONAL INFORMATION

IGR_Get_Page_Text operates on the same concept as IGR_Get_Text; the caller should keep calling

IGR_Get_Page_Text until it returns IGR_E_NO_MORE error.

SEE ALSO

IGR_Get_Text•

Document Filters Implementation Guide 2.2.2 Functions

- 252/1268 -

IGR_Get_Page_Word_Count

IGR_Get_Page_Word_Count returns the number of words of the given page.

PROTOTYPE

C/C++

PARAMETERS

PageHandle: HPAGE

Handle to a page, opened by a call to IGR_Open_File.

WordCount: Pointer to IGR_LONG

Returns the number of words on the page on success.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Get_Page_Word_Count(

HPAGE PageHandle,

IGR_LONG* WordCount,

Error_Control_Block* error);

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle, PageCount, WordCount;

HPAGE PageHandle;

IGR_LONG RC = IGR_Open_Stream(pStream, IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle, &ISYSError);

if (RC == IGR_OK)

{

if (IGR_Get_Page_Count(DocHandle, &PageCount, &ISYSError) == IGR_OK)

{

for (IGR_LONG PageIndex = 0; PageIndex < PageCount; PageIndex++)

{

Document Filters Implementation Guide 2.2.2 Functions

- 253/1268 -

SEE ALSO

IGR_Get_Page_Words

if (IGR_Open_Page(DocHandle, PageIndex, &PageHandle, &ISYSError) == IGR_OK)

{

// Process Page Element

IGR_Get_Page_Word_Count(PageHandle, &WordCount, &ISYSError);

IGR_Close_Page(PageHandle, &ISYSError);

}

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 254/1268 -

IGR_Get_Page_Words

IGR_Get_Page_Words copies references of page words into the user supplied array. The caller can iterate

over all the page words by incrementing the Index parameter.

PROTOTYPE

C/C++

PARAMETERS

PageHandle: HPAGE

Handle to a page, opened by a call to IGR_Open_File.

Index: IGR_LONG

Oset of the rst word to return, 0 based.

Count: Pointer to IGR_LONG

Prior to the call: Set to the number of Words structures pointed to by the Words buer.

After the call: Returns the number of Words copied into the Words buer.

Words: Pointer to IGR_Page_Word

Pointer to a user allocated array of IGR_Page_Word structures to be lled.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Get_Page_Words(

HPAGE PageHandle,

IGR_LONG Index,

IGR_LONG *Count,

IGR_Page_Word* Words,

Error_Control_Block* Error);

Document Filters Implementation Guide 2.2.2 Functions

- 255/1268 -

SAMPLE CODE

C/C++

SEE ALSO

IGR_Get_Page_Word_Count

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle, PageCount, WordCount;

HPAGE PageHandle;

IGR_LONG RC = IGR_Open_Stream(pStream, IGR_FORMAT_IMAGE, &Capabilities, &DocType,

&DocHandle, &ISYSError);

if (RC == IGR_OK)

{

if (IGR_Get_Page_Count(DocHandle, &PageCount, &ISYSError) == IGR_OK)

{

for (IGR_LONG PageIndex = 0; PageIndex < PageCount; PageIndex++)

{

if (IGR_Open_Page(DocHandle, PageIndex, &PageHandle, &ISYSError) == IGR_OK)

{

// Buffer to hold the word records

IGR_Page_Word words[255];

IGR_LONG WordIndex = 0;

IGR_LONG Count = sizeof(words) / sizeof(words[0]);

while (IGR_Get_Page_Words(PageHandle, Index, &Count, words,

ISYSError) == 0)

{

for (IGR_LONG i = 0; i < Count; i++)

{

// Process the word record

}

WordIndex += Count;

Count = sizeof(words) / sizeof(words[0]);

}

IGR_Close_Page(PageHandle, &ISYSError);

}

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 256/1268 -

IGR_Get_Stream_Type

IGR_Get_Stream_Type gets the type and the capabilities of a given stream object.

PROTOTYPE

C/C++

PARAMETERS

Stream: Pointer to an IGR_Stream

(an stream object)

The stream can be either user implemented, or created using the IGR_Make_Stream_From_File and

IGR_Make_Stream_From_Memory utility functions.

Capabilities: Pointer to IGR_LONG

Returns the Document Capabilities as a bit eld.

DocType: Pointer to IGR_LONG

Returns the Document Format Code of the document.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Get_Stream_Type(

IGR_Stream *Stream,

IGR_LONG* Capabilities,

IGR_LONG* DocType,

Error_Control_Block* ISYSError);

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType;

Document Filters Implementation Guide 2.2.2 Functions

- 257/1268 -

ADDITIONAL INFORMATION

If the document has the IGR_FILE_SUPPORTS_TEXT capability, text may be directly extracted from the

document by calling IGR_Get_Text (e.g. a Word document).

If the document has the IGR_FILE_SUPPORTS_SUBFILES capability, then it is a container for other

documents and it is valid to enumerate and/or extract it’s sub-documents.

It is valid for a document to have both capabilities (for example email message documents have their

own text and also can have attached documents).

Document Filters also has the ability to identify certain document formats, without being able to extract

content. In this situation, the capabilities will be returned as 0. See Document Format Codes for a list of

these formats on page .

Compound documents can include other compound documents, for example an MSG with a ZIP

attachment, which contain ZIPs and MSGs. The calling application can navigate as far down as needed.

IGR_LONG RC = IGR_Get_Stream_Type(pStream, &Capabilities, &DocType, &ISYSError);

if (RC == IGR_OK)

{

if (DocType == 25)

{

// Document is an MS Word document

}

Document Filters Implementation Guide 2.2.2 Functions

- 258/1268 -

IGR_Get_Subfile_Entry

IGR_Get_Suble_Entry enumerates the sub-documents contained in a previously opened compound

document, such as message documents (MSG) or archive documents (ZIP).

PROTOTYPE

C/C++

PARAMETERS

DocHandle: IGR_LONG

Is a handle to a le, opened by a call to IGR_Open_File , IGR_Open_Stream or equivalent.

ID: Unicode string (UCS2)

Application allocated memory block of 8192 bytes that will be lled with up to 4096 Unicode characters

that specify the unique ID of the next sub-document.

Name: Unicode string (UCS2)

Application allocated memory block of 2048 bytes that will be lled with up to 1024 Unicode characters

that specify the name of the sub-document.

FileDate: Pointer to INT64

Returns the date and time of the sub-document in FILETIME format.

FileSize: Pointer to INT64

Returns the size in bytes of the sub-document.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

IGR_LONG IGR_Get_Subfile_Entry(

IGR_LONG DocHandle,

IGR_UCS2* ID,

IGR_UCS2* Name,

IGR_LONGLONG* FileDate,

IGR_LONGLONG* FileSize,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 259/1268 -

Returns IGR_OK.

Success and the end of the document was reached: IGR_LONG

Returns IGR_NO_MORE.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

ADDITIONAL INFORMATION

The previously opened document must have the IGR_FILE_SUPPORTS_SUBFILES capability.

After a successful call to IGR_Open_File / IGR_Open_Stream , each call to IGR_Get_Subfile_Entry

will retrieve information about the next sub-document contained in the compound document, referenced

by DocHandle. To traverse all the sub-documents, the application will need to call this method in a loop

until IGR_NO_MORE is returned.

Note that the null-terminating character will also be copied to the ID and Name parameters. The Name

parameter could be an empty string if the ID of the sub-document is not available. If the function

succeeds, the ID is guaranteed not to be empty and will be unique among all traversed sub-documents

retrieved from the document. The returned ID can be used in a call to IGR_Extract_Subfile to save

the binary content of the sub-document to disk.

If the date of the sub-document is not available, the parameter FileDate will be set to 0, otherwise it will

be populated in FILETIME format.

1 Error_Control_Block ISYSError;

2 IGR_UCS2 ID[4096], Name[1024];

3 INT64 FileDate, FileSize;

5 while (true)

6 {

7 IGR_LONG rc = IGR_Get_Subfile_Entry(DocHandle, ID, Name, &FileDate, &FileSize,

8 &ISYSError);

9 if (rc != IGR_OK)

10 {

11 if (rc != IGR_NO_MORE)

12 // ReportError(rc);

13 break;

14 }

15 rc = IGR_Extract_Subfile(DocHandle, ID, _UCS2("TEMP.DAT"), &ISYSError);

16 if (rc != IGR_OK)

17 // ReportError(rc);

18 else

19 // DoSomethingWithTheFile("TEMP.DAT", ID, Name);

20 }

Document Filters Implementation Guide 2.2.2 Functions

- 260/1268 -

If the size of the sub-document is not available, the parameter FileSize will be set to 0.

SEE ALSO

IGR_Get_Suble_Entry_Ex•

Document Filters Implementation Guide 2.2.2 Functions

- 261/1268 -

IGR_Get_Subfile_Entry_Ex

IGR_Get_Suble_Entry_Ex enumerates the sub-documents contained in a previously opened compound

document, such as message documents (MSG) or archive documents (ZIP).

PROTOTYPE

C/C++

PARAMETERS

docHandle: IGR_LONG

Is a handle to a le, opened by a call to IGR_Open_File , IGR_Open_Stream or equivalent.

result: Pointer to IGR_Subfile_Info

Pointer to a user allocated IGR_Subfile_Info to be populated with the suble information.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Success and the end of the document was reached: IGR_LONG

Returns IGR_NO_MORE.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Get_Subfile_Entry_Ex(

IGR_LONG docHandle,

struct IGR_Subfile_Info* result,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 262/1268 -

SAMPLE CODE

C/C++

ADDITIONAL INFORMATION

The previously opened document must have the IGR_FILE_SUPPORTS_SUBFILES capability.

After a successful call to IGR_Open_File / IGR_Open_Stream , each call to

IGR_Get_Subfile_Entry_Ex will retrieve information about the next sub-document contained in the

compound document, referenced by DocHandle. To traverse all the sub-documents, the application will

need to call this method in a loop until IGR_NO_MORE is returned.

Note that the null-terminating character will also be copied to the result.ID and result.Name parameters.

The Name parameter could be an empty string if the ID of the sub-document is not available. If the

function succeeds, the ID is guaranteed not to be empty and will be unique among all traversed sub-

documents retrieved from the document. The returned ID can be used in a call to

IGR_Extract_Subfile to save the binary content of the sub-document to disk.

If the date of the sub-document is not available, the parameter FileDate will be set to 0, otherwise it will

be populated in FILETIME format.

If the size of the sub-document is not available, the parameter FileSize will be set to 0.

SEE ALSO

IGR_Get_Suble_Entry

1 Error_Control_Block error = { 0 };

2 IGR_Subfile_Info subfile = { 0 };

3 IGR_RETURN_CODE res;

5 std::array<IGR_UCS2, 4096> id;

6 std::array<IGR_UCS2, 1024> name;

7 std::array<IGR_UCS2, 4096> comment;

9 subfile.struct_size = sizeof(subfile);

10 subfile.id = &id[0];

11 subfile.id_size = id.size();

13 subfile.name = &name[0];

14 subfile.name_size = name.size();

16 subfile.comment = &comment[0];

17 subfile.comment_size = comment.size();

19 while ((res = IGR_Get_Subfile_Entry_Ex(dochandle, &subfile, &error)) == IGR_OK)

20 {

21 res = IGR_Extract_Subfile(DocHandle, ID, _UCS2("TEMP.DAT"), &ISYSError);

22 if (res != IGR_OK)

23 // ReportError(rc);

24 else

25 // DoSomethingWithTheFile("TEMP.DAT", ID, Name);

26 }

•

Document Filters Implementation Guide 2.2.2 Functions

- 263/1268 -

IGR_Get_Subfiles_Enumerator

IGR_Get_Subfiles_Enumerator creates a new enumerator for subles. Unlike

IGR_Get_Subfile_Entry , it facilitates the creation of multiple enumerators, enabling the reprocessing

of subles within an open document. Remember to free a suble enumerator by calling

IGR_Subfiles_Close once it is no longer needed.

PROTOTYPE

C/C++

PARAMETERS

handle: IGR_LONG

Is a handle to a le, opened by a call to IGR_Open_File , IGR_Open_Stream or equivalent.

enumerator: HSUBFILES

Returns a handle to be used in subsequent enumerator calls.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_RETURN_CODE IGR_Get_Subfiles_Enumerator(

IGR_LONG docHandle,

HSUBFILES* enumerator,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 264/1268 -

SAMPLE CODE

C/C++

SEE ALSO

IGR_Subles_Close

IGR_Subles_Next_Ex

IGR_Subles_Next

IGR_Subles_Reset

1 Error_Control_Block error = { 0 };

2 IGR_Subfile_Info subfile = { 0 };

3 IGR_RETURN_CODE res;

4 HSUBFILES subs;

6 std::array<IGR_UCS2, 4096> id;

7 std::array<IGR_UCS2, 1024> name;

8 std::array<IGR_UCS2, 4096> comment;

10 subfile.struct_size = sizeof(subfile);

11 subfile.id = &id[0];

12 subfile.id_size = id.size();

14 subfile.name = &name[0];

15 subfile.name_size = name.size();

17 subfile.comment = &comment[0];

18 subfile.comment_size = comment.size();

20 if ((res = IGR_Get_Subfiles_Enumerator(docHandle, &subs, &error)) == IGR_OK)

21 {

22 while ((res = IGR_Subfiles_Next_Ex(subs, &subfile, &error)) == IGR_OK)

23 {

24 res = IGR_Extract_Subfile(DocHandle, ID, _UCS2("TEMP.DAT"), &ISYSError);

25 if (res != IGR_OK)

26 // ReportError(rc);

27 else

28 // DoSomethingWithTheFile("TEMP.DAT", ID, Name);

29 }

30 IGR_Subfiles_Close(subs, &error);

31 }

•

Document Filters Implementation Guide 2.2.2 Functions

- 265/1268 -

IGR_Get_Text

IGR_Get_Text extracts the text of previously opened document.

PROTOTYPE

C/C++

PARAMETERS

DocHandle: IGR_LONG

Handle to a document, opened by a call to IGR_Open_File, IGR_Open_File_Ex, IGR_Open_Stream,

IGR_Open_Stream_Ex or IGR_Open_Ex.

Buffer: Unicode string (UCS2)

Application allocated memory block that will be lled with the next portion of text.

BufferSize: Pointer to IGR_LONG

Prior to the call: The size in Unicode (UCS2) characters of the buer.

After the call: The actual number of Unicode (UCS2) characters extracted.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Success and the end of the document was reached: IGR_LONG

Returns IGR_NO_MORE.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Get_Text(

IGR_LONG DocHandle,

IGR_UCS2* Buffer,

IGR_LONG* BufferSize,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 266/1268 -

SAMPLE CODE

C/C++

ADDITIONAL INFORMATION

The previously opened document must have the IGR_FILE_SUPPORTS_TEXT capability.

Note The populated buer will not be null-terminated. If required, a null terminator may be explicitly

added to the buer at position BuerSize as shown in the Sample code (above).

After a successful call to IGR_Open_File, IGR_Open_File_Ex, IGR_Open_Stream or IGR_Open_Stream_Ex,

the document pointer is set to the beginning of the text to be returned. Each call to IGR_Get_Text will

retrieve the next portion of the text and a maximum of BuerSize characters will be copied to Buer. To

extract the whole text, the application will need to call IGR_Get_Text in a loop until the function returns

IGR_NO_MORE.

Text returned may contain markup characters that your application will need to process.

Error_Control_Block ISYSError;

IGR_UCS2 Buffer[BUFFER_SIZE+1];

IGR_LONG Size, rc;

while (true)

{

Size = BUFFER_SIZE;

rc = IGR_Get_Text(DocHandle, Buffer, &Size, &ISYSError);

if (rc != IGR_OK)

{

if (rc != IGR_NO_MORE)

// ReportError(rc);

break;

}

Buffer[Size] = 0;

// DoSomethingWithTheText(Buffer);

}

Document Filters Implementation Guide 2.2.2 Functions

- 267/1268 -

IGR_Make_Output_Canvas

IGR_Make_Output_Canvas creates a new canvas that is used for rendering page content. The output data

will be written to the le specied in Filename. To write to memory or stream, see

IGR_Make_Output_Canvas_On.

PROTOTYPE

C/C++

PARAMETERS

Type: IGR_LONG

Indicates the type of canvas object to create, can be one of the following:

IGR_LONG IGR_Make_Output_Canvas(

IGR_LONG Type,

const IGR_UCS2* Filename,

const IGR_UCS2* Options,

HCANVAS* CanvasHandle,

Error_Control_Block* error);

Name Value Description

IGR_DEVICE_HTML 6 Create a single or multipage HTML5

IGR_DEVICE_IMAGE_BMP 4 Create a single BMP per page

IGR_DEVICE_IMAGE_BRK 17 Create a single or multipage Brooktrout

FAX

IGR_DEVICE_IMAGE_DCX 19 Create a single or multipage DCX

IGR_DEVICE_IMAGE_EPS 13 Create a single EPS (Encapsulated

PostScript) per page

IGR_DEVICE_IMAGE_GIF 21 Create a single GIF per page

IGR_DEVICE_IMAGE_JPEG2000 20 Create a single JPEG2000 per page

IGR_DEVICE_IMAGE_JPG 1 Create a single JPG per page

IGR_DEVICE_IMAGE_PBM 7 Create a single PBM per page

IGR_DEVICE_IMAGE_PCX 18 Create a single PCX per page

IGR_DEVICE_IMAGE_PDF 2 Create a single or multipage PDF

Document Filters Implementation Guide 2.2.2 Functions

- 268/1268 -

Filename: Unicode string (UCS2)

Destination lename where the output is written.

CanvasHandle: Pointer to HCANVAS

Returns a handle to be used in subsequent canvas calls.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Name Value Description

IGR_DEVICE_IMAGE_PGM 8 Create a single PGM per page

IGR_DEVICE_IMAGE_PNG 0 Create a single PNG per page

IGR_DEVICE_IMAGE_PPM 9 Create a single PPM per page

IGR_DEVICE_IMAGE_PS 14 Create a single or multipage PostScript

IGR_DEVICE_IMAGE_SVG 12 Create a single SVG per page

IGR_DEVICE_IMAGE_TGA 16 Create a single TGA per page

IGR_DEVICE_IMAGE_TIF 3 Create a single or multipage TIF

IGR_DEVICE_IMAGE_WEBP 10 Create a single WEBP per page

IGR_DEVICE_IMAGE_WEBSAFE 15 Create a single image per page, where

the format is determined based on the

palette and number of colors.

IGR_DEVICE_IMAGE_XPS 11 Create a single or multipage XPS

IGR_DEVICE_JSON 22 Create a single or multipage structured

JSON

IGR_DEVICE_PDF 2 Create a single or multipage PDF (Alias

for IGR_DEVICE_IMAGE_PDF)

IGR_DEVICE_XML 5 Create a single or multipage structured

XML

Document Filters Implementation Guide 2.2.2 Functions

- 269/1268 -

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

ADDITIONAL INFORMATION

Some canvas objects allow multiple pages to be rendered to the same le, PDF for example. In this

circumstance, create the canvas object outside of the loop and call IGR_Render_Page to the one canvas

object. For output formats that support multiple pages, you may choose to write multiple input

documents to a single output document.

SEE ALSO

IGR_Make_Output_Canvas_On

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle, PageCount;

HPAGE PageHandle;

IGR_LONG RC = IGR_Open_Stream(pStream, IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle, &ISYSError);

if (RC == IGR_OK)

{

if (IGR_Get_Page_Count(DocHandle, &PageCount, &ISYSError) == IGR_OK)

{

for (IGR_LONG PageIndex = 0; PageIndex < PageCount; PageIndex++)

{

if (IGR_Open_Page(DocHandle, PageIndex, &PageHandle, &ISYSError) == IGR_OK)

{

HCANVAS CanvasHandle;

if (IGR_Make_Output_Canvas(IGR_DEVICE_IMAGE_PNG, L"page.png",

&CanvasHandle, &ISYSError) == IGR_OK)

{

IGR_Render_Page(PageHandle, CanvasHandle, &ISYSError);

IGR_Close_Canvas(CanvasHandle, &ISYSError);

}

IGR_Close_Page(PageHandle, &ISYSError);

}

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 270/1268 -

IGR_Make_Output_Canvas_On

IGR_Make_Output_Canvas_On creates a new canvas that is used for rendering page content, the output

data will be written to the stream specied. The Stream must be a caller created IGR_Writable_Stream

derivative.

PROTOTYPE

C/C++

PARAMETERS

Type: IGR_LONG

Indicates the type of canvas object to create. can be one of the following:

IGR_LONG IGR_Make_Output_Canvas_On(

IGR_LONG Type,

IGR_Writable_Stream* Stream,

const IGR_UCS2* options,

HCANVAS* CanvasHandle,

Error_Control_Block* error);

Name Value Description

IGR_DEVICE_HTML 6 Create a single or multipage HTML5

IGR_DEVICE_IMAGE_BMP 4 Create a single BMP per page

IGR_DEVICE_IMAGE_BRK 17 Create a single or multipage Brooktrout

FAX

IGR_DEVICE_IMAGE_DCX 19 Create a single or multipage DCX

IGR_DEVICE_IMAGE_EPS 13 Create a single EPS (Encapsulated

PostScript) per page

IGR_DEVICE_IMAGE_GIF 21 Create a single GIF per page

IGR_DEVICE_IMAGE_JPEG2000 20 Create a single JPEG2000 per page

IGR_DEVICE_IMAGE_JPG 1 Create a single JPG per page

IGR_DEVICE_IMAGE_PBM 7 Create a single PBM per page

IGR_DEVICE_IMAGE_PCX 18 Create a single PCX per page

IGR_DEVICE_IMAGE_PDF 2 Create a single or multipage PDF

Document Filters Implementation Guide 2.2.2 Functions

- 271/1268 -

Stream: Pointer to IGR_Writable_Stream

A caller provided stream object where the output data is to be written. It is the caller’s responsibility to

create and destroy the stream.

CanvasHandle: Pointer to HCANVAS

Returns a handle to be used in subsequent canvas calls.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

Name Value Description

IGR_DEVICE_IMAGE_PGM 8 Create a single PGM per page

IGR_DEVICE_IMAGE_PNG 0 Create a single PNG per page

IGR_DEVICE_IMAGE_PPM 9 Create a single PPM per page

IGR_DEVICE_IMAGE_PS 14 Create a single or multipage PostScript

IGR_DEVICE_IMAGE_SVG 12 Create a single SVG per page

IGR_DEVICE_IMAGE_TGA 16 Create a single TGA per page

IGR_DEVICE_IMAGE_TIF 3 Create a single or multipage TIF

IGR_DEVICE_IMAGE_WEBP 10 Create a single WEBP per page

IGR_DEVICE_IMAGE_WEBSAFE 15 Create a single image per page, where

the format is determined based on the

palette and number of colors.

IGR_DEVICE_IMAGE_XPS 11 Create a single or multipage XPS

IGR_DEVICE_JSON 22 Create a single or multipage structured

JSON

IGR_DEVICE_PDF 2 Create a single or multipage PDF (Alias

for IGR_DEVICE_IMAGE_PDF)

IGR_DEVICE_XML 5 Create a single or multipage structured

XML

Document Filters Implementation Guide 2.2.2 Functions

- 272/1268 -

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

To use IGR_Make_Output_Canvas_On, the caller must create an object/record that derives from

IGR_Writable_Stream. The implementation must dynamically grow memory, as the amount for data that

will be written is not known at creation time.

SEE ALSO

IGR_Make_Output_Canvas

IGR_Writable_Stream

•

Document Filters Implementation Guide 2.2.2 Functions

- 273/1268 -

IGR_Make_Stream_From_File

IGR_Make_Stream_From_File creates a stream based on a le for use with the document stream

functions.

PROTOTYPE

C/C++

PARAMETERS

FileName: Unicode string (UCS2)

Path to the document to be opened.

Flags: IGR_LONG

A bit eld of options that aect the behavior of the stream object.

FILE_FLAG_DELETE_ON_CLOSE Value: 0x4000000 _Description: _Indicates the document specied in

FileName should be deleted when the stream object is closed.

Stream: Pointer to an IGR_Stream pointer

A system allocated memory stream structure will be returned.

It is the caller’s responsibility to free the stream object by calling Stream->Close()

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Make_Stream_From_File(

const IGR_UCS2* FileName,

IGR_LONG Flags,

IGR_Stream **Stream,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 274/1268 -

SAMPLE CODE

C/C++

SEE ALSO

IGR_Open_Stream

IGR_Get_Stream_Type

IGR_Stream

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType;

IGR_Stream *pStream;

if (IGR_Make_Stream_From_File(_UCS2("TEST.DOC"), 0, &pStream, &ISYSError) == IGR_OK)

{

if (IGR_Get_Stream_Type(pStream, &Capabilities, &DocType, &ISYSError) == IGR_OK)

{

if (DocType == 25)

{

// Document is an MS Word document

}

pStream->Close(pStream);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 275/1268 -

IGR_Make_Stream_From_Functions

IGR_MAKE_STREAM_FROM_FUNCTIONS creates a new IGR stream based o the context and functions.

This is functionally identical to constructing the IGR_Stream structure by hand; this function can be used

by languages that do not have precise control over memory layout.

PROTOTYPE

C/C++

PARAMETERS

context: Pointer to void

Context is a user-provided block that is passed to each callback function.

flags: IGR_LONG

A bit eld of options that aect the behavior of the stream object.

seek: Pointer to func

Function pointer to required Seek method.

read: Pointer to func

Function pointer to required Read method.

write: Pointer to func

Function pointer to optional Write method.

action: Pointer to func

Function pointer to optional Action method.

destruct: Pointer to

IGR_RETURN_CODE IGR_Make_Stream_From_Functions(

void* context,

IGR_LONG flags,

IGR_ULONG(CALLBACK* seek)(void* context, IGR_LONGLONG offset, IGR_ULONG whence),

IGR_ULONG(CALLBACK* read)(void* context, void* buffer, IGR_ULONG buffer_size),

IGR_ULONG(CALLBACK* write)(void* context, const void* buffer, IGR_ULONG buffer_size),

IGR_LONG(CALLBACK* action)(void* context, int actionId, void* action_data),

void (CALLBACK* destruct)(void* context),

struct IGR_Stream** stream,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 276/1268 -

Function pointer to required destructor that can be used to dispose of context memory.

stream: Pointer to

A system allocated memory stream structure will be returned. It is the caller's responsibility to free the

stream object by calling stream->Close() .

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

Document Filters Implementation Guide 2.2.2 Functions

- 277/1268 -

IGR_Make_Stream_From_Memory

IGR_Make_Stream_From_Memory creates a stream based on a memory buer for use with the document

stream functions.

PROTOTYPE

C/C++

PARAMETERS

Data: Pointer

A pointer to a user allocated memory buer that contains the binary document you wish to work with.

DataSize: IGR_LONG

Indicates the size of the buer pointed to by Data.

Destructor: Pointer

Optional function pointer that will be called when the stream object is closed, giving your application the

ability to free the memory buer or perform other cleanup routines. Specify NULL if unused.

The destructor must take the following form:

void __cdecl Destruct(void *data);

Stream: Pointer to an IGR_Stream pointer

A system allocated memory stream structure will be returned.

It is the caller’s responsibility to free the stream object by calling:

stream->Close()

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

IGR_LONG IGR_Make_Stream_From_Memory(

void * Data,

IGR_LONG DataSize,

void * Destructor

IGR_Stream **Stream,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 278/1268 -

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

SEE ALSO

IGR_Open_Stream

IGR_Get_Stream_Type

IGR_Stream

void __cdecl FreeMyBuffer(void *p)

{

delete[] p;

}

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType;

IGR_Stream *pStream;

if (IGR_Make_Stream_From_Memory(myBuffer, myBufferSize, &FreeMyBuffer, &pStream,

&ISYSError) == IGR_OK)

{

if (IGR_Get_Stream_Type(pStream, &Capabilities, &DocType, &ISYSError) == IGR_OK)

{

if (DocType == 25)

{

// Document is an MS Word document

}

pStream->Close(pStream);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 279/1268 -

IGR_Multiplex

The IGR_Multiplex function is used to supply extensible functionality to the Document Filters API. It is

used as a general purpose extension mechanism to avoid disturbing the published Document Filters API.

PROTOTYPE

C/C++

PARAMETERS

Function: IGR_LONG

The function to perform as listed in the following Function Chart.

Parameter1: Pointer to size_t

Used for some functions.

Parameter2: Pointer to size_t

Used for some functions.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

FUNCTION CHART

RETURN VALUE

None

void IGR_Multiplex(

IGR_LONG Function,

size_t* Parameter1,

size_t* Parameter2,

Error_Control_Block* ISYSError);

Function Parameter1 Parameter2 Purpose

IGR_Multi_Set_Code_Page

(1)

Codepage Unused Species the default

character set when the

character set cannot be

determined.

IGR_Multi_Set_Temp_Path

(186)

Temp Path Unused Species the temp path to

use.

Document Filters Implementation Guide 2.2.2 Functions

- 280/1268 -

SAMPLE CODE

C/C++

Error_Control_Block ISYSError;

size_t L1 = 1251, L2 = 0;

IGR_Multiplex(IGR_Multi_Set_Code_Page, &L1, &L2, &ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 281/1268 -

IGR_Open_DDB

Opens a document from an OS based, device-dependant bitmap (Windows-Only).

PROTOTYPE

C/C++

PARAMETERS

bitmap: Pointer to void

Provide a handle to the OS bitmap (HBITMAP).

palette: Pointer to void

Provide a handle to an optional OS palette (HPALETTE).

flags: IGR_LONG

Species what type of data is returned from subsequent calls to the IGR_Get_Text function. These Open

Document Flags aect the verbosity or the format of the extracted data.

options: Pointer to IGR_UCS2

Extended processing options, used when converting the document to HTML. The Open Document

Options are expressed as Name=Value with a semicolon delimiter.

capabilities: Pointer to IGR_LONG

Returns the Document Capabilities as a bit-eld.

file_type: Pointer to IGR_LONG

Returns the Document Format Code of the document.

handle: Pointer to IGR_LONG

IGR_RETURN_CODE IGR_Open_DDB(

void* bitmap,

void* palette,

IGR_LONG flags,

const IGR_UCS2* options,

IGR_LONG* capabilities,

IGR_LONG* file_type,

IGR_LONG* handle,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 282/1268 -

Returns a handle to be used in subsequent calls.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

Document Filters Implementation Guide 2.2.2 Functions

- 283/1268 -

IGR_Open_DIB

IGR_Open_DIB opens a document for content extraction or enumeration of sub-documents from an

existing in-memory image.

PROTOTYPE

C/C++

PARAMETERS

Bitmap: const struct IGR_Open_DIB_Info

Pointer to a caller-provided IGR_Open_DIB_Info structure that contains details on how to decode the in-

memory image.

Flags: IGR_LONG

Species what type of data is returned from subsequent calls to the IGR_Get_Text function. These Open

Document Flags aect the verbosity or the format of the extracted data.

Options: Unicode string (UCS2)

Extended processing options, used when converting the document to HTML. The Open Document

Options are expressed as Name=Value with a semicolon delimiter.

Capabilities: Pointer to IGR_LONG

Returns the Document Capabilities as a bit eld.

DocType: Pointer to IGR_LONG

Returns the Document Format Code of the document.

DocHandle: Pointer to IGR_LONG

Returns a handle to be used in subsequent calls.

ISYSError: Pointer to Error_Control_Block

IGR_LONG IGR_Open_DIB(

const struct IGR_Open_DIB_Info* bitmap,

IGR_LONG flags,

const IGR_UCS2* options,

IGR_LONG* capabilities,

IGR_LONG* file_type,

IGR_LONG* handle,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 284/1268 -

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SEE ALSO

IGR_Open_DIB_Info•

Document Filters Implementation Guide 2.2.2 Functions

- 285/1268 -

IGR_Open_Ex

IGR_Open_Ex opens a document for text extraction or enumeration of sub-documents, and takes an

IGR_OPEN_CALLBACK parameter that allows for interaction with the API user during API calls.

PROTOTYPE

C/C++

PARAMETERS

source_type: IGR_OPEN_FROM

The type of source, that can be either a UTF-16 string containing the lename, or an IGR_Stream record.

See IGR_OPEN_FROM.

source: Pointer to VOID

The pointer to the source based on the source_type parameter. If the source is an IGR_Stream, the

stream MUST remain valid for the life-type of the document handle returned.

flags: IGR_LONG

Species what type of data is returned from subsequent calls to the IGR_Get_Text function. These Open

Document Flags aect the verbosity or the format of the extracted data.

options: Unicode string (UCS2)

Extended processing options, used when converting the document to HTML. The Open Document

Options are expressed as Name=Value with a semicolon delimiter.

capabilities: Pointer to IGR_LONG

Returns the Document Capabilities as a bit eld.

file_type: Pointer to IGR_LONG

IGR_LONG IGR_Open_Ex(

IGR_OPEN_FROM source_type,

const void* source,

IGR_LONG flags,

const IGR_UCS2* options,

IGR_LONG* capabilities,

IGR_LONG* file_type,

void* reserved,

IGR_OPEN_CALLBACK callback,

void* callback_context,

IGR_LONG* handle,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 286/1268 -

Returns the Document Format Code of the document.

reserved: Pointer to VOID

MUST be NULL. Reserved for future use.

callback: IGR_OPEN_CALLBACK

IGR_OPEN_CALLBACK that will be called for specic events while processing the document. MUST remain

valid for the lifetime of the document handle returned.

callback_context: Pointer to VOID

Contextual information that will be passed back when the callback is called. MUST remain valid for the

lifetime of the document handle returned.

handle: Pointer to IGR_LONG

Returns a handle to be used in subsequent calls.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

struct OpenExCallbackContext

{

OpenExCallbackContext();

bool isCancellationRequested();

};

IGR_LONG IGR_EXPORT OpenExCallback(IGR_OPEN_CALLBACK_ACTION action, void* payload, void* context)

{

if (action == IGR_OPEN_CALLBACK_ACTION_HEARTBEAT)

{

if (OpenExCallbackContext* callbackContext = static_cast<OpenExCallbackContext*>(context))

{

if (callbackContext->isCancellationRequested())

return IGR_CANCELLED;

Document Filters Implementation Guide 2.2.2 Functions

- 287/1268 -

ADDITIONAL INFORMATION

The call will establish a link to the document and populates a handle. The handle can be used to extract

the text by calling IGR_Get_Text, generate page images with IGR_Open_Page, or enumerate and extract

the sub-documents by calls to IGR_Get_Suble_Entry and IGR_Extract_Suble respectively.

}

else if (action == IGR_OPEN_CALLBACK_ACTION_PASSWORD)

{

IGR_Open_Callback_Action_Password*

passwordStruct(static_cast<IGR_Open_Callback_Action_Password*>(payload));

if (!passwordStruct || passwordStruct->struct_size != sizeof(*passwordStruct))

return IGR_E_ERROR;

// Read string from passwordStruct->id to identify which password is being requested

// Get password string for password being requested

// Write password string to passwordStruct->password

}

else if (action == IGR_OPEN_CALLBACK_ACTION_LOCALIZE)

{

IGR_Open_Callback_Action_Localize*

localizeStruct(static_cast<IGR_Open_Callback_Action_Localize*>(payload));

if (!localizeStruct || localizeStruct->struct_size != sizeof(*localizeStruct))

return IGR_E_ERROR;

// Read string from localizeStruct->original to identify the string to be replaced

// Get replacement string

// Write replacement string to localizeStruct->replacement

}

return IGR_OK;

}

int main(int argc, char** argv)

{

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle;

OpenExCallbackContext CallbackContext;

IGR_LONG RC = IGR_Open_Ex(IGR_OPEN_FROM_FILENAME_UTF16, _UCS2("TEST.DOC"),

IGR_BODY_AND_META | IGR_FORMAT_HTML, _UCS2("IMAGEPATH=C:\\Temp"),

&Capabilities, &DocType, NULL,

OpenExCallback, &CallbackContext, &DocHandle, &ISYSError);

if (RC == IGR_OK)

{

// Extract document text or sub-documents...

IGR_Close_File(DocHandle, &ISYSError);

}

Document Filters Implementation Guide 2.2.2 Functions

- 288/1268 -

The application must call IGR_Close_File when nished using the document.

If a (non-NULL) IGR_OPEN_CALLBACK is provided, the callbacks can happen any time from the point of

IGR_Open_Ex being called through to its handle being closed by IGR_Close_File.

See IGR_OPEN_CALLBACK for more information on the specics of each callback action.

SEE ALSO

IGR_OPEN_CALLBACK

IGR_Get_File_Type

IGR_Open_File_Ex

IGR_Open_Stream_Ex

•

Document Filters Implementation Guide 2.2.2 Functions

- 289/1268 -

IGR_Open_File

IGR_Open_File opens a document for content extraction or enumeration of sub-documents.

PROTOTYPE

C/C++

PARAMETERS

FileName: Unicode string (UCS2)

Path to the document to be opened.

Flags: IGR_LONG

Species what type of data is returned from subsequent calls to the IGR_Get_Text function. These Open

Document Flags aect the verbosity or the format of the extracted data.

Capabilities: Pointer to IGR_LONG

Returns the Document Capabilities as a bit eld.

DocType: Pointer to IGR_LONG

Returns the Document Format Code of the document.

DocHandle: Pointer to IGR_LONG

Returns a handle to be used in subsequent calls.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

IGR_LONG IGR_Open_File(

const IGR_UCS2* FileName,

IGR_LONG Flags,

IGR_LONG* Capabilities,

IGR_LONG* DocType,

IGR_LONG* DocHandle,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 290/1268 -

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

ADDITIONAL INFORMATION

The call will establish a link to the document and populates a handle. The handle can be used to extract

the text by calling IGR_Get_Text, generate page images with IGR_Open_Page, or enumerate and extract

the sub-documents by calls to IGR_Get_Suble_Entry and IGR_Extract_Suble respectively.

The application must call IGR_Close_File when nished using the document.

SEE ALSO

IGR_Open_File_Ex

IGR_Open_Stream

IGR_Get_File_Type

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle;

IGR_LONG RC = IGR_Open_File(_UCS2("TEST.DOC"), IGR_BODY_AND_META, &Capabilities, &DocType, &DocHandle,

&ISYSError);

if (RC == IGR_OK)

{

// Extract document text or sub-documents...

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 291/1268 -

IGR_Open_File_Ex

IGR_Open_File_Ex opens a document for content extraction or enumeration of sub-documents and

controls the output format, including converting the source document to HTML.

PROTOTYPE

C/C++

PARAMETERS

FileName: Unicode string (UCS2)

Path to the document to be opened.

Flags: IGR_LONG

Species what type of data is returned from subsequent calls to the IGR_Get_Text function. These Open

Document Flags aect the verbosity or the format of the extracted data.

Options: Unicode string (UCS2)

Extended processing options, used when converting the document to HTML. The Open Document

Options are expressed as Name=Value with a semicolon delimiter.

Capabilities: Pointer to IGR_LONG

Returns the Document Capabilities as a bit eld.

DocType: Pointer to IGR_LONG

Returns the Document Format Code of the document.

DocHandle: Pointer to IGR_LONG

Returns a handle to be used in subsequent calls.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

IGR_LONG IGR_Open_File_Ex(

const IGR_UCS2* FileName,

IGR_LONG Flags,

const IGR_UCS2* Options,

IGR_LONG* Capabilities,

IGR_LONG* DocType,

IGR_LONG* DocHandle,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 292/1268 -

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

ADDITIONAL INFORMATION

The call will establish a link to the document and populates a handle. The handle can be used to extract

the text by calling IGR_Get_Text, generate page images with IGR_Open_Page, or enumerate and extract

the sub-documents by calls to IGR_Get_Suble_Entry and IGR_Extract_Suble respectively.

The application must call IGR_Close_File when nished using the document.

SEE ALSO

IGR_Open_File

IGR_Get_File_Type

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle;

IGR_LONG RC = IGR_Open_File_Ex(_UCS2("TEST.DOC"), IGR_BODY_AND_META | IGR_FORMAT_HTML,

_UCS2("IMAGEPATH=C:\\Temp"), &Capabilities, &DocType, &DocHandle, &ISYSError);

if (RC == IGR_OK)

{

// Extract document text or sub-documents...

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 293/1268 -

IGR_Open_Page

IGR_Open_Page gives access to page specic content for documents opened using the

IGR_FORMAT_IMAGE ag, including page words, images, and structured XML.

PROTOTYPE

C/C++

PARAMETERS

DocHandle: IGR_LONG

Handle to a document, opened by a call to IGR_Open_File, IGR_Open_File_Ex, IGR_Open_Stream or

IGR_Open_Stream_Ex.

PageIndex: IGR_LONG

0-based page number to the page to open.

PageHandle: Pointer to HPAGE

Returns a handle to be used in subsequent page calls.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

IGR_LONG IGR_Open_Page(

IGR_LONG DocHandle,

IGR_LONG PageIndex,

HPAGE* PageHandle,

Error_Control_Block* error);

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle, PageCount;

Document Filters Implementation Guide 2.2.2 Functions

- 294/1268 -

ADDITIONAL INFORMATION

The call will load resources associated with the page that can then be used in calls to

IGR_Get_Page_Word_Count, IGR_Get_Page_Words, IGR_Get_Page_Dimensions, IGR_Get_Page_Text, and

IGR_Render_Page.

The application must call IGR_Close_Page when nished using the page. All pages must be closed before

calling IGR_Close_File.

SEE ALSO

IGR_Get_Page_Word_Count

IGR_Get_Page_Words

IGR_Get_Page_Dimensions

IGR_Get_Page_Text

IGR_Render_Page

IGR_Close_Page

HPAGE PageHandle;

IGR_LONG RC = IGR_Open_Stream(pStream, IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle, &ISYSError);

if (RC == IGR_OK)

{

if (IGR_Get_Page_Count(DocHandle, &PageCount, &ISYSError) == IGR_OK)

{

for (IGR_LONG PageIndex = 0; PageIndex < PageCount; PageIndex++)

{

if (IGR_Open_Page(DocHandle, PageIndex, &PageHandle, &ISYSError) == IGR_OK)

{

// Process Page Element

IGR_Close_Page(PageHandle, &ISYSError);

}

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 295/1268 -

IGR_Open_Stream

IGR_Open_Stream opens a document from a stream object for content extraction or enumeration of

contained sub-documents.

PROTOTYPE

C/C++

PARAMETERS

Stream: Pointer to an IGR_Stream

(a stream object)

The stream can be either user implemented, or created using the IGR_Make_Stream_From_File and

IGR_Make_Stream_From_Memory utility functions.

Flags: IGR_LONG

Species what type of data is returned from subsequent calls to the IGR_Get_Text function. These Open

Document Flags aect the verbosity or the format of the extracted data.

Capabilities: Pointer to IGR_LONG

Returns the Document Capabilities as a bit eld.

DocType: Pointer to IGR_LONG

Returns the Document Format Code of the document.

DocHandle: Pointer to IGR_LONG

Returns a handle to be used in subsequent calls.

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

IGR_LONG IGR_Open_Stream(

IGR_Stream *Stream,

IGR_LONG Flags,

IGR_LONG* Capabilities,

IGR_LONG* DocType,

IGR_LONG* DocHandle,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 296/1268 -

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

ADDITIONAL INFORMATION

The call will establish a link to the document and populates a handle. The handle can be used to extract

the text by calling IGR_Get_Text, generate page images with IGR_Open_Page, or enumerate and extract

the sub-documents by calls to IGR_Get_Suble_Entry and IGR_Extract_Suble respectively.

The application must call IGR_Close_File when nished using the document.

SEE ALSO

IGR_Open_File

IGR_Get_File_Type

IGR_Stream

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle;

IGR_LONG RC = IGR_Open_Stream(pStream, IGR_BODY_AND_META, &Capabilities, &DocType, &DocHandle, &ISYSError);

if (RC == IGR_OK)

{

// Extract document text or sub-documents...

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 297/1268 -

IGR_Open_Stream_Ex

IGR_Open_Stream_Ex opens a document from a stream object for content extraction or enumeration of

contained sub-documents and controls the output format.

PROTOTYPE

C/C++

PARAMETERS

Stream: Pointer to an IGR_Stream

(a stream object)

The stream can be either user implemented, or created using the IGR_Make_Stream_From_File and

IGR_Make_Stream_From_Memory utility functions.

Flags: IGR_LONG

Species what type of data is returned from subsequent calls to the IGR_Get_Text function. These Open

Document Flags aect the verbosity or the format of the extracted data.

Options: Unicode string (UCS2)

Extended processing options, used when converting the document. The Open Document Options are

expressed as Name=Value with a semicolon delimiter.

Capabilities: Pointer to IGR_LONG

Returns the Document Capabilities as a bit eld.

DocType: Pointer to IGR_LONG

Returns the Document Format Code of the document.

DocHandle: Pointer to IGR_LONG

Returns a handle to be used in subsequent calls.

IGR_LONG IGR_Open_Stream_Ex(

IGR_Stream *Stream,

IGR_LONG Flags,

const IGR_UCS2* Options,

IGR_LONG* Capabilities,

IGR_LONG* DocType,

IGR_LONG* DocHandle,

Error_Control_Block* ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 298/1268 -

ISYSError: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C/C++

ADDITIONAL INFORMATION

The call will establish a link to the document and populates a handle. The handle can be used to extract

the text by calling IGR_Get_Text, generate page images with IGR_Open_Page, or enumerate and extract

the sub-documents by calls to IGR_Get_Suble_Entry and IGR_Extract_Suble respectively.

The application must call IGR_Close_File when nished using the document.

SEE ALSO

IGR_Open_File

IGR_Get_File_Type

IGR_Stream

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle;

IGR_LONG RC = IGR_Open_Stream_Ex(pStream, IGR_BODY_AND_META | IGR_FORMAT_HTML,

_UCS2("IMAGEPATH=C:\\Temp"), &Capabilities, &DocType, &DocHandle, &ISYSError);

if (RC == IGR_OK)

{

// Extract document text or sub-documents...

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 299/1268 -

IGR_Redact_Page_Text

IGR_Redact_Page_Text removes the words and blacks out the location for the specied range from the

page.

PROTOTYPE

C/C++

PARAMETERS

Page: HPAGE

Handle to a page, opened by a call to IGR_Open_Page.

From: IGR_LONG

The index of the rst word to redact.

To: IGR_LONG

The index to the last word to redact.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

It should be assumed that redacted content will not persist between closing and re-opening a page. To

create a redacted Image, PDF or HTML le, open a page, perform the redaction and render the page to a

canvas before closing it.

IGR_LONG IGR_Redact_Page_Text(

HPAGE page,

IGR_LONG from,

IGR_LONG to,

Error_Control_Block* Error);

Document Filters Implementation Guide 2.2.2 Functions

- 300/1268 -

The API allows for redacting single words or a run or range of words. When redacting a range,

whitespace between the words will also be redacted.

SAMPLE CODE

C/C++

SEE ALSO

IGR_Open_Page

IGR_Make_Output_Canvas

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle, PageCount;

HPAGE PageHandle;

IGR_LONG RC = IGR_Open_Stream(pStream, IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle, &ISYSError);

if (RC == IGR_OK)

{

if (IGR_Get_Page_Count(DocHandle, &PageCount, &ISYSError) == IGR_OK)

{

for (IGR_LONG PageIndex = 0; PageIndex < PageCount; PageIndex++)

{

if (IGR_Open_Page(DocHandle, PageIndex, &PageHandle, &ISYSError) == IGR_OK)

{

IGR_Redact_Page_Text(PageHandle, 0, 15, &ISYSError);

HCANVAS CanvasHandle;

if (IGR_Make_Output_Canvas(IGR_DEVICE_IMAGE_PNG, L"page.png",

&CanvasHandle, &ISYSError) == IGR_OK)

{

IGR_Render_Page(PageHandle, CanvasHandle, &ISYSError);

IGR_Close_Canvas(CanvasHandle, &ISYSError);

}

IGR_Close_Page(PageHandle, &ISYSError);

}

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 301/1268 -

IGR_Render_Page

IGR_Render_Page draws the page content into the specied output canvas.

PROTOTYPE

C/C++

PARAMETERS

Page: HPAGE

Handle to a page, opened by a call to IGR_Open_Page.

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

ADDITIONAL INFORMATION

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

SAMPLE CODE

C/C++

IGR_LONG IGR_Render_Page(

HPAGE Page,

HCANVAS Canvas,

Error_Control_Block* Error);

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle, PageCount;

HPAGE PageHandle;

IGR_LONG RC = IGR_Open_Stream(pStream, IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle, &ISYSError);

Document Filters Implementation Guide 2.2.2 Functions

- 302/1268 -

SEE ALSO

IGR_Open_Page

IGR_Make_Output_Canvas

IGR_Render_Page_Ex

if (RC == IGR_OK)

{

if (IGR_Get_Page_Count(DocHandle, &PageCount, &ISYSError) == IGR_OK)

{

for (IGR_LONG PageIndex = 0; PageIndex < PageCount; PageIndex++)

{

if (IGR_Open_Page(DocHandle, PageIndex, &PageHandle, &ISYSError) == IGR_OK)

{

HCANVAS CanvasHandle;

if (IGR_Make_Output_Canvas(IGR_DEVICE_IMAGE_PNG, L"page.png",

&CanvasHandle, &ISYSError) == IGR_OK)

{

IGR_Render_Page(PageHandle, CanvasHandle, &ISYSError);

IGR_Close_Canvas(CanvasHandle, &ISYSError);

}

IGR_Close_Page(PageHandle, &ISYSError);

}

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 303/1268 -

IGR_Render_Page_Ex

IGR_Render_Page_Ex draws the page content into the specied output canvas

PROTOTYPE

C/C++

PARAMETERS

Page: HPAGE

Handle to a page, opened by a call to IGR_Open_Page.

Canvas: HCANVAS

Handle to a canvas, opened by a call to IGR_Make_Output_Canvas.

Options: Unicode string (UCS2)

Extended processing options used when converting the page. The Open Document Options are

expressed as Name=Value with a semicolon delimiter.

Properties: Pointer to const IGR_Render_Page_Properties

Page specic render properties

Error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_LONG IGR_Render_Page_Ex(

HPAGE Page,

HCANVAS Canvas,

IGR_UCS2* Options,

const struct IGR_Render_Page_Properties* Properties,

Error_Control_Block* Error);

Document Filters Implementation Guide 2.2.2 Functions

- 304/1268 -

ADDITIONAL INFORMATION

Note The drawing API is available for bitmap and PDF outputs only. Drawing onto an HTML5 output is not

supported.

SAMPLE CODE

C/C++

SEE ALSO

IGR_Open_Page

IGR_Make_Output_Canvas

IGR_Render_Page

IGR_Render_Page_Properties

Error_Control_Block ISYSError;

IGR_LONG Capabilities, DocType, DocHandle, PageCount;

HPAGE PageHandle;

IGR_Render_Page_Properties RenderProperties;

RenderProperties.struct_size = sizeof(IGR_Render_Page_Properties);

IGR_LONG RC = IGR_Open_Stream(pStream, IGR_FORMAT_IMAGE, &Capabilities, &DocType, &DocHandle, &ISYSError);

if (RC == IGR_OK)

{

if (IGR_Get_Page_Count(DocHandle, &PageCount, &ISYSError) == IGR_OK)

{

for (IGR_LONG PageIndex = 0; PageIndex < PageCount; PageIndex++)

{

if (IGR_Open_Page(DocHandle, PageIndex, &PageHandle, &ISYSError) == IGR_OK)

{

HCANVAS CanvasHandle;

if (IGR_Make_Output_Canvas(IGR_DEVICE_IMAGE_PNG, L"page.png",

&CanvasHandle, &ISYSError) == IGR_OK)

{

IGR_Render_Page_Ex(PageHandle, CanvasHandle,

UCS2("WATERMARK=EXAMPLE;GRAPHIC_EFFECT=GRAYSCALE"),

&RenderProperties , &ISYSError);

IGR_Close_Canvas(CanvasHandle, &ISYSError);

}

IGR_Close_Page(PageHandle, &ISYSError);

}

IGR_Close_File(DocHandle, &ISYSError);

}

•

Document Filters Implementation Guide 2.2.2 Functions

- 305/1268 -

IGR_Subfiles_Close

IGR_Subfiles_Close releases the resources associated with an enumeration generated by

IGR_Get_Subfiles_Enumerator or a similar function. It is imperative to free enumerators before

closing the owning document.

PROTOTYPE

C/C++

PARAMETERS

enumerator: HSUBFILES

Handle to an enumerator opened by IGR_Get_Subles_Enumerator.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_RETURN_CODE IGR_Subfiles_Close(

HSUBFILES handle,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 306/1268 -

SAMPLE CODE

C++

SEE ALSO

IGR_Get_Subles_Enumerator

IGR_Subles_Close

1 Error_Control_Block error;

2 HSUBFILES subs;

3 std::array<IGR_UCS2, 4096> id;

4 std::array<IGR_UCS2, 1024> name;

5 IGR_LONGLONG date, size;

6 IGR_RETURN_CODE res;

8 if ((res = IGR_Get_Subfiles_Enumerator(docHandle, &subs, &error)) == IGR_OK)

9 {

10 while ((res = IGR_Subfiles_Next(subs, &id[0], &name[0], &date, &size, &error)) == IGR_OK)

11 {

12 res = IGR_Extract_Subfile(docHandle, id, _UCS2("TEMP.DAT"), &error);

13 if (res != IGR_OK)

14 // ReportError(res);

15 else

16 // DoSomethingWithTheFile("TEMP.DAT", id, name);

17 }

18 IGR_Subfiles_Close(subs, &error);

19 }

•

Document Filters Implementation Guide 2.2.2 Functions

- 307/1268 -

IGR_Subfiles_Next

IGR_Subfiles_Next iterates through the sub-documents within a suble enumeration obtained from

IGR_Get_Subfiles_Enumerator or a similar function.

PROTOTYPE

C/C++

PARAMETERS

handle: IGR_LONG

Is a handle to a le, opened by a call to IGR_Open_File.

id: Unicode string (UCS2)

Application allocated memory block of 8192 bytes that will be lled with up to 4096 Unicode characters

that specify the unique id of the next sub-document.

Application allocated memory block of 2048 bytes that will be lled with up to 1024 Unicode characters

that specify the name of the sub-document.

date: Pointer to INT64

Returns the date and time of the sub-document in FILETIME format.

size: Pointer to INT64

Returns the size in bytes of the sub-document.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

IGR_RETURN_CODE IGR_Subfiles_Next(

HSUBFILES handle,

IGR_UCS2* id,

IGR_UCS2* name,

IGR_LONGLONG* date,

IGR_LONGLONG* size,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 308/1268 -

Returns IGR_OK.

Success and the end of the document was reached: IGR_LONG

Returns IGR_NO_MORE.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SAMPLE CODE

C++

ADDITIONAL INFORMATION

The previously opened document must have the IGR_FILE_SUPPORTS_SUBFILES capability.

After a successful call to IGR_Get_Subles_Enumerator, each call to IGR_Subles_Next will retrieve

information about the next sub-document contained in the compound document, referenced by

DocHandle. To traverse all the sub-documents, the application will need to call this method in a loop until

IGR_NO_MORE is returned.

Note that the null-terminating character will also be copied to the id and name parameters. The name

parameter could be an empty string if the id of the sub-document is not available. If the function

succeeds, the id is guaranteed not to be empty and will be unique among all traversed sub-documents

retrieved from the document. The returned id can be used in a call to IGR_Extract_Suble to save the

binary content of the sub-document to disk.

If the date of the sub-document is not available, the parameter FileDate will be set to 0, otherwise it will

be populated in FILETIME format.

If the size of the sub-document is not available, the parameter FileSize will be set to 0.

1 Error_Control_Block error;

2 HSUBFILES subs;

3 std::array<IGR_UCS2, 4096> id;

4 std::array<IGR_UCS2, 1024> name;

5 IGR_LONGLONG date, size;

6 IGR_RETURN_CODE res;

8 if ((res = IGR_Get_Subfiles_Enumerator(docHandle, &subs, &error)) == IGR_OK)

9 {

10 while ((res = IGR_Subfiles_Next(subs, &id[0], &name[0], &date, &size, &error)) == IGR_OK)

11 {

12 res = IGR_Extract_Subfile(docHandle, id, _UCS2("TEMP.DAT"), &error);

13 if (res != IGR_OK)

14 // ReportError(res);

15 else

16 // DoSomethingWithTheFile("TEMP.DAT", id, name);

17 }

18 IGR_Subfiles_Close(subs, &error);

19 }

Document Filters Implementation Guide 2.2.2 Functions

- 309/1268 -

SEE ALSO

IGR_Get_Subles_Enumerator

IGR_Subles_Close

IGR_Subles_Next_Ex

•

Document Filters Implementation Guide 2.2.2 Functions

- 310/1268 -

IGR_Subfiles_Next_Ex

IGR_Subfiles_Next_Ex iterates through the sub-documents within a suble enumeration obtained

from IGR_Get_Subfiles_Enumerator or a similar function.

PROTOTYPE

C/C++

PARAMETERS

enumerator: HSUBFILES

Handle to an enumerator opened by IGR_Get_Subles_Enumerator.

result: Pointer to IGR_Subfile_Info

Pointer to a user allocated IGR_Suble_Info to be populated with the suble information.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_RETURN_CODE IGR_Subfiles_Next_Ex(

HSUBFILES enumerator,

struct IGR_Subfile_Info* result,

Error_Control_Block* error);

Document Filters Implementation Guide 2.2.2 Functions

- 311/1268 -

SAMPLE CODE

C/C++

ADDITIONAL INFORMATION

The previously opened document must have the IGR_FILE_SUPPORTS_SUBFILES capability.

After a successful call to IGR_Get_Subles_Enumerator, each call to IGR_Get_Suble_Entry_Ex will

retrieve information about the next sub-document contained in the compound document, referenced by

DocHandle. To traverse all the sub-documents, the application will need to call this method in a loop until

IGR_NO_MORE is returned.

Note that the null-terminating character will also be copied to the result.ID and result.Name parameters.

The Name parameter could be an empty string if the ID of the sub-document is not available. If the

function succeeds, the ID is guaranteed not to be empty and will be unique among all traversed sub-

documents retrieved from the document. The returned ID can be used in a call to IGR_Extract_Suble to

save the binary content of the sub-document to disk.

If the date of the sub-document is not available, the parameter FileDate will be set to 0, otherwise it will

be populated in FILETIME format.

If the size of the sub-document is not available, the parameter FileSize will be set to 0.

1 Error_Control_Block error = { 0 };

2 IGR_Subfile_Info subfile = { 0 };

3 IGR_RETURN_CODE res;

4 HSUBFILES subs;

6 std::array<IGR_UCS2, 4096> id;

7 std::array<IGR_UCS2, 1024> name;

8 std::array<IGR_UCS2, 4096> comment;

10 subfile.struct_size = sizeof(subfile);

11 subfile.id = &id[0];

12 subfile.id_size = id.size();

14 subfile.name = &name[0];

15 subfile.name_size = name.size();

17 subfile.comment = &comment[0];

18 subfile.comment_size = comment.size();

20 if ((res = IGR_Get_Subfiles_Enumerator(docHandle, &subs, &error)) == IGR_OK)

21 {

22 while ((res = IGR_Subfiles_Next_Ex(subs, &subfile, &error)) == IGR_OK)

23 {

24 res = IGR_Extract_Subfile(DocHandle, ID, _UCS2("TEMP.DAT"), &ISYSError);

25 if (res != IGR_OK)

26 // ReportError(rc);

27 else

28 // DoSomethingWithTheFile("TEMP.DAT", ID, Name);

29 }

30 IGR_Subfiles_Close(subs, &error);

31 }

Document Filters Implementation Guide 2.2.2 Functions

- 312/1268 -

SEE ALSO

IGR_Get_Suble_Entry

IGR_Get_Subles_Enumerator

IGR_Subles_Next

•

Document Filters Implementation Guide 2.2.2 Functions

- 313/1268 -

IGR_Subfiles_Reset

IGR_Subfiles_Reset resets an enumeration to its initial state, positioning it at the beginning.

Subsequently, invoke IGR_Subfiles_Next to commence reprocessing the document. Notably, invoking

IGR_Subfiles_Reset is unnecessary for the initial iteration.

PROTOTYPE

C/C++

PARAMETERS

enumerator: HSUBFILES

Handle to an enumerator opened by IGR_Get_Subles_Enumerator.

error: Pointer to Error_Control_Block

Returns error details if the call fails.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SEE ALSO

IGR_Get_Subles_Enumerator

IGR_Subles_Close

IGR_RETURN_CODE IGR_Subfiles_Reset(

HSUBFILES enumerator,

Error_Control_Block* error);

•

Document Filters Implementation Guide 2.2.2 Functions

- 314/1268 -

IGR_Text_Compare_Close

Closes the text comparison enumerator and frees associated resources.

PROTOTYPE

C/C++

PARAMETERS

enumerator: IGR_HTEXTCOMPARE

The text comparison enumerator to close.

error: Pointer to Error_Control_Block

Contains any error text.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_RETURN_CODE IGR_Text_Compare_Close(

IGR_HTEXTCOMPARE enumerator,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 315/1268 -

SAMPLE CODE

C++

1 #include <DocumentFilters.h>

2 #include <string.h>

3 #include <string>

5 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

7 int main(int argc, char **argv)

8 {

9 Instance_Status_Block isb = {0};

10 Error_Control_Block ecb = {0};

11 IGR_LONG caps, type, pageCount = 0;

12 IGR_HDOC doc1_handle = 0, doc2_handle = 0;

13 IGR_HPAGE doc1_page1_handle = 0, doc2_page1_handle = 0;

14 IGR_HTEXTCOMPARE compare = 0;

16 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

17 Init_Instance(0, ".", &isb, &df, &ecb);

19 if ((res = IGR_Open_File_Ex(UCS2(u"original.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&doc1_handle, &ecb)) == IGR_OK

20 && (res = IGR_Open_File_Ex(UCS2(u"revised.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&doc2_handle, &ecb)) == IGR_OK)

21 {

22 IGR_Text_Compare_Settings settings = { sizeof(IGR_Text_Compare_Settings) };

23 IGR_Text_Compare_Document_Source doc1_source = { sizeof(IGR_Text_Compare_Document_Source) };

24 IGR_Text_Compare_Document_Source doc2_source = { sizeof(IGR_Text_Compare_Document_Source) };

25 IGR_Compare_Documents_Difference diff = { sizeof(IGR_Compare_Documents_Difference) };

27 doc1_source.doc_handle = doc1;

28 doc1_source.doc_first_page = 0;

30 doc2_source.doc_handle = doc2;

31 doc2.doc_first_page = 0;

33 if ((ret = IGR_Text_Compare_Documents(&doc1_source, &doc2_source, &settings, &compare, &ecb)) ==

IGR_OK)

34 {

35 while (IGR_Text_Compare_Next(compare, &diff, &ecb) == IGR_OK)

36 {

37 // ... work with diff object

39 IGR_Text_Compare_Difference_Dispose(&diff, &ecb);

40 }

42 IGR_Text_Compare_Close(compare, &ecb);

43 }

44 }

46 if (doc1_handle)

47 IGR_Close_File(doc1_handle, &ecb);

48 if (doc2_handle)

49 IGR_Close_File(doc2_handle, &ecb);

51 return 0;

52 }

Document Filters Implementation Guide 2.2.2 Functions

- 316/1268 -

SEE ALSO

IGR_Text_Compare_Documents

IGR_Text_Compare_Elements

IGR_Text_Compare_Pages

•

Document Filters Implementation Guide 2.2.2 Functions

- 317/1268 -

IGR_Text_Compare_Difference_Dispose

Disposes of a dierence result returned by the text comparison enumerator.

PROTOTYPE

C/C++

PARAMETERS

result: Pointer to IGR_Compare_Documents_Difference

The dierence result to dispose of.

error: Pointer to Error_Control_Block

Contains any error text.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_RETURN_CODE IGR_Text_Compare_Difference_Dispose(

struct IGR_Compare_Documents_Difference* result,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 318/1268 -

SAMPLE CODE

C++

1 #include <DocumentFilters.h>

2 #include <string.h>

3 #include <string>

5 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

7 int main(int argc, char **argv)

8 {

9 Instance_Status_Block isb = {0};

10 Error_Control_Block ecb = {0};

11 IGR_LONG caps, type, pageCount = 0;

12 IGR_HDOC doc1_handle = 0, doc2_handle = 0;

13 IGR_HPAGE doc1_page1_handle = 0, doc2_page1_handle = 0;

14 IGR_HTEXTCOMPARE compare = 0;

16 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

17 Init_Instance(0, ".", &isb, &df, &ecb);

19 if ((res = IGR_Open_File_Ex(UCS2(u"original.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&doc1_handle, &ecb)) == IGR_OK

20 && (res = IGR_Open_File_Ex(UCS2(u"revised.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&doc2_handle, &ecb)) == IGR_OK)

21 {

22 IGR_Text_Compare_Settings settings = { sizeof(IGR_Text_Compare_Settings) };

23 IGR_Text_Compare_Document_Source doc1_source = { sizeof(IGR_Text_Compare_Document_Source) };

24 IGR_Text_Compare_Document_Source doc2_source = { sizeof(IGR_Text_Compare_Document_Source) };

25 IGR_Compare_Documents_Difference diff = { sizeof(IGR_Compare_Documents_Difference) };

27 doc1_source.doc_handle = doc1;

28 doc1_source.doc_first_page = 0;

30 doc2_source.doc_handle = doc2;

31 doc2.doc_first_page = 0;

33 if ((ret = IGR_Text_Compare_Documents(&doc1_source, &doc2_source, &settings, &compare, &ecb)) ==

IGR_OK)

34 {

35 while (IGR_Text_Compare_Next(compare, &diff, &ecb) == IGR_OK)

36 {

37 // ... work with diff object

39 IGR_Text_Compare_Difference_Dispose(&diff, &ecb);

40 }

42 IGR_Text_Compare_Close(compare, &ecb);

43 }

44 }

46 if (doc1_handle)

47 IGR_Close_File(doc1_handle, &ecb);

48 if (doc2_handle)

49 IGR_Close_File(doc2_handle, &ecb);

51 return 0;

52 }

Document Filters Implementation Guide 2.2.2 Functions

- 319/1268 -

SEE ALSO

IGR_Text_Compare_Documents

IGR_Text_Compare_Pages

IGR_Text_Compare_Elements

IGR_Compare_Documents_Dierence data type

•

Document Filters Implementation Guide 2.2.2 Functions

- 320/1268 -

IGR_Text_Compare_Documents

Compares two documents and returns an enumerator for iterating through the dierences.

PROTOTYPE

C/C++

PARAMETERS

doc1: Pointer to IGR_Text_Compare_Document_Source

The rst document to compare.

doc2: Pointer to IGR_Text_Compare_Document_Source

The second document to compare.

settings: Pointer to IGR_Text_Compare_Settings

Settings for text comparison.

enumerator: Pointer to IGR_HTEXTCOMPARE

Pointer to store the enumerator for iterating through dierences.

error: Pointer to Error_Control_Block

Contains any error text.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_RETURN_CODE IGR_Text_Compare_Documents(

const struct IGR_Text_Compare_Document_Source* doc1,

const struct IGR_Text_Compare_Document_Source* doc2,

const struct IGR_Text_Compare_Settings* settings,

IGR_HTEXTCOMPARE* enumerator,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 321/1268 -

SAMPLE CODE

C++

1 #include <DocumentFilters.h>

2 #include <string.h>

3 #include <string>

5 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

7 int main(int argc, char **argv)

8 {

9 Instance_Status_Block isb = {0};

10 Error_Control_Block ecb = {0};

11 IGR_LONG caps, type, pageCount = 0;

12 IGR_HDOC doc1_handle = 0, doc2_handle = 0;

13 IGR_HPAGE doc1_page1_handle = 0, doc2_page1_handle = 0;

14 IGR_HTEXTCOMPARE compare = 0;

16 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

17 Init_Instance(0, ".", &isb, &df, &ecb);

19 if ((res = IGR_Open_File_Ex(UCS2(u"original.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&doc1_handle, &ecb)) == IGR_OK

20 && (res = IGR_Open_File_Ex(UCS2(u"revised.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&doc2_handle, &ecb)) == IGR_OK)

21 {

22 IGR_Text_Compare_Settings settings = { sizeof(IGR_Text_Compare_Settings) };

23 IGR_Text_Compare_Document_Source doc1_source = { sizeof(IGR_Text_Compare_Document_Source) };

24 IGR_Text_Compare_Document_Source doc2_source = { sizeof(IGR_Text_Compare_Document_Source) };

25 IGR_Compare_Documents_Difference diff = { sizeof(IGR_Compare_Documents_Difference) };

27 doc1_source.doc_handle = doc1;

28 doc1_source.doc_first_page = 0;

30 doc2_source.doc_handle = doc2;

31 doc2.doc_first_page = 0;

33 if ((ret = IGR_Text_Compare_Documents(&doc1_source, &doc2_source, &settings, &compare, &ecb)) ==

IGR_OK)

34 {

35 while (IGR_Text_Compare_Next(compare, &diff, &ecb) == IGR_OK)

36 {

37 // ... work with diff object

39 IGR_Text_Compare_Difference_Dispose(&diff, &ecb);

40 }

42 IGR_Text_Compare_Close(compare, &ecb);

43 }

44 }

46 if (doc1_handle)

47 IGR_Close_File(doc1_handle, &ecb);

48 if (doc2_handle)

49 IGR_Close_File(doc2_handle, &ecb);

51 return 0;

52 }

Document Filters Implementation Guide 2.2.2 Functions

- 322/1268 -

SEE ALSO

IGR_Text_Compare_Close

IGR_Text_Compare_Dierence_Dispose

IGR_Text_Compare_Elements

IGR_Text_Compare_Next

IGR_Text_Compare_Pages

IGR_Text_Compare_Document_Source data type

IGR_Text_Compare_Settings data type

•

Document Filters Implementation Guide 2.2.2 Functions

- 323/1268 -

IGR_Text_Compare_Elements

Compares elements within pages of documents and returns an enumerator for iterating through the

dierences.

PROTOTYPE

C/C++

PARAMETERS

page1: IGR_HPAGE

The rst page containing elements to compare.

page1_ele_root: Pointer to IGR_Page_Element

The root element of the rst page to start comparison.

page2: IGR_HPAGE

The second page containing elements to compare.

page2_ele_root: Pointer to IGR_Page_Element

The root element of the second page to start comparison.

settings: Pointer to IGR_Text_Compare_Settings

Settings for text comparison.

enumerator: Pointer to IGR_HTEXTCOMPARE

Pointer to store the enumerator for iterating through dierences.

error: Pointer to Error_Control_Block

Contains any error text.

IGR_RETURN_CODE IGR_Text_Compare_Elements(

IGR_HPAGE page1,

const struct IGR_Page_Element* page1_ele_root,

IGR_HPAGE page2,

const struct IGR_Page_Element* page2_ele_root,

const struct IGR_Text_Compare_Settings* settings,

IGR_HTEXTCOMPARE* enumerator,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 324/1268 -

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

Document Filters Implementation Guide 2.2.2 Functions

- 325/1268 -

SAMPLE CODE

C++

1 #include <DocumentFilters.h>

2 #include <string.h>

3 #include <string>

5 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

7 bool findSectionElement(IGR_HPAGE page, IGR_Page_Element& res)

8 {

9 struct helper_t

10 {

11 IGR_Page_Element result;

13 helper_t() : result()

14 {

15 }

16 static IGR_LONG CALLBACK cb(IGR_HPAGE page, const struct IGR_Page_Element* item, void* context)

17 {

18 if (item->type == IGR_PAGE_ELEMENT_TYPE_SECTION)

19 {

20 static_cast<helper_t*>(context)->result = *item;

21 return IGR_NO_MORE;

22 }

23 return IGR_OK;

24 }

25 };

27 Error_Control_Block ecb = { 0 };

28 helper_t h;

30 if (IGR_Enum_Page_Elements(page, NULL, 0, 0xffff, helper_t::cb, &h, &ecb) == IGR_OK)

31 {

32 res = h.result;

33 return true;

34 }

35 return false;

36 }

38 int main(int argc, char **argv)

39 {

40 Instance_Status_Block isb = {0};

41 Error_Control_Block ecb = {0};

42 IGR_SHORT df;

43 IGR_LONG caps, type, pageCount = 0;

44 IGR_HDOC doc1_handle = 0, doc2_handle = 0;

45 IGR_HPAGE doc1_page1_handle = 0, doc2_page1_handle = 0;

46 IGR_HTEXTCOMPARE compare = 0;

47 IGR_Page_Element doc1_page1_root = { sizeof(IGR_Page_Element) };

48 IGR_Page_Element doc2_page1_root = { sizeof(IGR_Page_Element) };

50 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

51 Init_Instance(0, ".", &isb, &df, &ecb);

53 if ((res = IGR_Open_File_Ex(UCS2(u"original.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&doc1_handle, &ecb)) == IGR_OK

54 && (res = IGR_Open_File_Ex(UCS2(u"revised.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&doc2_handle, &ecb)) == IGR_OK

Document Filters Implementation Guide 2.2.2 Functions

- 326/1268 -

SEE ALSO

IGR_Text_Compare_Close

IGR_Text_Compare_Dierence_Dispose

IGR_Text_Compare_Documents

IGR_Text_Compare_Next

IGR_Text_Compare_Pages

IGR_Text_Compare_Settings data type

IGR_Page_Element data type

55 && (res = IGR_Open_Page(doc1_handle, 0, &doc1_page1_handle, &ecb)) == IGR_OK

56 && (res = IGR_Open_Page(doc2_handle, 0, &doc2_page1_handle, &ecb)) == IGR_OK

57 && findSectionElement(doc1_page1_handle, doc1_page1_root)

58 && findSectionElement(doc2_page1_handle, doc2_page1_root))

60 {

61 IGR_Text_Compare_Settings settings = { sizeof(IGR_Text_Compare_Settings) };

62 IGR_Compare_Documents_Difference diff = { sizeof(IGR_Compare_Documents_Difference) };

64 if ((ret = IGR_Text_Compare_Elements(doc1_page1_handle, &doc1_page1_root, doc2_page1_handle,

&doc2_page1_root, &settings, &compare, &ecb)) == IGR_OK)

65 {

66 while (IGR_Text_Compare_Next(compare, &diff, &ecb) == IGR_OK)

67 {

68 // ... work with diff object

70 IGR_Text_Compare_Difference_Dispose(&diff, &ecb);

71 }

73 IGR_Text_Compare_Close(compare, &ecb);

74 }

75 }

77 if (doc1_page1_handle)

78 IGR_Close_Page(doc1_page1_handle, &ecb);

79 if (doc2_page1_handle)

80 IGR_Close_Page(doc2_page1_handle, &ecb);

81 if (doc1_handle)

82 IGR_Close_File(doc1_handle, &ecb);

83 if (doc2_handle)

84 IGR_Close_File(doc2_handle, &ecb);

85 return 0;

86 }

•

Document Filters Implementation Guide 2.2.2 Functions

- 327/1268 -

IGR_Text_Compare_Next

Retrieves the next dierence from the text comparison enumerator.

PROTOTYPE

C/C++

PARAMETERS

enumerator: IGR_HTEXTCOMPARE

The text comparison enumerator.

result: Pointer to IGR_Compare_Documents_Difference

Pointer to store the next dierence.

error: Pointer to Error_Control_Block

Contains any error text.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

IGR_RETURN_CODE IGR_Text_Compare_Next(

IGR_HTEXTCOMPARE enumerator,

struct IGR_Compare_Documents_Difference* result,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 328/1268 -

SAMPLE CODE

C++

1 #include <DocumentFilters.h>

2 #include <string.h>

3 #include <string>

5 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

7 int main(int argc, char **argv)

8 {

9 Instance_Status_Block isb = {0};

10 Error_Control_Block ecb = {0};

11 IGR_LONG caps, type, pageCount = 0;

12 IGR_HDOC doc1_handle = 0, doc2_handle = 0;

13 IGR_HPAGE doc1_page1_handle = 0, doc2_page1_handle = 0;

14 IGR_HTEXTCOMPARE compare = 0;

16 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

17 Init_Instance(0, ".", &isb, &df, &ecb);

19 if ((res = IGR_Open_File_Ex(UCS2(u"original.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&doc1_handle, &ecb)) == IGR_OK

20 && (res = IGR_Open_File_Ex(UCS2(u"revised.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&doc2_handle, &ecb)) == IGR_OK)

21 {

22 IGR_Text_Compare_Settings settings = { sizeof(IGR_Text_Compare_Settings) };

23 IGR_Text_Compare_Document_Source doc1_source = { sizeof(IGR_Text_Compare_Document_Source) };

24 IGR_Text_Compare_Document_Source doc2_source = { sizeof(IGR_Text_Compare_Document_Source) };

25 IGR_Compare_Documents_Difference diff = { sizeof(IGR_Compare_Documents_Difference) };

27 doc1_source.doc_handle = doc1;

28 doc1_source.doc_first_page = 0;

30 doc2_source.doc_handle = doc2;

31 doc2.doc_first_page = 0;

33 if ((ret = IGR_Text_Compare_Documents(&doc1_source, &doc2_source, &settings, &compare, &ecb)) ==

IGR_OK)

34 {

35 while (IGR_Text_Compare_Next(compare, &diff, &ecb) == IGR_OK)

36 {

37 // ... work with diff object

39 IGR_Text_Compare_Difference_Dispose(&diff, &ecb);

40 }

42 IGR_Text_Compare_Close(compare, &ecb);

43 }

44 }

46 if (doc1_handle)

47 IGR_Close_File(doc1_handle, &ecb);

48 if (doc2_handle)

49 IGR_Close_File(doc2_handle, &ecb);

51 return 0;

52 }

Document Filters Implementation Guide 2.2.2 Functions

- 329/1268 -

SEE ALSO

IGR_Text_Compare_Documents

IGR_Text_Compare_Pages

IGR_Text_Compare_Elements

IGR_Compare_Documents_Dierence

•

Document Filters Implementation Guide 2.2.2 Functions

- 330/1268 -

IGR_Text_Compare_Pages

Compares two pages within documents and returns an enumerator for iterating through the dierences.

PROTOTYPE

C/C++

PARAMETERS

page1: IGR_HPAGE

The rst page to compare.

page1_margins: Pointer to IGR_FRect

The margins of the rst page.

page2: IGR_HPAGE

The second page to compare.

page2_margins: Pointer to IGR_FRect

The margins of the second page.

settings: Pointer to IGR_Text_Compare_Settings

Settings for text comparison.

enumerator: Pointer to IGR_HTEXTCOMPARE

Pointer to store the enumerator for iterating through dierences.

error: Pointer to Error_Control_Block

Contains any error text.

IGR_RETURN_CODE IGR_Text_Compare_Pages(

IGR_HPAGE page1,

const struct IGR_FRect* page1_margins,

IGR_HPAGE page2,

const struct IGR_FRect* page2_margins,

const struct IGR_Text_Compare_Settings* settings,

IGR_HTEXTCOMPARE* enumerator,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 331/1268 -

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

Document Filters Implementation Guide 2.2.2 Functions

- 332/1268 -

SAMPLE CODE

C++

SEE ALSO

IGR_Text_Compare_Close

1 #include <DocumentFilters.h>

2 #include <string.h>

3 #include <string>

5 #define UCS2(src) reinterpret_cast<const IGR_UCS2 *>(std::u16string(src).c_str())

7 int main(int argc, char **argv)

8 {

9 Instance_Status_Block isb = {0};

10 Error_Control_Block ecb = {0};

11 IGR_SHORT df;

12 IGR_LONG caps, type, pageCount = 0;

13 IGR_HDOC doc1_handle = 0, doc2_handle = 0;

14 IGR_HPAGE doc1_page1_handle = 0, doc2_page1_handle = 0;

15 IGR_HTEXTCOMPARE compare = 0;

17 strncpy(isb.Licensee_ID1, "License Code", sizeof(isb.Licensee_ID1) - 1);

18 Init_Instance(0, ".", &isb, &df, &ecb);

20 if ((res = IGR_Open_File_Ex(UCS2(u"original.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&doc1_handle, &ecb)) == IGR_OK

21 && (res = IGR_Open_File_Ex(UCS2(u"revised.doc"), IGR_FORMAT_IMAGE, UCS2(u""), &caps, &type,

&doc2_handle, &ecb)) == IGR_OK

22 && (res = IGR_Open_Page(doc1_handle, 0, &doc1_page1_handle, &ecb)) == IGR_OK

23 && (res = IGR_Open_Page(doc2_handle, 0, &doc2_page1_handle, &ecb)) == IGR_OK)

24 {

25 IGR_Text_Compare_Settings settings = { sizeof(IGR_Text_Compare_Settings) };

26 IGR_Compare_Documents_Difference diff = { sizeof(IGR_Compare_Documents_Difference) };

28 if ((ret = IGR_Text_Compare_Pages(doc1_page1_handle, nullptr, doc2_page1_handle, nullptr,

&settings, &compare, &ecb)) == IGR_OK)

29 {

30 while (IGR_Text_Compare_Next(compare, &diff, &ecb) == IGR_OK)

31 {

32 // ... work with diff object

34 IGR_Text_Compare_Difference_Dispose(&diff, &ecb);

35 }

37 IGR_Text_Compare_Close(compare, &ecb);

38 }

39 }

41 if (doc1_page1_handle)

42 IGR_Close_Page(doc1_page1_handle, &ecb);

43 if (doc2_page1_handle)

44 IGR_Close_Page(doc2_page1_handle, &ecb);

45 if (doc1_handle)

46 IGR_Close_File(doc1_handle, &ecb);

47 if (doc2_handle)

48 IGR_Close_File(doc2_handle, &ecb);

49 return 0;

50 }

•

Document Filters Implementation Guide 2.2.2 Functions

- 333/1268 -

IGR_Text_Compare_Dierence_Dispose

IGR_Text_Compare_Documents

IGR_Text_Compare_Elements

IGR_Text_Compare_Next

IGR_Text_Compare_Settings data type

IGR_FRect data type

•

Document Filters Implementation Guide 2.2.2 Functions

- 334/1268 -

IGR_Text_Compare_Reset

Resets the text comparison enumerator to its initial state.

PROTOTYPE

C/C++

PARAMETERS

enumerator: IGR_HTEXTCOMPARE

The text comparison enumerator to reset.

error: Pointer to Error_Control_Block

Contains any error text.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

SEE ALSO

IGR_RETURN_CODE IGR_Text_Compare_Reset(

IGR_HTEXTCOMPARE enumerator,

Error_Control_Block* error

)

Document Filters Implementation Guide 2.2.2 Functions

- 335/1268 -

UTF8_to_Widechar

UTF8_to_Widechar converts a UTF-8 string into a UCS2 string.

PROTOTYPE

C/C++

PARAMETERS

source: Pointer to char

Contains a NULL terminated UTF-8 string.

buffer: Pointer to IGR_UCS2

Pointer to a buer that will hold the converted text.

bufferSize: IGR_LONG

Indicates the size of the buer, the system will copy up to this size including the NULL.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

void UTF8_to_Widechar(

const char* source,

IGR_UCS2* buffer,

IGR_LONG bufferSize

)

Document Filters Implementation Guide 2.2.2 Functions

- 336/1268 -

UTF8_to_Widechar_Ex

UTF8_to_Widechar converts a UTF-8 string into a UCS2 string.

PROTOTYPE

C/C++

PARAMETERS

source: Pointer to char

Contains a NULL terminated UTF-8 string.

sourceLen: IGR_LONG

Indicate the size of the buer pointed to by source , in bytes.

buffer: Pointer to IGR_UCS2

Pointer to a buer that will hold the converted text.

bufferSize: IGR_LONG

Indicates the size of the buer, the system will copy up to this size including the NULL.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

void UTF8_to_Widechar_Ex(

const char* source,

IGR_LONG sourceLen,

IGR_UCS2* buffer,

IGR_LONG bufferSize

)

Document Filters Implementation Guide 2.2.2 Functions

- 337/1268 -

Widechar_to_UTF8

Widechar_to_UTF8 converts a UCS2 string into UTF-8.

PROTOTYPE

C/C++

PARAMETERS

source: Pointer to IGR_UCS2

Contains a NULL terminated UCS2 string.

buffer: Pointer to char

Pointer to a buer that will hold the converted text.

bufferSize: IGR_LONG

Indicates the size of the buer, the system will copy up to this size including the NULL.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

void Widechar_to_UTF8(

const IGR_UCS2* source,

char* buffer,

IGR_LONG bufferSize

)

Document Filters Implementation Guide 2.2.2 Functions

- 338/1268 -

Widechar_to_UTF8_Ex

Widechar_to_UTF8 converts a UCS2 string into UTF-8

PROTOTYPE

C/C++

PARAMETERS

source: Pointer to IGR_UCS2

Contains a NULL terminated UCS2 string.

sourceLen: IGR_LONG

Indicate the size of the buer pointed to by source , in bytes.

buffer: Pointer to char

Pointer to a buer that will hold the converted text.

bufferSize: IGR_LONG

Indicates the size of the buer, the system will copy up to this size including the NULL.

RETURN VALUE

Success: IGR_LONG

Returns IGR_OK.

Failure: IGR_LONG

Returns one of the possible IGR_E error codes.

void Widechar_to_UTF8_Ex(

const IGR_UCS2* source,

IGR_LONG sourceLen,

char* buffer,

IGR_LONG bufferSize

)

Document Filters Implementation Guide 2.2.2 Functions

- 339/1268 -

2.2.3 Structures

Overview

Error_Control_Block data type Used to return error messages from the C API.

IGR_Annotation data type The IGR_Annotation structure is used by the

IGR_Get_Page_Annotations, IGR_Get_Page_Annotation_Long,

and IGR_Get_Page_Annotation_Str methods to return

information such as annotation type, position, and dimensions

for annotations on a given page.

IGR_Bookmark data type The IGR_Bookmark structure is used by the

IGR_Get_Bookmarks_Root method to return information about

the hierarchical navigation of a document.

IGR_CALLBACK data type The IGR_CALLBACK data type represents the function

signature of a callback from Document Filters.

IGR_Compare_Documents_Callback_Context

data type

Context structure for the callback functions used in document

comparison.

IGR_Compare_Documents_Dierence data

type

Structure representing a dierence between compared

documents.

IGR_Compare_Documents_Dierence_Item

data type

Structure representing a dierence item in a compared

document.

IGR_FRect data type Structure representing a rectangle with oating-point

coordinates. The coordinates are dened by the left, top, right,

and bottom edges.

IGR_Hyperlink data type The IGR_Hyperlink structure is used by the

IGR_Get_Page_Hyperlinks method to return information such

as position and destination for hyperlinks on a given page.

IGR_OPEN_CALLBACK data type The IGR_OPEN_CALLBACK data type represents the function

signature of a callback passed to IGR_Open_Ex.

IGR_Open_Callback_Action_Heartbeat data

type

The IGR_Open_Callback_Action_Heartbeat structure is the

payload argument for IGR_OPEN_CALLBACK when the action

argument is IGR_OPEN_CALLBACK_ACTION_HEARTBEAT.

Document Filters Implementation Guide 2.2.3 Structures

- 340/1268 -

IGR_Open_Callback_Action_Localize data
type
The IGR_Open_Callback_Action_Localize structure is the
payload argument for IGR_OPEN_CALLBACK when the action
argument is IGR_OPEN_CALLBACK_ACTION_LOCALIZE.
IGR_Open_Callback_Action_Password data
type
The IGR_Open_Callback_Action_Password structure is the
payload argument for IGR_OPEN_CALLBACK when the action
argument is IGR_OPEN_CALLBACK_ACTION_PASSWORD.
IGR_Open_DIB_Info data type Structure representing information about an open Device
Independent Bitmap (DIB). It includes details such as size,
ags, width, height, stride, pixel format, pixel data, palette
information, and palette count.
IGR_Page_Element data type IGR_Open_DIB_Info is used by IGR_Get_Page_Elements and
related functions to enumerate the elements on a page.
IGR_Page_Form_Element data type The IGR_Page_Form_Element structure is used by the 
IGR_Get_Page_Form_Elements method to return information
such as position, dimensions, and text about the form items
on a given page.
IGR_Page_Pixels data type The IGR_Page_Pixels structure is used by IGR_Get_Page_Pixels
to retrieve the pixel data for a given page.
IGR_Page_Word data type The IGR_Page_Word structure is used by the 
IGR_Get_Page_Words method to return information such as
position, dimensions, and text about the words on a given
page.
IGR_Rect data type The IGR_Rect structure is used to specify the position of a
rectangle.
IGR_Render_Page_Form_Values data type The IGR_Render_Page_Form_Values structure is used within 
IGR_Render_Page_Properties to specify new values for form
values.
IGR_Render_Page_Properties data type The IGR_Render_Page_Properties structure is used by the 
IGR_Render_Page_Ex method and provides additional
information for rendering a page to a canvas.
IGR_Render_Page_Redactions data type Structure representing a redaction area for rendering on a
page. The redaction area is dened by its position (x, y) and
Document Filters Implementation Guide 2.2.3 Structures
- 341/1268 -
© 2024 Hyland Software, Inc. and its ailiates. All rights reserved.

size (width, height), along with the color to use for rendering

and additional reserved data.

IGR_SRect data type Structure representing a rectangle with signed integer

coordinates. The coordinates are dened by the left, top, right,

and bottom edges.

IGR_Size data type The IGR_Size structure is used to specify the size of a

rectangle.

IGR_Stream data type The IGR_Stream data type allows for the creation of custom

input streams.

IGR_Suble_Info data type Used to return suble information from the

IGR_Get_Suble_Entry_Ex C API.

IGR_T_ACTION_GET_STREAM_PART data

type

When a second or later part of a multi-part archive is required

as part of processing an Extended Stream, a callback will

request this structure to be populated with a new stream

instance.

IGR_Text_Compare_Document_Source data

type

Structure representing a source document for text

comparison.

IGR_Text_Compare_Settings data type Settings structure for text comparison operations.

IGR_Writable_Stream data type Similar to the IGR_Stream, the IGR_Writable_Stream data type

allows for the creation of custom output streams. It’s

important to note, all methods must be implemented, not just

the Write.

Instance_Status_Block data type The Instance_Status_Block data type is a control block

returned by Init_Instance with information about the installed

Document Filters engine.

Document Filters Implementation Guide 2.2.3 Structures

- 342/1268 -

Error_Control_Block data type

Used to return error messages from the C API.

DEFINITIONS

C/C++

ADDITIONAL INFORMATION

The functions in the C API report errors via an error message control block. It consists of an array of 238

null-terminated ANSI characters, followed by a IGR_SHORT error code.

If the call worked, the error message is empty (the rst character is zero).

Any C API function that fails will populate the error message block with additional information.

struct Error_Control_Block

{

char Msg[238]; // Array of 238 null-terminated ANSI characters

IGR_SHORT MsgId; // error code

};

Document Filters Implementation Guide 2.2.3 Structures

- 343/1268 -

IGR_Annotation data type

The IGR_Annotation structure is used by the IGR_Get_Page_Annotations, IGR_Get_Page_Annotation_Long,

and IGR_Get_Page_Annotation_Str methods to return information such as annotation type, position, and

dimensions for annotations on a given page.

DEFINITIONS

C/C++

DETAILS

reserved: Pointer to VOID

Reserved data

type: IGR_LONG

Contains the annotation type, see IGR_ANNOTATION_TYPE.

flags: IGR_LONG

Is a bitmask containing specifying various characteristics of the annotation. See

IGR_ANNOTATION_FLAGS_TYPE.

x: IGR_LONG

Contains the X coordinate of the annotation’s bounding box in pixels.

y: IGR_LONG

Contains the Y coordinate of the annotation’s bounding box in pixels.

width: IGR_LONG

Contains the Width dimension of the annotation’s bounding box in pixels.

struct IGR_Annotation

{

const void* reserved;

IGR_LONG type;

IGR_LONG flags;

IGR_LONG x;

IGR_LONG y;

IGR_LONG width;

IGR_LONG height;

IGR_LONG reserved2[8];

};

Document Filters Implementation Guide 2.2.3 Structures

- 344/1268 -

height: IGR_LONG

Contains the Height dimension of the annotation’s bounding box in pixels.

reserved2: IGR_LONG[8]

Reserved for future use.

SEE ALSO

IGR_Get_Page_Annotations

IGR_Get_Page_Annotation_Count

IGR_Get_Page_Annotation_Long

IGR_Get_Page_Annotation_Str

•

Document Filters Implementation Guide 2.2.3 Structures

- 345/1268 -

IGR_Bookmark data type

The IGR_Bookmark structure is used by the IGR_Get_Bookmarks_Root method to return information

about the hierarchical navigation of a document.

DEFINITIONS

C/C++

DETAILS

reserved: Pointer to VOID

Reserved data

flags: Unicode String

Reserved for future use

title: Unicode String

Contains the Unicode String of the bookmark title

action: IGR_LONG

Contains the action that should be executed when a user selects the bookmark, can be one of:

IGR_BOOKMARK_ACTION_GOTO: 0

IGR_BOOKMARK_ACTION_LINK: 1

dest: Unicode String

struct IGR_Bookmark

{

const void* reserved;

IGR_LONG flags;

IGR_UCS2 title[255];

IGR_LONG action;

IGR_UCS2 dest[1024];

IGR_LONG level;

IGR_LONG fit;

IGR_LONG zoom;

IGR_LONG x;

IGR_LONG y;

IGR_LONG width;

IGR_LONG height;

IGR_LONG color;

IGR_LONG text_style;

IGR_LONG reserved2[8];

};

•

Document Filters Implementation Guide 2.2.3 Structures

- 346/1268 -

Contains the Unicode String of the bookmark destination

level: IGR_LONG

Contains the indent level of the bookmark in the navigation tree.

fit: IGR_LONG

Contains the zoom/t information which should be applied when a user selects the bookmark, can be

one of:

IGR_BOOKMARK_FIT_NONE : 0

IGR_BOOKMARK_FIT_BOTH : 1

IGR_BOOKMARK_FIT_WIDTH : 2

IGR_BOOKMARK_FIT_HEIGHT : 3

IGR_BOOKMARK_FIT_RECT : 4

zoom: IGR_LONG

Contains the zoom/t information which should be applied when a user selects the bookmark

x: IGR_LONG

Contains the X coordinate of the word in pixels.

y: IGR_LONG

Contains the Y coordinate of the word in pixels.

width: IGR_LONG

Contains the Width dimension of the word in pixels.

height: IGR_LONG

Contains the Height dimension of the word in pixels.

color: IGR_LONG

Contains the color that the bookmark should be shown

text_style: IGR_LONG

Contains any text styling that should be applied when showing the bookmark title; see Text Styles for

details.

•

Document Filters Implementation Guide 2.2.3 Structures

- 347/1268 -

reserved2: IGR_LONG[8]

Reserved for future use.

SEE ALSO

IGR_Get_Bookmark_Root

IGR_Get_Bookmark_First_Child

IGR_Get_Bookmark_Next_Child

•

Document Filters Implementation Guide 2.2.3 Structures

- 348/1268 -

IGR_CALLBACK data type

The IGR_CALLBACK data type represents the function signature of a callback from Document Filters.

DEFINITION

DETAILS

Function return type: IGR_LONG

User-set error code return value from function.

actionID: int

Represents the action or request type required of the API user’s code.

actionData: void pointer

A structure, dependant on the actionID, for the API user to populate with return data.

context: void pointer

A context pointer for the API user to utilise in any way.

ADDITIONAL INFORMATION

API User callback function signatures must match the signature of this typedef. The nature of actionID

and actionData are specic to the function generating the callback.The API user passes the context

pointer to Document Filters and it is returned when the callback is invoked. This can be employed by the

API user for any purpose.

SEE ALSO

IGR_Extend_Stream

typedef IGR_LONG (*IGR_CALLBACK)(int actionID, void* actionData, void* context);

•

Document Filters Implementation Guide 2.2.3 Structures

- 349/1268 -

IGR_Compare_Documents_Callback_Context data type

Context structure for the callback functions used in document comparison.

PROTOTYPE

C/C++

DETAILS

struct_size: IGR_ULONG

Size of this structure.

doc_index: IGR_ULONG

Index to the document being processed. Will be either 0 or 1.

doc_handle: IGR_LONG

The handle to the document being processed.

page_index: IGR_ULONG

The index to the current page being processed.

page_handle: IGR_HPAGE

The handle to the current page being processed.

struct IGR_Compare_Documents_Callback_Context

{

IGR_ULONG struct_size;

IGR_ULONG doc_index;

IGR_LONG doc_handle;

IGR_ULONG page_index;

IGR_HPAGE page_handle;

}

Document Filters Implementation Guide 2.2.3 Structures

- 350/1268 -

IGR_Compare_Documents_Difference data type

Structure representing a dierence between compared documents.

PROTOTYPE

C/C++

DETAILS

struct_size: IGR_ULONG

Size of this structure.

type: IGR_ULONG

The type of dierence.

doc_source: IGR_ULONG

The document where the dierence occurred.

original_page_index: IGR_ULONG

The page index in the original/left document of the rst item in the hit list.

revised_page_index: IGR_ULONG

The page index in the revised/right document of the rst item in the hit list.

item_count: IGR_ULONG

The number of dierence items pointed to by items.

items: Pointer to IGR_Compare_Documents_Difference_Item

Pointer to the rst rectangle.

struct IGR_Compare_Documents_Difference

{

IGR_ULONG struct_size;

IGR_ULONG type;

IGR_ULONG doc_source;

IGR_ULONG original_page_index;

IGR_ULONG revised_page_index;

IGR_ULONG item_count;

const struct IGR_Compare_Documents_Difference_Item* items;

}

Document Filters Implementation Guide 2.2.3 Structures

- 351/1268 -

IGR_Compare_Documents_Difference_Item data type

Structure representing a dierence item in a compared document.

PROTOTYPE

C/C++

DETAILS

struct_size: IGR_ULONG

Size of this structure.

page_index: IGR_ULONG

The index of the page that generated the di.

bounds: struct IGR_FRect

The bounding box of the word, in pixels.

text: Pointer to IGR_UCS2

Null terminated UCS2 text buer.

struct IGR_Compare_Documents_Difference_Item

{

IGR_ULONG struct_size;

IGR_ULONG page_index;

struct IGR_FRect bounds;

const IGR_UCS2* text;

}

Document Filters Implementation Guide 2.2.3 Structures

- 352/1268 -

IGR_FRect data type

Structure representing a rectangle with oating-point coordinates. The coordinates are dened by the

left, top, right, and bottom edges.

PROTOTYPE

C/C++

DETAILS

left: IGR_FLOAT

Left edge coordinate.

top: IGR_FLOAT

Top edge coordinate.

right: IGR_FLOAT

Right edge coordinate.

bottom: IGR_FLOAT

Bottom edge coordinate.

struct IGR_FRect

{

IGR_FLOAT left;

IGR_FLOAT top;

IGR_FLOAT right;

IGR_FLOAT bottom;

}

Document Filters Implementation Guide 2.2.3 Structures

- 353/1268 -

IGR_Hyperlink data type

The IGR_Hyperlink structure is used by the IGR_Get_Page_Hyperlinks method to return information such

as position and destination for hyperlinks on a given page.

DEFINITIONS

C/C++

DETAILS

reserved: Pointer to const void

Reserved for internal use

type: IGR_LONG

Indicates the type of action to execute when the link is clicked. Can be one or more of:

IGR_HYPERLINK_ACTION_GOTO : 0x1

IGR_HYPERLINK_ACTION_URI : 0x2

x: IGR_LONG

The x pixel position of the hyperlink

y: IGR_LONG

The y pixel position of the hyperlink

width: IGR_LONG

struct IGR_Hyperlink

{

const void * reserved;

IGR_LONG type;

IGR_LONG x;

IGR_LONG y;

IGR_LONG width;

IGR_LONG height;

IGR_LONG page_number;

IGR_LONG dest_fit;

IGR_LONG dest_zoom;

IGR_LONG dest_left;

IGR_LONG dest_top;

IGR_LONG dest_right;

IGR_LONG dest_bottom;

IGR_LONG flags;

IGR_LONG reserved2[8];

};

•

Document Filters Implementation Guide 2.2.3 Structures

- 354/1268 -

The width in pixels of the hyperlink

height: IGR_LONG

The height in pixels of the hyperlink

page_number: IGR_LONG

Indicates the page number to show if the type is IGR_HYPERLINK_ACTION_GOTO

dest_fit: IGR_LONG

Indicates the page t that should be applied when navigating to the destination. See PDF Reference for

additional information. One of:

IGR_HYPERLINK_FIT_XYZ : 0

IGR_HYPERLINK_FIT_FIT : 1

IGR_HYPERLINK_FIT_FITH : 2

IGR_HYPERLINK_FIT_FITV : 3

IGR_HYPERLINK_FIT_FITR : 4

IGR_HYPERLINK_FIT_FITB : 5

IGR_HYPERLINK_FIT_FITBH : 6

IGR_HYPERLINK_FIT_FITBV : 7

dest_zoom: IGR_LONG

Indicates the zoom factor to apply when navigating

dest_left: IGR_LONG

Indicates left position in pixels that should be applied when navigating to the destination, t value

specic

dest_top: IGR_LONG

Indicates top position in pixels that should be applied when navigating to the destination, t value

specic

dest_right: IGR_LONG

Indicates right position in pixels that should be applied when navigating to the destination, t value

specic

dest_bottom: IGR_LONG

•

Document Filters Implementation Guide 2.2.3 Structures

- 355/1268 -

Indicates bottom position in pixels that should be applied when navigating to the destination, t value

specic

flags: IGR_LONG

Flags specifying which destination coordinates are provided. See PDF Reference for additional

information. One or more of:

IGR_HYPERLINK_FLAGS_CHANGE_LEFT : 0x1

IGR_HYPERLINK_FLAGS_CHANGE_TOP : 0x2

IGR_HYPERLINK_FLAGS_CHANGE_ZOOM : 0x4

reserved2: IGR_LONG[8]

Reserved for future use.

SEE ALSO

IGR_Get_Page_Hyperlink_Count

IGR_Get_Page_Hyperlinks

IGR_Get_Page_Hyperlink_Str

•

Document Filters Implementation Guide 2.2.3 Structures

- 356/1268 -

IGR_OPEN_CALLBACK data type

The IGR_OPEN_CALLBACK data type represents the function signature of a callback passed to

IGR_Open_Ex.

DEFINITION

DETAILS

Function return type: IGR_LONG

User-set error code return value from function. The interpretation of the return value is dependent on the

type of action.

action: IGR_OPEN_CALLBACK_ACTION

The type of action that prompted the calling of the callback.

payload: Pointer to VOID

A structure that can be modied to provide information that will be used to process the document. The

type of the structure corresponds to the type of action, e.g. if action is

IGR_OPEN_CALLBACK_ACTION_HEARTBEAT, then payload is a IGR_Open_Callback_Action_Heartbeat

structure.

typedef IGR_LONG(IGR_EXPORT* IGR_OPEN_CALLBACK)(IGR_OPEN_CALLBACK_ACTION action, void* payload, void*

context);

Name Value Description

IGR_OPEN_CALLBACK_ACTION_HEARTBEAT 0 Species the type of

callback action is heartbeat.

IGR_OPEN_CALLBACK_ACTION_PASSWORD 1 Species the type of

callback action is password.

IGR_OPEN_CALLBACK_ACTION_LOCALIZE 2 Species the type of

callback action is localize.

action payload type

IGR_OPEN_CALLBACK_ACTION_HEARTBEAT IGR_Open_Callback_Action_Heartbeat

IGR_OPEN_CALLBACK_ACTION_PASSWORD IGR_Open_Callback_Action_Password

Document Filters Implementation Guide 2.2.3 Structures

- 357/1268 -

context: Pointer to VOID

Contextual information that was passed to IGR_Open_Ex as the callback_context argument.

ADDITIONAL INFORMATION

IGR_Open_Ex callback function signatures must match the signature of this typedef.

The API user passes the context pointer to Document Filters and it is returned when the callback is

invoked. This can be employed by the API user for any purpose.

Heartbeat

A heartbeat callback allows for the API user to request cancellation of an operation.

For example, an API user can measure the time of an API call and request cancellation if 30 seconds has

passed without completion.

A return value of anything other than IGR_OK from the callback function is considered a request for

cancellation.

If a Document Filters API call exits early without success because of cancellation, it will return with code

IGR_CANCELLED.

Password

A password callback allows for the API user to provide a password string that will be used to decode a

le, e.g. a password-protected archive.

It provides the API user with an id that species if the password being requested is for the top-level

document or for a suble, and allows the API user to ll a buer with a password string meant to satisfy

the password request.

The password callback for a specic id will repeatedly be called until the password is correct, allowing for

multiple passwords to be tried is succession, unless any of the following conditions is true: - Anything

other than IGR_OK is returned from the callback function - On return from the callback function, the

password string buer is empty - On return from the callback function, the password string buer is lled

with the same password string returned from the previous password callback

Localize

A localize callback allows for the API user to replace hard-coded English string values, specically in

metadata.

action payload type

IGR_OPEN_CALLBACK_ACTION_LOCALIZE IGR_Open_Callback_Action_Localize

Document Filters Implementation Guide 2.2.3 Structures

- 358/1268 -

It provides the API user with the original value, i.e. the hard-coded English value, and allows them to ll a

buer with its replacement.

The original value is used without replacement if any of the following conditions is true: - Anything other

than IGR_OK is returned from the callback function - The replacement buer is empty

SEE ALSO

IGR_Open_Ex

IGR_OPEN_CALLBACK_ACTION

IGR_Open_Callback_Action_Heartbeat

IGR_Open_Callback_Action_Password

IGR_Open_Callback_Action_Localize

•

Document Filters Implementation Guide 2.2.3 Structures

- 359/1268 -

IGR_Open_Callback_Action_Heartbeat data type

The IGR_Open_Callback_Action_Heartbeat structure is the payload argument for IGR_OPEN_CALLBACK

when the action argument is IGR_OPEN_CALLBACK_ACTION_HEARTBEAT.

DEFINITIONS

C/C++

DETAILS

struct_size: IGR_ULONG

Species the size of this structure in bytes. Used to determine available elds.

SEE ALSO

IGR_OPEN_CALLBACK

IGR_OPEN_CALLBACK_ACTION

IGR_Open_Ex

struct IGR_Open_Callback_Action_Heartbeat

{

IGR_ULONG struct_size;

};

•

Document Filters Implementation Guide 2.2.3 Structures

- 360/1268 -

IGR_Open_Callback_Action_Localize data type

The IGR_Open_Callback_Action_Localize structure is the payload argument for IGR_OPEN_CALLBACK

when the action argument is IGR_OPEN_CALLBACK_ACTION_LOCALIZE.

DEFINITIONS

C/C++

DETAILS

struct_size: IGR_ULONG

Species the size of this structure in bytes. Used to determine available elds.

string_id: IGR_ULONG

Indicates the string resource id for the string being localized. This number is xed, and will not change

across builds. See IGR_STRING_ID for a list of strings.

original: IGR_UCS2

The original unlocalized string.

replacement: IGR_UCS2

Buer where user populates the localized replacement value.

SEE ALSO

IGR_OPEN_CALLBACK

IGR_OPEN_CALLBACK_ACTION

IGR_Open_Ex

struct IGR_Open_Callback_Action_Localize

{

IGR_ULONG struct_size;

IGR_ULONG string_id;

IGR_UCS2 original[1024];

IGR_UCS2 replacement[1024];

};

•

Document Filters Implementation Guide 2.2.3 Structures

- 361/1268 -

IGR_Open_Callback_Action_Password data type

The IGR_Open_Callback_Action_Password structure is the payload argument for IGR_OPEN_CALLBACK

when the action argument is IGR_OPEN_CALLBACK_ACTION_PASSWORD.

DEFINITIONS

C/C++

DETAILS

struct_size: IGR_ULONG

Species the size of this structure in bytes. Used to determine available elds.

id: IGR_UCS2

Suble Id indicating which suble the password is requested for. May be empty to indicate the top level

document password is requested. Null terminated.

password: IGR_UCS2

Password string to be used to decode the requested document or suble. Must be null terminated.

SEE ALSO

IGR_OPEN_CALLBACK

IGR_OPEN_CALLBACK_ACTION

IGR_Open_Ex

struct IGR_Open_Callback_Action_Password

{

IGR_ULONG struct_size;

IGR_UCS2 id[4096];

IGR_UCS2 password[4096];

};

•

Document Filters Implementation Guide 2.2.3 Structures

- 362/1268 -

IGR_Open_DIB_Info data type

Structure representing information about an open Device Independent Bitmap (DIB). It includes details

such as size, ags, width, height, stride, pixel format, pixel data, palette information, and palette count.

PROTOTYPE

C/C++

DETAILS

struct_size: IGR_ULONG

Size of this structure, must be populated.

flags: IGR_ULONG

Flags indicating specic characteristics.

width: IGR_ULONG

Width of the bitmap, in pixels.

height: IGR_ULONG

Height of the bitmap, in pixels.

stride: IGR_ULONG

Number of bytes per scanline.

pixel_format: IGR_LONG

Format of the pixel data.

pixel_data: Pointer to void

struct IGR_Open_DIB_Info

{

IGR_ULONG struct_size;

IGR_ULONG flags;

IGR_ULONG width;

IGR_ULONG height;

IGR_ULONG stride;

IGR_LONG pixel_format;

const void* pixel_data;

IGR_ULONG pixel_data_size;

const IGR_LONG* palette;

IGR_ULONG palette_count;

}

Document Filters Implementation Guide 2.2.3 Structures

- 363/1268 -

Pointer to the raw pixel data.

pixel_data_size: IGR_ULONG

Size of the buer in pixel_data.

palette: Pointer to IGR_LONG

Pointer to the RGB palette information.

palette_count: IGR_ULONG

Number of colors in the palette.

Document Filters Implementation Guide 2.2.3 Structures

- 364/1268 -

IGR_Page_Element data type

IGR_Open_DIB_Info is used by IGR_Get_Page_Elements and related functions to enumerate the elements

on a page.

DEFINITIONS

C/C++

DETAILS

struct_size: IGR_ULONG

The size of the structure, in bytes. The caller must set this member to sizeof(IGR_Page_Element).

reserved: void

Reserved for future use.

type: IGR_PAGE_ELEMENT_TYPE

The type of element being enumerated. See IGR_PAGE_ELEMENT_TYPE for details.

depth: IGR_ULONG

The depth of the element in the element stack.

flags: IGR_ULONG

Reserved for future use.

pos: IGR_FRect

The absolute position of the element on the page, in points.

rotation: IGR_ULONG

struct IGR_Page_Element

{

IGR_ULONG struct_size;

const void* reserved;

IGR_PAGE_ELEMENT_TYPE type;

IGR_ULONG depth;

IGR_ULONG flags;

struct IGR_FRect pos;

IGR_ULONG rotation;

};

Document Filters Implementation Guide 2.2.3 Structures

- 365/1268 -

Any rotation applied to the element.

SEE ALSO

IGR_Get_Page_Elements

IGR_PAGE_ELEMENT_TYPE

•

Document Filters Implementation Guide 2.2.3 Structures

- 366/1268 -

IGR_Page_Form_Element data type

The IGR_Page_Form_Element structure is used by the IGR_Get_Page_Form_Elements method to return

information such as position, dimensions, and text about the form items on a given page.

DEFINITIONS

C/C++

DETAILS

reserved: Pointer to VOID

Reserved data

Contains the Unicode String of the form element name

x: IGR_LONG

Contains the X coordinate of the word in pixels.

y: IGR_LONG

Contains the Y coordinate of the word in pixels.

width: IGR_LONG

Contains the Width dimension of the word in pixels.

height: IGR_LONG

struct IGR_Page_Form_Element

{

const void* reserved;

IGR_UCS2 name[255];

IGR_LONG x;

IGR_LONG y;

IGR_LONG width;

IGR_LONG height;

IGR_LONG type;

IGR_LONG flags;

IGR_LONG fontSize;

IGR_LONG fontStyle;

IGR_LONG rotation;

IGR_LONG textAlignment;

IGR_LONG selectedItem;

IGR_LONG option_count;

IGR_LONG reserved2[8];

};

Document Filters Implementation Guide 2.2.3 Structures

- 367/1268 -

Contains the Height dimension of the word in pixels.

type: IGR_LONG

Contains the form element type, see IGR_PAGE_FORM_ELEMENT_TYPE.

flags: IGR_LONG

Is a bitmask containing any style information known about the form element. See

IGR_PAGE_FORM_ELEMENT_FLAG_TYPE.

fontSize: IGR_LONG

Contains the font size that should be used when presenting single or multiline text boxes.

fontStyle: IGR_LONG

Is a bitmask containing any style information known about the word; see Text Styles f or details.

rotation: IGR_LONG

Contains any rotation to apply to the element, in 90 degree increments.

textAlignment: IGR_LONG

Contains the text alignment that should be used when presenting single or multiline text boxes, one of:

IGR_TEXT_ALIGN_LEFT : 0

IGR_TEXT_ALIGN_RIGHT : 1

IGR_TEXT_ALIGN_CENTER : 2

selectedItem: IGR_LONG

Contains the index of the selected item for list boxes or dropdown boxes

option_count: IGR_LONG

Contains the number of items available for list boxes or dropdown boxes.

reserved2: IGR_LONG[8]

Reserved for future use.

SEE ALSO

IGR_Get_Page_Form_Elements

•

Document Filters Implementation Guide 2.2.3 Structures

- 368/1268 -

IGR_Page_Pixels data type

The IGR_Page_Pixels structure is used by IGR_Get_Page_Pixels to retrieve the pixel data for a given page.

DEFINITIONS

C/C++

DETAILS

width: IGR_ULONG

Number of pixel in one scan line of the extracted pixels.

height: IGR_ULONG

Number of scanlines extracted.

stride: IGR_ULONG

Oset, in bytes, between consecutive scan lines of the page. If the stride is positive, the scan lines are

top-down. If the stride is negative, the scan lines are bottom-up.

pixel_format: IGR_OPEN_BITMAP_PIXEL_TYPE

Integer that species the pixel format of the extracted pixels.

flags: IGR_OPEN_BITMAP_FLAGS_TYPE

Integer that species any pixel format ags

scanline0: Pointer

Pointer to the rst scan line extracted.

palette_count: IGR_ULONG

struct IGR_Page_Pixels

{

IGR_ULONG width;

IGR_ULONG height;

IGR_LONG stride;

IGR_OPEN_BITMAP_PIXEL_TYPE pixel_format;

IGR_OPEN_BITMAP_FLAGS_TYPE flags;

void* scanline0;

IGR_ULONG palette_count;

IGR_LONG palette[256];

void* reserved;

};

Document Filters Implementation Guide 2.2.3 Structures

- 369/1268 -

Indicates the number of palette colors extracted, if any

palette: Array of 256 IGR_LONG

Indicates the palette colors extracted

reserved: Pointer

Reserved for internal use

Document Filters Implementation Guide 2.2.3 Structures

- 370/1268 -

IGR_Page_Word data type

The IGR_Page_Word structure is used by the IGR_Get_Page_Words method to return information such as

position, dimensions, and text about the words on a given page.

DEFINITIONS

C/C++

DETAILS

X: Integer

Contains the X coordinate of the word in pixels.

Y: Integer

Contains the Y coordinate of the word in pixels.

Width: Integer

Contains the Width dimension of the word in pixels.

Height: Integer

Contains the Height dimension of the word in pixels.

Style: Integer

Is a bitmask containing any style information known about the word; see Text Styles for details.

Word: Unicode String

Contains the Unicode String of the word.

WordLength: Integer

Contains the length of the word pointed to by Word.

struct IGR_Page_Word

{

int x;

int y;

int width;

int height;

int style;

const IGR_UCS2 *word;

int wordLength;

int charOffset;

};

Document Filters Implementation Guide 2.2.3 Structures

- 371/1268 -

CharOffset: Integer

Contains the character oset of the word in the current page.

SEE ALSO

IGR_Get_Page_Words•

Document Filters Implementation Guide 2.2.3 Structures

- 372/1268 -

IGR_Rect data type

The IGR_Rect structure is used to specify the position of a rectangle.

DEFINITIONS

C/C++

DETAILS

left: IGR_ULONG

Left positional value of the rectangle

top: IGR_ULONG

Top positional value of the rectangle

right: IGR_ULONG

Right positional value of the rectangle

bottom: IGR_ULONG

Bottom positional value of the rectangle

struct IGR_Rect

{

IGR_ULONG left;

IGR_ULONG top;

IGR_ULONG right;

IGR_ULONG bottom;

};

Document Filters Implementation Guide 2.2.3 Structures

- 373/1268 -

IGR_Render_Page_Form_Values data type

The IGR_Render_Page_Form_Values structure is used within IGR_Render_Page_Properties to specify new

values for form values.

DEFINITIONS

C/C++

DETAILS

Name of the form value to update

value: Pointer to const IGR_UCS2

Value to be replaced. If the form element type is a multi-select list box this may contain the name of

multiple elements separated by space

selected: int

For elements of type Check Box or Radio Button a value of 1 sets the state to On and a value of 0 sets

the state to O

SEE ALSO

IGR_Render_Page_Ex

IGR_Render_Page_Properties

struct IGR_Render_Page_Form_Values

{

const IGR_UCS2 * name;

const IGR_UCS2 * value;

int selected;

};

•

Document Filters Implementation Guide 2.2.3 Structures

- 374/1268 -

IGR_Render_Page_Properties data type

The IGR_Render_Page_Properties structure is used by the IGR_Render_Page_Ex method and provides

additional information for rendering a page to a canvas.

DEFINITIONS

C/C++

DETAILS

struct_size: IGR_ULONG

Size of this structure used to determine available elds. Set to sizeof(IGR_Render_Page_Properties)

before using this structure.

form_value_count: IGR_ULONG

Number of elements in the form_values array

form_values: const struct IGR_Render_Page_Form_Values *

Pointer to an array of const struct IGR_Render_Page_Form_Values objects matching the length specied

in form_value_count

IGR_REDACT_FLAGS_TYPE: IGR_ULONG

Indicates the type of action to execute when redacting. Can be one or more of:

IGR_REDACT_FLAGS_DO_NOT_REDACT_TEXT : 0x1

IGR_REDACT_FLAGS_DO_NOT_REDACT_IMAGES : 0x2

IGR_REDACT_FLAGS_ALWAYS_RASTER : 0x4

IGR_REDACT_FLAGS_NEVER_RASTER : 0x8

IGR_REDACT_FLAGS_DO_NOT_DRAW_REGION : 0x10

struct IGR_Render_Page_Properties

{

IGR_ULONG struct_size;

IGR_ULONG form_value_count;

const struct IGR_Render_Page_Form_Values * form_values;

IGR_REDACT_FLAGS_TYPE redaction_flags;

IGR_ULONG redaction_count;

const struct IGR_Render_Page_Redactions * redactions;

struct IGR_Rect source_rect;

struct IGR_Rect dest_rect;

};

•

Document Filters Implementation Guide 2.2.3 Structures

- 375/1268 -

redaction_count: IGR_ULONG

Number of items in the redaction array

redactions: IGR_Render_Page_Redactions

Pointer to an array of const struct IGR_Render_Page_Redactions objects matching the length specied in

redaction_count

source_rect: IGR_Rect

Source rect measured in pixels

dest_rect: IGR_Rect

Destination rect measured in pixels

SEE ALSO

IGR_Render_Page_Ex

IGR_Render_Page_Form_Values

IGR_Render_Page_Redactions

IGR_Rect

•

Document Filters Implementation Guide 2.2.3 Structures

- 376/1268 -

IGR_Render_Page_Redactions data type

Structure representing a redaction area for rendering on a page. The redaction area is dened by its

position (x, y) and size (width, height), along with the color to use for rendering and additional reserved

data.

PROTOTYPE

C/C++

DETAILS

x: IGR_LONG

X-coordinate of the redaction area.

y: IGR_LONG

Y-coordinate of the redaction area.

width: IGR_LONG

Width of the redaction area.

height: IGR_LONG

Height of the redaction area.

color: IGR_ULONG

Color type used for rendering the redaction.

reserved: IGR_ULONG

Reserved data for future use.

struct IGR_Render_Page_Redactions

{

IGR_LONG x;

IGR_LONG y;

IGR_LONG width;

IGR_LONG height;

IGR_ULONG color;

IGR_ULONG reserved;

}

Document Filters Implementation Guide 2.2.3 Structures

- 377/1268 -

IGR_SRect data type

Structure representing a rectangle with signed integer coordinates. The coordinates are dened by the

left, top, right, and bottom edges.

PROTOTYPE

C/C++

DETAILS

left: IGR_LONG

Left edge coordinate.

top: IGR_LONG

Top edge coordinate.

right: IGR_LONG

Right edge coordinate.

bottom: IGR_LONG

Bottom edge coordinate.

struct IGR_SRect

{

IGR_LONG left;

IGR_LONG top;

IGR_LONG right;

IGR_LONG bottom;

}

Document Filters Implementation Guide 2.2.3 Structures

- 378/1268 -

IGR_Size data type

The IGR_Size structure is used to specify the size of a rectangle.

DEFINITIONS

C/C++

DETAILS

width: IGR_ULONG

The width of the item in pixels.

height: IGR_ULONG

The height of the item in pixels.

struct IGR_Size

{

IGR_ULONG width;

IGR_ULONG height;

};

Document Filters Implementation Guide 2.2.3 Structures

- 379/1268 -

IGR_Stream data type

The IGR_Stream data type allows for the creation of custom input streams.

DEFINITIONS

C/C++

DETAILS

Open: Function Pointer

A pointer to an application supplied function that will be called when Document Filters attempts to open

the document.

Read: Function Pointer

A pointer to an application supplied function that will be called when Document Filters attempts to read

the document.

Seek: Function Pointer

A pointer to an application supplied function that will be called when Document Filters attempts to seek

within the document.

Close: Function Pointer

A pointer to an application supplied function that will be called when Document Filters attempts to close

the document.

ADDITIONAL INFORMATION

The helper functions IGR_Make_Stream_From_File and IGR_Make_Stream_From_Memory are provided to

enable applications to easily instantiate streams from these common sources. The stream created by

these functions must be freed by the application calling the stream’s close function.

All functions above need to be implemented to stream documents from custom sources.

SEE ALSO

IGR_Open_Stream

struct IGR_Stream

{

unsigned long (CALLBACK* Open) (IGR_Stream*);

unsigned long (CALLBACK* Read) (IGR_Stream*, void *, unsigned long);

LONGLONG (CALLBACK* Seek) (IGR_Stream*, LONGLONG, unsigned long);

void (CALLBACK* Close) (IGR_Stream*);

};

•

Document Filters Implementation Guide 2.2.3 Structures

- 380/1268 -

IGR_Open_Stream_Ex•

Document Filters Implementation Guide 2.2.3 Structures

- 381/1268 -

IGR_Subfile_Info data type

Used to return suble information from the IGR_Get_Suble_Entry_Ex C API.

DEFINITIONS

C/C++

DETAILS

struct_size: IGR_ULONG

Indicate the size of this structure, must be populated

flags: IGR_ULONG

Bitmask of IGR_SUBFILE_INFO_FLAG_TYPE values.

id: IGR_UCS2*

Buer to be populated with the id, up to id_size characters.

id_size: IGR_ULONG

The number of IGR_UCS2 characters pointed to by id.

Buer to be populated with the name, up to name_size characters.

name_size: IGR_ULONG ;

The number of IGR_UCS2 characters pointed to by name.

comment: IGR_UCS2* ;

struct IGR_Subfile_Info

{

IGR_ULONG struct_size;

IGR_ULONG flags;

IGR_UCS2* id;

IGR_ULONG id_size;

IGR_UCS2* name;

IGR_ULONG name_size;

IGR_UCS2* comment;

IGR_ULONG comment_size;

IGR_ULONGLONG size;

IGR_ULONGLONG date;

};

Document Filters Implementation Guide 2.2.3 Structures

- 382/1268 -

Buer to be populated with the comment, up to comment_size characters.

comment_size: IGR_ULONG

The number of IGR_UCS2 characters pointed to by comment.

size: IGR_ULONGLONG

Contains the size in bytes of the sub-document.

date: IGR_ULONGLONG

Contains the date and time of the sub-document in FILETIME format.

ADDITIONAL INFORMATION

struct_size must be set to sizeof(IGR_Subfile_Info) .

The caller must assign a buer and it's size to retrieve strings for id, name and comments. To ignore any

of these value, assign it's buer to NULL and its size to 0.

SEE ALSO

IGR_Get_Suble_Entry_Ex•

Document Filters Implementation Guide 2.2.3 Structures

- 383/1268 -

IGR_T_ACTION_GET_STREAM_PART data type

When a second or later part of a multi-part archive is required as part of processing an Extended Stream,

a callback will request this structure to be populated with a new stream instance.

DEFINITION

C/C++

DETAILS

size: uint32_t

(in) The size of this structure in bytes.

partName: const wchar_t*

(in) The le name, if available (may be null).

partFullName: const wchar_t*

(in) The le name and path, if available (may be null).

partIndex: int

(in) The number of the le part required (guaranteed to be correct).

istr: IGR_Stream*

(out) User creates the requested stream and stores the pointer here.

ADDITIONAL INFORMATION

This structure is allocated by Document Filters and passed to the API user’s code through a callback with

actionID = IGR_ACTION_GET_STREAM_PART.The user should create a stream for the requested le part

and store a pointer to that stream in the istr member of the struct.

SEE ALSO

IGR_Extend_Stream

struct IGR_T_ACTION_GET_STREAM_PART

{

uint32_t size;

const wchar_t* partName;

const wchar_t* partFullName;

int partIndex;

IGR_Stream* istr;

};

•

Document Filters Implementation Guide 2.2.3 Structures

- 384/1268 -

IGR_Text_Compare_Document_Source data type

Structure representing a source document for text comparison.

PROTOTYPE

C/C++

DETAILS

struct_size: IGR_ULONG

Size of this structure.

doc_handle: IGR_LONG

The handle to an open document.

doc_first_page: IGR_ULONG

The index to the rst page to compare from document.

doc_page_count: IGR_ULONG

The number of pages from doc1_rst_page to compare.

doc_margins: struct IGR_FRect

The margins, in pts, to exclude from the comparison for document.

struct IGR_Text_Compare_Document_Source

{

IGR_ULONG struct_size;

IGR_LONG doc_handle;

IGR_ULONG doc_first_page;

IGR_ULONG doc_page_count;

struct IGR_FRect doc_margins;

}

Document Filters Implementation Guide 2.2.3 Structures

- 385/1268 -

IGR_Text_Compare_Settings data type

Settings structure for text comparison operations.

PROTOTYPE

C/C++

DETAILS

struct_size: IGR_ULONG

Size of this structure.

compare_type: IGR_ULONG

The type of comparison to perform.

flags: IGR_ULONG

Flags that control the comparison logic.

user_context: Pointer to void

Pointer to user supplied context that is passed as /context to each of the callbacks.

struct IGR_Text_Compare_Settings

{

IGR_ULONG struct_size;

IGR_ULONG compare_type;

IGR_ULONG flags;

void* user_context;

IGR_ULONG comparison_window;

IGR_ULONG comparison_overlap;

void* reserved1;

void* reserved2;

void* reserved3;

void* reserved4;

IGR_RETURN_CODE(CALLBACK* OpenPage) (void* context, const struct IGR_Compare_Documents_Callback_Context*

info, IGR_ULONG page_index, IGR_HPAGE* page_handle);

IGR_RETURN_CODE(CALLBACK* ClosePage) (void* context, const struct

IGR_Compare_Documents_Callback_Context* info, IGR_HPAGE page_handle);

IGR_RETURN_CODE(CALLBACK* GetPageMargins)(void* context, const struct

IGR_Compare_Documents_Callback_Context* info, struct IGR_FRect* margins);

IGR_RETURN_CODE(CALLBACK* GetPageArea)(void* context, const struct

IGR_Compare_Documents_Callback_Context* info, struct IGR_FRect* page_area);

IGR_RETURN_CODE(CALLBACK* GetNextPageIndex) (void* context, const struct

IGR_Compare_Documents_Callback_Context* info, IGR_ULONG* page_index);

IGR_RETURN_CODE(CALLBACK* HandleError) (void* context, const struct

IGR_Compare_Documents_Callback_Context* info, const Error_Control_Block* ecb);

}

Document Filters Implementation Guide 2.2.3 Structures

- 386/1268 -

comparison_window: IGR_ULONG

Reserved.

comparison_overlap: IGR_ULONG

Reserved.

reserved1: Pointer to void

Reserved for future use.

reserved2: Pointer to void

Reserved for future use.

reserved3: Pointer to void

Reserved for future use.

reserved4: Pointer to void

Reserved for future use.

OpenPage: Pointer to Callback

Optional callback that is called to provide when the page resource is required.

ClosePage: Pointer to Callback

Optional callback that is called to provide when the page resource can be destroyed.

GetPageMargins: Pointer to Callback

Optional callback that is called to provide the margins for a given page. User can modify the left, top,

right, margins of the page. Units are in pixels.

GetPageArea: Pointer to Callback

Optional callback that is called with the page area where text is to be died.

GetNextPageIndex: Pointer to Callback

Optional callback that is called to provide the next page number to process.

HandleError: Pointer to Callback

Optional callback that is called to when an error is encountered.

Document Filters Implementation Guide 2.2.3 Structures

- 387/1268 -

IGR_Writable_Stream data type

Similar to the IGR_Stream, the IGR_Writable_Stream data type allows for the creation of custom output

streams. It’s important to note, all methods must be implemented, not just the Write.

DEFINITIONS

C/C++

DETAILS

Base.Open: Function Pointer

A pointer to an application supplied function that will be called when Document Filters attempts to open

the document.

Base.Read: Function Pointer

A pointer to an application supplied function that will be called when Document Filters attempts to read

the document.

Base.Seek: Function Pointer

A pointer to an application supplied function that will be called when Document Filters attempts to seek

within the document.

Base.Close: Function Pointer

A pointer to an application supplied function that will be called when Document Filters attempts to close

the document.

Write: Function Pointer

A pointer to an application supplied function that will be called when Document Filters attempts to write

to the output.

ADDITIONAL INFORMATION

All functions above need to be implemented to stream to custom output sources.

SEE ALSO

IGR_Make_Output_Canvas_On

struct IGR_Writable_Stream

{

struct IGR_Stream Base;

unsigned long (CALLBACK* Write)(IGR_Writable_Stream* stream, void * buffer, unsigned long bufferSize);

};

•

Document Filters Implementation Guide 2.2.3 Structures

- 388/1268 -

Instance_Status_Block data type

The Instance_Status_Block data type is a control block returned by Init_Instance with information about

the installed Document Filters engine.

DEFINITIONS

C/C++

SEE ALSO

Init_Instance

struct Instance_Status_Block

{

char DLL_Version[16];

short Reserved;

short License_Type;

char Licensee_ID1[40];

char Licensee_ID2[40];

};

•

Document Filters Implementation Guide 2.2.3 Structures

- 389/1268 -

2.2.4 Constants

Overview

IGR_RETURN_CODE Indicates the success or failure of a call.

IGR_ANNOTATION_FLAGS_TYPE Contains the annotation ags.

IGR_ANNOTATION_TYPE Contains the annotation type.

IGR_BRUSH_STYLE Contains the brush types available when

calling IGR_Canvas_SetBrush or

Canvas.SetBrush .

IGR_CANVAS_TYPE Canvas Types specify the type of output

to create when rendering a page. They

are passed to the

IGR_Make_Output_Canvas and

DocumentFilters::MakeOutputCanvas

functions.

IGR_CAPABILITY Document Capabilities are a bitmask

representing the operations that may be

performed on a document.

IGR_CHAR_CODE These character codes are output by

Document Filters when using the

IGR_Get_Text function and

Extractor.GetText.

IGR_COMPARE_DOCUMENTS_COMPARE_TYPE Contains the list of document

comparison types.

IGR_COMPARE_DOCUMENTS_DIFFERENCE_SOURCE_TYPE Contains the list of comparison

dierence source types.

IGR_COMPARE_DOCUMENTS_DIFFERENCE_TYPE Contains the list of comparison

dierence types.

IGR_COMPARE_DOCUMENTS_FLAGS_TYPE Contains the list of comparison ags.

IGR_FILETYPE_CATEGORY

Document Filters Implementation Guide 2.2.4 Constants

- 390/1268 -

The File Type Category provides extra

classication of a le type. It is returned

by calls to IGR_Get_Format_Attribute.

IGR_FONT_STYLE These font styles are used with the

IGR_Canvas_SetFont method.

IGR_GET_PAGE_PIXELS_FLAGS_TYPE Contains the ags available when calling

IGR_Page_Get_Pixels .

IGR_OPEN_BITMAP_FLAGS_TYPE IGR_OPEN_BITMAP_FLAGS_TYPE is used

by IGR_Open_DIB_Info and

IGR_Open_DIB when creating a

Document Filters document from an

existing in-memory image.

IGR_OPEN_BITMAP_PIXEL_TYPE IGR_OPEN_BITMAP_PIXEL_TYPE is used

by IGR_Open_DIB_Info and

IGR_Open_DIB when creating a

Document Filters document from an

existing in-memory image; or

IGR_Get_Page_Pixels when accessing

pixels of a page.

IGR_OPEN_CALLBACK_ACTION IGR_OPEN_CALLBACK_ACTION is used by

IGR_OPEN_CALLBACK and IGR_Open_Ex

when opening a document for text

extraction or enumeration of sub-

documents.

IGR_OPEN_FLAGS Open Document Flags specify the type

of content that is to be retrieved from

the document. The ags are a bitwise

combination of the values below.

IGR_OPEN_FROM IGR_OPEN_FROM is used by

IGR_Open_Ex when opening a document

for text extraction or enumeration of

sub-documents.

IGR_PAGE_ELEMENT_TYPE Contains the list of form element types.

IGR_PAGE_FORM_ELEMENT_FLAG_TYPE Contains the form element type ags.

Document Filters Implementation Guide 2.2.4 Constants

- 391/1268 -

IGR_PAGE_FORM_ELEMENT_GET_TYPE Contains the options when requesting

form element data.

IGR_PAGE_FORM_ELEMENT_TYPE Contains the form element type ags.

IGR_PEN_STYLE Contains the pen types available when

calling IGR_Canvas_SetPen or

Canvas.SetPen .

IGR_STRING_ID Contains the list of strings that can be

localized.

IGR_SUBFILE_INFO_FLAG_TYPE Contains the suble ag information.

IGR_TEXT_STYLE Contains the text style types available

when calling IGR_Canvas_DrawText or

Canvas.DrawText .

Document Filters Implementation Guide 2.2.4 Constants

- 392/1268 -

Result Codes

SUCCESSFUL RESULT CODES

UNSUCCESSFUL RESULT CODES

Name Value

IGR_OK 0

IGR_NO_MORE 19

Name Value Description

IGR_E_OPEN_ERROR 1 Open error

IGR_E_WRONG_TYPE 2 Attempt to open le with wrong

type

IGR_E_IN_USE 3 File is locked

IGR_E_NOT_READABLE 4 File is not readable

IGR_E_PASSWORD 5 File is encrypted

IGR_E_NOT_FOUND 10 File not found

IGR_E_WRITE_ERROR 11 Unable to write le

IGR_E_NOT_VALID_FOR_THIS_CLASS 12 Operation is not valid for this type

of object

IGR_E_ERROR 13 General error

IGR_E_INVALID_HANDLE 14 Invalid handle

IGR_E_INVALID_POINTER 15 Invalid pointer

IGR_E_INVALID_PARAMETER 16 Invalid parameter

IGR_E_FILE_CORRUPT 17 Corrupt le

IGR_E_OUT_OF_MEMORY 20 Out of memory

IGR_E_BAD_ERROR 21 Bad error

IGR_E_WRONG_THREAD 22 Method called from wrong thread

Document Filters Implementation Guide 2.2.4 Constants

- 393/1268 -

Name Value Description

IGR_E_TOO_MANY_HANDLES 23 Too many open handles

IGR_E_FONTS_NOT_FOUND 24 Fonts not found

IGR_E_VERSION_MISMATCH 25 Version mismatch

IGR_E_ACTION_NOT_SUPPORTED 26 Action not supported

IGR_CANCELLED 27 Operation has been cancelled

Document Filters Implementation Guide 2.2.4 Constants

- 394/1268 -

IGR_ANNOTATION_FLAGS_TYPE

Name Value Description

IGR_ANNOTATION_FLAGS_INVISIBLE 0x001 Indicates the annotation

should not be displayed if

the annotation type is

unknown.

IGR_ANNOTATION_FLAGS_HIDDEN 0x002 Indicates the annotation

should not be displayed

nor printed nor allowed to

interact with the user.

IGR_ANNOTATION_FLAGS_PRINT 0x004 Indicates the annotation

should be printed when

the page is printed.

IGR_ANNOTATION_FLAGS_NOZOOM 0x008 Indicates the annotation’s

appearance should not be

scaled to match the

magnication of the page.

IGR_ANNOTATION_FLAGS_NOROTATE 0x010 Indicates the annotation’s

appearance should not be

rotated to match the

rotation of the page.

IGR_ANNOTATION_FLAGS_NOVIEW 0x020 Indicates the annotation

should not be displayed

nor allowed to interact

with the user.

IGR_ANNOTATION_FLAGS_READONLY 0x040 Indicates the annotation

should not be allowed to

interact with the user.

IGR_ANNOTATION_FLAGS_LOCKED 0x080 Indicates the annotation

should not be allowed to

be deleted and its

properties should not be

Document Filters Implementation Guide 2.2.4 Constants

- 395/1268 -

Name Value Description

allowed to be modied by

the user.

IGR_ANNOTATION_FLAGS_TOGGLENOVIEW 0x100 Indicates the

interpretation of the

annotation’s NoView ag

should be inverted for

certain events.

IGR_ANNOTATION_FLAGS_LOCKEDCONTENTS 0x200 Indicates the annotation’s

contents should not be

allowed to be modied by

the user.

Document Filters Implementation Guide 2.2.4 Constants

- 396/1268 -

IGR_ANNOTATION_TYPE

Name Value Description

IGR_ANNOTATION_UNKNOWN 0 Indicates the annotation type is

unknown.

IGR_ANNOTATION_TEXT 1 Indicates the annotation is a Text

annotation.

IGR_ANNOTATION_LINK 2 Indicates the annotation is a Link

annotation.

IGR_ANNOTATION_FREETEXT 3 Indicates the annotation is a Free

Text annotation.

IGR_ANNOTATION_LINE 4 Indicates the annotation is a Line

annotation.

IGR_ANNOTATION_SQUARE 5 Indicates the annotation is a

Square annotation

IGR_ANNOTATION_CIRCLE 6 Indicates the annotation is a Circle

annotation.

IGR_ANNOTATION_POLYGON 7 Indicates the annotation is a

Polygon annotation.

IGR_ANNOTATION_POLYLINE 8 Indicates the annotation is a

Polyline annotation.

IGR_ANNOTATION_HIGHLIGHT 9 Indicates the annotation is a

Highlight annotation.

IGR_ANNOTATION_UNDERLINE 10 Indicates the annotation is a

Underline annotation.

IGR_ANNOTATION_SQUIGGLE 11 Indicates the annotation is a

Squiggly-underline annotation.

IGR_ANNOTATION_STRIKEOUT 12 Indicates the annotation is a

Strikeout annotation.

IGR_ANNOTATION_STAMP 13

Document Filters Implementation Guide 2.2.4 Constants

- 397/1268 -

Name Value Description

Indicates the annotation is a

Rubber Stamp annotation.

IGR_ANNOTATION_CARET 14 Indicates the annotation is a Caret

annotation.

IGR_ANNOTATION_INK 15 Indicates the annotation is a Ink

annotation.

IGR_ANNOTATION_POPUP 16 Indicates the annotation is a Pop-

up annotation.

IGR_ANNOTATION_FILEATTACHMENT 17 Indicates the annotation is a File

Attachment annotation.

IGR_ANNOTATION_SOUND 18 Indicates the annotation is a Sound

annotation.

IGR_ANNOTATION_MOVIE 19 Indicates the annotation is a Movie

annotation.

IGR_ANNOTATION_WIDGET 20 Indicates the annotation is a

Widget annotation.

IGR_ANNOTATION_SCREEN 21 Indicates the annotation is a

Screen annotation.

IGR_ANNOTATION_PRINTERMARK 22 Indicates the annotation is a

Printer’s Mark annotation.

IGR_ANNOTATION_TRAPNET 23 Indicates the annotation is a Trap

Network annotation.

IGR_ANNOTATION_WATERMARK 24 Indicates the annotation is a

Watermark annotation.

IGR_ANNOTATION_3D 25 Indicates the annotation is a 3D

annotation.

IGR_ANNOTATION_BARCODE 26 Indicates the annotation is a

Barcode annotation.

Document Filters Implementation Guide 2.2.4 Constants

- 398/1268 -

Brush Styles

Name Value Description

IGR_BRUSH_NONE 0 Indicates that objects should not be lled with the

brush.

IGR_BRUSH_SOLID 1 Indicates that objects should be lled with the

specied brush color.

Document Filters Implementation Guide 2.2.4 Constants

- 399/1268 -

Canvas Types

Canvas Types specify the type of output to create when rendering a page. They are passed to the

IGR_Make_Output_Canvas and DocumentFilters::MakeOutputCanvas functions.

Name Value Description

IGR_DEVICE_HTML 6 Create a single or multipage HTML5

IGR_DEVICE_IMAGE_BMP 4 Create a single BMP per page

IGR_DEVICE_IMAGE_BRK 17 Create a single or multipage Brooktrout

FAX

IGR_DEVICE_IMAGE_DCX 19 Create a single or multipage DCX

IGR_DEVICE_IMAGE_EPS 13 Create a single EPS (Encapsulated

PostScript) per page

IGR_DEVICE_IMAGE_GIF 21 Create a single GIF per page

IGR_DEVICE_IMAGE_JPEG2000 20 Create a single JPEG2000 per page

IGR_DEVICE_IMAGE_JPG 1 Create a single JPG per page

IGR_DEVICE_IMAGE_PBM 7 Create a single PBM per page

IGR_DEVICE_IMAGE_PCX 18 Create a single PCX per page

IGR_DEVICE_IMAGE_PDF 2 Create a single or multipage PDF

IGR_DEVICE_IMAGE_PGM 8 Create a single PGM per page

IGR_DEVICE_IMAGE_PNG 0 Create a single PNG per page

IGR_DEVICE_IMAGE_PPM 9 Create a single PPM per page

IGR_DEVICE_IMAGE_PS 14 Create a single or multipage PostScript

IGR_DEVICE_IMAGE_SVG 12 Create a single SVG per page

IGR_DEVICE_IMAGE_TGA 16 Create a single TGA per page

IGR_DEVICE_IMAGE_TIF 3 Create a single or multipage TIF

IGR_DEVICE_IMAGE_WEBP 10 Create a single WEBP per page

Document Filters Implementation Guide 2.2.4 Constants

- 400/1268 -

Name Value Description

IGR_DEVICE_IMAGE_WEBSAFE 15 Create a single image per page, where

the format is determined based on the

palette and number of colors.

IGR_DEVICE_IMAGE_XPS 11 Create a single or multipage XPS

IGR_DEVICE_JSON 22 Create a single or multipage structured

JSON

IGR_DEVICE_PDF 2 Create a single or multipage PDF (Alias

for IGR_DEVICE_IMAGE_PDF)

IGR_DEVICE_XML 5 Create a single or multipage structured

XML

Document Filters Implementation Guide 2.2.4 Constants

- 401/1268 -

Document capabilities

Document Capabilities are a bitmask representing the operations that may be performed on a

document.

Name Value Description

IGR_FILE_SUPPORTS_TEXT 1 The document contains text that may be

retrieved by calls to IGR_Get_Text.

IGR_FILE_SUPPORTS_SUBFILES 2 The document may contain sub-

documents that can be enumerated with

IGR_Get_Suble_Entry and extracted

with IGR_Extract_Suble

IGR_FILE_SUPPORTS_HDHTML 4 The document may be converted to

high-denition, preserving the document

layout, font colors, styles, tables, and

images.

Document Filters Implementation Guide 2.2.4 Constants

- 402/1268 -

Character codes

These character codes are output by Document Filters when using the IGR_Get_Text function and

Extractor.GetText.

**Note ** End of lines are always specied by character 13.

Character Value Description

1 Soft space

2 Reset normal Style

3 Start bold

4 Start italics

5 Start underlined

9 TAB

12 Page break

13 Line break

14 Paragraph break

15 Start of metadata

16 End of metadata

Document Filters Implementation Guide 2.2.4 Constants

- 403/1268 -

IGR_COMPARE_DOCUMENTS_COMPARE_TYPE

Name Value Description

IGR_COMPARE_DOCUMENTS_COMPARE_WORDS 0x0 Perform word-level

comparison.

Document Filters Implementation Guide 2.2.4 Constants

- 404/1268 -

IGR_COMPARE_DOCUMENTS_DIFFERENCE_SOURCE_TYPE

Name Value Description

IGR_COMPARE_DOCUMENTS_DIFFERENCE_SOURCE_ORIGINAL 0x0 Di was

generated

for the

original

document.

IGR_COMPARE_DOCUMENTS_DIFFERENCE_SOURCE_REVISED 0x1 Di was

generated

for the

revised

document.

IGR_COMPARE_DOCUMENTS_DIFFERENCE_SOURCE_BOTH 0x2 Di was

generated

against

both

documents.

Document Filters Implementation Guide 2.2.4 Constants

- 405/1268 -

IGR_COMPARE_DOCUMENTS_DIFFERENCE_TYPE

Name Value Description

IGR_COMPARE_DOCUMENTS_DIFFERENCE_EQUAL 0 Emitted when

IGR_COMPARE_DOCUMENTS_FLAGS_EQUALS

ag is set; indicates that the text appears in

both documents.

IGR_COMPARE_DOCUMENTS_DIFFERENCE_INSERT 1 Indicates that the text was inserted into the

revised document.

IGR_COMPARE_DOCUMENTS_DIFFERENCE_DELETE 2 Indicates that the text was deleted from the

original document.

IGR_COMPARE_DOCUMENTS_DIFFERENCE_FORMATTING 3 Indicates that formatting was changed.

IGR_COMPARE_DOCUMENTS_DIFFERENCE_NEXT_BATCH 0xFF Indicates that the comparer is about to pull

See Also

AnnotationAppearanceStreams

Hyland.DocumentFilters.Annotations.AppearanceStreams Appearance { get; set; }

AnnotationAppearanceStreams getAppearance() throws IGRException;

void setAppearance(AnnotationAppearanceStreams value) throws IGRException;

@property

def Appearance(self) -> AnnotationAppearanceStreams:

@property.setter

def Appearance(self, value: AnnotationAppearanceStreams)

[propget] HRESULT Appearance([out, retval] AnnotationAppearanceStreams* *result);

[propput] HRESULT Appearance([in] AnnotationAppearanceStreams* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 488/1268 -

ANNOTATION::BORDER PROPERTY

Indicates the border style of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationBorderStyle

See Also

AnnotationBorderStyle

Hyland.DocumentFilters.Annotations.BorderStyle Border { get; set; }

AnnotationBorderStyle getBorder() throws IGRException;

void setBorder(AnnotationBorderStyle value) throws IGRException;

@property

def Border(self) -> AnnotationBorderStyle:

@property.setter

def Border(self, value: AnnotationBorderStyle)

[propget] HRESULT Border([out, retval] AnnotationBorderStyle* *result);

[propput] HRESULT Border([in] AnnotationBorderStyle* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 489/1268 -

ANNOTATION::COLOR PROPERTY

Indicates the color of the annotation.Color used for the following purposes:

The background of the annotation’s icon when closed

The title bar of the annotation’s pop-up window

The border of a link annotation

.NET

JAVA

PYTHON

COM

Return Value

string

•

System.Drawing.Color Color { get; set; }

string getColor() throws IGRException;

void setColor(string value) throws IGRException;

@property

def Color(self) -> string:

@property.setter

def Color(self, value: string)

[propget] HRESULT Color([out, retval] BSTR *result);

[propput] HRESULT Color([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 490/1268 -

ANNOTATION::DATECREATED PROPERTY

Indicates the date the annotation was created.

.NET

JAVA

PYTHON

COM

Return Value

date

System.DateTime DateCreated { get; set; }

java.util.Date getDateCreated() throws IGRException;

void setDateCreated(java.util.Date value) throws IGRException;

@property

def DateCreated(self) -> datetime:

@property.setter

def DateCreated(self, value: datetime)

[propget] HRESULT DateCreated([out, retval] date* *result);

[propput] HRESULT DateCreated([in] date* value);

Document Filters Implementation Guide 2.3.3 Objects

- 491/1268 -

ANNOTATION::DATEMODIFIED PROPERTY

Indicates the date the annotation was last modied.

.NET

JAVA

PYTHON

COM

Return Value

date

System.DateTime DateModified { get; set; }

java.util.Date getDateModified() throws IGRException;

void setDateModified(java.util.Date value) throws IGRException;

@property

def DateModified(self) -> datetime:

@property.setter

def DateModified(self, value: datetime)

[propget] HRESULT DateModified([out, retval] date* *result);

[propput] HRESULT DateModified([in] date* value);

Document Filters Implementation Guide 2.3.3 Objects

- 492/1268 -

ANNOTATION::FLAGS PROPERTY

Indicates the ags of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

int : See IGR_ANNOTATION_FLAGS_TYPE for details.

See Also

IGR_ANNOTATION_FLAGS_TYPE

Hyland.DocumentFilters.Annotations.Flags Flags { get; set; }

int getFlags() throws IGRException;

void setFlags(int value) throws IGRException;

@property

def Flags(self) -> int:

@property.setter

def Flags(self, value: int)

[propget] HRESULT Flags([out, retval] int *result);

[propput] HRESULT Flags([in] int value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 493/1268 -

ANNOTATION::INTENT PROPERTY

String containing a name describing the intent of the markup annotation. Intents allow viewer

applications to distinguish between dierent uses and behaviors of a single markup annotation type. If

this entry is not present or its value is the same as the annotation type, the annotation has no explicit

intent and should behave in a generic manner in a viewer app.

.NET

JAVA

PYTHON

COM

Return Value

string

string Intent { get; set; }

string getIntent() throws IGRException;

void setIntent(string value) throws IGRException;

@property

def Intent(self) -> string:

@property.setter

def Intent(self, value: string)

[propget] HRESULT Intent([out, retval] BSTR *result);

[propput] HRESULT Intent([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 494/1268 -

ANNOTATION::NAME PROPERTY

Indicates the name of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

string

string Name { get; set; }

string getName() throws IGRException;

void setName(string value) throws IGRException;

@property

def Name(self) -> string:

@property.setter

def Name(self, value: string)

[propget] HRESULT Name([out, retval] BSTR *result);

[propput] HRESULT Name([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 495/1268 -

ANNOTATION::OPACITY PROPERTY

The constant opacity value to be used in painting the annotation

.NET

JAVA

PYTHON

COM

Return Value

System.Double

System.Double Opacity { get; set; }

System.Double getOpacity() throws IGRException;

void setOpacity(System.Double value) throws IGRException;

@property

def Opacity(self) -> System.Double:

@property.setter

def Opacity(self, value: System.Double)

[propget] HRESULT Opacity([out, retval] System.Double* *result);

[propput] HRESULT Opacity([in] System.Double* value);

Document Filters Implementation Guide 2.3.3 Objects

- 496/1268 -

ANNOTATION::POPUP PROPERTY

Pop-up annotation for entering or editing the text associated with this annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationPopup

See Also

AnnotationPopup

Hyland.DocumentFilters.Annotations.Popup Popup { get; set; }

AnnotationPopup getPopup() throws IGRException;

void setPopup(AnnotationPopup value) throws IGRException;

@property

def Popup(self) -> AnnotationPopup:

@property.setter

def Popup(self, value: AnnotationPopup)

[propget] HRESULT Popup([out, retval] AnnotationPopup* *result);

[propput] HRESULT Popup([in] AnnotationPopup* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 497/1268 -

ANNOTATION::RECT PROPERTY

Indicates the rectangle of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationRect

See Also

AnnotationRectangle

System.Drawing.Rectangle Rect { get; set; }

AnnotationRect getRect() throws IGRException;

void setRect(AnnotationRect value) throws IGRException;

@property

def Rect(self) -> AnnotationRect:

@property.setter

def Rect(self, value: AnnotationRect)

[propget] HRESULT Rect([out, retval] AnnotationRect* *result);

[propput] HRESULT Rect([in] AnnotationRect* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 498/1268 -

ANNOTATION::REPLIES PROPERTY

Contains the list of replies to the annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationNoteList

See Also

AnnotationNoteList

List<Hyland.DocumentFilters.Annotations.Note> Replies { get; set; }

AnnotationNoteList getReplies() throws IGRException;

void setReplies(AnnotationNoteList value) throws IGRException;

@property

def Replies(self) -> AnnotationNoteList:

@property.setter

def Replies(self, value: AnnotationNoteList)

[propget] HRESULT Replies([out, retval] AnnotationNoteList* *result);

[propput] HRESULT Replies([in] AnnotationNoteList* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 499/1268 -

ANNOTATION::SUBJECT PROPERTY

Text representing a short description of the subject being addressed by the annotation.

.NET

JAVA

PYTHON

COM

Return Value

string

string Subject { get; set; }

string getSubject() throws IGRException;

void setSubject(string value) throws IGRException;

@property

def Subject(self) -> string:

@property.setter

def Subject(self, value: string)

[propget] HRESULT Subject([out, retval] BSTR *result);

[propput] HRESULT Subject([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 500/1268 -

ANNOTATION::TEXT PROPERTY

String to be displayed for the annotation or, if this type of annotation does not display text, an alternate

description of the annotation's contents in human-readable form.

.NET

JAVA

PYTHON

COM

Return Value

string

string Text { get; set; }

string getText() throws IGRException;

void setText(string value) throws IGRException;

@property

def Text(self) -> string:

@property.setter

def Text(self, value: string)

[propget] HRESULT Text([out, retval] BSTR *result);

[propput] HRESULT Text([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 501/1268 -

ANNOTATION::TYPE PROPERTY

Indicates the type of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

int : See IGR_ANNOTATION_TYPE for details.

See Also

IGR_ANNOTATION_TYPE

Hyland.DocumentFilters.Annotations.Type Type { get; set; }

int getType() throws IGRException;

void setType(int value) throws IGRException;

@property

def Type(self) -> int:

@property.setter

def Type(self, value: int)

[propget] HRESULT Type([out, retval] int *result);

[propput] HRESULT Type([in] int value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 502/1268 -

AnnotationAction

ANNOTATIONACTION INTERFACE

Represents the base class for Link actions.

AnnotationAction::Type property Indicates the action type.

AnnotationAction::NewWindow property Indicates if the action is performed in a new window.

Document Filters Implementation Guide 2.3.3 Objects

- 503/1268 -

ACTION::TYPE PROPERTY

Indicates the action type.

.NET

JAVA

PYTHON

COM

Return Value

string : Indicates the action type.

string Type { get; set; }

string getType() throws IGRException;

void setType(string value) throws IGRException;

@property

def Type(self) -> string:

@property.setter

def Type(self, value: string)

[propget] HRESULT Type([out, retval] BSTR *result);

[propput] HRESULT Type([in] BSTR value);

Type AnnotationAction object

GoTo AnnotationActionGoTo

GoToR AnnotationActionGoToRemote

URI AnnotationActionURI

Named AnnotationActionNamed

Document Filters Implementation Guide 2.3.3 Objects

- 504/1268 -

ACTION::NEWWINDOW PROPERTY

Indicates if the action is performed in a new window.

.NET

JAVA

PYTHON

COM

Return Value

bool

bool NewWindow { get; set; }

boolean getNewWindow() throws IGRException;

void setNewWindow(boolean value) throws IGRException;

@property

def NewWindow(self) -> bool:

@property.setter

def NewWindow(self, value: bool)

[propget] HRESULT NewWindow([out, retval] VARIANT_BOOL *result);

[propput] HRESULT NewWindow([in] VARIANT_BOOL value);

Document Filters Implementation Guide 2.3.3 Objects

- 505/1268 -

AnnotationActionGoTo

ANNOTATIONACTIONGOTO INTERFACE

Represents a goto action that scrolls to a specied location in the document.

Inherited from AnnotationAction

AnnotationActionGoTo::Name property Indicates the named location to scroll to.

AnnotationActionGoTo::Page property Indicates the page number to scroll to.

AnnotationActionGoTo::Rect property Indicates the rectangle to scroll to.

AnnotationActionGoTo::Zoom property Indicates the zoom level to set once scrolled.

AnnotationAction::AnnotationAction

interface

Represents the base class for Link actions.

AnnotationAction::Type property Indicates the action type.

AnnotationAction::NewWindow property Indicates if the action is performed in a new

window.

Document Filters Implementation Guide 2.3.3 Objects

- 506/1268 -

ANNOTATIONACTIONGOTO::NAME PROPERTY

Indicates the named location to scroll to.

.NET

JAVA

PYTHON

COM

Return Value

string

string Name { get; set; }

string getName() throws IGRException;

void setName(string value) throws IGRException;

@property

def Name(self) -> string:

@property.setter

def Name(self, value: string)

[propget] HRESULT Name([out, retval] BSTR *result);

[propput] HRESULT Name([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 507/1268 -

ANNOTATIONACTIONGOTO::PAGE PROPERTY

Indicates the page number to scroll to.

.NET

JAVA

PYTHON

COM

Return Value

int

int Page { get; set; }

int getPage() throws IGRException;

void setPage(int value) throws IGRException;

@property

def Page(self) -> int:

@property.setter

def Page(self, value: int)

[propget] HRESULT Page([out, retval] int *result);

[propput] HRESULT Page([in] int value);

Document Filters Implementation Guide 2.3.3 Objects

- 508/1268 -

ANNOTATIONACTIONGOTO::RECT PROPERTY

Indicates the rectangle to scroll to.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationRect

See Also

AnnotationRect

System.Drawing.Rectangle Rect { get; set; }

AnnotationRect getRect() throws IGRException;

void setRect(AnnotationRect value) throws IGRException;

@property

def Rect(self) -> AnnotationRect:

@property.setter

def Rect(self, value: AnnotationRect)

[propget] HRESULT Rect([out, retval] AnnotationRect* *result);

[propput] HRESULT Rect([in] AnnotationRect* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 509/1268 -

ANNOTATIONACTIONGOTO::ZOOM PROPERTY

Indicates the zoom level to set once scrolled.

.NET

JAVA

PYTHON

COM

Return Value

double

double Zoom { get; set; }

double getZoom() throws IGRException;

void setZoom(double value) throws IGRException;

@property

def Zoom(self) -> double:

@property.setter

def Zoom(self, value: double)

[propget] HRESULT Zoom([out, retval] double* *result);

[propput] HRESULT Zoom([in] double* value);

Document Filters Implementation Guide 2.3.3 Objects

- 510/1268 -

AnnotationActionGoToRemote

ANNOTATIONACTIONGOTOREMOTE INTERFACE

Represents a goto remote action that opens another document.

Inherited from AnnotationActionGoTo

AnnotationActionGoToRemote::Filename property Indicates the le to open.

AnnotationActionGoTo::AnnotationActionGoTo

interface

Represents a goto action that scrolls to a

specied location in the document.

AnnotationActionGoTo::Name property Indicates the named location to scroll to.

AnnotationActionGoTo::Page property Indicates the page number to scroll to.

AnnotationActionGoTo::Rect property Indicates the rectangle to scroll to.

AnnotationActionGoTo::Zoom property Indicates the zoom level to set once

scrolled.

Document Filters Implementation Guide 2.3.3 Objects

- 511/1268 -

ANNOTATIONACTIONGOTOREMOTE::FILENAME PROPERTY

Indicates the le to open.

.NET

JAVA

PYTHON

COM

Return Value

string

string Filename { get; set; }

string getFilename() throws IGRException;

void setFilename(string value) throws IGRException;

@property

def Filename(self) -> string:

@property.setter

def Filename(self, value: string)

[propget] HRESULT Filename([out, retval] BSTR *result);

[propput] HRESULT Filename([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 512/1268 -

AnnotationActionNamed

ANNOTATIONACTIONNAMED INTERFACE

Represents a named action that can be executed.

Inherited from AnnotationAction

AnnotationActionNamed::Name property Indicates the name of the action.

AnnotationAction::AnnotationAction

interface

Represents the base class for Link actions.

AnnotationAction::Type property Indicates the action type.

AnnotationAction::NewWindow property Indicates if the action is performed in a new

window.

Document Filters Implementation Guide 2.3.3 Objects

- 513/1268 -

ANNOTATIONACTIONNAMED::NAME PROPERTY

Indicates the name of the action.

.NET

JAVA

PYTHON

COM

Return Value

string : A string representing a predened named action to be performed by the viewer.

string Name { get; set; }

string getName() throws IGRException;

void setName(string value) throws IGRException;

@property

def Name(self) -> string:

@property.setter

def Name(self, value: string)

[propget] HRESULT Name([out, retval] BSTR *result);

[propput] HRESULT Name([in] BSTR value);

Name Action

NextPage Go to the next page of the document.

PrevPage Go to the previous page of the document.

FirstPage Go to the rst page of the document.

LastPage Go to the last page of the document.

Document Filters Implementation Guide 2.3.3 Objects

- 514/1268 -

AnnotationActionUri

ANNOTATIONACTIONURI INTERFACE

Represents a URI action that opens another document.

Inherited from AnnotationAction

AnnotationActionUri::Uri property Indicates the URI to open.

AnnotationAction::AnnotationAction

interface

Represents the base class for Link actions.

AnnotationAction::Type property Indicates the action type.

AnnotationAction::NewWindow property Indicates if the action is performed in a new

window.

Document Filters Implementation Guide 2.3.3 Objects

- 515/1268 -

ANNOTATIONACTIONURI::URI PROPERTY

Indicates the URI to open.

.NET

JAVA

PYTHON

COM

Return Value

string

string Uri { get; set; }

string getUri() throws IGRException;

void setUri(string value) throws IGRException;

@property

def Uri(self) -> string:

@property.setter

def Uri(self, value: string)

[propget] HRESULT Uri([out, retval] BSTR *result);

[propput] HRESULT Uri([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 516/1268 -

AnnotationAppearanceStream

ANNOTATIONAPPEARANCESTREAM INTERFACE

Optional appearance data that controls how the annotation is rendered. Appearance streams enable the

annotation to be presented visually in dierent ways to reect its interactions with the user. Each

appearance stream is a byte stream of a Document Filters supported image format. See Supported

Formats, Raster image and Vector image for a list of supported formats. Please note only the SVG format

is preserved as an SVG when creating appearance streams. All other formats will be rasterized.

Appearance streams are currently for writing only and are not read from PDFs.

AnnotationAppearanceStream::ContentType

property

The content type of the Content stream.

AnnotationAppearanceStream::Encoding

property

String describing the content encoding. This

must be "Base64" unless the content of the

stream is a SVG in which case this value may

also be "none". For .NET this value is always

"Base64".

AnnotationAppearanceStream::Content

property

The content in a supported format, such as SVG.

Document Filters Implementation Guide 2.3.3 Objects

- 517/1268 -

ANNOTATIONAPPEARANCESTREAM::CONTENTTYPE PROPERTY

The content type of the Content stream.

.NET

JAVA

PYTHON

COM

Return Value

string

string ContentType { get; set; }

string getContentType() throws IGRException;

void setContentType(string value) throws IGRException;

@property

def ContentType(self) -> string:

@property.setter

def ContentType(self, value: string)

[propget] HRESULT ContentType([out, retval] BSTR *result);

[propput] HRESULT ContentType([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 518/1268 -

ANNOTATIONAPPEARANCESTREAM::ENCODING PROPERTY

String describing the content encoding. This must be "Base64" unless the content of the stream is a SVG

in which case this value may also be "none". For .NET this value is always "Base64".

.NET

JAVA

PYTHON

COM

Return Value

string

string Encoding { get; set; }

string getEncoding() throws IGRException;

void setEncoding(string value) throws IGRException;

@property

def Encoding(self) -> string:

@property.setter

def Encoding(self, value: string)

[propget] HRESULT Encoding([out, retval] BSTR *result);

[propput] HRESULT Encoding([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 519/1268 -

ANNOTATIONAPPEARANCESTREAM::CONTENT PROPERTY

The content in a supported format, such as SVG.

.NET

JAVA

PYTHON

COM

Return Value

string

System.IO.Stream Content { get; set; }

string getContent() throws IGRException;

void setContent(string value) throws IGRException;

@property

def Content(self) -> string:

@property.setter

def Content(self, value: string)

[propget] HRESULT Content([out, retval] BSTR *result);

[propput] HRESULT Content([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 520/1268 -

AnnotationAppearanceStreams

ANNOTATIONAPPEARANCESTREAMS INTERFACE

Represents the appearance streams for an annotation.

AnnotationAppearanceStreams::Normal property Indicates the default appearance stream for

the annotation.

AnnotationAppearanceStreams::RollOverProperty Indicates the mouse-over appearance stream

for the annotation.

AnnotationAppearanceStreams::Down property Indicates the appearance stream for when

the annotation is clicked.

Document Filters Implementation Guide 2.3.3 Objects

- 521/1268 -

ANNOTATIONAPPEARANCESTREAMS::NORMAL PROPERTY

Indicates the default appearance stream for the annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationAppearanceStream

See Also

AnnotationAppearanceStream

Hyland.DocumentFilters.Annotations.AppearanceStream Normal { get; set; }

AnnotationAppearanceStream getNormal() throws IGRException;

void setNormal(AnnotationAppearanceStream value) throws IGRException;

@property

def Normal(self) -> AnnotationAppearanceStream:

@property.setter

def Normal(self, value: AnnotationAppearanceStream)

[propget] HRESULT Normal([out, retval] AnnotationAppearanceStream* *result);

[propput] HRESULT Normal([in] AnnotationAppearanceStream* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 522/1268 -

ANNOTATIONAPPEARANCESTREAMS::ROLLOVERPROPERTY

Indicates the mouse-over appearance stream for the annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationAppearanceStream

See Also

AnnotationAppearanceStream

Hyland.DocumentFilters.Annotations.AppearanceStream RollOver { get; set; }

AnnotationAppearanceStream getRollOver() throws IGRException;

void setRollOver(AnnotationAppearanceStream value) throws IGRException;

@property

def RollOver(self) -> AnnotationAppearanceStream:

@property.setter

def RollOver(self, value: AnnotationAppearanceStream)

[propget] HRESULT RollOver([out, retval] AnnotationAppearanceStream* *result);

[propput] HRESULT RollOver([in] AnnotationAppearanceStream* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 523/1268 -

ANNOTATIONAPPEARANCESTREAMS::DOWN PROPERTY

Indicates the appearance stream for when the annotation is clicked.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationAppearanceStream

See Also

AnnotationAppearanceStream

Hyland.DocumentFilters.Annotations.AppearanceStream Down { get; set; }

AnnotationAppearanceStream getDown() throws IGRException;

void setDown(AnnotationAppearanceStream value) throws IGRException;

@property

def Down(self) -> AnnotationAppearanceStream:

@property.setter

def Down(self, value: AnnotationAppearanceStream)

[propget] HRESULT Down([out, retval] AnnotationAppearanceStream* *result);

[propput] HRESULT Down([in] AnnotationAppearanceStream* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 524/1268 -

AnnotationAztec

ANNOTATIONAZTEC INTERFACE

Represents an Aztec barcode annotation.

Inherited from AnnotationBarcode

AnnotationBarcode::AnnotationBarcode

interface

Implements Annotation Interface. Represents the

base class for all barcode annotations.

AnnotationBarcode::SubType property Indicates the subtype of the barcode.

AnnotationBarcode::Caption property Indicates the caption of the barcode.

AnnotationBarcode::Content property Indicates the content of the barcode.

AnnotationBarcode::ErrorCorrectionLevel

property

Indicates the error correction level of the barcode.

AnnotationBarcode::Margin property Indicates the margin of the barcode.

AnnotationBarcode::BgColor property Indicates the background color of the barcode.

Document Filters Implementation Guide 2.3.3 Objects

- 525/1268 -

AnnotationBarcode

ANNOTATIONBARCODE INTERFACE

Implements Annotation Interface. Represents the base class for all barcode annotations.

Inherited from Annotation

AnnotationBarcode::SubType property Indicates the subtype of the barcode.

AnnotationBarcode::Caption property Indicates the caption of the barcode.

AnnotationBarcode::Content property Indicates the content of the barcode.

AnnotationBarcode::ErrorCorrectionLevel

property

Indicates the error correction level of the

barcode.

AnnotationBarcode::Margin property Indicates the margin of the barcode.

AnnotationBarcode::BgColor property Indicates the background color of the

barcode.

Annotation::Annotation

interface

The Annotation interface represents a single annotation on a given

page.

To obtain this interface, call the Page.GetFirstAnnotation,

Page.GetNextAnnotation, or Page.GetAnnotationCount method.

Annotation::Annotate

method

Applies the annotation to the provided canvas. This is the equivalent

of calling the Canvas::Annotate method.

Annotation::Appearance

property

Contains the appearance streams for the annotation.

Annotation::Border

property

Indicates the border style of the annotation.

Annotation::Color

property

Indicates the color of the annotation.

Annotation::DateCreated

property

Indicates the date the annotation was created.

Indicates the date the annotation was last modied.

Document Filters Implementation Guide 2.3.3 Objects

- 526/1268 -

Annotation::DateModied

property

Annotation::Flags

property

Indicates the ags of the annotation.

Annotation::Intent

property

String containing a name describing the intent of the markup

annotation. Intents allow viewer applications to distinguish between

dierent uses and behaviors of a single markup annotation type. If

this entry is not present or its value is the same as the annotation

type, the annotation has no explicit intent and should behave in a

generic manner in a viewer app.

Annotation::Name

property

Indicates the name of the annotation.

Annotation::Opacity

property

The constant opacity value to be used in painting the annotation

Annotation::Popup

property

Pop-up annotation for entering or editing the text associated with

this annotation.

Annotation::Rect property Indicates the rectangle of the annotation.

Annotation::Replies

property

Contains the list of replies to the annotation.

Annotation::Subject

property

Text representing a short description of the subject being addressed

by the annotation.

Annotation::Text property String to be displayed for the annotation or, if this type of annotation

does not display text, an alternate description of the annotation's

contents in human-readable form.

Annotation::Type

property

Indicates the type of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 527/1268 -

ANNOTATIONBARCODE::SUBTYPE PROPERTY

Indicates the subtype of the barcode.

.NET

JAVA

PYTHON

COM

Return Value

string : String representing the barcode type. Can be one of:

string SubType { get; set; }

string getSubType() throws IGRException;

void setSubType(string value) throws IGRException;

@property

def SubType(self) -> string:

@property.setter

def SubType(self, value: string)

[propget] HRESULT SubType([out, retval] BSTR *result);

[propput] HRESULT SubType([in] BSTR value);

Name Annotation object type

aztec AnnotationAztec

code39 AnnotationCode39

code93 AnnotationCode93

code128 AnnotationCode128

datamatrix AnnotationDataMatrix

gs1128 AnnotationGS1_128

pdf417 AnnotationPDF417

qr AnnotationQrCode

Document Filters Implementation Guide 2.3.3 Objects

- 528/1268 -

ANNOTATIONBARCODE::CAPTION PROPERTY

Indicates the caption of the barcode.

.NET

JAVA

PYTHON

COM

Return Value

string

string Caption { get; set; }

string getCaption() throws IGRException;

void setCaption(string value) throws IGRException;

@property

def Caption(self) -> string:

@property.setter

def Caption(self, value: string)

[propget] HRESULT Caption([out, retval] BSTR *result);

[propput] HRESULT Caption([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 529/1268 -

ANNOTATIONBARCODE::CONTENT PROPERTY

Indicates the content of the barcode.

.NET

JAVA

PYTHON

COM

Return Value

string

string Content { get; set; }

string getContent() throws IGRException;

void setContent(string value) throws IGRException;

@property

def Content(self) -> string:

@property.setter

def Content(self, value: string)

[propget] HRESULT Content([out, retval] BSTR *result);

[propput] HRESULT Content([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 530/1268 -

ANNOTATIONBARCODE::ERRORCORRECTIONLEVEL PROPERTY

Indicates the error correction level of the barcode.

.NET

JAVA

PYTHON

COM

Return Value

int

int ErrorCorrectionLevel { get; set; }

int getErrorCorrectionLevel() throws IGRException;

void setErrorCorrectionLevel(int value) throws IGRException;

@property

def ErrorCorrectionLevel(self) -> int:

@property.setter

def ErrorCorrectionLevel(self, value: int)

[propget] HRESULT ErrorCorrectionLevel([out, retval] int *result);

[propput] HRESULT ErrorCorrectionLevel([in] int value);

Document Filters Implementation Guide 2.3.3 Objects

- 531/1268 -

ANNOTATIONBARCODE::MARGIN PROPERTY

Indicates the margin of the barcode.

.NET

JAVA

PYTHON

COM

Return Value

int

int Margin { get; set; }

int getMargin() throws IGRException;

void setMargin(int value) throws IGRException;

@property

def Margin(self) -> int:

@property.setter

def Margin(self, value: int)

[propget] HRESULT Margin([out, retval] int *result);

[propput] HRESULT Margin([in] int value);

Document Filters Implementation Guide 2.3.3 Objects

- 532/1268 -

ANNOTATIONBARCODE::BGCOLOR PROPERTY

Indicates the background color of the barcode.

.NET

JAVA

PYTHON

COM

Return Value

string

System.Drawing.Color BgColor { get; set; }

string getBgColor() throws IGRException;

void setBgColor(string value) throws IGRException;

@property

def BgColor(self) -> string:

@property.setter

def BgColor(self, value: string)

[propget] HRESULT BgColor([out, retval] BSTR *result);

[propput] HRESULT BgColor([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 533/1268 -

AnnotationBorderStyle

ANNOTATIONBORDERSTYLE INTERFACE

Represents the border appearance of the annotation.

AnnotationBorderStyle::Width property The width of the border.

AnnotationBorderStyle::Intensity property The intensity of the border.

AnnotationBorderStyle::Type property The type of border style.

AnnotationBorderStyle::Dash property The dash pattern of the border.

Document Filters Implementation Guide 2.3.3 Objects

- 534/1268 -

ANNOTATIONBORDERSTYLE::WIDTH PROPERTY

The width of the border.

.NET

JAVA

PYTHON

COM

Return Value

System.Double

System.Double Width { get; set; }

System.Double getWidth() throws IGRException;

void setWidth(System.Double value) throws IGRException;

@property

def Width(self) -> System.Double:

@property.setter

def Width(self, value: System.Double)

[propget] HRESULT Width([out, retval] System.Double* *result);

[propput] HRESULT Width([in] System.Double* value);

Document Filters Implementation Guide 2.3.3 Objects

- 535/1268 -

ANNOTATIONBORDERSTYLE::INTENSITY PROPERTY

The intensity of the border.

.NET

JAVA

PYTHON

COM

Return Value

double

double Intensity { get; set; }

double getIntensity() throws IGRException;

void setIntensity(double value) throws IGRException;

@property

def Intensity(self) -> double:

@property.setter

def Intensity(self, value: double)

[propget] HRESULT Intensity([out, retval] double* *result);

[propput] HRESULT Intensity([in] double* value);

Document Filters Implementation Guide 2.3.3 Objects

- 536/1268 -

ANNOTATIONBORDERSTYLE::TYPE PROPERTY

The type of border style.

.NET

JAVA

PYTHON

COM

Return Value

int : Must be one of the following:

Hyland.DocumentFilters.Annotations.BorderStyleType Type { get; set; }

int getType() throws IGRException;

void setType(int value) throws IGRException;

@property

def Type(self) -> int:

@property.setter

def Type(self, value: int)

[propget] HRESULT Type([out, retval] int *result);

[propput] HRESULT Type([in] int value);

Integer Value Border Style Type

0 Unknown

1 Solid

2 Dashed

3 Beveled

4 Inset

5 Underline

Document Filters Implementation Guide 2.3.3 Objects

- 537/1268 -

ANNOTATIONBORDERSTYLE::DASH PROPERTY

The dash pattern of the border.

.NET

JAVA

PYTHON

COM

Return Value

int[]

List<int> Dash { get; set; }

int[] getDash() throws IGRException;

void setDash(int[] value) throws IGRException;

@property

def Dash(self) -> int[]:

@property.setter

def Dash(self, value: int[])

[propget] HRESULT Dash([out, retval] int[]* *result);

[propput] HRESULT Dash([in] int[]* value);

Document Filters Implementation Guide 2.3.3 Objects

- 538/1268 -

AnnotationCode128

ANNOTATIONCODE128 INTERFACE

Represents a Code128 barcode annotation.

Inherited from AnnotationBarcode

AnnotationBarcode::AnnotationBarcode

interface

Implements Annotation Interface. Represents the

base class for all barcode annotations.

AnnotationBarcode::SubType property Indicates the subtype of the barcode.

AnnotationBarcode::Caption property Indicates the caption of the barcode.

AnnotationBarcode::Content property Indicates the content of the barcode.

AnnotationBarcode::ErrorCorrectionLevel

property

Indicates the error correction level of the barcode.

AnnotationBarcode::Margin property Indicates the margin of the barcode.

AnnotationBarcode::BgColor property Indicates the background color of the barcode.

Document Filters Implementation Guide 2.3.3 Objects

- 539/1268 -

AnnotationCode39

ANNOTATIONCODE39 INTERFACE

Represents a Code39 barcode annotation.

Inherited from AnnotationBarcode

AnnotationBarcode::AnnotationBarcode

interface

Implements Annotation Interface. Represents the

base class for all barcode annotations.

AnnotationBarcode::SubType property Indicates the subtype of the barcode.

AnnotationBarcode::Caption property Indicates the caption of the barcode.

AnnotationBarcode::Content property Indicates the content of the barcode.

AnnotationBarcode::ErrorCorrectionLevel

property

Indicates the error correction level of the barcode.

AnnotationBarcode::Margin property Indicates the margin of the barcode.

AnnotationBarcode::BgColor property Indicates the background color of the barcode.

Document Filters Implementation Guide 2.3.3 Objects

- 540/1268 -

AnnotationDataMatrix

ANNOTATIONDATAMATRIX INTERFACE

Represents a DataMatrix barcode annotation.

Inherited from AnnotationBarcode

AnnotationBarcode::AnnotationBarcode

interface

Implements Annotation Interface. Represents the

base class for all barcode annotations.

AnnotationBarcode::SubType property Indicates the subtype of the barcode.

AnnotationBarcode::Caption property Indicates the caption of the barcode.

AnnotationBarcode::Content property Indicates the content of the barcode.

AnnotationBarcode::ErrorCorrectionLevel

property

Indicates the error correction level of the barcode.

AnnotationBarcode::Margin property Indicates the margin of the barcode.

AnnotationBarcode::BgColor property Indicates the background color of the barcode.

Document Filters Implementation Guide 2.3.3 Objects

- 541/1268 -

AnnotationDefaultAppearance

ANNOTATIONDEFAULTAPPEARANCE INTERFACE

Represents the default appearance values for the annotation, independent of any specic appearance

stream.

AnnotationDefaultAppearance::FontName property Indicates the font name.

AnnotationDefaultAppearance::FontSize property Indicates the font size.

AnnotationDefaultAppearance::TextColor property Indicates the text color.

Document Filters Implementation Guide 2.3.3 Objects

- 542/1268 -

ANNOTATIONDEFAULTAPPEARANCE::FONTNAME PROPERTY

Indicates the font name.

.NET

JAVA

PYTHON

COM

Return Value

string

string FontName { get; set; }

string getFontName() throws IGRException;

void setFontName(string value) throws IGRException;

@property

def FontName(self) -> string:

@property.setter

def FontName(self, value: string)

[propget] HRESULT FontName([out, retval] BSTR *result);

[propput] HRESULT FontName([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 543/1268 -

ANNOTATIONDEFAULTAPPEARANCE::FONTSIZE PROPERTY

Indicates the font size.

.NET

JAVA

PYTHON

COM

Return Value

double

double FontSize { get; set; }

double getFontSize() throws IGRException;

void setFontSize(double value) throws IGRException;

@property

def FontSize(self) -> double:

@property.setter

def FontSize(self, value: double)

[propget] HRESULT FontSize([out, retval] double* *result);

[propput] HRESULT FontSize([in] double* value);

Document Filters Implementation Guide 2.3.3 Objects

- 544/1268 -

ANNOTATIONDEFAULTAPPEARANCE::TEXTCOLOR PROPERTY

Indicates the text color.

.NET

JAVA

PYTHON

COM

Return Value

string

System.Drawing.Color TextColor { get; set; }

string getTextColor() throws IGRException;

void setTextColor(string value) throws IGRException;

@property

def TextColor(self) -> string:

@property.setter

def TextColor(self, value: string)

[propget] HRESULT TextColor([out, retval] BSTR *result);

[propput] HRESULT TextColor([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 545/1268 -

AnnotationEllipse

ANNOTATIONELLIPSE INTERFACE

A circle or ellipse annotation displays an ellipse on the page. When opened, it displays a pop-up window

containing the text of the associated note.

Inherited from Annotation

AnnotationEllipse::InteriorColor property Indicates the interior color of the annotation.

AnnotationEllipse::RectDierences

property

Indicates the rectangle dierences of the

annotation.

Annotation::Annotation

interface

The Annotation interface represents a single annotation on a given

page.

To obtain this interface, call the Page.GetFirstAnnotation,

Page.GetNextAnnotation, or Page.GetAnnotationCount method.

Annotation::Annotate

method

Applies the annotation to the provided canvas. This is the equivalent

of calling the Canvas::Annotate method.

Annotation::Appearance

property

Contains the appearance streams for the annotation.

Annotation::Border

property

Indicates the border style of the annotation.

Annotation::Color

property

Indicates the color of the annotation.

Annotation::DateCreated

property

Indicates the date the annotation was created.

Annotation::DateModied

property

Indicates the date the annotation was last modied.

Annotation::Flags

property

Indicates the ags of the annotation.

Annotation::Intent

property

String containing a name describing the intent of the markup

annotation. Intents allow viewer applications to distinguish between

dierent uses and behaviors of a single markup annotation type. If

Document Filters Implementation Guide 2.3.3 Objects

- 546/1268 -

this entry is not present or its value is the same as the annotation

type, the annotation has no explicit intent and should behave in a

generic manner in a viewer app.

Annotation::Name

property

Indicates the name of the annotation.

Annotation::Opacity

property

The constant opacity value to be used in painting the annotation

Annotation::Popup

property

Pop-up annotation for entering or editing the text associated with

this annotation.

Annotation::Rect property Indicates the rectangle of the annotation.

Annotation::Replies

property

Contains the list of replies to the annotation.

Annotation::Subject

property

Text representing a short description of the subject being addressed

by the annotation.

Annotation::Text property String to be displayed for the annotation or, if this type of annotation

does not display text, an alternate description of the annotation's

contents in human-readable form.

Annotation::Type

property

Indicates the type of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 547/1268 -

ANNOTATIONELLIPSE::INTERIORCOLOR PROPERTY

Indicates the interior color of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

string

System.Drawing.Color InteriorColor { get; set; }

string getInteriorColor() throws IGRException;

void setInteriorColor(string value) throws IGRException;

@property

def InteriorColor(self) -> string:

@property.setter

def InteriorColor(self, value: string)

[propget] HRESULT InteriorColor([out, retval] BSTR *result);

[propput] HRESULT InteriorColor([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 548/1268 -

ANNOTATIONELLIPSE::RECTDIFFERENCES PROPERTY

Indicates the rectangle dierences of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationRect

Additional Information

A set of four numbers describing the numerical dierences between two rectangles: the Rect entry of the

annotation and a rectangle contained within that rectangle. The inner rectangle is where the

annotation's text should be displayed. Any border styles and/or border eects specied by BS and BE

entries, respectively, are applied to the border of the inner rectangle. The four numbers correspond to

the dierences in default user space between the left, top, right, and bottom coordinates of Rect and

those of the inner rectangle, respectively. Each value must be greater than or equal to 0. The sum of the

top and bottom dierences must be less than the height of Rect, and the sum of the left and right

dierences must be less than the width of Rect.

See Also

AnnotationRect

System.Drawing.Rectangle RectDifferences { get; set; }

AnnotationRect getRectDifferences() throws IGRException;

void setRectDifferences(AnnotationRect value) throws IGRException;

@property

def RectDifferences(self) -> AnnotationRect:

@property.setter

def RectDifferences(self, value: AnnotationRect)

[propget] HRESULT RectDifferences([out, retval] AnnotationRect* *result);

[propput] HRESULT RectDifferences([in] AnnotationRect* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 549/1268 -

AnnotationFreeText

ANNOTATIONFREETEXT INTERFACE

A free text annotation displays text directly on the page. Unlike an ordinary text annotation, a free text

annotation has no open or closed state; instead of being displayed in a pop-up window, the text is

always visible.

Inherited from Annotation

AnnotationFreeText::Alignment property Indicates the text alignment of the annotation.

AnnotationFreeText::DefaultAppearance

property

Indicates the default appearance values for the

annotation.

Annotation::Annotation

interface

The Annotation interface represents a single annotation on a given

page.

To obtain this interface, call the Page.GetFirstAnnotation,

Page.GetNextAnnotation, or Page.GetAnnotationCount method.

Annotation::Annotate

method

Applies the annotation to the provided canvas. This is the equivalent

of calling the Canvas::Annotate method.

Annotation::Appearance

property

Contains the appearance streams for the annotation.

Annotation::Border

property

Indicates the border style of the annotation.

Annotation::Color

property

Indicates the color of the annotation.

Annotation::DateCreated

property

Indicates the date the annotation was created.

Annotation::DateModied

property

Indicates the date the annotation was last modied.

Annotation::Flags

property

Indicates the ags of the annotation.

Annotation::Intent

property

String containing a name describing the intent of the markup

annotation. Intents allow viewer applications to distinguish between

Document Filters Implementation Guide 2.3.3 Objects

- 550/1268 -

dierent uses and behaviors of a single markup annotation type. If

this entry is not present or its value is the same as the annotation

type, the annotation has no explicit intent and should behave in a

generic manner in a viewer app.

Annotation::Name

property

Indicates the name of the annotation.

Annotation::Opacity

property

The constant opacity value to be used in painting the annotation

Annotation::Popup

property

Pop-up annotation for entering or editing the text associated with

this annotation.

Annotation::Rect property Indicates the rectangle of the annotation.

Annotation::Replies

property

Contains the list of replies to the annotation.

Annotation::Subject

property

Text representing a short description of the subject being addressed

by the annotation.

Annotation::Text property String to be displayed for the annotation or, if this type of annotation

does not display text, an alternate description of the annotation's

contents in human-readable form.

Annotation::Type

property

Indicates the type of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 551/1268 -

ANNOTATIONFREETEXT::ALIGNMENT PROPERTY

Indicates the text alignment of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

int : Must be one of the following:

Hyland.DocumentFilters.Annotations.AlignmentType Alignment { get; set; }

int getAlignment() throws IGRException;

void setAlignment(int value) throws IGRException;

@property

def Alignment(self) -> int:

@property.setter

def Alignment(self, value: int)

[propget] HRESULT Alignment([out, retval] int *result);

[propput] HRESULT Alignment([in] int value);

Integer Value AnnotationAlignment

0 Left

1 Center

2 Right

Document Filters Implementation Guide 2.3.3 Objects

- 552/1268 -

ANNOTATIONFREETEXT::DEFAULTAPPEARANCE PROPERTY

Indicates the default appearance values for the annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationDefaultAppearance

See Also

AnnotationDefaultAppearance

Hyland.DocumentFilters.Annotations.DefaultAppearance DefaultAppearance { get; set; }

AnnotationDefaultAppearance getDefaultAppearance() throws IGRException;

void setDefaultAppearance(AnnotationDefaultAppearance value) throws IGRException;

@property

def DefaultAppearance(self) -> AnnotationDefaultAppearance:

@property.setter

def DefaultAppearance(self, value: AnnotationDefaultAppearance)

[propget] HRESULT DefaultAppearance([out, retval] AnnotationDefaultAppearance* *result);

[propput] HRESULT DefaultAppearance([in] AnnotationDefaultAppearance* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 553/1268 -

AnnotationGS1_128

ANNOTATIONGS1_128 INTERFACE

Represents a GS1-128 barcode annotation.

Inherited from AnnotationBarcode

AnnotationGS1_128::Parts property Contains the application identiers for the barcode.

AnnotationGS1_128::AutoCaption

property

Indicates if the barcode should be automatically

captioned.

AnnotationGS1_128::AddPart method Add a new part to the GS1-128 annotation

AnnotationBarcode::AnnotationBarcode

interface

Implements Annotation Interface. Represents the

base class for all barcode annotations.

AnnotationBarcode::SubType property Indicates the subtype of the barcode.

AnnotationBarcode::Caption property Indicates the caption of the barcode.

AnnotationBarcode::Content property Indicates the content of the barcode.

AnnotationBarcode::ErrorCorrectionLevel

property

Indicates the error correction level of the barcode.

AnnotationBarcode::Margin property Indicates the margin of the barcode.

AnnotationBarcode::BgColor property Indicates the background color of the barcode.

Document Filters Implementation Guide 2.3.3 Objects

- 554/1268 -

ANNOTATIONGS1_128::PARTS PROPERTY

Contains the application identiers for the barcode.

.NET

Return Value

IDictionary<string, string>

IDictionary<string, string> Parts { get; set; }

Document Filters Implementation Guide 2.3.3 Objects

- 555/1268 -

ANNOTATIONGS1_128::AUTOCAPTION PROPERTY

Indicates if the barcode should be automatically captioned.

.NET

JAVA

PYTHON

COM

Return Value

bool

bool AutoCaption { get; set; }

boolean getAutoCaption() throws IGRException;

void setAutoCaption(boolean value) throws IGRException;

@property

def AutoCaption(self) -> bool:

@property.setter

def AutoCaption(self, value: bool)

[propget] HRESULT AutoCaption([out, retval] VARIANT_BOOL *result);

[propput] HRESULT AutoCaption([in] VARIANT_BOOL value);

Document Filters Implementation Guide 2.3.3 Objects

- 556/1268 -

ANNOTATIONGS1_128::ADDPART METHOD

Add a new part to the GS1-128 annotation

Prototype

.NET

JAVA

PYTHON

Parameters

value: string : The part value

void AddPart(string name, string value)

void AddPart(string name, string value) throws IGRException;

def AddPart(self, name: string, value: string) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 557/1268 -

AnnotationHighlight

ANNOTATIONHIGHLIGHT INTERFACE

Highlight annotations are used to highlight text content on a page.

Inherited from AnnotationTextMarkup

AnnotationTextMarkup::AnnotationTextMarkup

interface

Represents the base class for text markup

annotations.

Document Filters Implementation Guide 2.3.3 Objects

- 558/1268 -

AnnotationInk

ANNOTATIONINK INTERFACE

An ink annotation represents a freehand "scribble" composed of one or more disjoint paths. When

opened, it displays a pop-up window containing the text of the associated note.

Inherited from Annotation

AnnotationInk::Points property The rst entry (i.e. path) in .

Annotation::Annotation

interface

The Annotation interface represents a single annotation on a given

page.

To obtain this interface, call the Page.GetFirstAnnotation,

Page.GetNextAnnotation, or Page.GetAnnotationCount method.

Annotation::Annotate

method

Applies the annotation to the provided canvas. This is the equivalent

of calling the Canvas::Annotate method.

Annotation::Appearance

property

Contains the appearance streams for the annotation.

Annotation::Border

property

Indicates the border style of the annotation.

Annotation::Color

property

Indicates the color of the annotation.

Annotation::DateCreated

property

Indicates the date the annotation was created.

Annotation::DateModied

property

Indicates the date the annotation was last modied.

Annotation::Flags

property

Indicates the ags of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 559/1268 -

Annotation::Intent

property

String containing a name describing the intent of the markup

annotation. Intents allow viewer applications to distinguish between

dierent uses and behaviors of a single markup annotation type. If

this entry is not present or its value is the same as the annotation

type, the annotation has no explicit intent and should behave in a

generic manner in a viewer app.

Annotation::Name

property

Indicates the name of the annotation.

Annotation::Opacity

property

The constant opacity value to be used in painting the annotation

Annotation::Popup

property

Pop-up annotation for entering or editing the text associated with

this annotation.

Annotation::Rect property Indicates the rectangle of the annotation.

Annotation::Replies

property

Contains the list of replies to the annotation.

Annotation::Subject

property

Text representing a short description of the subject being addressed

by the annotation.

Annotation::Text property String to be displayed for the annotation or, if this type of annotation

does not display text, an alternate description of the annotation's

contents in human-readable form.

Annotation::Type

property

Indicates the type of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 560/1268 -

ANNOTATIONINK::POINTS PROPERTY

The rst entry (i.e. path) in .

.NET

JAVA

PYTHON

COM

Return Value

AnnotationPointListList

IList<System.Drawing.Point> Points { get; set; }

AnnotationPointListList getPoints() throws IGRException;

void setPoints(AnnotationPointListList value) throws IGRException;

@property

def Points(self) -> AnnotationPointListList:

@property.setter

def Points(self, value: AnnotationPointListList)

[propget] HRESULT Points([out, retval] AnnotationPointListList* *result);

[propput] HRESULT Points([in] AnnotationPointListList* value);

Document Filters Implementation Guide 2.3.3 Objects

- 561/1268 -

AnnotationLine

ANNOTATIONLINE INTERFACE

A line annotation displays a single straight line on the page. When opened, it displays a pop-up window

containing the text of the associated note.

Inherited from Annotation

AnnotationLine::InteriorColor property Indicates the interior color of the annotation.

AnnotationLine::LineEndings property Indicates the line endings of the annotation.

AnnotationLine::Points property Indicates the points of the annotation.

Annotation::Annotation

interface

The Annotation interface represents a single annotation on a given

page.

To obtain this interface, call the Page.GetFirstAnnotation,

Page.GetNextAnnotation, or Page.GetAnnotationCount method.

Annotation::Annotate

method

Applies the annotation to the provided canvas. This is the equivalent

of calling the Canvas::Annotate method.

Annotation::Appearance

property

Contains the appearance streams for the annotation.

Annotation::Border

property

Indicates the border style of the annotation.

Annotation::Color

property

Indicates the color of the annotation.

Annotation::DateCreated

property

Indicates the date the annotation was created.

Annotation::DateModied

property

Indicates the date the annotation was last modied.

Annotation::Flags

property

Indicates the ags of the annotation.

Annotation::Intent

property

String containing a name describing the intent of the markup

annotation. Intents allow viewer applications to distinguish between

Document Filters Implementation Guide 2.3.3 Objects

- 562/1268 -

dierent uses and behaviors of a single markup annotation type. If

this entry is not present or its value is the same as the annotation

type, the annotation has no explicit intent and should behave in a

generic manner in a viewer app.

Annotation::Name

property

Indicates the name of the annotation.

Annotation::Opacity

property

The constant opacity value to be used in painting the annotation

Annotation::Popup

property

Pop-up annotation for entering or editing the text associated with

this annotation.

Annotation::Rect property Indicates the rectangle of the annotation.

Annotation::Replies

property

Contains the list of replies to the annotation.

Annotation::Subject

property

Text representing a short description of the subject being addressed

by the annotation.

Annotation::Text property String to be displayed for the annotation or, if this type of annotation

does not display text, an alternate description of the annotation's

contents in human-readable form.

Annotation::Type

property

Indicates the type of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 563/1268 -

ANNOTATIONLINE::INTERIORCOLOR PROPERTY

Indicates the interior color of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

string

System.Drawing.Color InteriorColor { get; set; }

string getInteriorColor() throws IGRException;

void setInteriorColor(string value) throws IGRException;

@property

def InteriorColor(self) -> string:

@property.setter

def InteriorColor(self, value: string)

[propget] HRESULT InteriorColor([out, retval] BSTR *result);

[propput] HRESULT InteriorColor([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 564/1268 -

ANNOTATIONLINE::LINEENDINGS PROPERTY

Indicates the line endings of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationLineEndings

See Also

AnnotationLineEndings

Hyland.DocumentFilters.Annotations.LineEndings LineEndings { get; set; }

AnnotationLineEndings getLineEndings() throws IGRException;

void setLineEndings(AnnotationLineEndings value) throws IGRException;

@property

def LineEndings(self) -> AnnotationLineEndings:

@property.setter

def LineEndings(self, value: AnnotationLineEndings)

[propget] HRESULT LineEndings([out, retval] AnnotationLineEndings* *result);

[propput] HRESULT LineEndings([in] AnnotationLineEndings* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 565/1268 -

ANNOTATIONLINE::POINTS PROPERTY

Indicates the points of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationPointList

IList<System.Drawing.Point> Points { get; set; }

AnnotationPointList getPoints() throws IGRException;

void setPoints(AnnotationPointList value) throws IGRException;

@property

def Points(self) -> AnnotationPointList:

@property.setter

def Points(self, value: AnnotationPointList)

[propget] HRESULT Points([out, retval] AnnotationPointList* *result);

[propput] HRESULT Points([in] AnnotationPointList* value);

Document Filters Implementation Guide 2.3.3 Objects

- 566/1268 -

AnnotationLineEndings

ANNOTATIONLINEENDINGS INTERFACE

Represents the line ending of the annotation.

AnnotationLineEndings::Begin property The type of line ending at the beginning.

AnnotationLineEndings::End property The type of line ending at the end.

Document Filters Implementation Guide 2.3.3 Objects

- 567/1268 -

ANNOTATIONLINEENDINGS::BEGIN PROPERTY

The type of line ending at the beginning.

.NET

JAVA

PYTHON

COM

Return Value

int : One of the following:

Hyland.DocumentFilters.Annotations.LineEndingType Begin { get; set; }

int getBegin() throws IGRException;

void setBegin(int value) throws IGRException;

@property

def Begin(self) -> int:

@property.setter

def Begin(self, value: int)

[propget] HRESULT Begin([out, retval] int *result);

[propput] HRESULT Begin([in] int value);

Name Value

None 0

Square 1

Circle 2

Diamond 3

OpenArrow 4

ClosedArrow 5

Butt 6

RightOpenArrow 7

RightClosedArrow 8

Slash 9

Document Filters Implementation Guide 2.3.3 Objects

- 568/1268 -

ANNOTATIONLINEENDINGS::END PROPERTY

The type of line ending at the end.

.NET

JAVA

PYTHON

COM

Return Value

int : One of the following:

Hyland.DocumentFilters.Annotations.LineEndingType End { get; set; }

int getEnd() throws IGRException;

void setEnd(int value) throws IGRException;

@property

def End(self) -> int:

@property.setter

def End(self, value: int)

[propget] HRESULT End([out, retval] int *result);

[propput] HRESULT End([in] int value);

Name Value

None 0

Square 1

Circle 2

Diamond 3

OpenArrow 4

ClosedArrow 5

Butt 6

RightOpenArrow 7

RightClosedArrow 8

Slash 9

Document Filters Implementation Guide 2.3.3 Objects

- 569/1268 -

AnnotationLink

ANNOTATIONLINK INTERFACE

A link annotation represents either a hypertext link to a destination elsewhere in the document or an

action to be performed.

Inherited from Annotation

AnnotationLink::Highlight

property

Indicates the highlight type of the annotation.

AnnotationLink::Action property Indicates the action to be performed when the annotation is

activated.

AnnotationLink::Points property Indicates the points of the annotation.

Annotation::Annotation

interface

The Annotation interface represents a single annotation on a given

page.

To obtain this interface, call the Page.GetFirstAnnotation,

Page.GetNextAnnotation, or Page.GetAnnotationCount method.

Annotation::Annotate

method

Applies the annotation to the provided canvas. This is the equivalent

of calling the Canvas::Annotate method.

Annotation::Appearance

property

Contains the appearance streams for the annotation.

Annotation::Border

property

Indicates the border style of the annotation.

Annotation::Color

property

Indicates the color of the annotation.

Annotation::DateCreated

property

Indicates the date the annotation was created.

Annotation::DateModied

property

Indicates the date the annotation was last modied.

Annotation::Flags

property

Indicates the ags of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 570/1268 -

Annotation::Intent

property

String containing a name describing the intent of the markup

annotation. Intents allow viewer applications to distinguish between

dierent uses and behaviors of a single markup annotation type. If

this entry is not present or its value is the same as the annotation

type, the annotation has no explicit intent and should behave in a

generic manner in a viewer app.

Annotation::Name

property

Indicates the name of the annotation.

Annotation::Opacity

property

The constant opacity value to be used in painting the annotation

Annotation::Popup

property

Pop-up annotation for entering or editing the text associated with

this annotation.

Annotation::Rect property Indicates the rectangle of the annotation.

Annotation::Replies

property

Contains the list of replies to the annotation.

Annotation::Subject

property

Text representing a short description of the subject being addressed

by the annotation.

Annotation::Text property String to be displayed for the annotation or, if this type of annotation

does not display text, an alternate description of the annotation's

contents in human-readable form.

Annotation::Type

property

Indicates the type of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 571/1268 -

ANNOTATIONLINK::HIGHLIGHT PROPERTY

Indicates the highlight type of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

int : One of the following:

Hyland.DocumentFilters.Annotations.HighlightType Highlight { get; set; }

int getHighlight() throws IGRException;

void setHighlight(int value) throws IGRException;

@property

def Highlight(self) -> int:

@property.setter

def Highlight(self, value: int)

[propget] HRESULT Highlight([out, retval] int *result);

[propput] HRESULT Highlight([in] int value);

Value Highlight

0 Unknown

1 Invert

2 Outline

3 Push

Document Filters Implementation Guide 2.3.3 Objects

- 572/1268 -

ANNOTATIONLINK::ACTION PROPERTY

Indicates the action to be performed when the annotation is activated.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationAction

See Also

AnnotationAction

Hyland.DocumentFilters.Annotations.Action Action { get; set; }

AnnotationAction getAction() throws IGRException;

void setAction(AnnotationAction value) throws IGRException;

@property

def Action(self) -> AnnotationAction:

@property.setter

def Action(self, value: AnnotationAction)

[propget] HRESULT Action([out, retval] AnnotationAction* *result);

[propput] HRESULT Action([in] AnnotationAction* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 573/1268 -

ANNOTATIONLINK::POINTS PROPERTY

Indicates the points of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationPointList

See Also

AnnotationPointList

IList<System.Drawing.Point> Points { get; set; }

AnnotationPointList getPoints() throws IGRException;

void setPoints(AnnotationPointList value) throws IGRException;

@property

def Points(self) -> AnnotationPointList:

@property.setter

def Points(self, value: AnnotationPointList)

[propget] HRESULT Points([out, retval] AnnotationPointList* *result);

[propput] HRESULT Points([in] AnnotationPointList* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 574/1268 -

AnnotationNamedDestination

ANNOTATIONNAMEDDESTINATION INTERFACE

Represents a named destination in the document.

Inherited from Annotation

Annotation::Annotation

interface

The Annotation interface represents a single annotation on a given

page.

To obtain this interface, call the Page.GetFirstAnnotation,

Page.GetNextAnnotation, or Page.GetAnnotationCount method.

Annotation::Annotate

method

Applies the annotation to the provided canvas. This is the equivalent

of calling the Canvas::Annotate method.

Annotation::Appearance

property

Contains the appearance streams for the annotation.

Annotation::Border

property

Indicates the border style of the annotation.

Annotation::Color

property

Indicates the color of the annotation.

Annotation::DateCreated

property

Indicates the date the annotation was created.

Annotation::DateModied

property

Indicates the date the annotation was last modied.

Annotation::Flags

property

Indicates the ags of the annotation.

Annotation::Intent

property

String containing a name describing the intent of the markup

annotation. Intents allow viewer applications to distinguish between

dierent uses and behaviors of a single markup annotation type. If

this entry is not present or its value is the same as the annotation

type, the annotation has no explicit intent and should behave in a

generic manner in a viewer app.

Indicates the name of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 575/1268 -

Sample code

Annotation::Name

property

Annotation::Opacity

property

The constant opacity value to be used in painting the annotation

Annotation::Popup

property

Pop-up annotation for entering or editing the text associated with

this annotation.

Annotation::Rect property Indicates the rectangle of the annotation.

Annotation::Replies

property

Contains the list of replies to the annotation.

Annotation::Subject

property

Text representing a short description of the subject being addressed

by the annotation.

Annotation::Text property String to be displayed for the annotation or, if this type of annotation

does not display text, an alternate description of the annotation's

contents in human-readable form.

Annotation::Type

property

Indicates the type of the annotation.

using var source = api.OpenExtractor(sourceFilename, OpenMode.Paginated);

using var canvas = api.MakeOutputCanvas(destFilename, CanvasType.PDF);

canvas.BlankPage((int)(8.5 * 96), (int)(11 * 96));

canvas.SetBrush(0, 1);

canvas.SetFont("Arial", 11, 0);

// create a simple table of contents

int y = 36;

for (int i = 0; i < source.PageCount; ++i)

{

var text = $"Page {i + 1}";

canvas.TextOut(36, y, text);

canvas.Annotate(new Annotations.Link

{

Action = new Annotations.ActionGoTo

{

Name = $"sourcePage{i + 1}"

Rect = new System.Drawing.Rectangle(36, y, canvas.TextWidth(text), lineHeight)

});

y += (int) (lineHeight * 1.2);

}

Document Filters Implementation Guide 2.3.3 Objects

- 576/1268 -

See also

Link Interface

// render the actual document and create named destinations

for (var i = 0; i < source.PageCount; ++i)

{

using (var page = source.GetPage(i))

{

canvas.RenderPage(page);

canvas.Annotate(new Annotations.NamedDestination

{

Name = $"sourcePage{i+1}",

Rect = new System.Drawing.Rectangle(0, 0, page.Width, page.Height),

});

}

•

Document Filters Implementation Guide 2.3.3 Objects

- 577/1268 -

AnnotationNote

ANNOTATIONNOTE INTERFACE

Represents the base class for note annotations.

Inherited from Annotation

AnnotationNote::State property Indicates the state of the annotation.

AnnotationNote::StateModel property Indicates the state model of the annotation.

AnnotationNote::Author property Indicates the author of the annotation.

Annotation::Annotation

interface

The Annotation interface represents a single annotation on a given

page.

To obtain this interface, call the Page.GetFirstAnnotation,

Page.GetNextAnnotation, or Page.GetAnnotationCount method.

Annotation::Annotate

method

Applies the annotation to the provided canvas. This is the equivalent

of calling the Canvas::Annotate method.

Annotation::Appearance

property

Contains the appearance streams for the annotation.

Annotation::Border

property

Indicates the border style of the annotation.

Annotation::Color

property

Indicates the color of the annotation.

Annotation::DateCreated

property

Indicates the date the annotation was created.

Annotation::DateModied

property

Indicates the date the annotation was last modied.

Annotation::Flags

property

Indicates the ags of the annotation.

Annotation::Intent

property

String containing a name describing the intent of the markup

annotation. Intents allow viewer applications to distinguish between

dierent uses and behaviors of a single markup annotation type. If

Document Filters Implementation Guide 2.3.3 Objects

- 578/1268 -

this entry is not present or its value is the same as the annotation

type, the annotation has no explicit intent and should behave in a

generic manner in a viewer app.

Annotation::Name

property

Indicates the name of the annotation.

Annotation::Opacity

property

The constant opacity value to be used in painting the annotation

Annotation::Popup

property

Pop-up annotation for entering or editing the text associated with

this annotation.

Annotation::Rect property Indicates the rectangle of the annotation.

Annotation::Replies

property

Contains the list of replies to the annotation.

Annotation::Subject

property

Text representing a short description of the subject being addressed

by the annotation.

Annotation::Text property String to be displayed for the annotation or, if this type of annotation

does not display text, an alternate description of the annotation's

contents in human-readable form.

Annotation::Type

property

Indicates the type of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 579/1268 -

ANNOTATIONNOTE::STATE PROPERTY

Indicates the state of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

string : Paired with stateModel, state represents a model specic value.

string State { get; set; }

string getState() throws IGRException;

void setState(string value) throws IGRException;

@property

def State(self) -> string:

@property.setter

def State(self, value: string)

[propget] HRESULT State([out, retval] BSTR *result);

[propput] HRESULT State([in] BSTR value);

StateModel Valid states

Marked Marked, Unmarked

Review Accepted, Rejected, Cancelled, Completed, None

Document Filters Implementation Guide 2.3.3 Objects

- 580/1268 -

ANNOTATIONNOTE::STATEMODEL PROPERTY

Indicates the state model of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

string

string StateModel { get; set; }

string getStateModel() throws IGRException;

void setStateModel(string value) throws IGRException;

@property

def StateModel(self) -> string:

@property.setter

def StateModel(self, value: string)

[propget] HRESULT StateModel([out, retval] BSTR *result);

[propput] HRESULT StateModel([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 581/1268 -

ANNOTATIONNOTE::AUTHOR PROPERTY

Indicates the author of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

string

string Author { get; set; }

string getAuthor() throws IGRException;

void setAuthor(string value) throws IGRException;

@property

def Author(self) -> string:

@property.setter

def Author(self, value: string)

[propget] HRESULT Author([out, retval] BSTR *result);

[propput] HRESULT Author([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 582/1268 -

AnnotationNoteList

ANNOTATIONNOTELIST INTERFACE

A list of AnnotationNote objects.

AnnotationNoteList::Count method Returns the number of elements.

AnnotationNoteList::Add method Adds an element.

AnnotationNoteList::Remove method Removes an element.

AnnotationNoteList::Clear method Removes all elements from the list.

AnnotationNoteList::Item method Returns a specic element from the list.

Document Filters Implementation Guide 2.3.3 Objects

- 583/1268 -

ANNOTATIONNOTELIST::COUNT METHOD

Returns the number of elements.

Prototype

.NET

JAVA

PYTHON

Return value

int : The number of items in the list.

int GetCount()

int GetCount() throws IGRException;

def GetCount(self) -> int

Document Filters Implementation Guide 2.3.3 Objects

- 584/1268 -

ANNOTATIONNOTELIST::ADD METHOD

Adds an element.

Prototype

.NET

JAVA

PYTHON

Parameters

note: AnnotationNote : The item to add.

void Add(AnnotationNote note)

void Add(AnnotationNote note) throws IGRException;

def Add(self, note: AnnotationNote) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 585/1268 -

ANNOTATIONNOTELIST::REMOVE METHOD

Removes an element.

Prototype

.NET

JAVA

PYTHON

Parameters

index: int : The index of the item to be remove.

void Remove(int index)

void Remove(int index) throws IGRException;

def Remove(self, index: int) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 586/1268 -

ANNOTATIONNOTELIST::CLEAR METHOD

Removes all elements from the list.

Prototype

.NET

JAVA

PYTHON

void Clear()

void Clear() throws IGRException;

def Clear(self) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 587/1268 -

ANNOTATIONNOTELIST::ITEM METHOD

Returns a specic element from the list.

Prototype

.NET

JAVA

PYTHON

Parameters

index: int : The index of the item being requested.

Return value

AnnotationNote : The requested item.

AnnotationNote Get(int index)

AnnotationNote Get(int index) throws IGRException;

def Get(self, index: int) -> AnnotationNote

Document Filters Implementation Guide 2.3.3 Objects

- 588/1268 -

AnnotationPDF417

ANNOTATIONPDF417 INTERFACE

Represents a PDF417 barcode annotation.

Inherited from AnnotationBarcode

AnnotationBarcode::AnnotationBarcode

interface

Implements Annotation Interface. Represents the

base class for all barcode annotations.

AnnotationBarcode::SubType property Indicates the subtype of the barcode.

AnnotationBarcode::Caption property Indicates the caption of the barcode.

AnnotationBarcode::Content property Indicates the content of the barcode.

AnnotationBarcode::ErrorCorrectionLevel

property

Indicates the error correction level of the barcode.

AnnotationBarcode::Margin property Indicates the margin of the barcode.

AnnotationBarcode::BgColor property Indicates the background color of the barcode.

Document Filters Implementation Guide 2.3.3 Objects

- 589/1268 -

AnnotationPoint

ANNOTATIONPOINT INTERFACE

A single point in the document's user space units. For .NET instead see System.Drawing.Point .

AnnotationPoint::X

property

The horizontal value of the point in the document's user space

units.

AnnotationPoint::Y

property

The vertical value of the point in the document's user space units.

Document Filters Implementation Guide 2.3.3 Objects

- 590/1268 -

ANNOTATIONPOINT::X PROPERTY

The horizontal value of the point in the document's user space units.

.NET

JAVA

PYTHON

COM

Return Value

int

int X { get; set; }

int getX() throws IGRException;

void setX(int value) throws IGRException;

@property

def X(self) -> int:

@property.setter

def X(self, value: int)

[propget] HRESULT X([out, retval] int *result);

[propput] HRESULT X([in] int value);

Document Filters Implementation Guide 2.3.3 Objects

- 591/1268 -

ANNOTATIONPOINT::Y PROPERTY

The vertical value of the point in the document's user space units.

.NET

JAVA

PYTHON

COM

Return Value

int

int Y { get; set; }

int getY() throws IGRException;

void setY(int value) throws IGRException;

@property

def Y(self) -> int:

@property.setter

def Y(self, value: int)

[propget] HRESULT Y([out, retval] int *result);

[propput] HRESULT Y([in] int value);

Document Filters Implementation Guide 2.3.3 Objects

- 592/1268 -

AnnotationPointList

ANNOTATIONPOINTLIST INTERFACE

A list of AnnotationPoint objects.

AnnotationPointList::Count method Returns the number of elements.

AnnotationPointList::Add method Adds an element.

AnnotationPointList::Remove method Removes an element.

AnnotationPointList::Clear method Removes all elements from the list.

AnnotationPointList::Item method Returns a specic element from the list.

Document Filters Implementation Guide 2.3.3 Objects

- 593/1268 -

ANNOTATIONPOINTLIST::COUNT METHOD

Returns the number of elements.

Prototype

.NET

JAVA

PYTHON

Return value

int : The number of items in the list.

int GetCount()

int GetCount() throws IGRException;

def GetCount(self) -> int

Document Filters Implementation Guide 2.3.3 Objects

- 594/1268 -

ANNOTATIONPOINTLIST::ADD METHOD

Adds an element.

Prototype

.NET

JAVA

PYTHON

Parameters

note: AnnotationPoint : The item to add.

void Add(AnnotationPoint note)

void Add(AnnotationPoint note) throws IGRException;

def Add(self, note: AnnotationPoint) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 595/1268 -

ANNOTATIONPOINTLIST::REMOVE METHOD

Removes an element.

Prototype

.NET

JAVA

PYTHON

Parameters

index: int : The index of the item to be remove.

void Remove(int index)

void Remove(int index) throws IGRException;

def Remove(self, index: int) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 596/1268 -

ANNOTATIONPOINTLIST::CLEAR METHOD

Removes all elements from the list.

Prototype

.NET

JAVA

PYTHON

void Clear()

void Clear() throws IGRException;

def Clear(self) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 597/1268 -

ANNOTATIONPOINTLIST::ITEM METHOD

Returns a specic element from the list.

Prototype

.NET

JAVA

PYTHON

Parameters

index: int : The index of the item being requested.

Return value

AnnotationPoint : The requested item.

AnnotationPoint Get(int index)

AnnotationPoint Get(int index) throws IGRException;

def Get(self, index: int) -> AnnotationPoint

Document Filters Implementation Guide 2.3.3 Objects

- 598/1268 -

AnnotationPointListList

ANNOTATIONPOINTLISTLIST INTERFACE

A list containing AnnotationPointList objects.

AnnotationPointListList::Count method Returns the number of elements.

AnnotationPointListList::Add method Adds an element.

AnnotationPointListList::Remove method Removes an element.

AnnotationPointListList::Clear method Removes all elements from the list.

AnnotationPointListList::Item method Returns a specic element from the list.

Document Filters Implementation Guide 2.3.3 Objects

- 599/1268 -

ANNOTATIONPOINTLISTLIST::COUNT METHOD

Returns the number of elements.

Prototype

.NET

JAVA

PYTHON

Return value

int : The number of items in the list.

int GetCount()

int GetCount() throws IGRException;

def GetCount(self) -> int

Document Filters Implementation Guide 2.3.3 Objects

- 600/1268 -

ANNOTATIONPOINTLISTLIST::ADD METHOD

Adds an element.

Prototype

.NET

JAVA

PYTHON

Parameters

note: AnnotationPointList : The item to add.

void Add(AnnotationPointList note)

void Add(AnnotationPointList note) throws IGRException;

def Add(self, note: AnnotationPointList) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 601/1268 -

ANNOTATIONPOINTLISTLIST::REMOVE METHOD

Removes an element.

Prototype

.NET

JAVA

PYTHON

Parameters

index: int : The index of the item to be remove.

void Remove(int index)

void Remove(int index) throws IGRException;

def Remove(self, index: int) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 602/1268 -

ANNOTATIONPOINTLISTLIST::CLEAR METHOD

Removes all elements from the list.

Prototype

.NET

JAVA

PYTHON

void Clear()

void Clear() throws IGRException;

def Clear(self) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 603/1268 -

ANNOTATIONPOINTLISTLIST::ITEM METHOD

Returns a specic element from the list.

Prototype

.NET

JAVA

PYTHON

Parameters

index: int : The index of the item being requested.

Return value

AnnotationPointList : The requested item.

AnnotationPointList Get(int index)

AnnotationPointList Get(int index) throws IGRException;

def Get(self, index: int) -> AnnotationPointList

Document Filters Implementation Guide 2.3.3 Objects

- 604/1268 -

AnnotationPolygon

ANNOTATIONPOLYGON INTERFACE

Polygon annotations display closed polygons on the page. Such polygons may have any number of

vertices connected by straight lines. Polyline annotations are similar to polygons, except that the rst

and last vertex are not implicitly connected.

Inherited from Annotation

AnnotationPolygon::InteriorColor property Indicates the interior color of the annotation.

AnnotationPolygon::Points property Indicates the points of the annotation.

Annotation::Annotation

interface

The Annotation interface represents a single annotation on a given

page.

To obtain this interface, call the Page.GetFirstAnnotation,

Page.GetNextAnnotation, or Page.GetAnnotationCount method.

Annotation::Annotate

method

Applies the annotation to the provided canvas. This is the equivalent

of calling the Canvas::Annotate method.

Annotation::Appearance

property

Contains the appearance streams for the annotation.

Annotation::Border

property

Indicates the border style of the annotation.

Annotation::Color

property

Indicates the color of the annotation.

Annotation::DateCreated

property

Indicates the date the annotation was created.

Annotation::DateModied

property

Indicates the date the annotation was last modied.

Annotation::Flags

property

Indicates the ags of the annotation.

Annotation::Intent

property

String containing a name describing the intent of the markup

annotation. Intents allow viewer applications to distinguish between

dierent uses and behaviors of a single markup annotation type. If

Document Filters Implementation Guide 2.3.3 Objects

- 605/1268 -

this entry is not present or its value is the same as the annotation

type, the annotation has no explicit intent and should behave in a

generic manner in a viewer app.

Annotation::Name

property

Indicates the name of the annotation.

Annotation::Opacity

property

The constant opacity value to be used in painting the annotation

Annotation::Popup

property

Pop-up annotation for entering or editing the text associated with

this annotation.

Annotation::Rect property Indicates the rectangle of the annotation.

Annotation::Replies

property

Contains the list of replies to the annotation.

Annotation::Subject

property

Text representing a short description of the subject being addressed

by the annotation.

Annotation::Text property String to be displayed for the annotation or, if this type of annotation

does not display text, an alternate description of the annotation's

contents in human-readable form.

Annotation::Type

property

Indicates the type of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 606/1268 -

ANNOTATIONPOLYGON::INTERIORCOLOR PROPERTY

Indicates the interior color of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

string

System.Drawing.Color InteriorColor { get; set; }

string getInteriorColor() throws IGRException;

void setInteriorColor(string value) throws IGRException;

@property

def InteriorColor(self) -> string:

@property.setter

def InteriorColor(self, value: string)

[propget] HRESULT InteriorColor([out, retval] BSTR *result);

[propput] HRESULT InteriorColor([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 607/1268 -

ANNOTATIONPOLYGON::POINTS PROPERTY

Indicates the points of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationPointList

See Also

AnnotationPointList

IList<System.Drawing.Point> Points { get; set; }

AnnotationPointList getPoints() throws IGRException;

void setPoints(AnnotationPointList value) throws IGRException;

@property

def Points(self) -> AnnotationPointList:

@property.setter

def Points(self, value: AnnotationPointList)

[propget] HRESULT Points([out, retval] AnnotationPointList* *result);

[propput] HRESULT Points([in] AnnotationPointList* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 608/1268 -

AnnotationPolyline

ANNOTATIONPOLYLINE INTERFACE

Polygon annotations display closed polygons on the page. Such polygons may have any number of

vertices connected by straight lines. Polyline annotations are similar to polygons, except that the rst

and last vertex are not implicitly connected.

Inherited from Annotation

AnnotationPolyLine::Points property Indicates the points of the annotation.

AnnotationPolyLine::LineEndings property Indicates the line endings of the annotation.

Annotation::Annotation

interface

The Annotation interface represents a single annotation on a given

page.

To obtain this interface, call the Page.GetFirstAnnotation,

Page.GetNextAnnotation, or Page.GetAnnotationCount method.

Annotation::Annotate

method

Applies the annotation to the provided canvas. This is the equivalent

of calling the Canvas::Annotate method.

Annotation::Appearance

property

Contains the appearance streams for the annotation.

Annotation::Border

property

Indicates the border style of the annotation.

Annotation::Color

property

Indicates the color of the annotation.

Annotation::DateCreated

property

Indicates the date the annotation was created.

Annotation::DateModied

property

Indicates the date the annotation was last modied.

Annotation::Flags

property

Indicates the ags of the annotation.

Annotation::Intent

property

String containing a name describing the intent of the markup

annotation. Intents allow viewer applications to distinguish between

dierent uses and behaviors of a single markup annotation type. If

Document Filters Implementation Guide 2.3.3 Objects

- 609/1268 -

this entry is not present or its value is the same as the annotation

type, the annotation has no explicit intent and should behave in a

generic manner in a viewer app.

Annotation::Name

property

Indicates the name of the annotation.

Annotation::Opacity

property

The constant opacity value to be used in painting the annotation

Annotation::Popup

property

Pop-up annotation for entering or editing the text associated with

this annotation.

Annotation::Rect property Indicates the rectangle of the annotation.

Annotation::Replies

property

Contains the list of replies to the annotation.

Annotation::Subject

property

Text representing a short description of the subject being addressed

by the annotation.

Annotation::Text property String to be displayed for the annotation or, if this type of annotation

does not display text, an alternate description of the annotation's

contents in human-readable form.

Annotation::Type

property

Indicates the type of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 610/1268 -

ANNOTATIONPOLYLINE::POINTS PROPERTY

Indicates the points of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationPointList

See Also

AnnotationPointList

IList<System.Drawing.Point> Points { get; set; }

AnnotationPointList getPoints() throws IGRException;

void setPoints(AnnotationPointList value) throws IGRException;

@property

def Points(self) -> AnnotationPointList:

@property.setter

def Points(self, value: AnnotationPointList)

[propget] HRESULT Points([out, retval] AnnotationPointList* *result);

[propput] HRESULT Points([in] AnnotationPointList* value);

•

Document Filters Implementation Guide 2.3.3 Objects

- 611/1268 -

ANNOTATIONPOLYLINE::LINEENDINGS PROPERTY

Indicates the line endings of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationLineEndings

Hyland.DocumentFilters.Annotations.LineEndings LineEndings { get; set; }

AnnotationLineEndings getLineEndings() throws IGRException;

void setLineEndings(AnnotationLineEndings value) throws IGRException;

@property

def LineEndings(self) -> AnnotationLineEndings:

@property.setter

def LineEndings(self, value: AnnotationLineEndings)

[propget] HRESULT LineEndings([out, retval] AnnotationLineEndings* *result);

[propput] HRESULT LineEndings([in] AnnotationLineEndings* value);

Document Filters Implementation Guide 2.3.3 Objects

- 612/1268 -

AnnotationPopup

ANNOTATIONPOPUP INTERFACE

A pop-up annotation displays text in a pop-up window for entry and editing. It typically does not appear

alone but is associated with a markup annotation, its parent annotation, and is used for editing the

parent’s text.

It has no appearance stream or associated actions of its own.

Inherited from Annotation

AnnotationPopup::Open property Indicates whether the annotation is open/visible.

Annotation::Annotation

interface

The Annotation interface represents a single annotation on a given

page.

To obtain this interface, call the Page.GetFirstAnnotation,

Page.GetNextAnnotation, or Page.GetAnnotationCount method.

Annotation::Annotate

method

Applies the annotation to the provided canvas. This is the equivalent

of calling the Canvas::Annotate method.

Annotation::Appearance

property

Contains the appearance streams for the annotation.

Annotation::Border

property

Indicates the border style of the annotation.

Annotation::Color

property

Indicates the color of the annotation.

Annotation::DateCreated

property

Indicates the date the annotation was created.

Annotation::DateModied

property

Indicates the date the annotation was last modied.

Annotation::Flags

property

Indicates the ags of the annotation.

Annotation::Intent

property

String containing a name describing the intent of the markup

annotation. Intents allow viewer applications to distinguish between

dierent uses and behaviors of a single markup annotation type. If

Document Filters Implementation Guide 2.3.3 Objects

- 613/1268 -

this entry is not present or its value is the same as the annotation

type, the annotation has no explicit intent and should behave in a

generic manner in a viewer app.

Annotation::Name

property

Indicates the name of the annotation.

Annotation::Opacity

property

The constant opacity value to be used in painting the annotation

Annotation::Popup

property

Pop-up annotation for entering or editing the text associated with

this annotation.

Annotation::Rect property Indicates the rectangle of the annotation.

Annotation::Replies

property

Contains the list of replies to the annotation.

Annotation::Subject

property

Text representing a short description of the subject being addressed

by the annotation.

Annotation::Text property String to be displayed for the annotation or, if this type of annotation

does not display text, an alternate description of the annotation's

contents in human-readable form.

Annotation::Type

property

Indicates the type of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 614/1268 -

ANNOTATIONPOPUP::OPEN PROPERTY

Indicates whether the annotation is open/visible.

.NET

JAVA

PYTHON

COM

Return Value

bool

bool Open { get; set; }

boolean getOpen() throws IGRException;

void setOpen(boolean value) throws IGRException;

@property

def Open(self) -> bool:

@property.setter

def Open(self, value: bool)

[propget] HRESULT Open([out, retval] VARIANT_BOOL *result);

[propput] HRESULT Open([in] VARIANT_BOOL value);

Document Filters Implementation Guide 2.3.3 Objects

- 615/1268 -

AnnotationQrCode

ANNOTATIONQRCODE INTERFACE

Represents a QR code barcode annotation.

Inherited from AnnotationBarcode

AnnotationBarcode::AnnotationBarcode

interface

Implements Annotation Interface. Represents the

base class for all barcode annotations.

AnnotationBarcode::SubType property Indicates the subtype of the barcode.

AnnotationBarcode::Caption property Indicates the caption of the barcode.

AnnotationBarcode::Content property Indicates the content of the barcode.

AnnotationBarcode::ErrorCorrectionLevel

property

Indicates the error correction level of the barcode.

AnnotationBarcode::Margin property Indicates the margin of the barcode.

AnnotationBarcode::BgColor property Indicates the background color of the barcode.

Document Filters Implementation Guide 2.3.3 Objects

- 616/1268 -

AnnotationRect

ANNOTATIONRECT INTERFACE

The AnnotationRect interface represents an annotation’s bounding box.

AnnotationRect::Left property The Left property returns the left coordinate of the annotation’s

bounding box.

AnnotationRect::Top property The Top property returns the top coordinate of the annotation’s

bounding box.

AnnotationRect::Right

property

The Right property returns the right coordinate of the

annotation’s bounding box.

AnnotationRect::Bottom

property

The Bottom property returns the bottom coordinate of the

annotation’s bounding box.

Document Filters Implementation Guide 2.3.3 Objects

- 617/1268 -

ANNOTATIONRECT::LEFT PROPERTY

The Left property returns the left coordinate of the annotation’s bounding box.

.NET

JAVA

PYTHON

COM

Return Value

double

double Left { get; set; }

double getLeft() throws IGRException;

void setLeft(double value) throws IGRException;

@property

def Left(self) -> double:

@property.setter

def Left(self, value: double)

[propget] HRESULT Left([out, retval] double* *result);

[propput] HRESULT Left([in] double* value);

Document Filters Implementation Guide 2.3.3 Objects

- 618/1268 -

ANNOTATIONRECT::TOP PROPERTY

The Top property returns the top coordinate of the annotation’s bounding box.

.NET

JAVA

PYTHON

COM

Return Value

double

double Top { get; set; }

double getTop() throws IGRException;

void setTop(double value) throws IGRException;

@property

def Top(self) -> double:

@property.setter

def Top(self, value: double)

[propget] HRESULT Top([out, retval] double* *result);

[propput] HRESULT Top([in] double* value);

Document Filters Implementation Guide 2.3.3 Objects

- 619/1268 -

ANNOTATIONRECT::RIGHT PROPERTY

The Right property returns the right coordinate of the annotation’s bounding box.

.NET

JAVA

PYTHON

COM

Return Value

double

double Right { get; set; }

double getRight() throws IGRException;

void setRight(double value) throws IGRException;

@property

def Right(self) -> double:

@property.setter

def Right(self, value: double)

[propget] HRESULT Right([out, retval] double* *result);

[propput] HRESULT Right([in] double* value);

Document Filters Implementation Guide 2.3.3 Objects

- 620/1268 -

ANNOTATIONRECT::BOTTOM PROPERTY

The Bottom property returns the bottom coordinate of the annotation’s bounding box.

.NET

JAVA

PYTHON

COM

Return Value

double

double Bottom { get; set; }

double getBottom() throws IGRException;

void setBottom(double value) throws IGRException;

@property

def Bottom(self) -> double:

@property.setter

def Bottom(self, value: double)

[propget] HRESULT Bottom([out, retval] double* *result);

[propput] HRESULT Bottom([in] double* value);

Document Filters Implementation Guide 2.3.3 Objects

- 621/1268 -

AnnotationRectangle

ANNOTATIONRECTANGLE INTERFACE

A rectangle annotation displays a rectangle on the page. When opened, it displays a pop-up window

containing the text of the associated note.

Inherited from Annotation

AnnotationRectangle::InteriorColor property Indicates the interior color of the annotation.

AnnotationRectangle::RectDierences

property

Indicates the rectangle dierences of the

annotation.

Annotation::Annotation

interface

The Annotation interface represents a single annotation on a given

page.

To obtain this interface, call the Page.GetFirstAnnotation,

Page.GetNextAnnotation, or Page.GetAnnotationCount method.

Annotation::Annotate

method

Applies the annotation to the provided canvas. This is the equivalent

of calling the Canvas::Annotate method.

Annotation::Appearance

property

Contains the appearance streams for the annotation.

Annotation::Border

property

Indicates the border style of the annotation.

Annotation::Color

property

Indicates the color of the annotation.

Annotation::DateCreated

property

Indicates the date the annotation was created.

Annotation::DateModied

property

Indicates the date the annotation was last modied.

Annotation::Flags

property

Indicates the ags of the annotation.

Annotation::Intent

property

String containing a name describing the intent of the markup

annotation. Intents allow viewer applications to distinguish between

dierent uses and behaviors of a single markup annotation type. If

Document Filters Implementation Guide 2.3.3 Objects

- 622/1268 -

this entry is not present or its value is the same as the annotation

type, the annotation has no explicit intent and should behave in a

generic manner in a viewer app.

Annotation::Name

property

Indicates the name of the annotation.

Annotation::Opacity

property

The constant opacity value to be used in painting the annotation

Annotation::Popup

property

Pop-up annotation for entering or editing the text associated with

this annotation.

Annotation::Rect property Indicates the rectangle of the annotation.

Annotation::Replies

property

Contains the list of replies to the annotation.

Annotation::Subject

property

Text representing a short description of the subject being addressed

by the annotation.

Annotation::Text property String to be displayed for the annotation or, if this type of annotation

does not display text, an alternate description of the annotation's

contents in human-readable form.

Annotation::Type

property

Indicates the type of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 623/1268 -

ANNOTATIONRECTANGLE::INTERIORCOLOR PROPERTY

Indicates the interior color of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

string

System.Drawing.Color InteriorColor { get; set; }

string getInteriorColor() throws IGRException;

void setInteriorColor(string value) throws IGRException;

@property

def InteriorColor(self) -> string:

@property.setter

def InteriorColor(self, value: string)

[propget] HRESULT InteriorColor([out, retval] BSTR *result);

[propput] HRESULT InteriorColor([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 624/1268 -

ANNOTATIONRECTANGLE::RECTDIFFERENCES PROPERTY

Indicates the rectangle dierences of the annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationRect

Additional Information

A set of four numbers describing the numerical dierences between two rectangles: the Rect entry of the

annotation and a rectangle contained within that rectangle. The inner rectangle is where the

annotation's text should be displayed. Any border styles and/or border eects specied by BS and BE

entries, respectively, are applied to the border of the inner rectangle. The four numbers correspond to

the dierences in default user space between the left, top, right, and bottom coordinates of Rect and

those of the inner rectangle, respectively. Each value must be greater than or equal to 0. The sum of the

top and bottom dierences must be less than the height of Rect, and the sum of the left and right

dierences must be less than the width of Rect.

System.Drawing.Rectangle RectDifferences { get; set; }

AnnotationRect getRectDifferences() throws IGRException;

void setRectDifferences(AnnotationRect value) throws IGRException;

@property

def RectDifferences(self) -> AnnotationRect:

@property.setter

def RectDifferences(self, value: AnnotationRect)

[propget] HRESULT RectDifferences([out, retval] AnnotationRect* *result);

[propput] HRESULT RectDifferences([in] AnnotationRect* value);

Document Filters Implementation Guide 2.3.3 Objects

- 625/1268 -

AnnotationSquiggly

ANNOTATIONSQUIGGLY INTERFACE

Squiggly annotations are used to underline text content on a page with a squiggly line.

Inherited from AnnotationTextMarkup

AnnotationTextMarkup::AnnotationTextMarkup

interface

Represents the base class for text markup

annotations.

Document Filters Implementation Guide 2.3.3 Objects

- 626/1268 -

AnnotationStamp

ANNOTATIONSTAMP INTERFACE

A rubber stamp annotation displays text or graphics intended to look as if they were stamped on the

page with a rubber stamp. When opened, it displays a pop-up window containing the text of the

associated note.

Inherited from Annotation

AnnotationStamp::DefaultAppearance

property

Indicates the default appearance values for the

annotation.

Annotation::Annotation

interface

The Annotation interface represents a single annotation on a given

page.

To obtain this interface, call the Page.GetFirstAnnotation,

Page.GetNextAnnotation, or Page.GetAnnotationCount method.

Annotation::Annotate

method

Applies the annotation to the provided canvas. This is the equivalent

of calling the Canvas::Annotate method.

Annotation::Appearance

property

Contains the appearance streams for the annotation.

Annotation::Border

property

Indicates the border style of the annotation.

Annotation::Color

property

Indicates the color of the annotation.

Annotation::DateCreated

property

Indicates the date the annotation was created.

Annotation::DateModied

property

Indicates the date the annotation was last modied.

Annotation::Flags

property

Indicates the ags of the annotation.

Annotation::Intent

property

String containing a name describing the intent of the markup

annotation. Intents allow viewer applications to distinguish between

dierent uses and behaviors of a single markup annotation type. If

this entry is not present or its value is the same as the annotation

Document Filters Implementation Guide 2.3.3 Objects

- 627/1268 -

type, the annotation has no explicit intent and should behave in a

generic manner in a viewer app.

Annotation::Name

property

Indicates the name of the annotation.

Annotation::Opacity

property

The constant opacity value to be used in painting the annotation

Annotation::Popup

property

Pop-up annotation for entering or editing the text associated with

this annotation.

Annotation::Rect property Indicates the rectangle of the annotation.

Annotation::Replies

property

Contains the list of replies to the annotation.

Annotation::Subject

property

Text representing a short description of the subject being addressed

by the annotation.

Annotation::Text property String to be displayed for the annotation or, if this type of annotation

does not display text, an alternate description of the annotation's

contents in human-readable form.

Annotation::Type

property

Indicates the type of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 628/1268 -

ANNOTATIONSTAMP::DEFAULTAPPEARANCE PROPERTY

Indicates the default appearance values for the annotation.

.NET

JAVA

PYTHON

COM

Return Value

AnnotationDefaultAppearance

Hyland.DocumentFilters.Annotations.DefaultAppearance DefaultAppearance { get; set; }

AnnotationDefaultAppearance getDefaultAppearance() throws IGRException;

void setDefaultAppearance(AnnotationDefaultAppearance value) throws IGRException;

@property

def DefaultAppearance(self) -> AnnotationDefaultAppearance:

@property.setter

def DefaultAppearance(self, value: AnnotationDefaultAppearance)

[propget] HRESULT DefaultAppearance([out, retval] AnnotationDefaultAppearance* *result);

[propput] HRESULT DefaultAppearance([in] AnnotationDefaultAppearance* value);

Document Filters Implementation Guide 2.3.3 Objects

- 629/1268 -

AnnotationStickyNote

ANNOTATIONSTICKYNOTE INTERFACE

A text annotation represents a "sticky note" attached to a point in the document. When closed, the

annotation appears as an icon; when open, it displays a pop-up window containing the text of the note in

a font and size chosen by the viewer application.Text annotations do not scale and rotate with the page;

they behave as if the NoZoom and NoRotate annotation ags were always set.

Inherited from AnnotationNote

AnnotationStickyNote::Open property Indicates if the annotation is open/visible.

AnnotationStickyNote::IconName

property

Indicates the name of the icon to use when the

annotation is closed.

AnnotationNote::AnnotationNote interface Represents the base class for note annotations.

AnnotationNote::State property Indicates the state of the annotation.

AnnotationNote::StateModel property Indicates the state model of the annotation.

AnnotationNote::Author property Indicates the author of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 630/1268 -

ANNOTATIONSTICKYNOTE::OPEN PROPERTY

Indicates if the annotation is open/visible.

.NET

JAVA

PYTHON

COM

Return Value

bool

bool Open { get; set; }

boolean getOpen() throws IGRException;

void setOpen(boolean value) throws IGRException;

@property

def Open(self) -> bool:

@property.setter

def Open(self, value: bool)

[propget] HRESULT Open([out, retval] VARIANT_BOOL *result);

[propput] HRESULT Open([in] VARIANT_BOOL value);

Document Filters Implementation Guide 2.3.3 Objects

- 631/1268 -

ANNOTATIONSTICKYNOTE::ICONNAME PROPERTY

Indicates the name of the icon to use when the annotation is closed.

.NET

JAVA

PYTHON

COM

Return Value

string

string IconName { get; set; }

string getIconName() throws IGRException;

void setIconName(string value) throws IGRException;

@property

def IconName(self) -> string:

@property.setter

def IconName(self, value: string)

[propget] HRESULT IconName([out, retval] BSTR *result);

[propput] HRESULT IconName([in] BSTR value);

Document Filters Implementation Guide 2.3.3 Objects

- 632/1268 -

AnnotationStrikeout

ANNOTATIONSTRIKEOUT INTERFACE

Strikeout annotations are used to strike through text content on a page.

Inherited from AnnotationTextMarkup

AnnotationTextMarkup::AnnotationTextMarkup

interface

Represents the base class for text markup

annotations.

Document Filters Implementation Guide 2.3.3 Objects

- 633/1268 -

AnnotationTextMarkup

ANNOTATIONTEXTMARKUP INTERFACE

Represents the base class for text markup annotations.

Inherited from Annotation

Annotation::Annotation

interface

The Annotation interface represents a single annotation on a given

page.

To obtain this interface, call the Page.GetFirstAnnotation,

Page.GetNextAnnotation, or Page.GetAnnotationCount method.

Annotation::Annotate

method

Applies the annotation to the provided canvas. This is the equivalent

of calling the Canvas::Annotate method.

Annotation::Appearance

property

Contains the appearance streams for the annotation.

Annotation::Border

property

Indicates the border style of the annotation.

Annotation::Color

property

Indicates the color of the annotation.

Annotation::DateCreated

property

Indicates the date the annotation was created.

Annotation::DateModied

property

Indicates the date the annotation was last modied.

Annotation::Flags

property

Indicates the ags of the annotation.

Annotation::Intent

property

String containing a name describing the intent of the markup

annotation. Intents allow viewer applications to distinguish between

dierent uses and behaviors of a single markup annotation type. If

this entry is not present or its value is the same as the annotation

type, the annotation has no explicit intent and should behave in a

generic manner in a viewer app.

Indicates the name of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 634/1268 -

Annotation::Name

property

Annotation::Opacity

property

The constant opacity value to be used in painting the annotation

Annotation::Popup

property

Pop-up annotation for entering or editing the text associated with

this annotation.

Annotation::Rect property Indicates the rectangle of the annotation.

Annotation::Replies

property

Contains the list of replies to the annotation.

Annotation::Subject

property

Text representing a short description of the subject being addressed

by the annotation.

Annotation::Text property String to be displayed for the annotation or, if this type of annotation

does not display text, an alternate description of the annotation's

contents in human-readable form.

Annotation::Type

property

Indicates the type of the annotation.

Document Filters Implementation Guide 2.3.3 Objects

- 635/1268 -

AnnotationUnderline

ANNOTATIONUNDERLINE INTERFACE

Underline annotations are used to underline text content on a page.

Inherited from AnnotationTextMarkup

AnnotationTextMarkup::AnnotationTextMarkup

interface

Represents the base class for text markup

annotations.

Document Filters Implementation Guide 2.3.3 Objects

- 636/1268 -

Bookmark

BOOKMARK INTERFACE

The Bookmark interface allows for the extraction of the hierarchical navigation data for a document.

Bookmarks are either extracted directly from the document, or generated from the heading style

information

To obtain this interface, call the Extractor.GetRootBookmark method.

Bookmark::Action property The Action property returns the behavior when a user clicks the

bookmark.

Bookmark::AddChild method The AddMethod adds a new bookmark as a child of this

bookmark.

Bookmark::Color property Returns the color that the bookmark should be shown.

Bookmark::Destination

property

The Destination property returns a Unicode string for the

destination of this bookmark. The destination value is based on

the Action type of the bookmark.

Bookmark::Fit property The Fit property returns the zoom/t level that should be applied

when navigating to the destination.

Bookmark::GetFirstChild

property

The GetFirstChild method returns the rst child bookmark of the

current node, or NULL if the node contains no children.

Bookmark::GetNextSibling

property

The GetNextSibling method returns the next peer bookmark of

the current node, or NULL if the node is the last in it’s chain.

Bookmark::Height property The Height property return the dimensions on the page where

the user should be zoomed into. The dimension information is

based on the DPI used when loading the page.

Bookmark::Level property The Level property returns the depth in the hierarchy of the

current bookmark.

Bookmark::PageIndex

property

The PageIndex property returns the index of the page to navigate

to when the Action is GoTo, otherwise it returns -1.

Bookmark::Rect property Returns the destination rectangle of the bookmark.

Document Filters Implementation Guide 2.3.3 Objects

- 637/1268 -

Bookmark::TextStyle

property

Returns any text styling that should be applied when showing the

bookmark title; see Text Styles for details.

Bookmark::Title property The Title property returns a Unicode string for the title of this

bookmark.

Bookmark::Width property The Width property return the dimensions on the page where the

user should be zoomed into. The dimension information is based

on the DPI used hen loading the page.

Bookmark::X property The X property return the position on the page where the user

should be scrolled to. The position information is based on the

DPI used when loading the page.

Bookmark::Y property The Y property return the position on the page where the user

should be scrolled to. The position information is based on the

DPI used when loading the page.

Bookmark::Zoom property The Zoom property returns the zoom/t level that should be

applied when navigating to the destination.

Document Filters Implementation Guide 2.3.3 Objects

- 638/1268 -

BOOKMARK::ACTION PROPERTY

The Action property returns the behavior when a user clicks the bookmark.

.NET

JAVA

PYTHON

Return Value

int : Integer value containing the Action enumerated value, one of:

See Also

Bookmark interface

int Action { get; set; }

int getAction() throws IGRException;

void setAction(int value) throws IGRException;

@property

def Action(self) -> int:

@property.setter

def Action(self, value: int)

Name Value

IGR_BOOKMARK_ACTION_GOTO 0x00

IGR_BOOKMARK_ACTION_LINK 0x01

•

Document Filters Implementation Guide 2.3.3 Objects

- 639/1268 -

BOOKMARK::ADDCHILD METHOD

The AddMethod adds a new bookmark as a child of this bookmark.

Prototype

.NET

JAVA

PYTHON

Parameters

bookmark : Bookmark : The new bookmark to add

See Also

Bookmark interface

void AddChild(Bookmark bookmark)

void AddChild(Bookmark bookmark) throws IGRException;

def AddChild(self, bookmark: Bookmark) -> void

•

Document Filters Implementation Guide 2.3.3 Objects

- 640/1268 -

BOOKMARK::COLOR PROPERTY

Returns the color that the bookmark should be shown.

.NET

JAVA

PYTHON

Return Value

int : Returns the color that the bookmark should be shown.

See Also

Bookmark interface

System.Drawing.Color Color { get; set; }

int getColor() throws IGRException;

void setColor(int value) throws IGRException;

@property

def Color(self) -> int:

@property.setter

def Color(self, value: int)

•

Document Filters Implementation Guide 2.3.3 Objects

- 641/1268 -

BOOKMARK::DESTINATION PROPERTY

The Destination property returns a Unicode string for the destination of this bookmark. The destination

value is based on the Action type of the bookmark.

.NET

JAVA

PYTHON

Return Value

string : Unicode string containing the destination of the bookmark.

See Also

Bookmark interface

string Destination { get; set; }

string getDestination() throws IGRException;

void setDestination(string value) throws IGRException;

@property

def Destination(self) -> string:

@property.setter

def Destination(self, value: string)

•

Document Filters Implementation Guide 2.3.3 Objects

- 642/1268 -

BOOKMARK::FIT PROPERTY

The Fit property returns the zoom/t level that should be applied when navigating to the destination.

.NET

JAVA

PYTHON

Return Value

int : Integer value containing the Fit enumerated value, one of:

See Also

Bookmark interface

int Fit { get; set; }

int getFit() throws IGRException;

void setFit(int value) throws IGRException;

@property

def Fit(self) -> int:

@property.setter

def Fit(self, value: int)

Name Value

IGR_BOOKMARK_FIT_NONE 0x0

IGR_BOOKMARK_FIT_BOTH 0x1

IGR_BOOKMARK_FIT_WIDTH 0x2

IGR_BOOKMARK_FIT_HEIGHT 0x3

IGR_BOOKMARK_FIT_RECT 0x4

•

Document Filters Implementation Guide 2.3.3 Objects

- 643/1268 -

BOOKMARK::GETFIRSTCHILD PROPERTY

The GetFirstChild method returns the rst child bookmark of the current node, or NULL if the node

contains no children.

Prototype

.NET

JAVA

PYTHON

Return value

Bookmark : The GetFirstChild method returns the rst child bookmark of the current node, or NULL if the

node contains no children.

See Also

Bookmark interface

Bookmark GetFirstChild()

Bookmark GetFirstChild() throws IGRException;

def GetFirstChild(self) -> Bookmark

•

Document Filters Implementation Guide 2.3.3 Objects

- 644/1268 -

BOOKMARK::GETNEXTSIBLING PROPERTY

The GetNextSibling method returns the next peer bookmark of the current node, or NULL if the node is

the last in it’s chain.

Prototype

.NET

JAVA

PYTHON

Return value

Bookmark : The GetNextSibling method returns the next peer bookmark of the current node, or NULL if

the node is the last in it’s chain.

See Also

Bookmark interface

Bookmark GetNextSibling()

Bookmark GetNextSibling() throws IGRException;

def GetNextSibling(self) -> Bookmark

•

Document Filters Implementation Guide 2.3.3 Objects

- 645/1268 -

BOOKMARK::HEIGHT PROPERTY

The Height property return the dimensions on the page where the user should be zoomed into. The

dimension information is based on the DPI used when loading the page.

.NET

JAVA

PYTHON

Return Value

int : Integer containing the dimension in pixels.

See Also

Bookmark interface

int Height { get; set; }

int getHeight() throws IGRException;

void setHeight(int value) throws IGRException;

@property

def Height(self) -> int:

@property.setter

def Height(self, value: int)

•

Document Filters Implementation Guide 2.3.3 Objects

- 646/1268 -

BOOKMARK::LEVEL PROPERTY

The Level property returns the depth in the hierarchy of the current bookmark.

.NET

JAVA

PYTHON

Return Value

int : The Level property returns the depth in the hierarchy of the current bookmark.

See Also

Bookmark interface

int Level { get; set; }

int getLevel() throws IGRException;

void setLevel(int value) throws IGRException;

@property

def Level(self) -> int:

@property.setter

def Level(self, value: int)

•

Document Filters Implementation Guide 2.3.3 Objects

- 647/1268 -

BOOKMARK::PAGEINDEX PROPERTY

The PageIndex property returns the index of the page to navigate to when the Action is GoTo, otherwise

it returns -1.

.NET

JAVA

PYTHON

Return Value

int : The PageIndex property returns the index of the page to navigate to when the Action is GoTo,

otherwise it returns -1.

See Also

Bookmark interface

int PageIndex { get; set; }

int getPageIndex() throws IGRException;

void setPageIndex(int value) throws IGRException;

@property

def PageIndex(self) -> int:

@property.setter

def PageIndex(self, value: int)

•

Document Filters Implementation Guide 2.3.3 Objects

- 648/1268 -

BOOKMARK::RECT PROPERTY

Returns the destination rectangle of the bookmark.

.NET

Return Value

System.Drawing.Rect : The destination rectangle.

See Also

Bookmark interface

TextStyleFlags Rect { get; set; }

•

Document Filters Implementation Guide 2.3.3 Objects

- 649/1268 -

BOOKMARK::TEXTSTYLE PROPERTY

Returns any text styling that should be applied when showing the bookmark title; see Text Styles for

details.

.NET

JAVA

PYTHON

Return Value

int : See Text Styles for details

See Also

Bookmark interface

TextStyleFlags TextStyle { get; set; }

int getTextStyle() throws IGRException;

void setTextStyle(int value) throws IGRException;

@property

def TextStyle(self) -> int:

@property.setter

def TextStyle(self, value: int)

•

Document Filters Implementation Guide 2.3.3 Objects

- 650/1268 -

BOOKMARK::TITLE PROPERTY

The Title property returns a Unicode string for the title of this bookmark.

.NET

JAVA

PYTHON

Return Value

string : Unicode string containing the title of the bookmark.

See Also

Bookmark interface

string Title { get; set; }

string getTitle() throws IGRException;

void setTitle(string value) throws IGRException;

@property

def Title(self) -> string:

@property.setter

def Title(self, value: string)

•

Document Filters Implementation Guide 2.3.3 Objects

- 651/1268 -

BOOKMARK::WIDTH PROPERTY

The Width property return the dimensions on the page where the user should be zoomed into. The

dimension information is based on the DPI used hen loading the page.

.NET

JAVA

PYTHON

Return Value

int : Integer containing the dimension in pixels.

See Also

Bookmark interface

int Width { get; set; }

int getWidth() throws IGRException;

void setWidth(int value) throws IGRException;

@property

def Width(self) -> int:

@property.setter

def Width(self, value: int)

•

Document Filters Implementation Guide 2.3.3 Objects

- 652/1268 -

BOOKMARK::X PROPERTY

The X property return the position on the page where the user should be scrolled to. The position

information is based on the DPI used when loading the page.

.NET

JAVA

PYTHON

Return Value

int : Integer containing the coordinate in pixels.

See Also

Bookmark interface

int X { get; set; }

int getX() throws IGRException;

void setX(int value) throws IGRException;

@property

def X(self) -> int:

@property.setter

def X(self, value: int)

•

Document Filters Implementation Guide 2.3.3 Objects

- 653/1268 -

BOOKMARK::Y PROPERTY

The Y property return the position on the page where the user should be scrolled to. The position

information is based on the DPI used when loading the page.

.NET

JAVA

PYTHON

Return Value

int : Integer containing the coordinate in pixels.

See Also

Bookmark interface

int Y { get; set; }

int getY() throws IGRException;

void setY(int value) throws IGRException;

@property

def Y(self) -> int:

@property.setter

def Y(self, value: int)

•

Document Filters Implementation Guide 2.3.3 Objects

- 654/1268 -

BOOKMARK::ZOOM PROPERTY

The Zoom property returns the zoom/t level that should be applied when navigating to the destination.

.NET

JAVA

PYTHON

Return Value

double : The Zoom property returns the zoom/t level that should be applied when navigating to the

destination.

See Also

Bookmark interface

double Zoom { get; set; }

double getZoom() throws IGRException;

void setZoom(double value) throws IGRException;

@property

def Zoom(self) -> double:

@property.setter

def Zoom(self, value: double)

•

Document Filters Implementation Guide 2.3.3 Objects

- 655/1268 -

Canvas

CANVAS INTERFACE

The Canvas interface allows rendering of pages to a variety of output devices, including HD HTML, PNG,

and PDF.

The Canvas object also allows post-processing / image manipulation of output such as annotations,

redaction, bates stamping, or general drawing.

To obtain this interface, call the DocumentFilters.MakeOutputCanvas or

DocumentFilters.MakeOutputCanvasOnStream methods.

Note The drawing API is available for bitmap and PDF outputs only.

Canvas::AddCustomMetadata

method

Add a custom metadata eld to the output canvas. This

function MUST be called before the rst call to

RenderPage.

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”.

Canvas::AppendBookmark method Appends only this current bookmark.

This function does not enumerate the Children

bookmarks.

Canvas::AppendBookmarkRecursive

method

Appends this bookmark and the and it's children

recursively.

Canvas::Arc method The Arc method draws an arc on the image along the

perimeter of the ellipse, bounded by the specied

rectangle. It uses the current Pen.

Canvas::BlankPage method Create a blank page on the canvas with the specied

properties.

Canvas::Chord method The Chord method draws a closed gure represented by

the intersection of a line and an ellipse. The ellipse is

Document Filters Implementation Guide 2.3.3 Objects

- 656/1268 -

bisected by a line that runs between X3, Y3 and X4, Y4

coordinates.

Canvas::ClearBookmarks method Remove existing bookmarks from the canvas.

Canvas::Close method Close the canvas object, disposing of any resources.

Canvas::DrawImage method DrawImage renders an image from a buer onto the

Canvas.

Canvas::DrawScaleImage method DrawScaleImage renders an image from a buer onto

the Canvas. The image is scaled to a specied size.

Canvas::Ellipse method The Ellipse method draws the ellipse dened by a

bounding rectangle on the canvas, outlined with the

current pen and lled with the current brush.

Canvas::Handle property Returns the internal HCANVAS handle for the canvas

object.

Canvas::LineTo method LineTo draws a line on the canvas from current pen

position to the point specied by X and Y, and sets the

pen position to (X, Y) coordinates.

Canvas::MoveTo method MoveTo changes the current drawing position to the point

(X, Y).

Canvas::Pie method The Pie method draws a pie-shaped section of the ellipse

on the canvas, bounded by the rectangle (X, Y) and (X2,

Y2).

Canvas::Rect method The Rect method draws a rectangle using the Brush and

Pen of the canvas to ll and draw the border.

Canvas::RenderPage method Render a page to the canvas using default options.

Canvas::RenderPages method Render all pages of the extractor to the canvas.

Canvas::RoundRect method RoundRect draws a rectangle with rounded corners on

the canvas, outlined with the current pen and lled with

the current brush.

Canvas::SetBrush method SetBrush updates the current brush on the canvas with

the given color and style. Brushes are used when

drawing rectangles and text.

Document Filters Implementation Guide 2.3.3 Objects

- 657/1268 -

Canvas::SetFont method SetFont species the font to be used when drawing text

to the canvas. All subsequent calls to TextOut and

MeasureText will use this font.

Canvas::SetOpacity method SetOpacity sets the opacity or transparency for future

drawing routines.

Canvas::SetPen method SetPen updates the canvas pen with the specic color,

width, and style.

Canvas::TextOut method TextOut writes a string on the canvas, starting at (X, Y). It

updates the pen position to the end of the string and

uses the current font and brush.

Canvas::TextRect method Writes a string inside a clipping rectangle, using the

current brush and font.

Canvas::TextWidth method Returns the width in pixels, of a string if rendered with

the current font.

Canvas::TextHeight method Returns the height in pixels, of a string if rendered with

the current font.

Document Filters Implementation Guide 2.3.3 Objects

- 658/1268 -

CANVAS::ADDCUSTOMMETADATA METHOD

Add a custom metadata eld to the output canvas. This function MUST be called before the rst call to

RenderPage.

Prototype

.NET

JAVA

PYTHON

Parameters

value: string : The name of the metadata eld.

Return value

void : void

void AddCustomMetadata(string name, string value)

void AddCustomMetadata(string name, string value) throws IGRException;

def AddCustomMetadata(self, name: string, value: string) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 659/1268 -

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)

Prototype

.NET

JAVA

PYTHON

Parameters

annotation: string : JSON representation of an annotation.

Return value

void : void

Annotate(Annotation)

Prototype

.NET

JAVA

PYTHON

Annotate(string) Add an annotation from a JSON.

Annotate(Annotation) Add an annotation from am object.

void Annotate(string annotation)

void Annotate(string annotation) throws IGRException;

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

void Annotate(Annotation annotation)

void Annotate(Annotation annotation) throws IGRException;

Document Filters Implementation Guide 2.3.3 Objects

- 660/1268 -

Parameters

annotation : Annotation : Object representation of an annotation.

Return value

void : void

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

Document Filters Implementation Guide 2.3.3 Objects

- 661/1268 -

CANVAS::APPENDBOOKMARK METHOD

Appends only this current bookmark.

This function does not enumerate the Children bookmarks.

Prototype

.NET

JAVA

PYTHON

Parameters

bookmark : Bookmark : The bookmark to add to the output canvas.

Return value

void : void

void AppendBookmark(Bookmark bookmark)

void AppendBookmark(Bookmark bookmark) throws IGRException;

def AppendBookmark(self, bookmark: Bookmark) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 662/1268 -

CANVAS::APPENDBOOKMARKRECURSIVE METHOD

Appends this bookmark and the and it's children recursively.

Prototype

.NET

JAVA

PYTHON

Parameters

bookmark : Bookmark : The bookmark to add to the output canvas.

Return value

void : void

void AppendBookmarkRecursive(Bookmark bookmark)

void AppendBookmarkRecursive(Bookmark bookmark) throws IGRException;

def AppendBookmarkRecursive(self, bookmark: Bookmark) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 663/1268 -

CANVAS::ARC METHOD

The Arc method draws an arc on the image along the perimeter of the ellipse, bounded by the specied

rectangle. It uses the current Pen.

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

x: int : Left-most coordinate of the bounding box.

y: int : Top-most coordinate of the bounding box.

x2: int : Right-most coordinate of the bounding box.

y2: int : Bottom-most coordinate of the bounding box.

x3: int : X coordinate of the start point.

y3: int : Y coordinate of the start point.

x4: int : X coordinate of the end point.

y4: int : Y coordinate of the end point.

void Arc(int x, int y, int x2, int y2, int x3, int y3, int x4, int y4)

void Arc(int x, int y, int x2, int y2, int x3, int y3, int x4, int y4) throws IGRException;

def Arc(self, x: int, y: int, x2: int, y2: int, x3: int, y3: int, x4: int, y4: int) -> void

void Arc(int x, int y, int x2, int y2, int x3, int y3, int x4, int y4)

HRESULT Arc([in] int x, [in] int y, [in] int x2, [in] int y2, [in] int x3, [in] int y3, [in] int x4, [in]

int y4)

Document Filters Implementation Guide 2.3.3 Objects

- 664/1268 -

CANVAS::BLANKPAGE METHOD

Create a blank page on the canvas with the specied properties.

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

width: int : The width of the new page, in pixels.

height: int : The height of the new page, in pixels.

options: string : Canvas processing options to use when creating the new page.

void BlankPage(int width, int height, string options)

void BlankPage(int width, int height, string options) throws IGRException;

def BlankPage(self, width: int, height: int, options: string) -> void

void BlankPage(int width, int height, std::wstring options)

HRESULT BlankPage([in] int width, [in] int height, [in] BSTR options)

Document Filters Implementation Guide 2.3.3 Objects

- 665/1268 -

CANVAS::CHORD METHOD

The Chord method draws a closed gure represented by the intersection of a line and an ellipse. The

ellipse is bisected by a line that runs between X3, Y3 and X4, Y4 coordinates.

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

x: int : Left-most coordinate of the bounding box.

y: int : Top-most coordinate of the bounding box.

x2: int : Right-most coordinate of the bounding box.

y2: int : Bottom-most coordinate of the bounding box.

x3: int : X coordinate of the start point.

y3: int : Y coordinate of the start point.

x4: int : X coordinate of the end point.

y4: int : Y coordinate of the end point.

void Chord(int x, int y, int x2, int y2, int x3, int y3, int x4, int y4)

void Chord(int x, int y, int x2, int y2, int x3, int y3, int x4, int y4) throws IGRException;

def Chord(self, x: int, y: int, x2: int, y2: int, x3: int, y3: int, x4: int, y4: int) -> void

void Chord(int x, int y, int x2, int y2, int x3, int y3, int x4, int y4)

HRESULT Chord([in] int x, [in] int y, [in] int x2, [in] int y2, [in] int x3, [in] int y3, [in] int x4, [in]

int y4)

Document Filters Implementation Guide 2.3.3 Objects

- 666/1268 -

CANVAS::CLEARBOOKMARKS METHOD

Remove existing bookmarks from the canvas.

Prototype

.NET

JAVA

PYTHON

C++

COM

void ClearBookmarks()

void ClearBookmarks() throws IGRException;

def ClearBookmarks(self) -> void

void ClearBookmarks()

HRESULT ClearBookmarks()

Document Filters Implementation Guide 2.3.3 Objects

- 667/1268 -

CANVAS::CLOSE METHOD

Close the canvas object, disposing of any resources.

Prototype

.NET

JAVA

PYTHON

C++

COM

Additional Information

This method should be called when nished working on the canvas to release its resources. The method

will be internally called when the instance itself is released. Calling this method on closed canvases has

no eect.

Resources can also be managed with the using IDisposable pattern in C#, or the

try-with-resources pattern in Java.

void Close()

void Close() throws IGRException;

def Close(self) -> void

void Close()

HRESULT Close()

Document Filters Implementation Guide 2.3.3 Objects

- 668/1268 -

CANVAS::DRAWIMAGE METHOD

DrawImage renders an image from a buer onto the Canvas.

Overloads

DrawImage(int, int, byte[], string)

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

x: int : Left-most coordinate of the image bounding box.

y: int : Top-most coordinate of the image bounding box.

imagedata: byte[] : Binary data of the image.

mimetype: string : Describes the format of the image data.

DrawImage(int, int, byte[],

string)

DrawImage renders an image from a buer onto the

Canvas.

void DrawImage(int x, int y, byte[] imagedata, string mimetype)

void DrawImage(int x, int y, byte[] imagedata, string mimetype) throws IGRException;

def DrawImage(self, x: int, y: int, imagedata: byte[], mimetype: string) -> void

void DrawImage(int x, int y, byte[] imagedata, std::wstring mimetype)

HRESULT DrawImage([in] int x, [in] int y, [in] byte[]* imagedata, [in] BSTR mimetype)

Document Filters Implementation Guide 2.3.3 Objects

- 669/1268 -

CANVAS::DRAWSCALEIMAGE METHOD

DrawScaleImage renders an image from a buer onto the Canvas. The image is scaled to a specied

size.

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

x: int : Left-most coordinate of the image bounding box.

y: int : Top-most coordinate of the image bounding box.

width: int : Desired width of the rendered image in pixels.

height: int : Desired height of the rendered image in pixels.

imagedata: byte[] : Binary data of the image.

mimetype: string : Describes the format of the image data.

void DrawScaleImage(int x, int y, int width, int height, byte[] imagedata, string mimetype)

void DrawScaleImage(int x, int y, int width, int height, byte[] imagedata, string mimetype) throws

IGRException;

def DrawScaleImage(self, x: int, y: int, width: int, height: int, imagedata: byte[], mimetype: string) ->

void

void DrawScaleImage(int x, int y, int width, int height, byte[] imagedata, std::wstring mimetype)

HRESULT DrawScaleImage([in] int x, [in] int y, [in] int width, [in] int height, [in] byte[]* imagedata, [in]

BSTR mimetype)

Document Filters Implementation Guide 2.3.3 Objects

- 670/1268 -

CANVAS::ELLIPSE METHOD

The Ellipse method draws the ellipse dened by a bounding rectangle on the canvas, outlined with the

current pen and lled with the current brush.

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

x: int : Left-most coordinate of the bounding box.

y: int : Top-most coordinate of the bounding box.

x2: int : Right-most coordinate of the bounding box.

y2: int : Bottom-most coordinate of the bounding box.

void Ellipse(int x, int y, int x2, int y2)

void Ellipse(int x, int y, int x2, int y2) throws IGRException;

def Ellipse(self, x: int, y: int, x2: int, y2: int) -> void

void Ellipse(int x, int y, int x2, int y2)

HRESULT Ellipse([in] int x, [in] int y, [in] int x2, [in] int y2)

Document Filters Implementation Guide 2.3.3 Objects

- 671/1268 -

CANVAS::HANDLE PROPERTY

Returns the internal HCANVAS handle for the canvas object.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : The HCANVAS handle that can be used by the C API.

int Handle { get; }

int getHandle() throws IGRException;

@property

def Handle(self) -> int

int getHandle();

[propget] HRESULT Handle([out, retval] int *result);

Document Filters Implementation Guide 2.3.3 Objects

- 672/1268 -

CANVAS::LINETO METHOD

LineTo draws a line on the canvas from current pen position to the point specied by X and Y, and sets

the pen position to (X, Y) coordinates.

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

x: int : The X coordinate for the new pen position.

y: int : The Y coordinate for the new pen position.

void LineTo(int x, int y)

void LineTo(int x, int y) throws IGRException;

def LineTo(self, x: int, y: int) -> void

void LineTo(int x, int y)

HRESULT LineTo([in] int x, [in] int y)

Document Filters Implementation Guide 2.3.3 Objects

- 673/1268 -

CANVAS::MOVETO METHOD

MoveTo changes the current drawing position to the point (X, Y).

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

x: int : The X coordinate for the new pen position.

y: int : The Y coordinate for the new pen position.

void MoveTo(int x, int y)

void MoveTo(int x, int y) throws IGRException;

def MoveTo(self, x: int, y: int) -> void

void MoveTo(int x, int y)

HRESULT MoveTo([in] int x, [in] int y)

Document Filters Implementation Guide 2.3.3 Objects

- 674/1268 -

CANVAS::PIE METHOD

The Pie method draws a pie-shaped section of the ellipse on the canvas, bounded by the rectangle (X, Y)

and (X2, Y2).

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

x: int : Left-most coordinate of the bounding box.

y: int : Top-most coordinate of the bounding box.

x2: int : Right-most coordinate of the bounding box.

y2: int : Bottom-most coordinate of the bounding box.

x3: int : X coordinate of the start point.

y3: int : Y coordinate of the start point.

x4: int : X coordinate of the end point.

y4: int : Y coordinate of the end point.

void Pie(int x, int y, int x2, int y2, int x3, int y3, int x4, int y4)

void Pie(int x, int y, int x2, int y2, int x3, int y3, int x4, int y4) throws IGRException;

def Pie(self, x: int, y: int, x2: int, y2: int, x3: int, y3: int, x4: int, y4: int) -> void

void Pie(int x, int y, int x2, int y2, int x3, int y3, int x4, int y4)

HRESULT Pie([in] int x, [in] int y, [in] int x2, [in] int y2, [in] int x3, [in] int y3, [in] int x4, [in]

int y4)

Document Filters Implementation Guide 2.3.3 Objects

- 675/1268 -

CANVAS::RECT METHOD

The Rect method draws a rectangle using the Brush and Pen of the canvas to ll and draw the border.

Overloads

Rect(int, int, int, int)

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

left: int : Left-most coordinate of the bounding box.

top: int : Top-most coordinate of the bounding box.

right: int : Right-most coordinate of the bounding box.

bottom: int : Bottom-most coordinate of the bounding box.

Rect(System.Drawing.Rectangle)

Prototype

Rect(int, int, int, int) The Rect method draws a rectangle using the Brush

and Pen of the canvas to ll and draw the border.

Rect(System.Drawing.Rectangle) The Rect method draws a rectangle using the Brush

and Pen of the canvas to ll and draw the border.

void Rect(int left, int top, int right, int bottom)

void Rect(int left, int top, int right, int bottom) throws IGRException;

def Rect(self, left: int, top: int, right: int, bottom: int) -> void

void Rect(int left, int top, int right, int bottom)

HRESULT Rect([in] int left, [in] int top, [in] int right, [in] int bottom)

Document Filters Implementation Guide 2.3.3 Objects

- 676/1268 -

.NET

Parameters

rect: System.Drawing.Rectangle : The rectangle to draw.

void Rect(System.Drawing.Rectangle rect)

Document Filters Implementation Guide 2.3.3 Objects

- 677/1268 -

CANVAS::RENDERPAGE METHOD

Render a page to the canvas using default options.

Overloads

RenderPage(Page)

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

page: Page : The page to be rendered

RenderPage(Page, string)

Prototype

.NET

RenderPage(Page) Render a page to the canvas using default

options.

RenderPage(Page, string) Render a page to the canvas using the

specied options.

RenderPage(Page, string,

RenderPageProperties)

Render the page to the canvas with the

specied properties.

void RenderPage(Page page)

void RenderPage(Page page) throws IGRException;

def RenderPage(self, page: Page) -> void

void RenderPage(Page page)

HRESULT RenderPage([in] Page* page)

void RenderPage(Page page, string options)

Document Filters Implementation Guide 2.3.3 Objects

- 678/1268 -

JAVA

PYTHON

C++

COM

Parameters

page: Page : The page to be rendered

options: string : Canvas processing options to use when creating the new page.

RenderPage(Page, string, RenderPageProperties)

Prototype

.NET

JAVA

PYTHON

Parameters

page: Page : The page to render.

options: string : Canvas options to use when rendering page.

renderPageProperties: RenderPageProperties : Render properties to use when rendering the page.

void RenderPage(Page page, string options) throws IGRException;

def RenderPage(self, page: Page, options: string) -> void

void RenderPage(Page page, std::wstring options)

HRESULT RenderPage([in] Page* page, [in] BSTR options)

void RenderPage(Page page, string options, RenderPageProperties renderPageProperties)

void RenderPage(Page page, string options, RenderPageProperties renderPageProperties) throws IGRException;

def RenderPage(self, page: Page, options: string, renderPageProperties: RenderPageProperties) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 679/1268 -

Sample Code

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.OpenExtractor("filename.doc", OpenMode.Paginated);

8 foreach (var page in doc.Pages)

9 {

10 using (page)

11 {

12 using var canvas = api.MakeOutputCanvas($"page-{page.Index+1}.png", CanvasType.PNG);

14 var renderPageProperties = new RenderPageProperties();

15 renderPageProperties.AddFormValue("FormKey", "NewFormValue", true);

17 canvas.RenderPage(page, "", renderPageProperties);

18 }

19 }

Document Filters Implementation Guide 2.3.3 Objects

- 680/1268 -

CANVAS::RENDERPAGES METHOD

Render all pages of the extractor to the canvas.

Prototype

.NET

JAVA

PYTHON

Parameters

extractor: Extractor : The extractor containing the pages to render.

Sample Code

void RenderPages(Extractor extractor)

void RenderPages(Extractor extractor) throws IGRException;

def RenderPages(self, extractor: Extractor) -> void

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.OpenExtractor("filename.doc", OpenMode.Paginated);

7 using var canvas = api.MakeOutputCanvas("filename.pdf", CanvasType.PDF);

9 canvas.RenderPages(doc);

Document Filters Implementation Guide 2.3.3 Objects

- 681/1268 -

CANVAS::ROUNDRECT METHOD

RoundRect draws a rectangle with rounded corners on the canvas, outlined with the current pen and

lled with the current brush.

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

x: int : Left-most coordinate of the bounding box.

y: int : Top-most coordinate of the bounding box.

x2: int : Right-most coordinate of the bounding box.

y2: int : Bottom-most coordinate of the bounding box.

radius: int : The radius to use for the rounded corner.

void RoundRect(int x, int y, int x2, int y2, int radius)

void RoundRect(int x, int y, int x2, int y2, int radius) throws IGRException;

def RoundRect(self, x: int, y: int, x2: int, y2: int, radius: int) -> void

void RoundRect(int x, int y, int x2, int y2, int radius)

HRESULT RoundRect([in] int x, [in] int y, [in] int x2, [in] int y2, [in] int radius)

Document Filters Implementation Guide 2.3.3 Objects

- 682/1268 -

CANVAS::SETBRUSH METHOD

SetBrush updates the current brush on the canvas with the given color and style. Brushes are used when

drawing rectangles and text.

Overloads

SetBrush(int, int)

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

color: int : The color expressed as a 32-bit integer.

style: int : The brush style used when drawing. See Brush Styles.

SetBrush(System.Drawing.Color, int)

Prototype

SetBrush(int, int) SetBrush updates the current brush on the canvas

with the given color and style. Brushes are used when

drawing rectangles and text.

SetBrush(System.Drawing.Color,

int)

SetBrush updates the current brush on the canvas

with the given color and style. Brushes are used when

drawing rectangles and text.

void SetBrush(int color, int style)

void SetBrush(int color, int style) throws IGRException;

def SetBrush(self, color: int, style: int) -> void

void SetBrush(int color, int style)

HRESULT SetBrush([in] int color, [in] int style)

Document Filters Implementation Guide 2.3.3 Objects

- 683/1268 -

.NET

Parameters

color: System.Drawing.Color : The color expressed as a System.Drawing.Color

style: int : The brush style used when drawing. See Brush Styles.

void SetBrush(System.Drawing.Color color, int style)

Document Filters Implementation Guide 2.3.3 Objects

- 684/1268 -

CANVAS::SETFONT METHOD

SetFont species the font to be used when drawing text to the canvas. All subsequent calls to TextOut

and MeasureText will use this font.

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

name: string : Font Family name to use; this is the font display name such as ‘Arial’ or ‘Courier New.’

size: int : The size to render the font.

style: int : A bitmask of style information. See Font Styles for details.

void SetFont(string name, int size, int style)

void SetFont(string name, int size, int style) throws IGRException;

def SetFont(self, name: string, size: int, style: int) -> void

void SetFont(std::wstring name, int size, int style)

HRESULT SetFont([in] BSTR name, [in] int size, [in] int style)

Document Filters Implementation Guide 2.3.3 Objects

- 685/1268 -

CANVAS::SETOPACITY METHOD

SetOpacity sets the opacity or transparency for future drawing routines.

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

opacity: int : The opacity expressed from 0 to 255.

void SetOpacity(int opacity)

void SetOpacity(int opacity) throws IGRException;

def SetOpacity(self, opacity: int) -> void

void SetOpacity(int opacity)

HRESULT SetOpacity([in] int opacity)

Document Filters Implementation Guide 2.3.3 Objects

- 686/1268 -

CANVAS::SETPEN METHOD

SetPen updates the canvas pen with the specic color, width, and style.

Overloads

SetPen(int, int, int)

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

color: int : The color expressed as a 32-bit integer.

width: int : The width of the pen, expressed in points.

style: int : The pen style used when drawing. See Pen Styles.

SetPen(System.Drawing.Color, int, int)

Prototype

.NET

SetPen(int, int, int) SetPen updates the canvas pen with the specic

color, width, and style.

SetPen(System.Drawing.Color, int,

int)

SetPen updates the canvas pen with the specic

color, width, and style.

void SetPen(int color, int width, int style)

void SetPen(int color, int width, int style) throws IGRException;

def SetPen(self, color: int, width: int, style: int) -> void

void SetPen(int color, int width, int style)

HRESULT SetPen([in] int color, [in] int width, [in] int style)

Document Filters Implementation Guide 2.3.3 Objects

- 687/1268 -

Parameters

color: System.Drawing.Color : The color expressed as a System.Drawing.Color

width: int : The width of the pen, expressed in points.

style: int : The pen style used when drawing. See Pen Styles.

void SetPen(System.Drawing.Color color, int width, int style)

Document Filters Implementation Guide 2.3.3 Objects

- 688/1268 -

CANVAS::TEXTOUT METHOD

TextOut writes a string on the canvas, starting at (X, Y). It updates the pen position to the end of the

string and uses the current font and brush.

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

x: int : Left-most coordinate of the bounding box.

y: int : Top-most coordinate of the bounding box.

text: string : The text to output to the canvas.

void TextOut(int x, int y, string text)

void TextOut(int x, int y, string text) throws IGRException;

def TextOut(self, x: int, y: int, text: string) -> void

void TextOut(int x, int y, std::wstring text)

HRESULT TextOut([in] int x, [in] int y, [in] BSTR text)

Document Filters Implementation Guide 2.3.3 Objects

- 689/1268 -

CANVAS::TEXTRECT METHOD

Writes a string inside a clipping rectangle, using the current brush and font.

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

x: int : Left-most coordinate of the bounding box.

y: int : Top-most coordinate of the bounding box.

x2: int : Right-most coordinate of the bounding box.

y2: int : Bottom-most coordinate of the bounding box.

text: string : The text to output to the canvas.

flags: int : Reserved for future use.

void TextRect(int x, int y, int x2, int y2, string text, int flags)

void TextRect(int x, int y, int x2, int y2, string text, int flags) throws IGRException;

def TextRect(self, x: int, y: int, x2: int, y2: int, text: string, flags: int) -> void

void TextRect(int x, int y, int x2, int y2, std::wstring text, int flags)

HRESULT TextRect([in] int x, [in] int y, [in] int x2, [in] int y2, [in] BSTR text, [in] int flags)

Document Filters Implementation Guide 2.3.3 Objects

- 690/1268 -

CANVAS::TEXTWIDTH METHOD

Returns the width in pixels, of a string if rendered with the current font.

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

text: string : A string containing the text to be measured.

Return value

int : Integer expressing the width or height.

int TextWidth(string text)

int TextWidth(string text) throws IGRException;

def TextWidth(self, text: string) -> int

int TextWidth(std::wstring text)

HRESULT TextWidth([in] BSTR text, [out, retval] int *result)

Document Filters Implementation Guide 2.3.3 Objects

- 691/1268 -

CANVAS::TEXTHEIGHT METHOD

Returns the height in pixels, of a string if rendered with the current font.

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

text: string : A string containing the text to be measured.

Return value

int : Integer expressing the width or height.

int TextHeight(string text)

int TextHeight(string text) throws IGRException;

def TextHeight(self, text: string) -> int

int TextHeight(std::wstring text)

HRESULT TextHeight([in] BSTR text, [out, retval] int *result)

Document Filters Implementation Guide 2.3.3 Objects

- 692/1268 -

CompareDocumentSettings

COMPAREDOCUMENTSETTINGS INTERFACE

The CompareDocumentSettings controls the compare settings for a document.

CompareDocumentSettings::FirstPage

property

Indicates the index of the rst page to include in

the document comparison.

CompareDocumentSettings::PageCount

property

Indicates the number of pages to include in the

document comparison.

CompareDocumentSettings::Margins

property

Indicates the margins from top, left, bottom and

right for the document.

Document Filters Implementation Guide 2.3.3 Objects

- 693/1268 -

COMPAREDOCUMENTSETTINGS::FIRSTPAGE PROPERTY

Indicates the index of the rst page to include in the document comparison.

.NET

JAVA

PYTHON

Return Value

Extractor : The rst page to compare.

Extractor FirstPage { get; set; }

Extractor getFirstPage() throws IGRException;

void setFirstPage(Extractor value) throws IGRException;

@property

def FirstPage(self) -> Extractor:

@property.setter

def FirstPage(self, value: Extractor)

Document Filters Implementation Guide 2.3.3 Objects

- 694/1268 -

COMPAREDOCUMENTSETTINGS::PAGECOUNT PROPERTY

Indicates the number of pages to include in the document comparison.

.NET

JAVA

PYTHON

Return Value

Extractor : The number of pages to compare.

Extractor PageCount { get; set; }

Extractor getPageCount() throws IGRException;

void setPageCount(Extractor value) throws IGRException;

@property

def PageCount(self) -> Extractor:

@property.setter

def PageCount(self, value: Extractor)

Document Filters Implementation Guide 2.3.3 Objects

- 695/1268 -

COMPAREDOCUMENTSETTINGS::MARGINS PROPERTY

Indicates the margins from top, left, bottom and right for the document.

.NET

JAVA

PYTHON

Return Value

IGR_FRect : The margins for the document.

System.Drawing.Rectangle Margins { get; set; }

IGR_FRect getMargins() throws IGRException;

void setMargins(IGR_FRect value) throws IGRException;

@property

def Margins(self) -> IGR_FRect:

@property.setter

def Margins(self, value: IGR_FRect)

Document Filters Implementation Guide 2.3.3 Objects

- 696/1268 -

CompareDocumentSource

COMPAREDOCUMENTSOURCE INTERFACE

The CompareDocumentSource interface is used when comparing two documents, allowing you to set an

extractor and provide optional settings.

Inherited from CompareDocumentSettings

CompareDocumentSource::Extractor

property

Set Extractor property to point to an open

Extractor instance.

CompareDocumentSettings::CompareDocumentSettings

interface

The CompareDocumentSettings

controls the compare settings for a

document.

CompareDocumentSettings::FirstPage property Indicates the index of the rst page

to include in the document

comparison.

CompareDocumentSettings::PageCount property Indicates the number of pages to

include in the document

comparison.

CompareDocumentSettings::Margins property Indicates the margins from top, left,

bottom and right for the document.

Document Filters Implementation Guide 2.3.3 Objects

- 697/1268 -

COMPAREDOCUMENTSOURCE::EXTRACTOR PROPERTY

Set Extractor property to point to an open Extractor instance.

.NET

JAVA

PYTHON

Return Value

Extractor : The extractor to use as the revised document

Extractor Extractor { get; set; }

Extractor getExtractor() throws IGRException;

void setExtractor(Extractor value) throws IGRException;

@property

def Extractor(self) -> Extractor:

@property.setter

def Extractor(self, value: Extractor)

Document Filters Implementation Guide 2.3.3 Objects

- 698/1268 -

CompareResultDifference

COMPARERESULTDIFFERENCE INTERFACE

The CompareResultDierence represents a single di in a document or page comparison.

CompareResultDierence::Details property Contains the words that are part of this di.

CompareResultDierence::OriginalPageIndex

property

Indicates the page index into the original

document where the dierence occurs.

CompareResultDierence::RevisedPageIndex

property

Indicates the page index into the revised

document where the dierence occurs.

CompareResultDierence::Source property Indicates the source of the dierence.

CompareResultDierence::Type property Indicates the source of the dierence.

Document Filters Implementation Guide 2.3.3 Objects

- 699/1268 -

COMPARERESULTDIFFERENCE::DETAILS PROPERTY

Contains the words that are part of this di.

.NET

JAVA

PYTHON

Return Value

IEnumerable<DifferenceDetail> : A collection of found dierences

IEnumerable<DifferenceDetail> Details { get; }

IEnumerable<DifferenceDetail> getDetails() throws IGRException;

@property

def Details(self) -> list

Document Filters Implementation Guide 2.3.3 Objects

- 700/1268 -

COMPARERESULTDIFFERENCE::ORIGINALPAGEINDEX PROPERTY

Indicates the page index into the original document where the dierence occurs.

.NET

JAVA

PYTHON

Return Value

int : The page index in the original document.

int OriginalPageIndex { get; }

int getOriginalPageIndex() throws IGRException;

@property

def OriginalPageIndex(self) -> int

Document Filters Implementation Guide 2.3.3 Objects

- 701/1268 -

COMPARERESULTDIFFERENCE::REVISEDPAGEINDEX PROPERTY

Indicates the page index into the revised document where the dierence occurs.

.NET

JAVA

PYTHON

Return Value

int : The page index in the revised document.

int RevisedPageIndex { get; }

int getRevisedPageIndex() throws IGRException;

@property

def RevisedPageIndex(self) -> int

Document Filters Implementation Guide 2.3.3 Objects

- 702/1268 -

COMPARERESULTDIFFERENCE::SOURCE PROPERTY

Indicates the source of the dierence.

.NET

JAVA

PYTHON

Return Value

DifferenceSource : Indicates the source of the dierence

DifferenceSource Source { get; }

DifferenceSource getSource() throws IGRException;

@property

def Source(self) -> DifferenceSource

Name Constant

Original ISYS11dfConstants.IGR_COMPARE_DOCUMENTS_DIFFERENCE_SOURCE_ORIGINAL

Revised ISYS11dfConstants.IGR_COMPARE_DOCUMENTS_DIFFERENCE_SOURCE_REVISED

Both ISYS11dfConstants.IGR_COMPARE_DOCUMENTS_DIFFERENCE_SOURCE_BOTH

Document Filters Implementation Guide 2.3.3 Objects

- 703/1268 -

COMPARERESULTDIFFERENCE::TYPE PROPERTY

Indicates the source of the dierence.

.NET

JAVA

PYTHON

Return Value

DifferenceType : Indicates the type of di found.

DifferenceType Type { get; }

DifferenceType getType() throws IGRException;

@property

def Type(self) -> DifferenceType

Name Constant

Equal IGR_COMPARE_DOCUMENTS_DIFFERENCE_EQUAL

Insert IGR_COMPARE_DOCUMENTS_DIFFERENCE_INSERT

Delete IGR_COMPARE_DOCUMENTS_DIFFERENCE_DELETE

Formatting IGR_COMPARE_DOCUMENTS_DIFFERENCE_FORMATTING

NextBatch IGR_COMPARE_DOCUMENTS_DIFFERENCE_NEXT_BATCH

Document Filters Implementation Guide 2.3.3 Objects

- 704/1268 -

CompareResultDifferenceDetail

COMPARERESULTDIFFERENCEDETAIL INTERFACE

The CompareResultDierenceDetail interface contains information about the words that make up a

CompareResultDifference , including the text, page index and bounding box.

CompareResultDierenceDetail::Bounds property Contains the bounding box of the word.

CompareResultDierenceDetail::PageIndex property Contains the page index.

CompareResultDierenceDetail::Text property Contains the text of the word.

Document Filters Implementation Guide 2.3.3 Objects

- 705/1268 -

COMPARERESULTDIFFERENCEDETAIL::BOUNDS PROPERTY

Contains the bounding box of the word.

.NET

JAVA

PYTHON

Return Value

IGR_FRect : The bounding box of the di.

System.Drawing.RectangleF Bounds { get; }

IGR_FRect getBounds() throws IGRException;

@property

def Bounds(self) -> IGR_FRect

Document Filters Implementation Guide 2.3.3 Objects

- 706/1268 -

COMPARERESULTDIFFERENCEDETAIL::PAGEINDEX PROPERTY

Contains the page index.

.NET

JAVA

PYTHON

Return Value

int : The page index.

int PageIndex { get; }

int getPageIndex() throws IGRException;

@property

def PageIndex(self) -> int

Document Filters Implementation Guide 2.3.3 Objects

- 707/1268 -

COMPARERESULTDIFFERENCEDETAIL::TEXT PROPERTY

Contains the text of the word.

.NET

JAVA

PYTHON

Return Value

string : The text of the word.

string Text { get; }

string getText() throws IGRException;

@property

def Text(self) -> string

Document Filters Implementation Guide 2.3.3 Objects

- 708/1268 -

CompareResults

COMPARERESULTS INTERFACE

The CompareResults interface is the returned object from a call to Extractor::Compare or Page::Compare

and is used to enumerate the dierences between the two entities.

CompareResults::Close Method Close the instances of a page or document comparison.

CompareResults::GetNext

Method

Returns the next Difference object for a document or page

comparison.

Document Filters Implementation Guide 2.3.3 Objects

- 709/1268 -

COMPARERESULTS::CLOSE METHOD

Close the instances of a page or document comparison.

Prototype

.NET

JAVA

PYTHON

Additional Information

Resources can also be managed with the using IDisposable pattern in C#, or the

try-with-resources pattern in Java.

See Also

CompareResultDifference

void Close()

void Close() throws IGRException;

def Close(self) -> void

•

Document Filters Implementation Guide 2.3.3 Objects

- 710/1268 -

COMPARERESULTS::GETNEXT METHOD

Returns the next Difference object for a document or page comparison.

Prototype

.NET

JAVA

PYTHON

Return value

CompareResultDifference : Returns a CompareResultDifference interface that contains the details

of the next dierence.

See Also

CompareResultDifference

CompareResultDifference GetNext()

CompareResultDifference GetNext() throws IGRException;

def GetNext(self) -> CompareResultDifference

•

Document Filters Implementation Guide 2.3.3 Objects

- 711/1268 -

CompareSettings

COMPARESETTINGS INTERFACE

The CompareSettings instance allows you to set the comparison type and ags when comparing

documents or pages.

CompareSettings::CompareType property Indicates the ags that control the comparison logic.

CompareSettings::Flags property Indicates the ags that control the comparison logic.

Document Filters Implementation Guide 2.3.3 Objects

- 712/1268 -

COMPARESETTINGS::COMPARETYPE PROPERTY

Indicates the ags that control the comparison logic.

.NET

JAVA

PYTHON

Return Value

CompareType : Returns a CompareResultDifference interface that contains the details of the next

dierence.

See Also

CompareSettings

IGR_COMPARE_DOCUMENTS_FLAGS_TYPE

CompareType CompareType { get; set; }

CompareType getCompareType() throws IGRException;

void setCompareType(CompareType value) throws IGRException;

@property

def CompareType(self) -> CompareType:

@property.setter

def CompareType(self, value: CompareType)

•

Document Filters Implementation Guide 2.3.3 Objects

- 713/1268 -

COMPARESETTINGS::FLAGS PROPERTY

Indicates the ags that control the comparison logic.

.NET

JAVA

PYTHON

Return Value

int : Provide the ags that control the comparison logic.

See Also

CompareSettings

IGR_COMPARE_DOCUMENTS_FLAGS_TYPE

int Flags { get; set; }

int getFlags() throws IGRException;

void setFlags(int value) throws IGRException;

@property

def Flags(self) -> int:

@property.setter

def Flags(self, value: int)

•

Document Filters Implementation Guide 2.3.3 Objects

- 714/1268 -

DocumentFilters

DOCUMENTFILTERS INTERFACE

DocumentFilters (formerly IFileReaders) is the primary factory object in the Document Filters Object

Library. You will need to create and initialize an instance of this object to start using the API. It is

recommended to dene the object in the application scope and create and initialize it only once.

The samples for each method are provided in JScript and assume a global instance of the

DocumentFilters factory object that is already created and initialized.

DocumentFilters::GetAvailableOptions

method

Returns the list of available conguration options.

DocumentFilters::GetExtractor method The GetExtractor method obtains an Extractor

object to process a document.

DocumentFilters::GetSupportedFormats

method

Returns the list of supported le types.

DocumentFilters::Initialize method The Initialize method initializes and authorizes the

Document Filters API. It is the rst method that your

application must call.

DocumentFilters::MakeOutputCanvas

method

Creates a new canvas that is used for rendering

page content. The output data will be written to the

le specied in Filename.

DocumentFilters::OpenExtractor method The OpenExtractor is a utility method that obtains

an Extractor object and immediately call's it's Open

method to process a document.

Document Filters Implementation Guide 2.3.3 Objects

- 715/1268 -

DOCUMENTFILTERS::GETAVAILABLEOPTIONS METHOD

Returns the list of available conguration options.

Prototype

.NET

JAVA

PYTHON

Return value

IGROption[] : List of available conguration options

IEnumerable<IGROption> GetAvailableOptions()

VectIGROption GetAvailableOptions() throws IGRException;

def GetAvailableOptions(self) -> IGROption[]

Document Filters Implementation Guide 2.3.3 Objects

- 716/1268 -

DOCUMENTFILTERS::GETEXTRACTOR METHOD

The GetExtractor method obtains an Extractor object to process a document. An Extractor allows you to:

Identify a document’s type.

Extract its text.

Extract its metadata.

Enumerate and extract sub-documents.

Convert a document to HTML.

Convert a document to an image or series of images.

Overloads

GetExtractor(string)

Prototype

.NET

JAVA

PYTHON

Parameters

filename: string : Path to the document to be opened.

Return value

Extractor : Extractor

GetExtractor(stream)

Prototype

.NET

•

GetExtractor(string) Get an Extractor object from a lename.

GetExtractor(stream) Get an Extractor object from a stream.

GetExtractor(byte[]) Get an Extractor object from a byte array.

Extractor GetExtractor(string filename)

Extractor GetExtractor(string filename) throws IGRException;

def GetExtractor(self, filename: string) -> Extractor

Document Filters Implementation Guide 2.3.3 Objects

- 717/1268 -

JAVA

PYTHON

Parameters

stream: stream : Stream object pointing to the binary document content, the stream type is language

dependent.

Return value

Extractor : Extractor

GetExtractor(byte[])

Prototype

.NET

JAVA

PYTHON

Parameters

bytes: byte[] : A memory block containing binary document content.

Return value

Extractor : Extractor

Sample code

C/C++

Extractor GetExtractor(System.IO.Stream stream)

Extractor GetExtractor(IGRStream stream) throws IGRException;

def GetExtractor(self, stream: Stream) -> Extractor

Extractor GetExtractor(byte[] bytes)

Extractor GetExtractor(byte[] bytes) throws IGRException;

def GetExtractor(self, bytes: byte[]) -> Extractor

var Extractor = IFR.GetExtractor("C:\\WORD.DOC");

Document Filters Implementation Guide 2.3.3 Objects

- 718/1268 -

See also

DocumentFilters interface

Extractor interface

Extractor.SaveTo("C:\\WORD.TXT");

Extractor.Close();

using var extractor = df.GetExtractor(@"c:\word.doc")

extractor.SaveTo(@"c:\word.txt")

•

Document Filters Implementation Guide 2.3.3 Objects

- 719/1268 -

DOCUMENTFILTERS::GETSUPPORTEDFORMATS METHOD

Returns the list of supported le types.

Prototype

.NET

JAVA

PYTHON

Return value

IGRFormat[] : List of supported le types.

IEnumerable<IGRFormat> GetSupportedFormats()

VectIGRFormat GetSupportedFormats() throws IGRException;

def GetSupportedFormats(self) -> IGRFormat[]

Document Filters Implementation Guide 2.3.3 Objects

- 720/1268 -

::INITIALIZE METHOD

The Initialize method initializes and authorizes the Document Filters API. It is the rst method that your

application must call.

Prototype

.NET

JAVA

PYTHON

Parameters

license: string : Document Filters License Code.

install_dir: string : Path to Document Filters resources, such as conguration les and fonts.

Return value

void : void

Additional Information

.NET Native Library path - ISYSdf11.dll will be loaded by P/Invoke through the [DllImport] attribute

and must be either in same folder as the currently executing Assembly or found by Default Probing rules

for Unmanaged (native) libraries

Java Native Library path - ISYS11df.(dll/so/dylib) will be loaded by a call to

System.loadLibrary("ISYS11df") See System.LoadLibrary for more information

Sample code

VBScript

void Initialize(string license, string install_dir)

void Initialize(string license, string install_dir) throws IGRException;

def Initialize(self, license: string, install_dir: string) -> void

using Hyland.DocumentFilters;

DocumentFilters IFR = new DocumentFilters();

IFR.Initialize("Put Your License Code Here", "");

Set IFR = CreateObject("Perceptive.DocumentFilters.11")

IFR.Initialize "Put Your License Code Here", ""

Document Filters Implementation Guide 2.3.3 Objects

- 721/1268 -

See also

DocumentFilters interface

IFR = new ActiveXObject ("Perceptive.DocumentFilters.11");

IFR.Initialize("Put Your License Code Here", "");

•

Document Filters Implementation Guide 2.3.3 Objects

- 722/1268 -

DOCUMENTFILTERS::MAKEOUTPUTCANVAS METHOD

Creates a new canvas that is used for rendering page content. The output data will be written to the le

specied in Filename.

Overloads

MakeOutputCanvas(string, int, string)

Prototype

.NET

JAVA

PYTHON

Parameters

filename: string : Filename where canvas is to be created

canvasType: int : Indicates the type of output device to create; see Canvas Types for details.

options: string : Semicolon separated list of name value pair options; see Constants and Codes for

details.

Return value

Canvas : Canvas

MakeOutputCanvas(stream, int, string)

Prototype

.NET

JAVA

MakeOutputCanvas(string, int, string) Create a new canvas writing to a le.

MakeOutputCanvas(stream, int, string) Create a new canvas writing to a stream.

Canvas MakeOutputCanvas(string filename, int canvasType, string options)

Canvas MakeOutputCanvas(string filename, int canvasType, string options) throws IGRException;

def MakeOutputCanvas(self, filename: string, canvasType: int, options: string) -> Canvas

Canvas MakeOutputCanvas(System.IO.Stream stream, int canvasType, string options)

Canvas MakeOutputCanvas(IGRStream stream, int canvasType, string options) throws IGRException;

Document Filters Implementation Guide 2.3.3 Objects

- 723/1268 -

PYTHON

Parameters

stream: stream : Stream where canvas is to be created

canvasType: int : Indicates the type of output device to create; see Canvas Types for details.

options: string : Semicolon separated list of name value pair options; see Constants and Codes for

details.

Return value

Canvas : Canvas

Sample code

Additional Information

For output formats that support multiple pages, you may choose to write multiple input documents to a

single output document.

See also

DocumentFilters interface

Canvas interface

def MakeOutputCanvas(self, stream: Stream, canvasType: int, options: string) -> Canvas

var Canvas = Filters.MakeOutputCanvas("C:\\OUTPUT.PDF", IGR_DEVICE_IMAGE_PDF, "");

Canvas.Close();

•

Document Filters Implementation Guide 2.3.3 Objects

- 724/1268 -

DOCUMENTFILTERS::OPENEXTRACTOR METHOD

The OpenExtractor is a utility method that obtains an Extractor object and immediately call's it's Open

method to process a document. An Extractor allows you to:

Identify a document’s type.

Extract its text.

Extract its metadata.

Enumerate and extract sub-documents.

Convert a document to HTML.

Convert a document to an image or series of images.

Overloads

OpenExtractor(string, OpenMode, string, Func<OpenCallback, int>)

Prototype

.NET

JAVA

PYTHON

Parameters

filename: string : Path to the document to be opened.

•

OpenExtractor(string, OpenMode, string,

Func<OpenCallback, int>)

Get and open an extractor from a

le.

OpenExtractor(stream, OpenMode, string,

Func<OpenCallback, int>)

Get and open an extractor from a

stream.

OpenExtractor(byte[], OpenMode, string,

Func<OpenCallback, int>)

Get and open an extractor from an

array of bytes.

void OpenExtractor(string filename, OpenMode openMode, string options, Func<OpenCallback, int> callback)

throws IGRException;

def OpenExtractor(self, filename: string, openMode: OpenMode, options: string, callback: Func<OpenCallback,

int>) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 725/1268 -

openMode: OpenMode : Indicates the processing mode for the document, can be one of:

Text

Paginated

ClassicHTML

options: string : See Open Options on page.

callback: Func<OpenCallback, int> : Optional IGR_Open_Ex callback function.

OpenExtractor(stream, OpenMode, string, Func<OpenCallback, int>)

Prototype

.NET

JAVA

PYTHON

Parameters

stream: stream : Stream object pointing to the binary document content.

openMode: OpenMode : Indicates the processing mode for the document, can be one of: - Text -

Paginated - ClassicHTML

options: string : See Open Options on page.

callback: Func<OpenCallback, int> : Optional IGR_Open_Ex callback function.

OpenExtractor(byte[], OpenMode, string, Func<OpenCallback, int>)

Prototype

.NET

JAVA

•

void OpenExtractor(System.IO.Stream stream, OpenMode openMode, string options, Func<OpenCallback, int>

callback)

void OpenExtractor(IGRStream stream, OpenMode openMode, string options, Func<OpenCallback, int> callback)

throws IGRException;

def OpenExtractor(self, stream: Stream, openMode: OpenMode, options: string, callback: Func<OpenCallback,

int>) -> void

void OpenExtractor(byte[] bytes, OpenMode openMode, string options, Func<OpenCallback, int> callback)

Document Filters Implementation Guide 2.3.3 Objects

- 726/1268 -

PYTHON

Parameters

bytes: byte[] : A memory block pointing to the binary document content.

openMode: OpenMode : Indicates the processing mode for the document, can be one of: - Text -

Paginated - ClassicHTML

options: string : See Open Options on page.

callback: Func<OpenCallback, int> : Optional IGR_Open_Ex callback function.

Additional Information

OpenMode indicates extended processing options, can be one of:

BodyOnly

MetaOnly

BodyAndMeta

FormatText

FormatHTML

FormatXML

FormatHTMLIfYouCan

FormatImage

FormatHTMLNoFallback

Sample code

See also

DocumentFilters interface

Extractor interface

void OpenExtractor(byte[] bytes, OpenMode openMode, string options, Func<OpenCallback, int> callback) throws

IGRException;

def OpenExtractor(self, bytes: byte[], openMode: OpenMode, options: string, callback: Func<OpenCallback,

int>) -> void

•

using var extractor = df.OpenExtractor(@"c:\word.doc", OpenMode.Paginated, OpenType.BodyAndMeta)

extractor.SaveTo(@"c:\word.txt")

•

Document Filters Implementation Guide 2.3.3 Objects

- 727/1268 -

Extractor

EXTRACTOR INTERFACE

The Extractor interface allows you to extract the content of a document and/or enumerate its sub-

documents, such as email attachments and ZIP archives.

To obtain this interface, call the DocumentFilters.GetExtractor method. The Extractor interface contains

the following methods and properties.

Extractor::Close method The Close method releases the document resources

referenced by this Extractor object.

Extractor::Compare method The Compare method allows you to compare two documents

returning the dierences.

Extractor::CopyTo method The CopyTo method extracts the binary content of the sub-

document to a le.

Extractor::EOF property The EOF property is only valid for documents where the

SupportsText property is TRUE. The EOF property will be set to

TRUE when no more text can be extracted from the document

with calls to GetText. If the document needs to be re-read, call

Close and Open rst.

Extractor::FileType property The FileType property is the document format code, as listed

in Document Format Codes chart on page . The function is

overloaded to be able to return the format name as a string.

Extractor::GetFirstImage

method

The GetFirstImage method obtains a SubFile object

representing the rst embedded image of the current

document when converting using classic HTML.

Extractor::GetFirstPage method The GetFirstPage method returns the rst page object of an

opened document. The document must be opened in image

mode (IGR_FORMAT_IMAGE).

Extractor::GetFirstSubFile

method

The GetFirstSubFile method obtains a SubFile object

representing the rst sub-document of the current document.

Extractor::GetHashMD5 method The getHashMD5 methods obtain a string representing the

calculated hash of the current document for unique

identication.

Document Filters Implementation Guide 2.3.3 Objects

- 728/1268 -

Extractor::GetHashSHA1

method

The getHashSHA1 methods obtain a string representing the

calculated hash of the current document for unique

identication.

Extractor::GetNextImage

method

The GetNextImage method obtains a SubFile object

representing the next embedded image of the current

document when converting using classic HTML.

Extractor::GetNextPage method The GetNextPage method returns the next page object of an

opened document. The document must be opened in image

mode (IGR_FORMAT_IMAGE).

Extractor::GetNextSubFile

method

The GetNextSubFile method obtains a SubFile object

representing the next sub-document of the current document.

Extractor::GetPage method The GetPage method returns the page at the given index,

where the page index is 0-based. An exception is raised if the

index is invalid.

Extractor::GetPageCount

method

Returns the number of pages in the current document, the

document must be opened in image mode for the page count

to be populated.

Extractor::GetRootBookmark

method

The GetRootBookmark method returns a Bookmark node

representing the top-most node of the bookmark hierarchy.

The root bookmark only has Children data, it has no title or

destination properties.

Extractor::GetSubFile method The GetSubFile method obtains a SubFile object representing

the nominated sub-le of the current document.

Extractor::GetText method The GetText method extracts the next portion of text content

from the document.

Extractor::Localize property Utility function that allows for localization of metadata without

providing a callback. Any localization options must be set

before an .Open call.

Extractor::MimeType property Returns the MimeType of the le.

Extractor::Open method The Open method opens a document for processing.

Extractor::PageCount property

Document Filters Implementation Guide 2.3.3 Objects

- 729/1268 -

Returns the number of pages in the current document, the

document must be opened in image mode for the page count

to be populated.

Extractor::SaveTo method The SaveTo method extracts the entire text content of the

document in a single call. The text may be saved to a le with

the given name or via an instance of an IStream (COM) object.

Extractor::getFileType method The FileType method allows for extended information to be

returned about the le type.

Extractor::getSupportsHTML

method

getSupportsHTML method is TRUE if document can be

converted to classic HTML.

Extractor::getSupportsSubFiles

property

getSupportsSubFiles property is TRUE if the document is a

compound or archive document, potentially with sub-

documents.

Extractor::getSupportsText

method

getSupportsText method return TRUE if text content can be

extracted from the document. This property must be TRUE to

be able to call to the Extractor::SaveTo and Extractor::GetText

methods.

Document Filters Implementation Guide 2.3.3 Objects

- 730/1268 -

EXTRACTOR::CLOSE METHOD

The Close method releases the document resources referenced by this Extractor object.

Prototype

.NET

JAVA

PYTHON

C++

COM

Sample Code

Additional Information

Call this method when nished working with the document to release its resources. The method will be

internally called when the instance itself is released. Calling this method on closed documents has no

eect.

void Close()

void Close() throws IGRException;

def Close(self) -> void

void Close()

HRESULT Close()

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 while (!doc.EndOfStream)

10 {

11 var text = doc.GetText(4096);

12 Console.Out.WriteLine(text);

13 }

15 doc.Close();

Document Filters Implementation Guide 2.3.3 Objects

- 731/1268 -

See Also

Extractor Interface

Open method

•

Document Filters Implementation Guide 2.3.3 Objects

- 732/1268 -

EXTRACTOR::COMPARE METHOD

The Compare method allows you to compare two documents returning the dierences.

Overloads

Compare(Extractor, CompareSettings)

Prototype

.NET

JAVA

PYTHON

Parameters

otherDocument: Extractor : Provide the other document to compare.

settings: CompareSettings : The settings for the comparison.

Return value

CompareResults : CompareResults containing the results of the comparison.

Compare(Extractor, CompareSettings) Compare this document

to another document.

Compare(CompareDocumentSettings, Extractor,

CompareDocumentSettings, CompareSettings)

Compare this document

to another document.

Compare(CompareDocumentSettings,

CompareDocumentSource, CompareSettings)

Compare this document

to another document.

Compare(Extractor, System.Drawing.RectangleF,

CompareSettings)

Compare this document

to another document.

Compare(Page, System.Drawing.RectangleF,

System.Drawing.RectangleF, CompareSettings)

Compare this document

to another document.

CompareResults Compare(Extractor otherDocument, CompareSettings settings)

CompareResults Compare(Extractor otherDocument, CompareSettings settings) throws IGRException;

def Compare(self, otherDocument: Extractor, settings: CompareSettings) -> CompareResults

Document Filters Implementation Guide 2.3.3 Objects

- 733/1268 -

Compare(CompareDocumentSettings, Extractor, CompareDocumentSettings, CompareSettings)

Prototype

.NET

JAVA

PYTHON

Parameters

thisDocSettings: CompareDocumentSettings : The settings that apply to this left/original document

in the comparison.

otherDocument: Extractor : Provide the other document to compare.

otherDocSettings: CompareDocumentSettings : The settings that apply to this right/revised

document in the comparison.

settings: CompareSettings : The settings for the comparison.

Return value

CompareResults : CompareResults containing the results of the comparison.

Compare(CompareDocumentSettings, CompareDocumentSource, CompareSettings)

Prototype

.NET

JAVA

PYTHON

CompareResults Compare(CompareDocumentSettings thisDocSettings, Extractor otherDocument,

CompareDocumentSettings otherDocSettings, CompareSettings settings)

CompareResults Compare(CompareDocumentSettings thisDocSettings, Extractor otherDocument,

CompareDocumentSettings otherDocSettings, CompareSettings settings) throws IGRException;

def Compare(self, thisDocSettings: CompareDocumentSettings, otherDocument: Extractor, otherDocSettings:

CompareDocumentSettings, settings: CompareSettings) -> CompareResults

CompareResults Compare(CompareDocumentSettings thisDocSettings, CompareDocumentSource otherDocument,

CompareSettings settings)

CompareResults Compare(CompareDocumentSettings thisDocSettings, CompareDocumentSource otherDocument,

CompareSettings settings) throws IGRException;

Document Filters Implementation Guide 2.3.3 Objects

- 734/1268 -

Parameters

thisDocSettings: CompareDocumentSettings : The settings that apply to this left/original document

in the comparison.

otherDocument: CompareDocumentSource : Provide the other document to compare.

settings: CompareSettings : The settings for the comparison.

Return value

CompareResults : CompareResults containing the results of the comparison.

Compare(Extractor, System.Drawing.RectangleF, CompareSettings)

Prototype

.NET

Parameters

otherDocument: Extractor : Provide the other document to compare.

margins: System.Drawing.RectangleF : The top, left, right and bottom margins.

settings: CompareSettings : The settings for the comparison.

Return value

CompareResults : CompareResults containing the results of the comparison.

Compare(Page, System.Drawing.RectangleF, System.Drawing.RectangleF, CompareSettings)

Prototype

.NET

Parameters

otherPage: Page :

leftMargins: System.Drawing.RectangleF : The margins for the left/original document.

def Compare(self, thisDocSettings: CompareDocumentSettings, otherDocument: CompareDocumentSource, settings:

CompareSettings) -> CompareResults

CompareResults Compare(Extractor otherDocument, System.Drawing.RectangleF margins, CompareSettings settings)

CompareResults Compare(Page otherPage, System.Drawing.RectangleF leftMargins, System.Drawing.RectangleF

rightMargins, CompareSettings settings)

Document Filters Implementation Guide 2.3.3 Objects

- 735/1268 -

rightMargins: System.Drawing.RectangleF : The margins for the right/revised document.

settings: CompareSettings : Provide the settings that control the compare logic.

Return value

CompareResults : CompareResults containing the results of the comparison.

Sample Code

See Also

CompareDocumentSettings interface

Extractor interface

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using (var doc1 = api.OpenExtractor(GetTestFilename("original.docx"), OpenMode.Paginated))

7 using (var doc2 = api.OpenExtractor(GetTestFilename("revision.docx"), OpenMode.Paginated))

8 using (var compare = doc1.Compare(doc2))

9 {

10 while (compare.MoveNext())

11 {

12 var diff = compare.Current;

13 // work with diff...

14 }

15 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 736/1268 -

EXTRACTOR::COPYTO METHOD

The CopyTo method extracts the binary content of the sub-document to a le.

Overloads

CopyTo(string)

Prototype

.NET

JAVA

PYTHON

Parameters

filename: string : Path to a le where the binary content of the sub-document will be written.

CopyTo(stream)

Prototype

.NET

JAVA

PYTHON

Parameters

stream: stream : Stream where the binary content of the sub-document will be written.

CopyTo(string) Copy the the binary content of the sub-document to a le.

CopyTo(stream) Copy the the binary content of the sub-document to a stream.

void CopyTo(string filename)

void CopyTo(string filename) throws IGRException;

def CopyTo(self, filename: string) -> void

void CopyTo(System.IO.Stream stream)

void CopyTo(IGRStream stream) throws IGRException;

def CopyTo(self, stream: Stream) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 737/1268 -

Sample Code

See Also

Extractor Interface

1 using var extractor = docfilters.GetExtractor("archive.zip");

3 foreach (var subFile in extractor.SubFiles)

4 {

5 using (subFile)

6 subFile.CopyTo("subfile_" + subFile.Name);

7 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 738/1268 -

EXTRACTOR::EOF PROPERTY

The EOF property is only valid for documents where the SupportsText property is TRUE. The EOF property

will be set to TRUE when no more text can be extracted from the document with calls to GetText. If the

document needs to be re-read, call Close and Open rst.

.NET

JAVA

PYTHON

C++

COM

Return Value

bool : Indicates if more text can be read from the le.

Sample Code

bool EndOfStream { get; }

boolean getEOF() throws IGRException;

@property

def EOF(self) -> bool

bool getEOF();

[propget] HRESULT EOF([out, retval] VARIANT_BOOL *result);

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 while (!doc.EndOfStream)

10 {

11 var text = doc.GetText(4096);

12 Console.Out.WriteLine(text);

13 }

15 doc.Close();

Document Filters Implementation Guide 2.3.3 Objects

- 739/1268 -

Java

Python

Additional Information

Accessing this property will open the document. Call the Close method when nished.

See Also

Extractor Interface

Extractor::GetText method

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize("License Code", ".");

10 try (Extractor doc = df.GetExtractor("filename.doc")) {

11 doc.Open(isys_docfilters.IGR_BODY_AND_META);

13 while (!doc.getEOF()) {

14 string text = doc.GetText(4096);

15 System.out.println(text);

16 }

17 }

18 }

19 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.GetExtractor("filename.doc") as doc:

7 doc.Open(IGR_BODY_AND_META, "")

9 while not doc.getEOF():

10 output.write(doc.GetText(MaxCharsPerGetText, stripControlCodes=True))

•

Document Filters Implementation Guide 2.3.3 Objects

- 740/1268 -

EXTRACTOR::FILETYPE PROPERTY

The FileType property is the document format code, as listed in Document Format Codes chart on page .

The function is overloaded to be able to return the format name as a string.

.NET

JAVA

PYTHON

Return Value

int : Integer containing the format code

See Also

Extractor Interface

Document Format Codes

EXTRACTOR::FILETYPE PROPERTY

The FileType property is the document format code, as listed in Document Format Codes chart on page .

The function is overloaded to be able to return the format name as a string.

Prototype

.NET

JAVA

PYTHON

int FileType { get; }

int getFileType() throws IGRException;

@property

def FileType(self) -> int

•

int getFileType();

string getFileType(IGRFormatWhat what);

int FileType { get; }

int getFileType()throws IGRException;

String getFileType(IGRFormatWhat what) throws IGRException;

def getFileType() -> int:

def getFileType(what) -> str:

Document Filters Implementation Guide 2.3.3 Objects

- 741/1268 -

C++

COM

Parameters

what: IGRFormatWhat

Indicates the string information that is requested, can be one of the following:

0: IGR_FORMAT_LONG_NAME

1: IGR_FORMAT_SHORT_NAME

2: IGR_FORMAT_CONFIG_NAME

3: IGR_FORMAT_CLASS_NAME

4: IGR_FORMAT_LEGACY

Return value

Integer containing the format code; or String containing the requested details.

Sample code

C/C++

See also

Extractor Interface

Document Format Codes

@property

def FileType() -> int

int getFileType();

std::string getFileType(IGRFormatWhat what);

HRESULT FileType([out, retval] long* Value);

HRESULT GetFileTypeName([in] IGRFormatWhat what, [out, retval] BSTR * Value );

var Extractor = IFR.GetExtractor("C:\\WORD.DOC");

var DocType = Extractor.FileType;

var TypeName = Extractor.FileType(IGR_FORMAT_LONG_NAME);

if (DocType == 25)

{

// Document is an MS Word document

}

•

Document Filters Implementation Guide 2.3.3 Objects

- 742/1268 -

EXTRACTOR::GETFIRSTIMAGE METHOD

The GetFirstImage method obtains a SubFile object representing the rst embedded image of the current

document when converting using classic HTML.

Prototype

.NET

JAVA

PYTHON

C++

COM

Return value

SubFile : Returns a SubFile object for the rst image or NULL if the document does not contain sub-

documents.

SubFile GetFirstImage()

SubFile GetFirstImage() throws IGRException;

def GetFirstImage(self) -> SubFile

SubFile GetFirstImage()

HRESULT GetFirstImage([out, retval] SubFile* *result)

Document Filters Implementation Guide 2.3.3 Objects

- 743/1268 -

Sample Code

Java

Python

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 foreach (var subfile in doc.SubFiles)

10 {

11 using (subfile)

12 {

13 // act on subfile

14 Console.Out.WriteLine("Name: " + subFile.Name);

15 Console.Out.WriteLine("ID: " + subFile.ID);

16 Console.Out.WriteLine("Date: " + subFile.FileDate);

17 Console.Out.WriteLine("Size: " + subFile.FileSize);

18 }

19 }

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize("License Code", ".");

10 try (Extractor doc = df.GetExtractor("filename.doc")) {

11 doc.Open(isys_docfilters.IGR_BODY_AND_META);

13 for (SubFile subfile = doc.GetFirstSubFile(); subfile != null; subfile = doc.GetNextSubFile())

14 {

15 try (subfile) {

16 // act on subfile

17 }

18 }

19 }

20 }

21 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.GetExtractor("filename.doc") as doc:

7 doc.Open(IGR_BODY_AND_META, "")

9 for subfile in doc.SubFiles:

10 with subfile:

11 # act on subfile

Document Filters Implementation Guide 2.3.3 Objects

- 744/1268 -

Additional Information

This method will implicitly open the document. Call the Close method when nished.

C# and Python support enumerating and accessing images through the Images property.

See Also

Extractor Interface

Extractor::GetNextImage method

•

Document Filters Implementation Guide 2.3.3 Objects

- 745/1268 -

EXTRACTOR::GETFIRSTPAGE METHOD

The GetFirstPage method returns the rst page object of an opened document. The document must be

opened in image mode (IGR_FORMAT_IMAGE). It is also possible to iterate over pages with GetPageCount

and GetPage methods.

Prototype

.NET

JAVA

PYTHON

C++

COM

Return value

Page : Returns a Page object for the rst page of the document, or NULL if there are no more pages OR

the document was not opened in HD image mode.

Sample Code

Page GetFirstPage()

Page GetFirstPage() throws IGRException;

def GetFirstPage(self) -> Page

Page GetFirstPage()

HRESULT GetFirstPage([out, retval] Page* *result)

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.OpenExtractor("filename.doc", OpenMode.Paginated);

8 foreach (var page in doc.Pages)

9 {

10 using (page)

11 {

12 using var canvas = api.MakeOutputCanvas($"page-{page.Index+1}.png", CanvasType.PNG);

13 canvas.RenderPage(page);

14 }

15 }

Document Filters Implementation Guide 2.3.3 Objects

- 746/1268 -

Java

Python

Additional Information

Call the Close method when nished working with the page to release its resources. A page will be

internally freed when the instance itself is released, however, this can be at indeterminate times in some

garbage collected languages such as .NET and Java.

See Also

Extractor Interface

Extractor::GetNextPage method

1 import com.perceptive.documentfilters.*;

3 public class App {

4 public static void main(String[] args) throws Exception {

5 DocumentFilters df = new DocumentFilters();

6 df.Initialize(("License Code"), ".");

8 try (Extractor doc = df.GetExtractor("filename.doc")) {

9 doc.Open(isys_docfiltersConstants.IGR_FORMAT_IMAGE, "");

11 for (int i = 0, c = doc.GetPageCount(); i < c; ++i) {

12 try (Page page = doc.GetPage(i)) {

13 try (Canvas canvas = df.MakeOutputCanvas(String.format("page-%d.png", i+1),

isys_docfiltersConstants.IGR_DEVICE_IMAGE_PNG, "")) {

14 canvas.RenderPage(page);

15 }

16 }

17 }

18 }

19 }

20 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.OpenExtractor("filename.doc", mode=IGR_FORMAT_IMAGE) as doc:

7 for page in doc.Pages:

8 with page:

9 with api.MakeOutputCanvas(f"page-{page.PageIndex+1}.png", canvasType=IGR_DEVICE_IMAGE_PNG) as

canvas:

10 canvas.RenderPages(doc)

•

Document Filters Implementation Guide 2.3.3 Objects

- 747/1268 -

EXTRACTOR::GETFIRSTSUBFILE METHOD

The GetFirstSubFile method obtains a SubFile object representing the rst sub-document of the current

document.

Prototype

.NET

JAVA

PYTHON

C++

COM

Return value

SubFile : Returns a SubFile object for the rst suble or NULL if the document does not contain sub-

documents.

SubFile GetFirstSubFile()

SubFile GetFirstSubFile() throws IGRException;

def GetFirstSubFile(self) -> SubFile

SubFile GetFirstSubFile()

HRESULT GetFirstSubFile([out, retval] SubFile* *result)

Document Filters Implementation Guide 2.3.3 Objects

- 748/1268 -

Sample Code

Java

Python

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 foreach (var subfile in doc.SubFiles)

10 {

11 using (subfile)

12 {

13 // act on subfile

14 Console.Out.WriteLine("Name: " + subFile.Name);

15 Console.Out.WriteLine("ID: " + subFile.ID);

16 Console.Out.WriteLine("Date: " + subFile.FileDate);

17 Console.Out.WriteLine("Size: " + subFile.FileSize);

18 }

19 }

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize("License Code", ".");

10 try (Extractor doc = df.GetExtractor("filename.doc")) {

11 doc.Open(isys_docfilters.IGR_BODY_AND_META);

13 for (SubFile subfile = doc.GetFirstSubFile(); subfile != null; subfile = doc.GetNextSubFile())

14 {

15 try (subfile) {

16 // act on subfile

17 }

18 }

19 }

20 }

21 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.GetExtractor("filename.doc") as doc:

7 doc.Open(IGR_BODY_AND_META, "")

9 for subfile in doc.SubFiles:

10 with subfile:

11 # act on subfile

Document Filters Implementation Guide 2.3.3 Objects

- 749/1268 -

Additional Information

This method will implicitly open the document. Call the Close method when nished.

C# and Python support enumerating and accessing images through the Images property.

See Also

Extractor Interface

Extractor::GetNextSubFile method

•

Document Filters Implementation Guide 2.3.3 Objects

- 750/1268 -

EXTRACTOR::GETHASHMD5 METHOD

The getHashMD5 methods obtain a string representing the calculated hash of the current document for

unique identication.

Prototype

.NET

JAVA

PYTHON

C++

COM

Return value

string : The hash string for the input (binary) document.

Sample Code

string getHashMD5()

string getHashMD5() throws IGRException;

def getHashMD5(self) -> string

std::wstring getHashMD5()

HRESULT getHashMD5([out, retval] BSTR *result)

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 var md5 = doc.getHashMD5();

10 var sha1 = doc.getHashSHA1();

Document Filters Implementation Guide 2.3.3 Objects

- 751/1268 -

EXTRACTOR::GETHASHSHA1 METHOD

The getHashSHA1 methods obtain a string representing the calculated hash of the current document for

unique identication.

Prototype

.NET

JAVA

PYTHON

C++

COM

Return value

string : The hash string for the input (binary) document.

Sample Code

string getHashSHA1()

string getHashSHA1() throws IGRException;

def getHashSHA1(self) -> string

std::wstring getHashSHA1()

HRESULT getHashSHA1([out, retval] BSTR *result)

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 var md5 = doc.getHashMD5();

10 var sha1 = doc.getHashSHA1();

Document Filters Implementation Guide 2.3.3 Objects

- 752/1268 -

EXTRACTOR::GETNEXTIMAGE METHOD

The GetNextImage method obtains a SubFile object representing the next embedded image of the

current document when converting using classic HTML.

Prototype

.NET

JAVA

PYTHON

C++

COM

Return value

SubFile : Returns a SubFile object for the rst image or NULL if the document does not contain sub-

documents.

SubFile GetNextImage()

SubFile GetNextImage() throws IGRException;

def GetNextImage(self) -> SubFile

SubFile GetNextImage()

HRESULT GetNextImage([out, retval] SubFile* *result)

Document Filters Implementation Guide 2.3.3 Objects

- 753/1268 -

Sample Code

Java

Python

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 foreach (var subfile in doc.SubFiles)

10 {

11 using (subfile)

12 {

13 // act on subfile

14 Console.Out.WriteLine("Name: " + subFile.Name);

15 Console.Out.WriteLine("ID: " + subFile.ID);

16 Console.Out.WriteLine("Date: " + subFile.FileDate);

17 Console.Out.WriteLine("Size: " + subFile.FileSize);

18 }

19 }

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize("License Code", ".");

10 try (Extractor doc = df.GetExtractor("filename.doc")) {

11 doc.Open(isys_docfilters.IGR_BODY_AND_META);

13 for (SubFile subfile = doc.GetFirstSubFile(); subfile != null; subfile = doc.GetNextSubFile())

14 {

15 try (subfile) {

16 // act on subfile

17 }

18 }

19 }

20 }

21 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.GetExtractor("filename.doc") as doc:

7 doc.Open(IGR_BODY_AND_META, "")

9 for subfile in doc.SubFiles:

10 with subfile:

11 # act on subfile

Document Filters Implementation Guide 2.3.3 Objects

- 754/1268 -

Additional Information

This method will implicitly open the document. Call the Close method when nished.

C# and Python support enumerating and accessing images through the Images property.

See Also

Extractor Interface

Extractor::GetFirstImage method

•

Document Filters Implementation Guide 2.3.3 Objects

- 755/1268 -

EXTRACTOR::GETNEXTPAGE METHOD

The GetNextPage method returns the next page object of an opened document. The document must be

opened in image mode (IGR_FORMAT_IMAGE). It is also possible to iterate over pages with GetPageCount

and GetPage methods.

Prototype

.NET

JAVA

PYTHON

C++

COM

Return value

Page : Returns a Page object for the next page of the document, or NULL if there are no more pages OR

the document was not opened in HD image mode.

Sample Code

Page GetNextPage()

Page GetNextPage() throws IGRException;

def GetNextPage(self) -> Page

Page GetNextPage()

HRESULT GetNextPage([out, retval] Page* *result)

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.OpenExtractor("filename.doc", OpenMode.Paginated);

8 foreach (var page in doc.Pages)

9 {

10 using (page)

11 {

12 using var canvas = api.MakeOutputCanvas($"page-{page.Index+1}.png", CanvasType.PNG);

13 canvas.RenderPage(page);

14 }

15 }

Document Filters Implementation Guide 2.3.3 Objects

- 756/1268 -

Java

Python

Additional Information

Call the Close method when nished working with the page to release its resources. A page will be

internally freed when the instance itself is released, however, this can be at indeterminate times in some

garbage collected languages such as .NET and Java.

See Also

Extractor Interface

Extractor::GetFirstPage method

1 import com.perceptive.documentfilters.*;

3 public class App {

4 public static void main(String[] args) throws Exception {

5 DocumentFilters df = new DocumentFilters();

6 df.Initialize(("License Code"), ".");

8 try (Extractor doc = df.GetExtractor("filename.doc")) {

9 doc.Open(isys_docfiltersConstants.IGR_FORMAT_IMAGE, "");

11 for (int i = 0, c = doc.GetPageCount(); i < c; ++i) {

12 try (Page page = doc.GetPage(i)) {

13 try (Canvas canvas = df.MakeOutputCanvas(String.format("page-%d.png", i+1),

isys_docfiltersConstants.IGR_DEVICE_IMAGE_PNG, "")) {

14 canvas.RenderPage(page);

15 }

16 }

17 }

18 }

19 }

20 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.OpenExtractor("filename.doc", mode=IGR_FORMAT_IMAGE) as doc:

7 for page in doc.Pages:

8 with page:

9 with api.MakeOutputCanvas(f"page-{page.PageIndex+1}.png", canvasType=IGR_DEVICE_IMAGE_PNG) as

canvas:

10 canvas.RenderPages(doc)

•

Document Filters Implementation Guide 2.3.3 Objects

- 757/1268 -

EXTRACTOR::GETNEXTSUBFILE METHOD

The GetNextSubFile method obtains a SubFile object representing the next sub-document of the current

document.

Prototype

.NET

JAVA

PYTHON

C++

COM

Return value

SubFile : Returns a SubFile object for the next suble or NULL if the document does not contain sub-

documents.

SubFile GetNextSubFile()

SubFile GetNextSubFile() throws IGRException;

def GetNextSubFile(self) -> SubFile

SubFile GetNextSubFile()

HRESULT GetNextSubFile([out, retval] SubFile* *result)

Document Filters Implementation Guide 2.3.3 Objects

- 758/1268 -

Sample Code

Java

Python

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 foreach (var subfile in doc.SubFiles)

10 {

11 using (subfile)

12 {

13 // act on subfile

14 Console.Out.WriteLine("Name: " + subFile.Name);

15 Console.Out.WriteLine("ID: " + subFile.ID);

16 Console.Out.WriteLine("Date: " + subFile.FileDate);

17 Console.Out.WriteLine("Size: " + subFile.FileSize);

18 }

19 }

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize("License Code", ".");

10 try (Extractor doc = df.GetExtractor("filename.doc")) {

11 doc.Open(isys_docfilters.IGR_BODY_AND_META);

13 for (SubFile subfile = doc.GetFirstSubFile(); subfile != null; subfile = doc.GetNextSubFile())

14 {

15 try (subfile) {

16 // act on subfile

17 }

18 }

19 }

20 }

21 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.GetExtractor("filename.doc") as doc:

7 doc.Open(IGR_BODY_AND_META, "")

9 for subfile in doc.SubFiles:

10 with subfile:

11 # act on subfile

Document Filters Implementation Guide 2.3.3 Objects

- 759/1268 -

Additional Information

This method will implicitly open the document. Call the Close method when nished.

C# and Python support enumerating and accessing images through the Images property.

See Also

Extractor Interface

Extractor::GetFirstSubFile method

•

Document Filters Implementation Guide 2.3.3 Objects

- 760/1268 -

EXTRACTOR::GETPAGE METHOD

The GetPage method returns the page at the given index, where the page index is 0-based. An exception

is raised if the index is invalid.

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

pageIndex: int : The index of the page to return.

Return value

Page : Returns a Page object for the requested page.

Sample Code

Page GetPage(int pageIndex)

Page GetPage(int pageIndex) throws IGRException;

def GetPage(self, pageIndex: int) -> Page

Page GetPage(int pageIndex)

HRESULT GetPage([in] int pageIndex, [out, retval] Page* *result)

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.OpenExtractor("filename.doc", OpenMode.Paginated);

8 for (int i = 0; i < doc.PageCount; i++)

9 {

10 using var page = doc.GetPage(i);

11 using var canvas = api.MakeOutputCanvas($"page-{i+1}.png", CanvasType.PNG);

12 canvas.RenderPage(page);

13 }

Document Filters Implementation Guide 2.3.3 Objects

- 761/1268 -

Additional Information

Call the Close method when you have nished working with the page to release its resources. A page will

be internally freed when the instance itself is released, however, this can be at indeterminate times in

some garbage collected languages such as .NET and Java.

See Also

Extractor Interface

Page interface

•

Document Filters Implementation Guide 2.3.3 Objects

- 762/1268 -

EXTRACTOR::GETPAGECOUNT METHOD

Returns the number of pages in the current document, the document must be opened in image mode for

the page count to be populated.

Prototype

.NET

JAVA

PYTHON

Return value

int : The number of pages in the document

Sample Code

See Also

Extractor Interface

Page interface

int GetPageCount()

int GetPageCount() throws IGRException;

def GetPageCount(self) -> int

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.OpenExtractor("filename.doc", OpenMode.Paginated);

8 for (int i = 0; i < doc.PageCount; i++)

9 {

10 using var page = doc.GetPage(i);

11 using var canvas = api.MakeOutputCanvas($"page-{i+1}.png", CanvasType.PNG);

12 canvas.RenderPage(page);

13 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 763/1268 -

EXTRACTOR::GETROOTBOOKMARK METHOD

The GetRootBookmark method returns a Bookmark node representing the top-most node of the

bookmark hierarchy. The root bookmark only has Children data, it has no title or destination properties.

Prototype

.NET

JAVA

PYTHON

Return value

Bookmark : Bookmark representing the root of the document.

Sample Code

Additional Information

Call the Close method when you have nished working with the page to release its resources. A page will

be internally freed when the instance itself is released, however, this can be at indeterminate times in

some garbage collected languages such as .NET and Java.

See Also

Extractor Interface

Page interface

Bookmark interface

Bookmark GetRootBookmark()

Bookmark GetRootBookmark() throws IGRException;

def GetRootBookmark(self) -> Bookmark

1 using var extractor = IFR.GetExtractor("word.docx");

2 extractor.Open(IGR_BODY_AND_META | IGR_FORMAT_IMAGE);

4 var bookmark = Extractor.GetRootBookmark()

5 for (var child = bookmark.GetFirstChild(); child != null;

6 child = child.GetNextSibling())

7 {

8 //

9 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 764/1268 -

EXTRACTOR::GETSUBFILE METHOD

The GetSubFile method obtains a SubFile object representing the nominated sub-le of the current

document.

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

id: string : An ID that was previously returned when enumerating sub les with GetFirstSubFile and

GetNextSubFile.

Note The sub le ID is not necessarily the same as its name.

Return value

SubFile : A SubFile object for the nominated sub-document, or NULL if the document is not found.

Sample Code

SubFile GetSubFile(string id)

SubFile GetSubFile(string id) throws IGRException;

def GetSubFile(self, id: string) -> SubFile

SubFile GetSubFile(std::wstring id)

HRESULT GetSubFile([in] BSTR id, [out, retval] SubFile* *result)

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("archive.zip");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 using var subfile = doc.GetSubFile("subfile.txt");

Document Filters Implementation Guide 2.3.3 Objects

- 765/1268 -

Additional Information

The identier string (ID) should be treated as an opaque identier, and can only be reliably obtained by

rst iterating over an archive document and retrieving it via a call to SubFile::getID(). Some archive

formats may yield identiers that look like le system paths, but several do not. The value of the ID for a

given sub-le may also vary between releases of the DocumentFilters API. Therefore, never try to

formulate an ID. Always use IDs returned from SubFile::getID().

This method will implicitly open the document. Call the Close method when nished.

Calling this method will not aect the “next” document that will be returned by GetNextSubFile. Use the

GetFirstSubFile / GetNextSubFile methods in an interleaved manner if required.

See Also

Extractor Interface

SubFile::ID

•

Document Filters Implementation Guide 2.3.3 Objects

- 766/1268 -

EXTRACTOR::GETTEXT METHOD

The GetText method extracts the next portion of text content from the document.

Prototype

.NET

JAVA

PYTHON

Parameters

maxLength: int : Maximum number of characters to be returned.

Return value

string : Returns a string of up to MaxLength characters from the document.

Sample Code

string GetText(int maxLength)

string GetText(int maxLength) throws IGRException;

def GetText(self, maxLength: int) -> string

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 while (!doc.EndOfStream)

10 {

11 var text = doc.GetText(4096);

12 Console.Out.WriteLine(text);

13 }

15 doc.Close();

Document Filters Implementation Guide 2.3.3 Objects

- 767/1268 -

Java

Python

Additional Information

This method will implicitly open the document. The Close method should be called when nished. The

text returned may contain markup characters that the calling application will need to process.

After the document is opened, each call to GetText will return the next portion of text until the end of the

document is reached. To retrieve the whole text of the document, the application should call this method

in a loop and check the value of the EOF property as shown above.

Note You can request any size of string from GetText, but Java and .NET will return 65535 bytes at most.

See Also

Extractor Interface

Extractor::EOF property

Extractor::SupportsText property

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize("License Code", ".");

10 try (Extractor doc = df.GetExtractor("filename.doc")) {

11 doc.Open(isys_docfilters.IGR_BODY_AND_META);

13 while (!doc.getEOF()) {

14 string text = doc.GetText(4096);

15 System.out.println(text);

16 }

17 }

18 }

19 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.GetExtractor("filename.doc") as doc:

7 doc.Open(IGR_BODY_AND_META, "")

9 while not doc.getEOF():

10 output.write(doc.GetText(MaxCharsPerGetText, stripControlCodes=True))

•

Document Filters Implementation Guide 2.3.3 Objects

- 768/1268 -

EXTRACTOR::LOCALIZE PROPERTY

Utility function that allows for localization of metadata without providing a callback. Any localization

options must be set before an .Open call.

.NET

JAVA

PYTHON

Return Value

Dictionary<string, string> : Dictionary of localized words

Sample Code

Dictionary<string, string> Localize { get; }

LocalizedDictionary getLocalize() throws IGRException;

@property

def Localize(self) -> dict

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using (var doc = api.GetExtractor("outlook.msg"))

7 {

8 doc.Localize["Subject"] = "Objet";

9 doc.Localize["To"] = "À";

10 doc.Localize["From"] = "De";

11 doc.Localize["Bcc"] = "Cci";

12 doc.Localize["Sent"] = "Envoyé";

13 doc.Open(IGR_FORMAT_IMAGE);

15 using (var canvas = api.MakeOutputCanvas("output.pdf", CanvasType.PDF))

16 {

17 canvas.RenderPages(doc);

18 }

19 }

Document Filters Implementation Guide 2.3.3 Objects

- 769/1268 -

Java

Python

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize(("License Code"), ".");

10 try (Extractor doc = df.GetExtractor("outlook.msg"))

11 {

12 doc.GetLocalize().set("Subject", "Objet");

13 doc.GetLocalize().set("To", "À");

14 doc.GetLocalize().set("From", "De");

15 doc.GetLocalize().set("Bcc", "Cci");

16 doc.GetLocalize().set("Sent", "Envoyé");

17 doc.Open(isys_docfiltersConstants.IGR_FORMAT_IMAGE);

19 try (Canvas canvas = df.MakeOutputCanvas("filename.pdf",

isys_docfiltersConstants.IGR_DEVICE_PDF, ""))

20 {

21 for (int i = 0, c = doc.GetPageCount(); i < c; ++i)

22 {

23 try (Page page = doc.GetPage(i)) {

24 canvas.RenderPage(page);

25 }

26 }

27 }

28 }

29 }

30 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.GetExtractor("outlook.msg") as doc:

7 doc.Localize["Subject"] = "Objet"

8 doc.Localize["To"] = "À"

9 doc.Localize["From"] = "De"

10 doc.Localize["Bcc"] = "Cci"

11 doc.Localize["Sent"] = "Envoyé"

12 doc.Open(IGR_FORMAT_IMAGE)

14 with api.MakeOutputCanvas("filename.pdf", canvasType=IGR_DEVICE_PDF) as canvas:

15 canvas.RenderPages(doc)

Document Filters Implementation Guide 2.3.3 Objects

- 770/1268 -

EXTRACTOR::MIMETYPE PROPERTY

Returns the MimeType of the le.

.NET

JAVA

PYTHON

Return Value

string : The MimeType of the le.

See Also

Document Format Codes

string MimeType { get; }

string getMimeType() throws IGRException;

@property

def MimeType(self) -> string

•

Document Filters Implementation Guide 2.3.3 Objects

- 771/1268 -

EXTRACTOR::OPEN METHOD

The Open method opens a document for processing.

Overloads

Open(int)

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

flags: int : Specify the open-mode ags; see Open Document Flags for details.

Open(int, string)

Prototype

.NET

JAVA

Open(int) Open the le with the given ags.

Open(int, string) Open the le with the given ags and options set.

void Open(int flags)

void Open(int flags) throws IGRException;

def Open(self, flags: int) -> void

void Open(int flags)

HRESULT Open([in] int flags)

void Open(int flags, string options)

void Open(int flags, string options) throws IGRException;

Document Filters Implementation Guide 2.3.3 Objects

- 772/1268 -

PYTHON

C++

COM

Parameters

flags: int : Specify the open-mode ags; see Open Document Flags for details.

options: string : Semicolon separated list of name value pair options; see Constants and Codes for

details.

Sample Code

def Open(self, flags: int, options: string) -> void

void Open(int flags, std::wstring options)

HRESULT Open([in] int flags, [in] BSTR options)

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 while (!doc.EndOfStream)

10 {

11 var text = doc.GetText(4096);

12 Console.Out.WriteLine(text);

13 }

15 doc.Close();

Document Filters Implementation Guide 2.3.3 Objects

- 773/1268 -

Java

Python

Additional Information

Most members of this interface operate on an open document. If you have not called the Open method,

it will be called internally.

Below is the list of members that will implicitly open the document when accessed:

SaveTo method

GetText method

EOF property

GetFirstSubFile method

GetNextSubFile method

See Also

Extractor Interface

Close method

1 import com.perceptive.documentfilters.*;

3 public class App

4 {

5 public static void main(String[] args) throws Exception

6 {

7 DocumentFilters df = new DocumentFilters();

8 df.Initialize("License Code", ".");

10 try (Extractor doc = df.GetExtractor("filename.doc")) {

11 doc.Open(isys_docfilters.IGR_BODY_AND_META);

13 while (!doc.getEOF()) {

14 string text = doc.GetText(4096);

15 System.out.println(text);

16 }

17 }

18 }

19 }

1 from DocumentFilters import *

3 api = DocumentFilters()

4 api.Initialize("License Code", ".")

6 with api.GetExtractor("filename.doc") as doc:

7 doc.Open(IGR_BODY_AND_META, "")

9 while not doc.getEOF():

10 output.write(doc.GetText(MaxCharsPerGetText, stripControlCodes=True))

•

Document Filters Implementation Guide 2.3.3 Objects

- 774/1268 -

EXTRACTOR::PAGECOUNT PROPERTY

Returns the number of pages in the current document, the document must be opened in image mode for

the page count to be populated.

.NET

JAVA

PYTHON

Return Value

int : The number of pages in the document

Sample Code

See Also

Extractor Interface

Page interface

int PageCount { get; }

int getPageCount() throws IGRException;

@property

def PageCount(self) -> int

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.OpenExtractor("filename.doc", OpenMode.Paginated);

8 for (int i = 0; i < doc.PageCount; i++)

9 {

10 using var page = doc.GetPage(i);

11 using var canvas = api.MakeOutputCanvas($"page-{i+1}.png", CanvasType.PNG);

12 canvas.RenderPage(page);

13 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 775/1268 -

EXTRACTOR::SAVETO METHOD

The SaveTo method extracts the entire text content of the document in a single call. The text may be

saved to a le with the given name or via an instance of an IStream (COM) object.

Overloads

SaveTo(string)

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

filename: string : The lename where the text is to be written

SaveTo(Stream)

Prototype

.NET

SaveTo(string) Save the text of the document to a le.

SaveTo(Stream) Save the text of the document to a stream.

SaveTo(string,

System.Text.Encoding)

Save the text of the document to a le with the

given encoding.

SaveTo(Stream,

System.Text.Encoding)

Save the text of the document to a le with the

given encoding.

void SaveTo(string filename)

void SaveTo(string filename) throws IGRException;

def SaveTo(self, filename: string) -> void

void SaveTo(std::wstring filename)

HRESULT SaveTo([in] BSTR filename)

Document Filters Implementation Guide 2.3.3 Objects

- 776/1268 -

JAVA

PYTHON

C++

COM

Parameters

stream: Stream : The stream where the text is to be written

SaveTo(string, System.Text.Encoding)

Prototype

.NET

Parameters

filename: string : The lename where the text is to be written

encoding: System.Text.Encoding : The encoding to use when saving the text.

SaveTo(Stream, System.Text.Encoding)

Prototype

.NET

PYTHON

Parameters

void SaveTo(Stream stream)

void SaveTo(Stream stream) throws IGRException;

def SaveTo(self, stream: Stream) -> void

void SaveTo(Stream stream)

HRESULT SaveTo([in] Stream* stream)

void SaveTo(string filename, System.Text.Encoding encoding)

void SaveTo(Stream stream, System.Text.Encoding encoding)

def SaveTo(self, stream: Stream, encoding: string) -> void

Document Filters Implementation Guide 2.3.3 Objects

- 777/1268 -

stream: Stream : The stream where the text is to be written

encoding: System.Text.Encoding : The encoding to use when saving the text.

Sample Code

Additional Information

The text stream may contain markup characters that the application will need to process. This method

will implicitly open the document. Call the Close method when nished.

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 doc.SaveTo("output.txt");

Document Filters Implementation Guide 2.3.3 Objects

- 778/1268 -

EXTRACTOR::GETFILETYPE METHOD

The FileType method allows for extended information to be returned about the le type.

Overloads

getFileType(int)

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

what: int : Indicates the string information that is requested, can be one of the following:

0: IGR_FORMAT_LONG_NAME

1: IGR_FORMAT_SHORT_NAME

2: IGR_FORMAT_CONFIG_NAME

3: IGR_FORMAT_CLASS_NAME

4: IGR_FORMAT_LEGACY

5: IGR_FORMAT_MIMETYPE

getFileType(int) The FileType method allows for extended information to be

returned about the le type

getFileType(IGRFormatWhat) The FileType method allows for extended information to be

returned about the le type

string getFileType(int what)

string getFileType(int what) throws IGRException;

def getFileType(self, what: int) -> string

std::wstring getFileType(int what)

HRESULT GetFileTypeName([in] int what, [out, retval] BSTR *result)

•

Document Filters Implementation Guide 2.3.3 Objects

- 779/1268 -

6: IGR_FORMAT_FILETYPE_CATEGORY

Return value

string : String value contained the requested data

getFileType(IGRFormatWhat)

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

what: IGRFormatWhat : Indicates the string information that is requested, can be one of the following:

0: IGR_FORMAT_LONG_NAME

1: IGR_FORMAT_SHORT_NAME

2: IGR_FORMAT_CONFIG_NAME

3: IGR_FORMAT_CLASS_NAME

4: IGR_FORMAT_LEGACY

5: IGR_FORMAT_MIMETYPE

6: IGR_FORMAT_FILETYPE_CATEGORY

Return value

string : String value contained the requested data

•

string getFileType(IGRFormatWhat what)

string getFileType(IGRFormatWhat what) throws IGRException;

def getFileType(self, what: IGRFormatWhat) -> string

std::wstring getFileType(IGRFormatWhat what)

HRESULT GetFileTypeName([in] IGRFormatWhat* what, [out, retval] BSTR *result)

•

Document Filters Implementation Guide 2.3.3 Objects

- 780/1268 -

See Also

Extractor Interface

Document Format Codes

•

Document Filters Implementation Guide 2.3.3 Objects

- 781/1268 -

EXTRACTOR::GETSUPPORTSHTML METHOD

getSupportsHTML method is TRUE if document can be converted to classic HTML.

Prototype

.NET

JAVA

PYTHON

Return value

bool : Indicates if the le supports HTML conversion.

Sample Code

See Also

Extractor Interface

Extractor::GetText method

Extractor::getSupportsText method

bool getSupportsSubFiles()

boolean getSupportsSubFiles() throws IGRException;

def getSupportsSubFiles(self) -> bool

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 var caps = docs.Capabilities;

11 if (docs.getSupportsText())

12 Console.WriteLine("File supports text extraction");

14 if (docs.getSupportsSubFiles())

15 Console.WriteLine("File supports subfile enumeration");

17 if (docs.getSupportsHTML())

18 Console.WriteLine("File supports HTML conversion");

•

Document Filters Implementation Guide 2.3.3 Objects

- 782/1268 -

EXTRACTOR::GETSUPPORTSSUBFILES PROPERTY

getSupportsSubFiles property is TRUE if the document is a compound or archive document, potentially

with sub-documents.

Prototype

.NET

JAVA

PYTHON

Return value

bool : Indicates if the le supports subles conversion.

Sample Code

See Also

Extractor Interface

Extractor::GetText method

Extractor::getSupportsText method

bool getSupportsSubFiles()

boolean getSupportsSubFiles() throws IGRException;

def getSupportsSubFiles(self) -> bool

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 var caps = docs.Capabilities;

11 if (docs.getSupportsText())

12 Console.WriteLine("File supports text extraction");

14 if (docs.getSupportsSubFiles())

15 Console.WriteLine("File supports subfile enumeration");

17 if (docs.getSupportsHTML())

18 Console.WriteLine("File supports HTML conversion");

•

Document Filters Implementation Guide 2.3.3 Objects

- 783/1268 -

EXTRACTOR::GETSUPPORTSTEXT METHOD

getSupportsText method return TRUE if text content can be extracted from the document. This property

must be TRUE to be able to call to the Extractor::SaveTo and Extractor::GetText methods.

Prototype

.NET

JAVA

PYTHON

Return value

bool : Indicates if the le supports subles conversion.

Sample Code

See Also

Extractor Interface

Extractor::GetText method

Extractor::getSupportsText method

bool getSupportsText()

boolean getSupportsText() throws IGRException;

def getSupportsText(self) -> bool

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 var caps = docs.Capabilities;

11 if (docs.getSupportsText())

12 Console.WriteLine("File supports text extraction");

14 if (docs.getSupportsSubFiles())

15 Console.WriteLine("File supports subfile enumeration");

17 if (docs.getSupportsHTML())

18 Console.WriteLine("File supports HTML conversion");

•

Document Filters Implementation Guide 2.3.3 Objects

- 784/1268 -

FormElement

FORMELEMENT INTERFACE

The FormElement interface represents a single form control for a given page. FormElements are

currently supported for static PDF documents.

FormElement::Action

property

The Action property contains the behavior when a user clicks the

form element.

FormElement::ActionDest

property

The ActionDest property contains the destination when a user

interacts with certain form controls.

FormElement::Alignment

property

The Alignment property contains the text alignment that a

viewer should use when presenting a single or multiline edit

control.

FormElement::Caption

property

The Caption property returns the optional text associated with a

check box or radio button.

FormElement::ElementType

property

The ElementType property contains the control type that a

viewer should use to collect input from a user.

FormElement::Flags property The Flags property contains a bit set of ags applicable to the

control.

FormElement::FontName

property

The FontName property contains the font that a viewer should

use when presenting a single or multiline edit control.

FormElement::FontSize

property

The FontSize property contains the font size that a viewer should

use when presenting a single or multiline edit control.

FormElement::GetOption

method

The GetOption method returns a FormElementOption object that

represents a single selectable option in a list box or dropdown

box.

FormElement::Height

property

The Height property return the dimensions on the page where

the form element should be positioned. The dimension

information is based on the DPI used when loading the page.

FormElement::Name property The Name property returns the qualied name for the form

element.

Document Filters Implementation Guide 2.3.3 Objects

- 785/1268 -

FormElement::OptionCount

property

The OptionCount property contains the number of items that are

available in list boxes and dropdown boxes.

FormElement::Rotation

property

The Rotation property contains the rotation in degrees of the

form element. Only rotation in 90 degree increments will be

returned.

FormElement::Selected

property

The Selected property contains the current selected item in a

single-select list box, or drop down box.

FormElement::Value property The Value property returns the stored value for the form

element.

FormElement::Width property The Width property return the dimensions on the page where the

form element should be positioned. The dimension information is

based on the DPI used when loading the page.

FormElement::X property The X property return the position on the page where the user

should be scrolled to. The position information is based on the

DPI used when loading the page.

FormElement::Y property The Y property return the position on the page where the user

should be scrolled to. The position information is based on the

DPI used when loading the page.

Document Filters Implementation Guide 2.3.3 Objects

- 786/1268 -

FORMELEMENT::ACTION PROPERTY

The Action property contains the behavior when a user clicks the form element.

.NET

JAVA

PYTHON

Return Value

string : Returns the behavior when a user clicks the form element.

See Also

FormElement interface

string Action { get; }

string getAction() throws IGRException;

@property

def Action(self) -> string

•

Document Filters Implementation Guide 2.3.3 Objects

- 787/1268 -

FORMELEMENT::ACTIONDEST PROPERTY

The ActionDest property contains the destination when a user interacts with certain form controls.

.NET

JAVA

PYTHON

Return Value

string : Returns the destination when a user interacts with certain form controls.

See Also

FormElement interface

string ActionDest { get; }

string getActionDest() throws IGRException;

@property

def ActionDest(self) -> string

•

Document Filters Implementation Guide 2.3.3 Objects

- 788/1268 -

FORMELEMENT::ALIGNMENT PROPERTY

The Alignment property contains the text alignment that a viewer should use when presenting a single

or multiline edit control.

.NET

JAVA

PYTHON

Return Value

int : Returns the text alignment that a viewer should use when presenting a single or multiline edit

control, one of:

See Also

FormElement interface

int Alignment { get; }

int getAlignment() throws IGRException;

@property

def Alignment(self) -> int

Name Value

IGR_TEXT_ALIGN_LEFT 0x00

IGR_TEXT_ALIGN_RIGHT 0x01

IGR_TEXT_ALIGN_CENTER 0x02

IGR_TEXT_ALIGN_TOP 0x10

IGR_TEXT_ALIGN_MIDDLE 0x11

IGR_TEXT_ALIGN_BOTTOM 0x12

•

Document Filters Implementation Guide 2.3.3 Objects

- 789/1268 -

FORMELEMENT::CAPTION PROPERTY

The Caption property returns the optional text associated with a check box or radio button.

.NET

JAVA

PYTHON

Return Value

string : Returns the optional text associated with a check box or radio button.

See Also

FormElement interface

string Caption { get; }

string getCaption() throws IGRException;

@property

def Caption(self) -> string

•

Document Filters Implementation Guide 2.3.3 Objects

- 790/1268 -

FORMELEMENT::ELEMENTTYPE PROPERTY

The ElementType property contains the control type that a viewer should use to collect input from a user.

.NET

JAVA

PYTHON

Return Value

int : Returns the control type that a viewer should use to collect input from a user, one of:

See Also

FormElement interface

int ElementType { get; }

int getElementType() throws IGRException;

@property

def ElementType(self) -> int

Name Value

IGR_PAGE_FORM_ELEMENT_TYPE_BUTTON 0x0

IGR_PAGE_FORM_ELEMENT_TYPE_RADIOBUTTON 0x1

IGR_PAGE_FORM_ELEMENT_TYPE_CHECKBOX 0x2

IGR_PAGE_FORM_ELEMENT_TYPE_FILESELECT 0x3

IGR_PAGE_FORM_ELEMENT_TYPE_MULTILINE_TEXT 0x4

IGR_PAGE_FORM_ELEMENT_TYPE_SINGLELINE_TEXT 0x5

IGR_PAGE_FORM_ELEMENT_TYPE_COMBOBOX 0x6

IGR_PAGE_FORM_ELEMENT_TYPE_LISTBOX 0x7

IGR_PAGE_FORM_ELEMENT_TYPE_SIGNATURE 0x8

IGR_PAGE_FORM_ELEMENT_TYPE_PASSWORD 0x10

•

Document Filters Implementation Guide 2.3.3 Objects

- 791/1268 -

FORMELEMENT::FLAGS PROPERTY

The Flags property contains a bit set of ags applicable to the control.

.NET

JAVA

PYTHON

Return Value

int : Returns a bit set of ags applicable to the control, one or more of:

See Also

FormElement interface

int ElementType { get; }

int getElementType() throws IGRException;

@property

def ElementType(self) -> int

Name Value

IGR_PAGE_FORM_ELEMENT_FLAG_READONLY 0x1

IGR_PAGE_FORM_ELEMENT_FLAG_REQUIRED 0x2

IGR_PAGE_FORM_ELEMENT_FLAG_COMB 0x4

IGR_PAGE_FORM_ELEMENT_FLAG_CHECKED 0x8

•

Document Filters Implementation Guide 2.3.3 Objects

- 792/1268 -

FORMELEMENT::FONTNAME PROPERTY

The FontName property contains the font that a viewer should use when presenting a single or multiline

edit control.

.NET

JAVA

PYTHON

Return Value

string : Returns the font that a viewer should use when presenting a single or multiline edit control.

See Also

FormElement interface

string FontName { get; }

string getFontName() throws IGRException;

@property

def FontName(self) -> string

•

Document Filters Implementation Guide 2.3.3 Objects

- 793/1268 -

FORMELEMENT::FONTSIZE PROPERTY

The FontSize property contains the font size that a viewer should use when presenting a single or

multiline edit control.

.NET

JAVA

PYTHON

Return Value

int : Returns the font size that a viewer should use when presenting a single or multiline edit control.

See Also

FormElement interface

int FontSize { get; }

int getFontSize() throws IGRException;

@property

def FontSize(self) -> int

•

Document Filters Implementation Guide 2.3.3 Objects

- 794/1268 -

FORMELEMENT::GETOPTION METHOD

The GetOption method returns a FormElementOption object that represents a single selectable option in

a list box or dropdown box.

Prototype

.NET

JAVA

PYTHON

Parameters

index: int : The index of the option.

Return value

FormElementOption : Returns a FormElementOption object that represents a single selectable option in

a list box or dropdown box.

See Also

FormElement interface

FormElementOption GetOption(int index)

FormElementOption GetOption(int index) throws IGRException;

def GetOption(self, index: int) -> FormElementOption

•

Document Filters Implementation Guide 2.3.3 Objects

- 795/1268 -

FORMELEMENT::HEIGHT PROPERTY

The Height property return the dimensions on the page where the form element should be positioned.

The dimension information is based on the DPI used when loading the page.

.NET

JAVA

PYTHON

Return Value

int : Integer containing the dimension in pixels.

See Also

FormElement interface

int Height { get; }

int getHeight() throws IGRException;

@property

def Height(self) -> int

•

Document Filters Implementation Guide 2.3.3 Objects

- 796/1268 -

FORMELEMENT::NAME PROPERTY

The Name property returns the qualied name for the form element.

.NET

JAVA

PYTHON

Return Value

string : Returns the qualied name for the form element.

See Also

FormElement interface

string Name { get; }

string getName() throws IGRException;

@property

def Name(self) -> string

•

Document Filters Implementation Guide 2.3.3 Objects

- 797/1268 -

FORMELEMENT::OPTIONCOUNT PROPERTY

The OptionCount property contains the number of items that are available in list boxes and dropdown

boxes.

.NET

JAVA

PYTHON

Return Value

int : Returns the number of items that are available in list boxes and dropdown boxes.

See Also

FormElement interface

int OptionCount { get; }

int getOptionCount() throws IGRException;

@property

def OptionCount(self) -> int

•

Document Filters Implementation Guide 2.3.3 Objects

- 798/1268 -

FORMELEMENT::ROTATION PROPERTY

The Rotation property contains the rotation in degrees of the form element. Only rotation in 90 degree

increments will be returned.

.NET

JAVA

PYTHON

Return Value

int : Returns the rotation in degrees of the form element. Only rotation in 90 degree increments will be

returned.

See Also

FormElement interface

int Rotation { get; }

int getRotation() throws IGRException;

@property

def Rotation(self) -> int

•

Document Filters Implementation Guide 2.3.3 Objects

- 799/1268 -

FORMELEMENT::SELECTED PROPERTY

The Selected property contains the current selected item in a single-select list box, or drop down box.

.NET

JAVA

PYTHON

Return Value

int : Returns the current selected item in a single-select list box, or drop down box.

See Also

FormElement interface

int Selected { get; }

int getSelected() throws IGRException;

@property

def Selected(self) -> int

•

Document Filters Implementation Guide 2.3.3 Objects

- 800/1268 -

FORMELEMENT::VALUE PROPERTY

The Value property returns the stored value for the form element.

.NET

JAVA

PYTHON

Return Value

string : Returns the stored value for the form element.

See Also

FormElement interface

string Value { get; }

string getValue() throws IGRException;

@property

def Value(self) -> string

•

Document Filters Implementation Guide 2.3.3 Objects

- 801/1268 -

FORMELEMENT::WIDTH PROPERTY

The Width property return the dimensions on the page where the form element should be positioned.

The dimension information is based on the DPI used when loading the page.

.NET

JAVA

PYTHON

Return Value

int : Integer containing the dimension in pixels.

See Also

FormElement interface

int Width { get; }

int getWidth() throws IGRException;

@property

def Width(self) -> int

•

Document Filters Implementation Guide 2.3.3 Objects

- 802/1268 -

FORMELEMENT::X PROPERTY

The X property return the position on the page where the user should be scrolled to. The position

information is based on the DPI used when loading the page.

.NET

JAVA

PYTHON

Return Value

int : Integer containing the coordinate in pixels.

See Also

FormElement interface

int X { get; }

int getX() throws IGRException;

@property

def X(self) -> int

•

Document Filters Implementation Guide 2.3.3 Objects

- 803/1268 -

FORMELEMENT::Y PROPERTY

The Y property return the position on the page where the user should be scrolled to. The position

information is based on the DPI used when loading the page.

.NET

JAVA

PYTHON

Return Value

int : Integer containing the coordinate in pixels.

See Also

FormElement interface

int Y { get; }

int getY() throws IGRException;

@property

def Y(self) -> int

•

Document Filters Implementation Guide 2.3.3 Objects

- 804/1268 -

FormElementOption

FORMELEMENTOPTION INTERFACE

The FormElement interface represents a single form control for a given page. FormElements are

currently support for static PDF documents.

FormElementOption::Name

property

The Name property contains the display name for the

option.

FormElementOption::Selected

property

The Selected property contains whether the option is the

selected value in the dropdown or list box.

FormElementOption::Value

property

The Value property contains the value for the option.

Document Filters Implementation Guide 2.3.3 Objects

- 805/1268 -

FORMELEMENTOPTION::NAME PROPERTY

The Name property contains the display name for the option.

.NET

JAVA

PYTHON

Return Value

string : Returns the display name for the option.

See Also

FormElementOption interface

string Name { get; }

string getName() throws IGRException;

@property

def Name(self) -> string

•

Document Filters Implementation Guide 2.3.3 Objects

- 806/1268 -

FORMELEMENTOPTION::SELECTED PROPERTY

The Selected property contains whether the option is the selected value in the dropdown or list box.

.NET

JAVA

PYTHON

Return Value

bool : Returns if the option is the selected value in the dropdown or list box.

See Also

FormElementOption interface

bool Selected { get; }

boolean getSelected() throws IGRException;

@property

def Selected(self) -> bool

•

Document Filters Implementation Guide 2.3.3 Objects

- 807/1268 -

FORMELEMENTOPTION::VALUE PROPERTY

The Value property contains the value for the option.

.NET

JAVA

PYTHON

Return Value

string : Returns the value for the option.

See Also

FormElementOption interface

string Value { get; }

string getValue() throws IGRException;

@property

def Value(self) -> string

•

Document Filters Implementation Guide 2.3.3 Objects

- 808/1268 -

FormKeyValue

FORMKEYVALUE INTERFACE

The FormKeyValue interface is used to provided updated values for Forms.

This interface can be created directly.

FormKeyValue::Name

property

The Name property contains the display name for the form to be

updated.

FormKeyValue::Selected

property

The Selected property contains the new boolean value representing

the selected state for checkbox and radio button forms.

FormKeyValue::Value

property

The Value property contains the new value for the form. If the form

type is single select list box or a combo box this value must be set to

one of the available choices. If the form type is a multi-select list box

this value may be zero or more of the available choices separated

delimited by a space character.

Document Filters Implementation Guide 2.3.3 Objects

- 809/1268 -

FORMKEYVALUE::NAME PROPERTY

The Name property contains the display name for the form to be updated.

.NET

JAVA

PYTHON

Return Value

string : Returns the display name for the form.

See Also

FormKeyValue interface

string Name { get; }

string getName() throws IGRException;

@property

def Name(self) -> string

•

Document Filters Implementation Guide 2.3.3 Objects

- 810/1268 -

FORMKEYVALUE::SELECTED PROPERTY

The Selected property contains the new boolean value representing the selected state for checkbox and

radio button forms.

.NET

JAVA

PYTHON

Return Value

string : Returns the form selected state.

See Also

FormKeyValue interface

string Selected { get; }

string getSelected() throws IGRException;

@property

def Selected(self) -> string

•

Document Filters Implementation Guide 2.3.3 Objects

- 811/1268 -

FORMKEYVALUE::VALUE PROPERTY

The Value property contains the new value for the form. If the form type is single select list box or a

combo box this value must be set to one of the available choices. If the form type is a multi-select list

box this value may be zero or more of the available choices separated delimited by a space character.

.NET

JAVA

PYTHON

Return Value

string : Returns the value for the form

See Also

FormKeyValue interface

string Value { get; }

string getValue() throws IGRException;

@property

def Value(self) -> string

•

Document Filters Implementation Guide 2.3.3 Objects

- 812/1268 -

Hyperlink

HYPERLINK INTERFACE

The Hyperlink interface represents a single hyperlink on a given page.

To obtain this interface, call the Page.GetNextHyperlink method.

Hyperlink::DestBottom

property

The DestBottom gets the bottom position of the hyperlink

destination in pixels.

Hyperlink::DestFit property The DestFit property stores the destination t type. See PDF

Reference for additional details.

Hyperlink::DestLeft

property

The DestLeft gets the left position of the hyperlink destination in

pixels.

Hyperlink::DestRight

property

The DestRight gets the right position of the hyperlink destination in

pixels.

Hyperlink::DestTop

property

The DestTop gets the top position of the hyperlink destination in

pixels.

Hyperlink::DestZoom

property

The DestTop gets the top position of the hyperlink destination in

pixels.

Hyperlink::Flags property The Flags property stores the ags describing which elds are valid.

This property is used in combination with the DestFit property. See

PDF reference for more information.

Hyperlink::Height property The Height property stores the height of the hyperlink element in

pixels.

Hyperlink::HyperlinkType

property

The HyperlinkType property stores the actions that should be

performed when a user clicks on the link.

Hyperlink::PageNumber

property

The PageNumber property stores the page number to navigate to if

the HyperlinkType contains IGR_HYPERLINK_ACTION_GOTO.

Hyperlink::Ref property The Ref property stores the reference within a document to

navigate to when the user clicks on the link. This value is only valid

if the hyperlink type contains the value

IGR_HYPERLINK_ACTION_GOTO.

Document Filters Implementation Guide 2.3.3 Objects

- 813/1268 -

Hyperlink::Uri property The Uri property stores the URI to navigate to when the user clicks

on the link. This value is only valid if the hyperlink type contains the

value IGR_HYPERLINK_ACTION_URI.

Hyperlink::Width property The Width property stores the width of the hyperlink element in

pixels.

Hyperlink::X property The X property stores the horizontal position of the hyperlink

element in pixels.

Hyperlink::Y property The Y property stores the vertical position of the hyperlink element

in pixels.

Document Filters Implementation Guide 2.3.3 Objects

- 814/1268 -

HYPERLINK::DESTBOTTOM PROPERTY

The DestBottom gets the bottom position of the hyperlink destination in pixels.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : The bottom position of the hyperlink destination in pixels.

See Also

Hyperlink Interface

int DestBottom { get; }

int getDestBottom() throws IGRException;

@property

def DestBottom(self) -> int

int getDestBottom();

[propget] HRESULT DestBottom([out, retval] int *result);

•

Document Filters Implementation Guide 2.3.3 Objects

- 815/1268 -

HYPERLINK::DESTFIT PROPERTY

The DestFit property stores the destination t type. See PDF Reference for additional details.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : The destination t type. One of:

See Also

Hyperlink Interface

int DestFit { get; }

int getDestFit() throws IGRException;

@property

def DestFit(self) -> int

int getDestFit();

[propget] HRESULT DestFit([out, retval] int *result);

Name Value

IGR_HYPERLINK_FIT_XYZ 0

IGR_HYPERLINK_FIT_FIT 1

IGR_HYPERLINK_FIT_FITH 2

IGR_HYPERLINK_FIT_FITV 3

IGR_HYPERLINK_FIT_FITR 4

IGR_HYPERLINK_FIT_FITB 5

IGR_HYPERLINK_FIT_FITBH 6

IGR_HYPERLINK_FIT_FITBV 7

•

Document Filters Implementation Guide 2.3.3 Objects

- 816/1268 -

HYPERLINK::DESTLEFT PROPERTY

The DestLeft gets the left position of the hyperlink destination in pixels.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : The left position of the hyperlink destination in pixels.

See Also

Hyperlink Interface

int DestLeft { get; }

int getDestLeft() throws IGRException;

@property

def DestLeft(self) -> int

int getDestLeft();

[propget] HRESULT DestLeft([out, retval] int *result);

•

Document Filters Implementation Guide 2.3.3 Objects

- 817/1268 -

HYPERLINK::DESTRIGHT PROPERTY

The DestRight gets the right position of the hyperlink destination in pixels.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : The right position of the hyperlink destination in pixels.

See Also

Hyperlink Interface

int DestRight { get; }

int getDestRight() throws IGRException;

@property

def DestRight(self) -> int

int getDestRight();

[propget] HRESULT DestRight([out, retval] int *result);

•

Document Filters Implementation Guide 2.3.3 Objects

- 818/1268 -

HYPERLINK::DESTTOP PROPERTY

The DestTop gets the top position of the hyperlink destination in pixels.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : The top position of the hyperlink destination in pixels.

See Also

Hyperlink Interface

int DestTop { get; }

int getDestTop() throws IGRException;

@property

def DestTop(self) -> int

int getDestTop();

[propget] HRESULT DestTop([out, retval] int *result);

•

Document Filters Implementation Guide 2.3.3 Objects

- 819/1268 -

HYPERLINK::DESTZOOM PROPERTY

The DestTop gets the top position of the hyperlink destination in pixels.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : The zoom property.

See Also

Hyperlink Interface

int Zoom { get; }

int getZoom() throws IGRException;

@property

def Zoom(self) -> int

int getZoom();

[propget] HRESULT Zoom([out, retval] int *result);

•

Document Filters Implementation Guide 2.3.3 Objects

- 820/1268 -

HYPERLINK::FLAGS PROPERTY

The Flags property stores the ags describing which elds are valid. This property is used in combination

with the DestFit property. See PDF reference for more information.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : Zero or more ags describing which destination properties have a value.

See Also

Hyperlink Interface

int Flags { get; }

int getFlags() throws IGRException;

@property

def Flags(self) -> int

int getFlags();

[propget] HRESULT Flags([out, retval] int *result);

Name Value

IGR_HYPERLINK_FLAGS_CHANGE_LEFT 0x1

IGR_HYPERLINK_FLAGS_CHANGE_TOP 0x2

IGR_HYPERLINK_FLAGS_CHANGE_ZOOM 0x4

•

Document Filters Implementation Guide 2.3.3 Objects

- 821/1268 -

HYPERLINK::HEIGHT PROPERTY

The Height property stores the height of the hyperlink element in pixels.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : The height of the hyperlink element in pixels.

See Also

Hyperlink Interface

int Height { get; }

int getHeight() throws IGRException;

@property

def Height(self) -> int

int getHeight();

[propget] HRESULT Height([out, retval] int *result);

•

Document Filters Implementation Guide 2.3.3 Objects

- 822/1268 -

HYPERLINK::HYPERLINKTYPE PROPERTY

The HyperlinkType property stores the actions that should be performed when a user clicks on the link.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : Integer value containing the IGR_HYPERLINK_ACTION_TYPE enumerated value, one of:

See Also

Hyperlink Interface

int HyperlinkType { get; }

int getHyperlinkType() throws IGRException;

@property

def HyperlinkType(self) -> int

int getHyperlinkType();

[propget] HRESULT HyperlinkType([out, retval] int *result);

Name Value

IGR_HYPERLINK_ACTION_GOTO 0x1

IGR_HYPERLINK_ACTION_URI 0x2

•

Document Filters Implementation Guide 2.3.3 Objects

- 823/1268 -

HYPERLINK::PAGENUMBER PROPERTY

The PageNumber property stores the page number to navigate to if the HyperlinkType contains

IGR_HYPERLINK_ACTION_GOTO.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : The page number to navigate to.

See Also

Hyperlink Interface

int PageNumber { get; }

int getPageNumber() throws IGRException;

@property

def PageNumber(self) -> int

int getPageNumber();

[propget] HRESULT PageNumber([out, retval] int *result);

•

Document Filters Implementation Guide 2.3.3 Objects

- 824/1268 -

HYPERLINK::REF PROPERTY

The Ref property stores the reference within a document to navigate to when the user clicks on the link.

This value is only valid if the hyperlink type contains the value IGR_HYPERLINK_ACTION_GOTO.

.NET

JAVA

PYTHON

C++

COM

Return Value

string : The reference within a document to navigate to when the user clicks on the link.

See Also

Hyperlink Interface

string Ref { get; }

string getRef() throws IGRException;

@property

def Ref(self) -> string

std::wstring getRef();

[propget] HRESULT Ref([out, retval] BSTR *result);

•

Document Filters Implementation Guide 2.3.3 Objects

- 825/1268 -

HYPERLINK::URI PROPERTY

The Uri property stores the URI to navigate to when the user clicks on the link. This value is only valid if

the hyperlink type contains the value IGR_HYPERLINK_ACTION_URI.

.NET

JAVA

PYTHON

C++

COM

Return Value

string : The URI to navigate to when the user clicks on the link.

See Also

Hyperlink Interface

string Uri { get; }

string getUri() throws IGRException;

@property

def Uri(self) -> string

std::wstring getUri();

[propget] HRESULT Uri([out, retval] BSTR *result);

•

Document Filters Implementation Guide 2.3.3 Objects

- 826/1268 -

HYPERLINK::WIDTH PROPERTY

The Width property stores the width of the hyperlink element in pixels.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : The width of the hyperlink element in pixels.

See Also

Hyperlink Interface

int Width { get; }

int getWidth() throws IGRException;

@property

def Width(self) -> int

int getWidth();

[propget] HRESULT Width([out, retval] int *result);

•

Document Filters Implementation Guide 2.3.3 Objects

- 827/1268 -

HYPERLINK::X PROPERTY

The X property stores the horizontal position of the hyperlink element in pixels.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : The horizontal position of the hyperlink element in pixels.

See Also

Hyperlink Interface

int X { get; }

int getX() throws IGRException;

@property

def X(self) -> int

int getX();

[propget] HRESULT X([out, retval] int *result);

•

Document Filters Implementation Guide 2.3.3 Objects

- 828/1268 -

HYPERLINK::Y PROPERTY

The Y property stores the vertical position of the hyperlink element in pixels.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : The vertical position of the hyperlink element in pixels.

See Also

Hyperlink Interface

int Y { get; }

int getY() throws IGRException;

@property

def Y(self) -> int

int getY();

[propget] HRESULT Y([out, retval] int *result);

•

Document Filters Implementation Guide 2.3.3 Objects

- 829/1268 -

IGRFormat

IGRFORMAT INTERFACE

Represents a le-type as returned by GetSupportedFormats .

IGRFormat::CongName property Gets the conguration name of the format.

IGRFormat::DisplayName property Gets the display name of the format.

IGRFormat::FileTypeCategory property Gets the le type category of the format.

IGRFormat::Id property Gets the ID of the format.

IGRFormat::MimeType property Gets the MIME type of the format.

IGRFormat::ShortName property Gets the short name of the format.

Document Filters Implementation Guide 2.3.3 Objects

- 830/1268 -

IGRFORMAT::CONFIGNAME PROPERTY

Gets the conguration name of the format.

.NET

JAVA

PYTHON

Return Value

string : The conguration name for the format.

string ConfigName { get; }

string getConfigName() throws IGRException;

@property

def ConfigName(self) -> string

Document Filters Implementation Guide 2.3.3 Objects

- 831/1268 -

IGRFORMAT::DISPLAYNAME PROPERTY

Gets the display name of the format.

.NET

JAVA

PYTHON

Return Value

string : The display name for the format.

string DisplayName { get; }

string getDisplayName() throws IGRException;

@property

def DisplayName(self) -> string

Document Filters Implementation Guide 2.3.3 Objects

- 832/1268 -

IGRFORMAT::FILETYPECATEGORY PROPERTY

Gets the le type category of the format.

.NET

JAVA

PYTHON

Return Value

int : The FileTypeCategory for the format. See IGR_FILETYPE_CATEGORY for details.

int FileTypeCategory { get; }

int getFileTypeCategory() throws IGRException;

@property

def FileTypeCategory(self) -> int

Document Filters Implementation Guide 2.3.3 Objects

- 833/1268 -

IGRFORMAT::ID PROPERTY

Gets the ID of the format.

.NET

JAVA

PYTHON

Return Value

int : The ID for the format.

int Id { get; }

int getId() throws IGRException;

@property

def Id(self) -> int

Document Filters Implementation Guide 2.3.3 Objects

- 834/1268 -

IGRFORMAT::MIMETYPE PROPERTY

Gets the MIME type of the format.

.NET

JAVA

PYTHON

Return Value

string : The MIME type for the format.

string MimeType { get; }

string getMimeType() throws IGRException;

@property

def MimeType(self) -> string

Document Filters Implementation Guide 2.3.3 Objects

- 835/1268 -

IGRFORMAT::SHORTNAME PROPERTY

Gets the short name of the format.

.NET

JAVA

PYTHON

Return Value

string : The short name for the format.

string ShortName { get; }

string getShortName() throws IGRException;

@property

def ShortName(self) -> string

Document Filters Implementation Guide 2.3.3 Objects

- 836/1268 -

IGROption

IGROPTION INTERFACE

Represents a conguration option as returned by GetAvailableOptions .

IGROption::DefaultValue property Gets the default value of the option.

IGROption::Description property Gets the description of the option.

IGROption::DisplayName property Gets the display name of the option.

IGROption::Flags property Gets the ags of the option.

IGROption::PossibleValues property Gets the possible values of the option.

IGROption::Type property Gets the type of the option.

Document Filters Implementation Guide 2.3.3 Objects

- 837/1268 -

IGROPTION::DEFAULTVALUE PROPERTY

Gets the default value of the option.

.NET

JAVA

PYTHON

Return Value

string : The default value for the option.

string DefaultValue { get; }

string getDefaultValue() throws IGRException;

@property

def DefaultValue(self) -> string

Document Filters Implementation Guide 2.3.3 Objects

- 838/1268 -

IGROPTION::DESCRIPTION PROPERTY

Gets the description of the option.

.NET

JAVA

PYTHON

Return Value

string : The description for the option.

string Description { get; }

string getDescription() throws IGRException;

@property

def Description(self) -> string

Document Filters Implementation Guide 2.3.3 Objects

- 839/1268 -

IGROPTION::DISPLAYNAME PROPERTY

Gets the display name of the option.

.NET

JAVA

PYTHON

Return Value

string : The display name for the option.

string DisplayName { get; }

string getDisplayName() throws IGRException;

@property

def DisplayName(self) -> string

Document Filters Implementation Guide 2.3.3 Objects

- 840/1268 -

IGROPTION::FLAGS PROPERTY

Gets the ags of the option.

.NET

JAVA

PYTHON

Return Value

int : The ags for the option.

int Flags { get; }

int getFlags() throws IGRException;

@property

def Flags(self) -> int

Document Filters Implementation Guide 2.3.3 Objects

- 841/1268 -

IGROPTION::POSSIBLEVALUES PROPERTY

Gets the possible values of the option.

.NET

JAVA

PYTHON

Return Value

string[] : The possible values for the option.

IEnumerable<string> PossibleValues { get; }

string[] getPossibleValues() throws IGRException;

@property

def PossibleValues(self) -> string[]

Document Filters Implementation Guide 2.3.3 Objects

- 842/1268 -

IGROPTION::TYPE PROPERTY

Gets the type of the option.

.NET

JAVA

PYTHON

Return Value

string : The type for the option.

string Type { get; }

string getType() throws IGRException;

@property

def Type(self) -> string

Document Filters Implementation Guide 2.3.3 Objects

- 843/1268 -

Page

PAGE INTERFACE

The Page interface represents a single page in an image laid-out document. The page allows access to

the words on a page, as well as the ability to render it onto a canvas such as TIFF, PNG, or PDF.

To obtain this interface, call the Extractor::GetPage.

Page::Annotations property Gets an enumerable collections of annotations on the page.

Page::Close method The Close method releases any resources associated with the

page.

Page::Compare method The Compare method allows you to compare two pages returning

the dierences.

Page::FormElements

property

Returns an enumerable collections of form elements on the page.

Page::GetAnnotation

method

The GetAnnotation method is used to retrieve the annotation on

the page at the specied index.

Page::GetAnnotationCount

method

The GetAnnotationCount method returns the number of

annotations that are on a page. The annotations can be

enumerated using the GetFirstAnnotation and GetNextAnnotation

methods, or accessed via index using the GetAnnotation method.

Page::GetAttribute method IGR_Get_Page_Attribute returns style or properties of an open

page; see <page> under Structured XML for a full list of options.

Page::GetFirstAnnotation

method

The GetFirstAnnotation method is used to enumerate the

annotations that are on the page.

Page::GetFirstFormElement

method

The GetFirstFormElement method is used to enumerate the form

controls that are on the page.

Page::GetFirstHyperlink

method

The GetFirstHyperlink method is used to enumerate the

hyperlinks that are on the page.

Page::GetFirstImage method The GetFirstImage method is used to enumerate the embedded

images that are on the page. This method is useful if the page

images are to be extracted and stored in separate les. These

Document Filters Implementation Guide 2.3.3 Objects

- 844/1268 -

methods are not needed if the page is to be rendered into an

image output canvas such as PNG, TIFF, or PDF.

Page::GetFirstWord method The GetFirstWord method is used to enumerate all the words on

the current page. GetFirstWord resets the enumeration back to

the beginning. The method will return a reference to a Word

object, or NULL if there are no more words.

Page::GetNextAnnotation

method

The GetNextAnnotation method is used to enumerate the

annotations that are on the page.

Page::GetNextFormElement

method

The GetNextFormElement method is used to enumerate the form

controls that are on the page.

Page::GetNextHyperlink

method

The GetNextHyperlink method is used to enumerate the

hyperlinks that are on the page.

Page::GetNextImage

method

The GetNextImage method is used to enumerate the embedded

images that are on the page. This method is useful if the page

images are to be extracted and stored in separate les. These

methods are not needed if the page is to be rendered into an

image output canvas such as PNG, TIFF, or PDF.

Page::GetNextWord method The GetNextWord method is used to enumerate all the words on

the current page. The method will return a reference to a Word

object, or NULL if there are no more words.

Page::GetRootPageElement

method

Returns the root page element for this page.

Page::Handle property Returns the pages IGR_HPAGE handle that can be used with the C

API.

Page::Height property The height property return the dimensions of a page in pixels.

Page::Hyperlinks property Returns an enumerable collections of hyperlinks on the page.

Page::Images property Returns an enumerable collections of image elements on the

page.

Page::Redact method Redact removes a range of words and blacks out the location for

the specied range from the page.

Page::Text property The Text property returns all the text contained on the page.

Document Filters Implementation Guide 2.3.3 Objects

- 845/1268 -

Page::Width property The width property return the dimensions of a page in pixels.

Page::WordCount property The WordCount property returns the number of “Word”s that are

on a page. The words can be enumerated using the GetFirstWord

and GetNextWord methods.

Page::Words property Returns an enumerable collections of form elements on the page.

Document Filters Implementation Guide 2.3.3 Objects

- 846/1268 -

PAGE::ANNOTATIONS PROPERTY

Gets an enumerable collections of annotations on the page.

.NET

PYTHON

Return Value

IEnumerable<Annotation> : Returns an enumerable set of annotations

IEnumerable<Annotation> Annotations { get; }

@property

def Annotations(self) -> list

Document Filters Implementation Guide 2.3.3 Objects

- 847/1268 -

PAGE::CLOSE METHOD

The Close method releases any resources associated with the page.

Prototype

.NET

JAVA

PYTHON

Additional Information

This method should be called when nished working with a page to release its resources. The method

will be internally called when the instance itself is released. Calling this method on closed pages has no

eect.

Resources can also be managed with the using IDisposable pattern in C#, or the

try-with-resources pattern in Java.

See Also

Page interface

Extractor::GetPage method

Extractor::GetFirstPage method

void Close()

void Close() throws IGRException;

def Close(self) -> void

•

Document Filters Implementation Guide 2.3.3 Objects

- 848/1268 -

PAGE::COMPARE METHOD

The Compare method allows you to compare two pages returning the dierences.

Overloads

Compare(Page, CompareSettings)

Prototype

.NET

JAVA

PYTHON

Parameters

otherPage : Page : Provide the other Page to compare.

settings : CompareSettings : Provide the settings that control the compare logic.

Return value

CompareResults : A new instance of a CompareResults interface.

Compare(Page, System.Drawing.RectangleF, CompareSettings)

Prototype

.NET

Compare(Page, CompareSettings) The Compare method allows you to

compare two pages returning the

dierences.

Compare(Page, System.Drawing.RectangleF,

CompareSettings)

The Compare method allows you to

compare two pages, applying margins,

returning the dierences.

Compare(Page, System.Drawing.RectangleF,

System.Drawing.RectangleF, CompareSettings)

The Compare method allows you to

compare two pages, applying margins,

returning the dierences.

CompareResults Compare(Page otherPage, CompareSettings settings)

CompareResults Compare(Page otherPage, CompareSettings settings) throws IGRException;

def Compare(self, otherPage: Page, settings: CompareSettings) -> CompareResults

Document Filters Implementation Guide 2.3.3 Objects

- 849/1268 -

Parameters

otherPage : Page : Provide the other Page to compare.

margins: System.Drawing.RectangleF : The margins to apply to both pages.

settings : CompareSettings : Provide the settings that control the compare logic.

Return value

CompareResults : A new instance of a CompareResults interface.

Compare(Page, System.Drawing.RectangleF, System.Drawing.RectangleF, CompareSettings)

Prototype

.NET

Parameters

otherPage : Page : Provide the other Page to compare.

leftMargins: System.Drawing.RectangleF : The margins to apply to the left/original page.

rightMargins: System.Drawing.RectangleF : The margins to apply to the right/revised page.

settings : CompareSettings : Provide the settings that control the compare logic.

Return value

CompareResults : A new instance of a CompareResults interface.

CompareResults Compare(Page otherPage, System.Drawing.RectangleF margins, CompareSettings settings)

CompareResults Compare(Page otherPage, System.Drawing.RectangleF leftMargins, System.Drawing.RectangleF

rightMargins, CompareSettings settings)

Document Filters Implementation Guide 2.3.3 Objects

- 850/1268 -

Sample Code

See Also

CompareDocumentSettings interface

Page interface

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using (var doc1 = api.OpenExtractor(GetTestFilename("original.docx"), OpenMode.Paginated))

7 using (var doc2 = api.OpenExtractor(GetTestFilename("revision.docx"), OpenMode.Paginated))

8 using (var page1 = doc1.GetPage(0))

9 using (var page2 = doc2.GetPage(0))

10 using (var compare = page1.Compare(page2))

11 {

12 while (compare.MoveNext())

13 {

14 var diff = compare.Current;

15 // work with diff...

16 }

17 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 851/1268 -

PAGE::FORMELEMENTS PROPERTY

Returns an enumerable collections of form elements on the page.

.NET

PYTHON

Return Value

IEnumerable<FormElement> : An enumerable collection of form element objects.

See Also

FormElement interface

IEnumerable<FormElement> FormElements { get; }

@property

def FormElements(self) -> list

•

Document Filters Implementation Guide 2.3.3 Objects

- 852/1268 -

PAGE::GETANNOTATION METHOD

The GetAnnotation method is used to retrieve the annotation on the page at the specied index.

Prototype

.NET

JAVA

PYTHON

Parameters

index: int : The index of the annotation to return.

Return value

Annotation : Returns the annotation on the current page at the specied index, or NULL if the index is

out of range.

See Also

Page interface

Annotation interface

Annotation GetAnnotation(int index)

Annotation GetAnnotation(int index) throws IGRException;

def GetAnnotation(self, index: int) -> Annotation

•

Document Filters Implementation Guide 2.3.3 Objects

- 853/1268 -

PAGE::GETANNOTATIONCOUNT METHOD

The GetAnnotationCount method returns the number of annotations that are on a page. The annotations

can be enumerated using the GetFirstAnnotation and GetNextAnnotation methods, or accessed via index

using the GetAnnotation method.

Prototype

.NET

JAVA

PYTHON

Return value

int : Integer containing the number of annotations on the page.

See Also

Page interface

Annotation interface

int GetAnnotationCount()

int GetAnnotationCount() throws IGRException;

def GetAnnotationCount(self) -> int

•

Document Filters Implementation Guide 2.3.3 Objects

- 854/1268 -

PAGE::GETATTRIBUTE METHOD

IGR_Get_Page_Attribute returns style or properties of an open page; see <page> under Structured XML

for a full list of options.

Prototype

.NET

JAVA

PYTHON

Parameters

Return value

string : String of the requested attribute.

Sample Code

Additional Information

In addition to the <page> styles and properties, you can use the following attribute names.

string GetAttribute(string name)

string GetAttribute(string name) throws IGRException;

def GetAttribute(self, name: string) -> string

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(OpenType.Paginated);

9 foreach (var page in doc.Pages)

10 {

11 using (page)

12 {

13 var dpi = page.GetAttribute("SourceDpiX");

14 }

15 }

Name Description

FONTS A semicolon delimited list of fonts present on the current

page.

Document Filters Implementation Guide 2.3.3 Objects

- 855/1268 -

Note To retrieve all fonts for a document, use DOCUMENT_FONTS or DOCUMENT_FONT_MAPPINGS after

processing the last page of the document. These attributes are more ecient than using FONTS or

FONT_MAPPINGS per page.

Name Description

FONT_MAPPINGS A semicolon delimited list of

“OriginalName=MappedName” fonts on the current page.

DOCUMENT_FONTS A semicolon delimited list of fonts processed in the

document, up to the point of the call.

DOCUMENT_FONT_MAPPINGS A semicolon delimited list of

"OriginalName=MappedName" fonts processed in the

document, up to the point of the call.

SOURCEWIDTH Width of source document if it is a raster image.

SOURCEHEIGHT Height of source document if it is a raster image.

OPTIONS Document options currently in eect.

Document Filters Implementation Guide 2.3.3 Objects

- 856/1268 -

PAGE::GETFIRSTANNOTATION METHOD

The GetFirstAnnotation method is used to enumerate the annotations that are on the page.

Prototype

.NET

JAVA

PYTHON

Return value

Annotation : Returns the rst annotation on the current page, or NULL if no annotations are present.

See Also

Page interface

Annotation interface

Annotation::GetNextAnnotation

Annotation GetFirstAnnotation()

Annotation GetFirstAnnotation() throws IGRException;

def GetFirstAnnotation(self) -> Annotation

•

Document Filters Implementation Guide 2.3.3 Objects

- 857/1268 -

PAGE::GETFIRSTFORMELEMENT METHOD

The GetFirstFormElement method is used to enumerate the form controls that are on the page.

Prototype

.NET

JAVA

PYTHON

COM

Return value

FormElement : Returns the rst form element on the current page, or NULL if no forms are present.

See Also

Page interface

FormElement interface

Page::GetNextFormElement

FormElement GetFirstFormElement()

FormElement GetFirstFormElement() throws IGRException;

def GetFirstFormElement(self) -> FormElement

HRESULT GetFirstFormElement([out, retval] FormElement* *result)

•

Document Filters Implementation Guide 2.3.3 Objects

- 858/1268 -

PAGE::GETFIRSTHYPERLINK METHOD

The GetFirstHyperlink method is used to enumerate the hyperlinks that are on the page.

Prototype

.NET

JAVA

PYTHON

COM

Return value

Hyperlink : Returns the rst hyperlink on the current page, or NULL if no hyperlinks are present.

See Also

Page interface

Hyperlink interface

Page::GetNextHyperlink

Hyperlink GetFirstHyperlink()

Hyperlink GetFirstHyperlink() throws IGRException;

def GetFirstHyperlink(self) -> Hyperlink

HRESULT GetFirstHyperlink([out, retval] Hyperlink* *result)

•

Document Filters Implementation Guide 2.3.3 Objects

- 859/1268 -

PAGE::GETFIRSTIMAGE METHOD

The GetFirstImage method is used to enumerate the embedded images that are on the page. This

method is useful if the page images are to be extracted and stored in separate les. These methods are

not needed if the page is to be rendered into an image output canvas such as PNG, TIFF, or PDF.

Prototype

.NET

JAVA

PYTHON

COM

Return value

SubFile : Reference to a SubFile object, SubFile::Close must be called when nished with the object.

See Also

Page interface

SubFile interface

Page::GetNextImage

SubFile GetFirstImage()

SubFile GetFirstImage() throws IGRException;

def GetFirstImage(self) -> SubFile

HRESULT GetFirstImage([out, retval] SubFile* *result)

•

Document Filters Implementation Guide 2.3.3 Objects

- 860/1268 -

PAGE::GETFIRSTWORD METHOD

The GetFirstWord method is used to enumerate all the words on the current page. GetFirstWord resets

the enumeration back to the beginning. The method will return a reference to a Word object, or NULL if

there are no more words.

Prototype

.NET

JAVA

PYTHON

C++

COM

Return value

Word : Reference to a Word object.

Word GetFirstWord()

Word GetFirstWord() throws IGRException;

def GetFirstWord(self) -> Word

Word GetFirstWord()

HRESULT GetFirstWord([out, retval] Word* *result)

Document Filters Implementation Guide 2.3.3 Objects

- 861/1268 -

Sample Code

See Also

Page interface

Word interface

Page::GetNextWord

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.Paginated);

9 foreach (var page in doc.Pages)

10 {

11 using (page)

12 {

13 // Iterate over all words on the page

14 for (Word word = page.GetFirstWord(); word != null; word = word.GetNextWord())

15 {

16 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

17 }

19 // Alternatively, use the iterator

20 foreach (Word word in page.Words)

21 {

22 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

23 }

25 }

26 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 862/1268 -

PAGE::GETNEXTANNOTATION METHOD

The GetNextAnnotation method is used to enumerate the annotations that are on the page.

Prototype

.NET

JAVA

PYTHON

Return value

Annotation : Returns the next annotation on the current page, or NULL if no annotations are present.

See Also

Page interface

Annotation interface

Annotation::GetFirstAnnotation

Annotation GetNextAnnotation()

Annotation GetNextAnnotation() throws IGRException;

def GetNextAnnotation(self) -> Annotation

•

Document Filters Implementation Guide 2.3.3 Objects

- 863/1268 -

PAGE::GETNEXTFORMELEMENT METHOD

The GetNextFormElement method is used to enumerate the form controls that are on the page.

Prototype

.NET

JAVA

PYTHON

COM

Return value

FormElement : Returns the next form element on the current page, or NULL if no more forms elements

are available.

See Also

Page interface

FormElement interface

Page::GetFirstFormElement

FormElement GetNextFormElement()

FormElement GetNextFormElement() throws IGRException;

def GetNextFormElement(self) -> FormElement

HRESULT GetNextFormElement([out, retval] FormElement* *result)

•

Document Filters Implementation Guide 2.3.3 Objects

- 864/1268 -

PAGE::GETNEXTHYPERLINK METHOD

The GetNextHyperlink method is used to enumerate the hyperlinks that are on the page.

Prototype

.NET

JAVA

PYTHON

COM

Return value

Hyperlink : Returns the next hyperlink on the current page, or NULL if no more hyperlinks are

available.

See Also

Page interface

Hyperlink interface

Page::GetFirstHyperlink

Hyperlink GetNextHyperlink()

Hyperlink GetNextHyperlink() throws IGRException;

def GetNextHyperlink(self) -> Hyperlink

HRESULT GetNextHyperlink([out, retval] Hyperlink* *result)

•

Document Filters Implementation Guide 2.3.3 Objects

- 865/1268 -

PAGE::GETNEXTIMAGE METHOD

The GetNextImage method is used to enumerate the embedded images that are on the page. This

method is useful if the page images are to be extracted and stored in separate les. These methods are

not needed if the page is to be rendered into an image output canvas such as PNG, TIFF, or PDF.

Prototype

.NET

JAVA

PYTHON

COM

Return value

SubFile : Reference to a SubFile object, SubFile::Close must be called when nished with the object.

See Also

Page interface

SubFile interface

Page::GetFirstImage

SubFile GetNextImage()

SubFile GetNextImage() throws IGRException;

def GetNextImage(self) -> SubFile

HRESULT GetNextImage([out, retval] SubFile* *result)

•

Document Filters Implementation Guide 2.3.3 Objects

- 866/1268 -

PAGE::GETNEXTWORD METHOD

The GetNextWord method is used to enumerate all the words on the current page. The method will

return a reference to a Word object, or NULL if there are no more words.

Prototype

.NET

JAVA

PYTHON

C++

COM

Return value

Word : Reference to a Word object.

Word GetNextWord()

Word GetNextWord() throws IGRException;

def GetNextWord(self) -> Word

Word GetNextWord()

HRESULT GetNextWord([out, retval] Word* *result)

Document Filters Implementation Guide 2.3.3 Objects

- 867/1268 -

Sample Code

See Also

Page interface

Word interface

Page::GetFirstWord

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.Paginated);

9 foreach (var page in doc.Pages)

10 {

11 using (page)

12 {

13 // Iterate over all words on the page

14 for (Word word = page.GetFirstWord(); word != null; word = word.GetNextWord())

15 {

16 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

17 }

19 // Alternatively, use the iterator

20 foreach (Word word in page.Words)

21 {

22 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

23 }

25 }

26 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 868/1268 -

PAGE::GETROOTPAGEELEMENT METHOD

Returns the root page element for this page.

Prototype

.NET

JAVA

PYTHON

Return value

PageElement : PageElement representing the root of the page.

See Also

PageElement

PageElement GetRootPageElement()

PageElement GetRootPageElement() throws IGRException;

def GetRootPageElement(self) -> PageElement

•

Document Filters Implementation Guide 2.3.3 Objects

- 869/1268 -

PAGE::HANDLE PROPERTY

Returns the pages IGR_HPAGE handle that can be used with the C API.

.NET

JAVA

PYTHON

Return Value

int : The IGR_HPAGE handle for the page.

int Handle { get; }

int getHandle() throws IGRException;

@property

def Handle(self) -> int

Document Filters Implementation Guide 2.3.3 Objects

- 870/1268 -

PAGE::HEIGHT PROPERTY

The height property return the dimensions of a page in pixels.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : Integer containing the height of the page in pixels.

Sample Code

int Height { get; }

int getHeight() throws IGRException;

@property

def Height(self) -> int

int getHeight();

[propget] HRESULT Height([out, retval] int *result);

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.Paginated);

9 foreach (var page in doc.Pages)

10 {

11 using (page)

12 {

13 Console.WriteLine($"Width: {page.Width}");

14 Console.WriteLine($"Height: {page.Height}");

15 Console.WriteLine($"Text: {page.Text}");

16 }

17 }

Document Filters Implementation Guide 2.3.3 Objects

- 871/1268 -

Additional Information

The dimensions are calculated based on the stored page width of the source document, or the default

page width for text documents.

The calculated dimensions of a page can be controlled by setting options, such as DPI, when loading the

document.

See Also

Page interface

Page::Width

•

Document Filters Implementation Guide 2.3.3 Objects

- 872/1268 -

PAGE::HYPERLINKS PROPERTY

Returns an enumerable collections of hyperlinks on the page.

.NET

PYTHON

Return Value

IEnumerable<Hyperlink> : An enumerable collection of hyperlink objects.

See Also

Hyperlink interface

IEnumerable<Hyperlink> Hyperlinks { get; }

@property

def Hyperlinks(self) -> list

•

Document Filters Implementation Guide 2.3.3 Objects

- 873/1268 -

PAGE::IMAGES PROPERTY

Returns an enumerable collections of image elements on the page.

.NET

PYTHON

Return Value

IEnumerable<SubFile> : An enumerable collection of image element objects.

See Also

SubFile interface

IEnumerable<SubFile> Images { get; }

@property

def Images(self) -> list

•

Document Filters Implementation Guide 2.3.3 Objects

- 874/1268 -

PAGE::REDACT METHOD

Redact removes a range of words and blacks out the location for the specied range from the page.

Overloads

Redact(Word, Word)

Prototype

.NET

JAVA

PYTHON

C++

COM

Parameters

firstWord: Word : The rst word to redact.

lastWord: Word : The rst word to redact.

Redact(int, int)

Prototype

.NET

JAVA

Redact(Word, Word) Redacts the words from the given range.

Redact(int, int) Redacts the words from the given range.

void Redact(Word firstWord, Word lastWord)

void Redact(Word firstWord, Word lastWord) throws IGRException;

def Redact(self, firstWord: Word, lastWord: Word) -> void

void Redact(Word firstWord, Word lastWord)

HRESULT Redact([in] Word* firstWord, [in] Word* lastWord)

void Redact(int firstWord, int lastWord)

void Redact(int firstWord, int lastWord) throws IGRException;

Document Filters Implementation Guide 2.3.3 Objects

- 875/1268 -

PYTHON

C++

COM

Parameters

firstWord: int : The rst word to redact.

lastWord: int : The rst word to redact.

Sample Code

Additional Information

It should be assumed that redacted content will not persist between closing and re-opening a page. To

create a redacted Image, PDF, or HTML le, rst open a Page, perform the redaction, and render the

Page to a Canvas before closing it.

The API allows for redacting single words or a range of words. When redacting a range, whitespace

between the words will also be redacted.

See Also

Page interface

def Redact(self, firstWord: int, lastWord: int) -> void

void Redact(int firstWord, int lastWord)

HRESULT Redact([in] int firstWord, [in] int lastWord)

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 using var page = Document.Page(0);

10 if (page.WordCount > 15)

11 page.Redact(0, 14);

13 using var canvas = Filters.MakeOutputCanvas("output.pdf", IGR_DEVICE_IMAGE_PDF, "");

14 canvas.RenderPage(page);

•

Document Filters Implementation Guide 2.3.3 Objects

- 876/1268 -

PAGE::TEXT PROPERTY

The Text property returns all the text contained on the page.

.NET

JAVA

PYTHON

C++

COM

Return Value

string : Unicode String containing the text of the page.

Sample Code

See Also

Page interface

string Text { get; }

string getText() throws IGRException;

@property

def Text(self) -> string

std::wstring getText();

[propget] HRESULT Text([out, retval] BSTR *result);

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.Paginated);

9 foreach (var page in doc.Pages)

10 {

11 using (page)

12 {

13 Console.WriteLine($"Width: {page.Width}");

14 Console.WriteLine($"Height: {page.Height}");

15 Console.WriteLine($"Text: {page.Text}");

16 }

17 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 877/1268 -

PAGE::WIDTH PROPERTY

The width property return the dimensions of a page in pixels.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : Integer containing the width of the page in pixels.

Sample Code

int Width { get; }

int getWidth() throws IGRException;

@property

def Width(self) -> int

int getWidth();

[propget] HRESULT Width([out, retval] int *result);

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.Paginated);

9 foreach (var page in doc.Pages)

10 {

11 using (page)

12 {

13 Console.WriteLine($"Width: {page.Width}");

14 Console.WriteLine($"Height: {page.Height}");

15 Console.WriteLine($"Text: {page.Text}");

16 }

17 }

Document Filters Implementation Guide 2.3.3 Objects

- 878/1268 -

Additional Information

The dimensions are calculated based on the stored page width of the source document, or the default

page width for text documents.

The calculated dimensions of a page can be controlled by setting options, such as DPI, when loading the

document.

See Also

Page interface

Page::Height

•

Document Filters Implementation Guide 2.3.3 Objects

- 879/1268 -

PAGE::WORDCOUNT PROPERTY

The WordCount property returns the number of “Word”s that are on a page. The words can be

enumerated using the GetFirstWord and GetNextWord methods.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : Integer containing the number of words on the page.

int WordCount { get; }

int getWordCount() throws IGRException;

@property

def WordCount(self) -> int

int getWordCount();

[propget] HRESULT WordCount([out, retval] int *result);

Document Filters Implementation Guide 2.3.3 Objects

- 880/1268 -

Sample Code

See Also

Page interface

Page::GetFirstWord

Page::GetNextWord

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.Paginated);

9 foreach (var page in doc.Pages)

10 {

11 using (page)

12 {

13 // Iterate over all words on the page

14 for (Word word = page.GetFirstWord(); word != null; word = word.GetNextWord())

15 {

16 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

17 }

19 // Alternatively, use the iterator

20 foreach (Word word in page.Words)

21 {

22 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

23 }

25 }

26 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 881/1268 -

PAGE::WORDS PROPERTY

Returns an enumerable collections of form elements on the page.

.NET

PYTHON

Return Value

IEnumerable<Word> : An enumerable collection of word element objects.

See Also

Word interface

IEnumerable<Word> Words { get; }

@property

def Words(self) -> list

•

Document Filters Implementation Guide 2.3.3 Objects

- 882/1268 -

PageElement

PAGEELEMENT INTERFACE

Represents a page element in a document.

PageElement::Bounds property Gets the bounds of the page element.

PageElement::Depth property Gets the depth of the page element.

PageElement::Flags property Gets the ags of the page element.

PageElement::GetFirstChild method Gets the rst child of the page element.

PageElement::GetNextSibling method Gets the next sibling of the page element.

PageElement::GetStyle method Get the named style from the page element.

PageElement::Styles property Gets the styles of the page element.

PageElement::Text property Gets the text of the page element.

PageElement::Type property Gets the type of the page element.

Document Filters Implementation Guide 2.3.3 Objects

- 883/1268 -

PAGEELEMENT::BOUNDS PROPERTY

Gets the bounds of the page element.

.NET

JAVA

PYTHON

Return Value

IGR_FRect : The bounding box of the page element

System.Drawing.Rectangle Bounds { get; }

IGR_FRect getBounds() throws IGRException;

@property

def Bounds(self) -> IGR_FRect

Document Filters Implementation Guide 2.3.3 Objects

- 884/1268 -

PAGEELEMENT::DEPTH PROPERTY

Gets the depth of the page element.

.NET

JAVA

PYTHON

Return Value

int : The depth of the element.

int Depth { get; }

int getDepth() throws IGRException;

@property

def Depth(self) -> int

Document Filters Implementation Guide 2.3.3 Objects

- 885/1268 -

PAGEELEMENT::FLAGS PROPERTY

Gets the ags of the page element.

.NET

JAVA

PYTHON

Return Value

int : The ags of the element.

See Also

IGR_PAGE_FORM_ELEMENT_FLAG_TYPE

int Flags { get; }

int getFlags() throws IGRException;

@property

def Flags(self) -> int

•

Document Filters Implementation Guide 2.3.3 Objects

- 886/1268 -

PAGEELEMENT::GETFIRSTCHILD METHOD

Gets the rst child of the page element.

Prototype

.NET

JAVA

PYTHON

Return value

PageElement : PageElement of the rst child, or null if no children present.

PageElement GetFirstChild()

PageElement GetFirstChild() throws IGRException;

def GetFirstChild(self) -> PageElement

Document Filters Implementation Guide 2.3.3 Objects

- 887/1268 -

PAGEELEMENT::GETNEXTSIBLING METHOD

Gets the next sibling of the page element.

Prototype

.NET

JAVA

PYTHON

Return value

PageElement : PageElement of the next sibling child, or null if last item.

PageElement GetNextSibling()

PageElement GetNextSibling() throws IGRException;

def GetNextSibling(self) -> PageElement

Document Filters Implementation Guide 2.3.3 Objects

- 888/1268 -

PAGEELEMENT::GETSTYLE METHOD

Get the named style from the page element.

Prototype

.NET

JAVA

PYTHON

Return value

string : String containing the name, or null if not available.

string GetStyle()

string GetStyle() throws IGRException;

def GetStyle(self) -> string

Document Filters Implementation Guide 2.3.3 Objects

- 889/1268 -

PAGEELEMENT::STYLES PROPERTY

Gets the styles of the page element.

.NET

JAVA

PYTHON

Return Value

LocalizedDictionary : The styles of the page elements.

IDictionary<string, string> Styles { get; }

LocalizedDictionary getStyles() throws IGRException;

@property

def Styles(self) -> LocalizedDictionary

Document Filters Implementation Guide 2.3.3 Objects

- 890/1268 -

PAGEELEMENT::TEXT PROPERTY

Gets the text of the page element.

.NET

JAVA

PYTHON

Return Value

string : The text of the page element

string Text { get; }

string getText() throws IGRException;

@property

def Text(self) -> string

Document Filters Implementation Guide 2.3.3 Objects

- 891/1268 -

PAGEELEMENT::TYPE PROPERTY

Gets the type of the page element.

.NET

JAVA

PYTHON

Return Value

int : The page element type.

See Also

IGR_PAGE_FORM_ELEMENT_TYPE

Hyland.DocumentFilters.PageElementType Type { get; }

int getType() throws IGRException;

@property

def Type(self) -> int

•

Document Filters Implementation Guide 2.3.3 Objects

- 892/1268 -

RenderPageProperties

RENDERPAGEPROPERTIES INTERFACE

The RenderPageProperties interface provides additional information for rendering a page to a canvas.

This interface can be created directly.

Sample code

C/C++

RenderPageProperties::AddFormValue method AddFormValue adds a new FormKeyValue to the

RenderPageProperties

RenderPageProperties::AddRedaction method Add a redaction to the list of redactions.

RenderPageProperties::GetFirstFormValue

method

GetFirstFormValue returns the rst form value or

NULL if there are no form values.

RenderPageProperties::GetFormValue method GetFormValue returns the form value at the

specied index

RenderPageProperties::GetFormValueCount

method

GetFormValueCount returns the number of form

values stored in the RenderPageProperties.

RenderPageProperties::GetNextFormValue

method

GetNextFormValue returns the rst form value

or NULL if there are no form values.

var RenderPageProperties = new RenderPageProperties();

RenderPageProperties.AddFormValue("FormKey", "NewFormValue", true);

canvas.RenderPage(page, "", RenderPageProperties)

Document Filters Implementation Guide 2.3.3 Objects

- 893/1268 -

RENDERPAGEPROPERTIES::ADDFORMVALUE METHOD

AddFormValue adds a new FormKeyValue to the RenderPageProperties

Prototype

.NET

JAVA

PYTHON

Parameters

value: string : Value to set.

None: bool : Indicates if a checkbox or radio button is selected.

Sample Code

See Also

RenderPageProperties

void AddFormValue(string name, string value, bool None)

void AddFormValue(string name, string value, boolean None) throws IGRException;

def AddFormValue(self, name: string, value: string, None: bool) -> void

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.OpenExtractor("filename.doc", OpenMode.Paginated);

8 foreach (var page in doc.Pages)

9 {

10 using (page)

11 {

12 using var canvas = api.MakeOutputCanvas($"page-{page.Index+1}.png", CanvasType.PNG);

14 var renderPageProperties = new RenderPageProperties();

15 renderPageProperties.AddFormValue("FormKey", "NewFormValue", true);

17 canvas.RenderPage(page, "", renderPageProperties);

18 }

19 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 894/1268 -

RENDERPAGEPROPERTIES::ADDREDACTION METHOD

Add a redaction to the list of redactions.

Overloads

AddRedaction(System.Drawing.Rectangle, System.Drawing.Color)

Prototype

.NET

Parameters

rect: System.Drawing.Rectangle : The bounding rectangle of the redaction.

color: System.Drawing.Color : The color of the redaction.

AddRedaction(int, int, int, int, string)

Prototype

.NET

Parameters

left: int : The left bounds of the rectangle to redact.

top: int : The top bounds of the rectangle to redact.

right: int : The right bounds of the rectangle to redact.

bottom: int : The bottom bounds of the rectangle to redact.

color: string : The color of the redaction.

AddRedaction(System.Drawing.Rectangle,

System.Drawing.Color)

Add a redaction to the list of

redactions.

AddRedaction(int, int, int, int, string) Add a redaction to the list of

redactions.

void AddRedaction(System.Drawing.Rectangle rect, System.Drawing.Color color)

void AddRedaction(int left, int top, int right, int bottom, string color)

Document Filters Implementation Guide 2.3.3 Objects

- 895/1268 -

RENDERPAGEPROPERTIES::GETFIRSTFORMVALUE METHOD

GetFirstFormValue returns the rst form value or NULL if there are no form values.

Prototype

.NET

JAVA

PYTHON

Return value

FormKeyValue : The rst form value or NULL if there are no form values.

See Also

RenderPageProperties

FormKeyValue interface

FormKeyValue GetFirstFormValue()

FormKeyValue GetFirstFormValue() throws IGRException;

def GetFirstFormValue(self) -> FormKeyValue

•

Document Filters Implementation Guide 2.3.3 Objects

- 896/1268 -

RENDERPAGEPROPERTIES::GETFORMVALUE METHOD

GetFormValue returns the form value at the specied index

Prototype

.NET

JAVA

PYTHON

Parameters

index: int : Index of item.

Return value

FormKeyValue : The form value at the specied index or NULL if the index is out of range.

See Also

RenderPageProperties

FormKeyValue GetFormValue(int index)

FormKeyValue GetFormValue(int index) throws IGRException;

def GetFormValue(self, index: int) -> FormKeyValue

•

Document Filters Implementation Guide 2.3.3 Objects

- 897/1268 -

RENDERPAGEPROPERTIES::GETFORMVALUECOUNT METHOD

GetFormValueCount returns the number of form values stored in the RenderPageProperties.

Prototype

.NET

JAVA

PYTHON

Return value

int : The count of form values.

See Also

RenderPageProperties

int GetFormValueCount()

int GetFormValueCount() throws IGRException;

def GetFormValueCount(self) -> int

•

Document Filters Implementation Guide 2.3.3 Objects

- 898/1268 -

RENDERPAGEPROPERTIES::GETNEXTFORMVALUE METHOD

GetNextFormValue returns the rst form value or NULL if there are no form values.

Prototype

.NET

JAVA

PYTHON

Return value

FormKeyValue : The next form value or NULL if there are no more form values.

See Also

RenderPageProperties

FormKeyValue interface

FormKeyValue GetNextFormValue()

FormKeyValue GetNextFormValue() throws IGRException;

def GetNextFormValue(self) -> FormKeyValue

•

Document Filters Implementation Guide 2.3.3 Objects

- 899/1268 -

SubFile

SUBFILE INTERFACE

The SubFile interface is a descendant of Extractor, allowing work with sub-documents, extracted from a

parent document, by calling the parent’s Extractor::GetFirstSubFile and Extractor::GetNextSubFile

methods.

Open the sub-document associated with an instance of SubFile, in the same way as described for

Extractor, allowing processing of sub-documents to any depth. This means that text can be extracted

and/or sub-documents contained in this SubFile maybe enumerated.

SubFile::Comment

property

The Comment property returns any stored comment for the suble.

SubFile::FileDate

property

The FileDate property contains last-modied date and time of the sub-

document as a double-precision number (DATE).

If the date information is not available, the value is 0.

SubFile::FileSize

property

The FileSize property contains the size, in bytes, of the sub-document

as a 64-bit number (INT64).

If the size information is not available, the value is 0.

SubFile::FileTime

property

The FileTime property contains last-modied date and time of the sub-

document in the date time format supported by the language.

SubFile::Flags property Returns stored ags for the suble.

SubFile::ID property The ID property contains the unique ID of the sub-document.

SubFile::IsEncrypted

property

The IsEncrypted property indicates if the suble requires a password

to extract.

SubFile::Name property The Name property displays name of the sub-document, if available.

Document Filters Implementation Guide 2.3.3 Objects

- 900/1268 -

SUBFILE::COMMENT PROPERTY

The Comment property returns any stored comment for the suble.

.NET

JAVA

PYTHON

Return Value

string : Returns the stored comment for the suble.

string Comment { get; }

string getComment() throws IGRException;

@property

def Comment(self) -> string

Document Filters Implementation Guide 2.3.3 Objects

- 901/1268 -

SUBFILE::FILEDATE PROPERTY

The FileDate property contains last-modied date and time of the sub-document as a double-precision

number (DATE).

If the date information is not available, the value is 0.

.NET

JAVA

PYTHON

C++

COM

Return Value

IGRTime : The date of the le.

IGRTime FileDate { get; }

IGRTime getFileDate() throws IGRException;

@property

def FileDate(self) -> IGRTime

IGRTime getFileDate();

[propget] HRESULT FileDate([out, retval] IGRTime* *result);

Document Filters Implementation Guide 2.3.3 Objects

- 902/1268 -

Sample Code

Additional Information

The integral part of the FileDate value is the number of days that have passed since 12/30/1899 and the

fractional part represents the percentage of a 24-hour day that has elapsed.

See Also

SubFile Interface

FileTime

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 foreach (var subfile in doc.SubFiles)

10 {

11 using (subfile)

12 {

13 // act on subfile

14 Console.Out.WriteLine("Name: " + subFile.Name);

15 Console.Out.WriteLine("ID: " + subFile.ID);

16 Console.Out.WriteLine("Date: " + subFile.FileDate);

17 Console.Out.WriteLine("Size: " + subFile.FileSize);

18 }

19 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 903/1268 -

SUBFILE::FILESIZE PROPERTY

The FileSize property contains the size, in bytes, of the sub-document as a 64-bit number (INT64).

If the size information is not available, the value is 0.

.NET

JAVA

PYTHON

Return Value

long : The size of the le in bytes

Sample Code

See Also

SubFile Interface

long FileSize { get; }

long getFileSize() throws IGRException;

@property

def FileSize(self) -> long

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 foreach (var subfile in doc.SubFiles)

10 {

11 using (subfile)

12 {

13 // act on subfile

14 Console.Out.WriteLine("Name: " + subFile.Name);

15 Console.Out.WriteLine("ID: " + subFile.ID);

16 Console.Out.WriteLine("Date: " + subFile.FileDate);

17 Console.Out.WriteLine("Size: " + subFile.FileSize);

18 }

19 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 904/1268 -

SUBFILE::FILETIME PROPERTY

The FileTime property contains last-modied date and time of the sub-document in the date time format

supported by the language.

.NET

JAVA

PYTHON

Return Value

datetime : The last modied date of the le.

Sample Code

See Also

FileDate

System.DateTime FileTime { get; }

java.util.Date getFileTime() throws IGRException;

@property

def FileTime(self) -> datetime

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 foreach (var subfile in doc.SubFiles)

10 {

11 using (subfile)

12 {

13 // act on subfile

14 Console.Out.WriteLine("Name: " + subFile.Name);

15 Console.Out.WriteLine("ID: " + subFile.ID);

16 Console.Out.WriteLine("Date: " + subFile.FileDate);

17 Console.Out.WriteLine("Size: " + subFile.FileSize);

18 }

19 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 905/1268 -

SUBFILE::FLAGS PROPERTY

Returns stored ags for the suble.

.NET

JAVA

PYTHON

Return Value

int : The ags for the sub le. See IGR_SUBFILE_INFO_FLAG_TYPE for details.

See Also

IGR_SUBFILE_INFO_FLAG_TYPE

int Flags { get; }

int getFlags() throws IGRException;

@property

def Flags(self) -> int

•

Document Filters Implementation Guide 2.3.3 Objects

- 906/1268 -

SUBFILE::ID PROPERTY

The ID property contains the unique ID of the sub-document.

.NET

JAVA

PYTHON

C++

COM

Return Value

string : The id of the suble.

Sample Code

string ID { get; }

string getID() throws IGRException;

@property

def ID(self) -> string

std::wstring getID();

[propget] HRESULT ID([out, retval] BSTR *result);

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 foreach (var subfile in doc.SubFiles)

10 {

11 using (subfile)

12 {

13 // act on subfile

14 Console.Out.WriteLine("Name: " + subFile.Name);

15 Console.Out.WriteLine("ID: " + subFile.ID);

16 Console.Out.WriteLine("Date: " + subFile.FileDate);

17 Console.Out.WriteLine("Size: " + subFile.FileSize);

18 }

19 }

Document Filters Implementation Guide 2.3.3 Objects

- 907/1268 -

See Also

SubFile Interface•

Document Filters Implementation Guide 2.3.3 Objects

- 908/1268 -

SUBFILE::ISENCRYPTED PROPERTY

The IsEncrypted property indicates if the suble requires a password to extract.

.NET

JAVA

PYTHON

Return Value

bool : Returns if a password is required to extract the le.

bool IsEncrypted { get; }

boolean getIsEncrypted() throws IGRException;

@property

def IsEncrypted(self) -> bool

Document Filters Implementation Guide 2.3.3 Objects

- 909/1268 -

SUBFILE::NAME PROPERTY

The Name property displays name of the sub-document, if available.

.NET

JAVA

PYTHON

C++

COM

Return Value

string : The name of the suble.

Sample Code

string Name { get; }

string getName() throws IGRException;

@property

def Name(self) -> string

std::wstring getName();

[propget] HRESULT Name([out, retval] BSTR *result);

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

9 foreach (var subfile in doc.SubFiles)

10 {

11 using (subfile)

12 {

13 // act on subfile

14 Console.Out.WriteLine("Name: " + subFile.Name);

15 Console.Out.WriteLine("ID: " + subFile.ID);

16 Console.Out.WriteLine("Date: " + subFile.FileDate);

17 Console.Out.WriteLine("Size: " + subFile.FileSize);

18 }

19 }

Document Filters Implementation Guide 2.3.3 Objects

- 910/1268 -

See Also

SubFile Interface•

Document Filters Implementation Guide 2.3.3 Objects

- 911/1268 -

Word

WORD INTERFACE

The Word interface allows extraction of words and their bounding boxes when in paginated image mode.

To obtain this interface, call the Page.GetFirstWord, Page.GetNextWord methods, or Page.Words property.

Word::CharacterOset

property

The CharacterOset property contains the character oset of the

word into the text on the current page.

Word::Text property The Text property returns a Unicode string for the text of this word.

Word::Width property The Width property return the dimensions of the word in pixels. The

dimension information is based on the DPI used when loading the

page.

Word::Height property The Height property return the dimensions of the word in pixels. The

dimension information is based on the DPI used when loading the

page.

Word::WordIndex

property

Return the index of the word on the current page.

Word::X property The X property return the position of the word in pixels. The position

information is based on the DPI used when loading the page.

Word::Y property The Y property return the position of the word in pixels. The position

information is based on the DPI used when loading the page.

Document Filters Implementation Guide 2.3.3 Objects

- 912/1268 -

WORD::CHARACTEROFFSET PROPERTY

The CharacterOset property contains the character oset of the word into the text on the current page.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : The oset into the text of the current page.

int CharacterOffset { get; }

int getCharacterOffset() throws IGRException;

@property

def CharacterOffset(self) -> int

int getCharacterOffset();

[propget] HRESULT CharacterOffset([out, retval] int *result);

Document Filters Implementation Guide 2.3.3 Objects

- 913/1268 -

Sample Code

Additional Information

The value returned is the oset into the current page. To calculate the oset into the document, the size

of the text of the previous pages must be accumulated.

See Also

Word interface

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.Paginated);

9 foreach (var page in doc.Pages)

10 {

11 using (page)

12 {

13 // Iterate over all words on the page

14 for (Word word = page.GetFirstWord(); word != null; word = word.GetNextWord())

15 {

16 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

17 }

19 // Alternatively, use the iterator

20 foreach (Word word in page.Words)

21 {

22 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

23 }

25 }

26 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 914/1268 -

WORD::TEXT PROPERTY

The Text property returns a Unicode string for the text of this word.

.NET

JAVA

PYTHON

C++

COM

Return Value

string : Unicode string containing the text of the word.

string Text { get; }

string getText() throws IGRException;

@property

def Text(self) -> string

std::wstring getText();

[propget] HRESULT Text([out, retval] BSTR *result);

Document Filters Implementation Guide 2.3.3 Objects

- 915/1268 -

Sample Code

See Also

Word interface

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.Paginated);

9 foreach (var page in doc.Pages)

10 {

11 using (page)

12 {

13 // Iterate over all words on the page

14 for (Word word = page.GetFirstWord(); word != null; word = word.GetNextWord())

15 {

16 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

17 }

19 // Alternatively, use the iterator

20 foreach (Word word in page.Words)

21 {

22 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

23 }

25 }

26 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 916/1268 -

WORD::WIDTH PROPERTY

The Width property return the dimensions of the word in pixels. The dimension information is based on

the DPI used when loading the page.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : Integer containing the dimension of the word in pixels.

int Width { get; }

int getWidth() throws IGRException;

@property

def Width(self) -> int

int getWidth();

[propget] HRESULT Width([out, retval] int *result);

Document Filters Implementation Guide 2.3.3 Objects

- 917/1268 -

Sample Code

See Also

Word interface

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.Paginated);

9 foreach (var page in doc.Pages)

10 {

11 using (page)

12 {

13 // Iterate over all words on the page

14 for (Word word = page.GetFirstWord(); word != null; word = word.GetNextWord())

15 {

16 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

17 }

19 // Alternatively, use the iterator

20 foreach (Word word in page.Words)

21 {

22 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

23 }

25 }

26 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 918/1268 -

WORD::HEIGHT PROPERTY

The Height property return the dimensions of the word in pixels. The dimension information is based on

the DPI used when loading the page.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : Integer containing the dimension of the word in pixels.

int Height { get; }

int getHeight() throws IGRException;

@property

def Height(self) -> int

int getHeight();

[propget] HRESULT Height([out, retval] int *result);

Document Filters Implementation Guide 2.3.3 Objects

- 919/1268 -

Sample Code

See Also

Word interface

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.Paginated);

9 foreach (var page in doc.Pages)

10 {

11 using (page)

12 {

13 // Iterate over all words on the page

14 for (Word word = page.GetFirstWord(); word != null; word = word.GetNextWord())

15 {

16 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

17 }

19 // Alternatively, use the iterator

20 foreach (Word word in page.Words)

21 {

22 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

23 }

25 }

26 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 920/1268 -

WORD::WORDINDEX PROPERTY

Return the index of the word on the current page.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : The index of the word on the current page.

See Also

Word interface

int WordIndex { get; }

int getWordIndex() throws IGRException;

@property

def WordIndex(self) -> int

int getWordIndex();

[propget] HRESULT WordIndex([out, retval] int *result);

•

Document Filters Implementation Guide 2.3.3 Objects

- 921/1268 -

WORD::X PROPERTY

The X property return the position of the word in pixels. The position information is based on the DPI

used when loading the page.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : Integer containing the coordinate of the word in pixels.

int X { get; }

int getX() throws IGRException;

@property

def X(self) -> int

int getX();

[propget] HRESULT X([out, retval] int *result);

Document Filters Implementation Guide 2.3.3 Objects

- 922/1268 -

Sample Code

See Also

Word interface

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.Paginated);

9 foreach (var page in doc.Pages)

10 {

11 using (page)

12 {

13 // Iterate over all words on the page

14 for (Word word = page.GetFirstWord(); word != null; word = word.GetNextWord())

15 {

16 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

17 }

19 // Alternatively, use the iterator

20 foreach (Word word in page.Words)

21 {

22 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

23 }

25 }

26 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 923/1268 -

WORD::Y PROPERTY

The Y property return the position of the word in pixels. The position information is based on the DPI

used when loading the page.

.NET

JAVA

PYTHON

C++

COM

Return Value

int : Integer containing the coordinate of the word in pixels.

int T { get; }

int getT() throws IGRException;

@property

def T(self) -> int

int getT();

[propget] HRESULT T([out, retval] int *result);

Document Filters Implementation Guide 2.3.3 Objects

- 924/1268 -

Sample Code

See Also

Word interface

1 using Hyland.DocumentFilters;

3 var api = new Hyland.DocumentFilters.Api();

4 api.Initialize("License Code", ".");

6 using var doc = api.GetExtractor("filename.doc");

7 doc.Open(Hyland.DocumentFilters.OpenType.Paginated);

9 foreach (var page in doc.Pages)

10 {

11 using (page)

12 {

13 // Iterate over all words on the page

14 for (Word word = page.GetFirstWord(); word != null; word = word.GetNextWord())

15 {

16 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

17 }

19 // Alternatively, use the iterator

20 foreach (Word word in page.Words)

21 {

22 Console.Out.WriteLine($"[{word.X}, {word.Y} @ {word.CharacterOffset}]: {word.Text}");

23 }

25 }

26 }

•

Document Filters Implementation Guide 2.3.3 Objects

- 925/1268 -

2.4 Structured XML

2.4.1 Overview

Structured XML is a hierarchical Document Object Model (DOM) that represents the paginated view of a

document. Most nodes have two distinct sections:

Where: Pixel Coordinates relative to the Page.

Why: Style Information used to calculate the coordinates.

Pixel coordinates are stored in a node with the attributes left, top, width, and height. All coordinates

are stored relative to the page.

Style information is stored in a single style attribute. Its content is a semicolon (;) delimited list of name:

value pairs. A style value can be one of the following data types:

•

Type Description

String Value is output “as is”, no encoding required.

Number Value is output “as is”, no encoding required.

Boolean 0 = false, 1 = true.

Rectangle Rect(left, top, right, bottom)

Margins Rect(left, top, right, bottom)

Borders (Style Width Color)

Color HTML format (#RRGGBB)

Document Filters Implementation Guide 2.4 Structured XML

- 926/1268 -

2.4.2 <doc> element

The <doc> node is the root-most element of Structured XML. There can only be one <doc> node per

document. It does not contain any attributes.

Attributes

None

Styles

None

Children

Example

Node Description

<head> Contains the metadata about the document; a <doc> can contain only one

<head> element.

<page> Contains the data for a page; a <doc> can contain multiple <page>

elements.

<?xmlversion="1.0"encoding="UTF-8"standalone="yes"?>

<doc>

<head>

</head>

...

</page>

</doc>

Document Filters Implementation Guide 2.4.2 <doc> element

- 927/1268 -

2.4.3 <head> element

The <head> node contains information about the document as a whole, such as metadata.

Attributes

None

Styles

None

Children

Example

Node Description

document.

<?xmlversion="1.0"encoding="UTF-8"standalone="yes"?>

<doc>

<head>

</head>

...

</page>

</doc>

Document Filters Implementation Guide 2.4.3 <head> element

- 928/1268 -

2.4.4 <meta> element

The <meta> node contains a single name/value pair of metadata from the source document. The node

does not have child elements.

Attributes

Styles

None

Children

None

Example

Attribute Description

name The name of the metadata eld, for example: Title, Author or Page Count.

value The value of the metadata eld.

<?xmlversion="1.0"encoding="UTF-8"standalone="yes"?>

<doc>

<head>

</head>

...

</page>

</doc>

Document Filters Implementation Guide 2.4.4 <meta> element

- 929/1268 -

2.4.5 <page> element

The <page> node represents a single page in the source document containing all the elements required

to render that page.

Attributes

Styles

Attribute Description

left The left oset in pixels in pixels. This is typically 0.

top The top oset in pixels in pixels. This is typically 0.

width The width of the page in pixels.

height The height of the page in pixels.

styles Contains a semicolon delimited list of name:value pair style information

values.

Style Description

pagewidth The width of the page in pixels.

pageheight The height of the page in pixels.

headerFromTop Indicates the space, in points, that the header is placed from

the top of the page.

footerFromBottom Indicates the space, in points, that the footer is placed from

the bottom of the page.

headerToBodySpacing Indicates the space, in points, that content is placed from the

bottom of the header.

footerFromBottomSpacing Indicates the space, in points, that the content is placed from

the top of the footer.

endSectionBreakType Indicates the type of break to use at the end of the current

section, can be one of the following:0 Continuous1

NewColumn2 NewPage3 EvenPage4 OddPage

Document Filters Implementation Guide 2.4.5 <page> element

- 930/1268 -

Style Description

pageNumFormat Indicates the format that elded page numbers use, can be

one of the following:0 decimal1 upperRoman2 lowerRoman3

upperLetter4 lowerLetter5 ordinal6 cardinalText7 ordinalText8

hex

pageNumStart Indicates the rst number to use when numbering pages.

pagemargins Species the top,left,right,bottom margin for the page in

points.

areColumnsEvenlySpaced Indicates that columns should be evenly sized.

pageNumOset Indicates the rst page number for the section.

clipPage Indicates that content outside of the page margins should be

clipped.

clipRect Indicates the top,left,right,bottom clipping rectangle for the

page in points.

borderLeft Indicates the border style, width and color for the left side of

the page.

borderRight Indicates the border style, width and color for the right side of

the page.

borderTop Indicates the border style, width and color for the top side of

the page.

borderBottom Indicates the border style, width and color for the bottom side

of the page.

borderOsetText Indicates if the left and right position of the text should be

incremented by the width of the borders.

sourceDpiX Indicates the horizontal DPI from the source document, when

present. Value is normally set for TIFF les.

sourceDpiY Indicates the vertical DPI from the source document, when

present. Value is normally set for TIFF les.

sourceOrientation Indicates the page orientation from the source document,

value is normally set for TIFF les, can be one of: TopLeft,

Document Filters Implementation Guide 2.4.5 <page> element

- 931/1268 -

Children

Example

Style Description

TopRight, BottomLeft, BottomRight, LeftTop, RightTop,

RightBottom, LeftBottom.

outputDpiX Indicates the output DPI used to create the generated output.

outputDpiY Indicates the output DPI used to create the generated output.

outputOrientation Indicates the page orientation used to create the generated

output.

Node Description

<header> A page can have zero or one <header> .

<footer> A page can have zero or one <footer> .

<section> A page can have zero or more <section> s.

<float> A page can have zero or more <float> ing objects.

<?xmlversion="1.0"encoding="UTF-8"standalone="yes"?>

<doc>

<head>

</head>

...

</page>

</doc>

Document Filters Implementation Guide 2.4.5 <page> element

- 932/1268 -

2.4.6 <header>/<footer> elements

The <header> element represents the header section of a page, generated from the header/footer

section of a source document. There can be one <header> and one <footer> per page.

Attributes

Styles

Children

Attribute Description

left The left oset of the header in pixels.

top The top oset of the header in pixels.

width The width of the header in pixels.

height The height of the header in pixels.

styles Contains a semicolon delimited list of name:value pair style information

values.

Style Description

sectionType Indicates the type of header/footer that was used to generate the content;

can be one of the following:0 Even1 Odd2 First

header Indicates if the node is a header or footer; this can also be achieved by

looking at the node name.

Node Description

<p>

<float>

<table>

Document Filters Implementation Guide 2.4.6 <header>/<footer> elements

- 933/1268 -

Example

...

</p>

</header>

</page>

Document Filters Implementation Guide 2.4.6 <header>/<footer> elements

- 934/1268 -

2.4.7 <section> element

The <section> element contains a logical grouping of text. A page can have multiple sections

depending on the source document type.

Attributes

Styles

Same as <page> element; see page .

Children

Example

Attribute Description

styles Contains a semicolon delimited list of name:value pair style information

values.

Node Description

<column> A section can have zero or more <column> elements.

...

</line>

</p>

</header>

<section styles="pagewidth:816;pageheight:1056;headerFromTop:48;footerFromBottom:9.33333;

headerToBodySpacing:0;footerFromBodySpacing:0;endSectionBreakType:0;pageNumFormat:decimal;pageNumChapterSeparator:45;">

...

</p>

</column>

</section>

</page>

Document Filters Implementation Guide 2.4.7 <section> element

- 935/1268 -

2.4.8 <column> element

The <column> element contains the data for a single column within a section. There can be one or more

columns per section.

Attributes

Styles

Children

Attribute Description

width The width of the column in pixels.

height The height of the column in pixels.

left The left oset of the column in pixels.

top The top oset of the column in pixels.

styles Contains a semicolon delimited list of name:value pair style information

values.

Style Description

iCol Index of the column when multiple columns exist within the section.

width Width to use for the column, -255 indicates that it is autosized.

space Spacing to use between columns, -255 indicates default space.

drawSeparator Indicates whether a vertical line should be drawn between columns.

Node Description

<p> A column can contain zero or more <p> elements.

<oat> A column can contain zero or more <oat> elements.

Document Filters Implementation Guide 2.4.8 <column> element

- 936/1268 -

Example

...

</line>

</p>

</header>

</p>

</column>

</section>

</page>

Document Filters Implementation Guide 2.4.8 <column> element

- 937/1268 -

2.4.9 <p> element

The <p> element contains the data for a single paragraph of text. There can be zero or more

paragraphs per section.

Attributes

Styles

Attribute Description

width The width of the paragraph in pixels.

height The height of the paragraph in pixels.

left The left oset of the paragraph in pixels.

top The top oset of the paragraph in pixels.

styles Contains a semicolon delimited list of name:value pair style information

values.

Style Description

numberingId Populated by MS Word for calculating leveled numbered lists.

numberingLevel Populated by MS Word for calculating leveled numbered lists.

alignment Text alignment, can be one of the following:- Left- Center- Right-

Both- Distributed- Medium Kashida- Numbered Tab- High

Kashida- Low Kashida- Thai Distributed

indenthanging Contains the hanging indent value in points.

indentrstline Contains the rst line indent value in points.

indentleft Contains the left indent value in points.

indentright Contains the right indent value in points.

spacebefore Contains the space to use before the paragraph in points.

spaceafter Contains the space to use after the paragraph in points.

Document Filters Implementation Guide 2.4.9 <p> element

- 938/1268 -

Style Description

linespacing Contains the line spacing to use for the paragraph expressed as

a multiplier.

marginleft Contains the left margin in points.

hyperlinked Indicates if the paragraph is a hyperlink.

defaultFontSize The default font style to use, in points, when a run does not

contain a font height.

backgroundColor The background color that should be shaded behind the

paragraph text.

borderLeft Contains details (width, color, style) for the left border.

borderRight Contains details (width, color, style) for the right border.

borderTop Contains details (width, color, style) for the top border.

borderBottom Contains details (width, color, style) for the bottom border.

borderInternalVert Contains details (width, color, style) for the internal vertical

borders.

borderInternalHorz Contains details (width, color, style) for the internal horizontal

borders.

tabProps Contains the tab stops to use for this paragraph.

hasBarTabs Indicates that the paragraph uses bar tabs.

keepLinesTogether Indicates the paragraph has the “Keep Lines Together” feature

enabled.

keepWithNextParagraph Indicates the paragraph has the “Keep With Next Paragraph”

feature enabled.

minWidowOrphanLines Indicates the minimum number of lines to leave on a page when

splitting paragraphs.

keepOnPage Indicates that the paragraph must not be moved to a new page.

pageBreakBefore Indicates that a page break should occur before the paragraph.

styleType

Document Filters Implementation Guide 2.4.9 <p> element

- 939/1268 -

Children

Style Description

Indicates the type of paragraph, can be one of the following:-

Normal- Heading 1- Heading 2- Heading 3- Heading 4- Heading

5- Heading 6- Heading 7- Heading 8- Heading 9- Caption- Title-

Sub Title- Strong

lineheight Indicates the minimum height that each line must take.

lineheightSize Indicates how the lineheight is to be applied, can be one of the

following:- AtLeast- Exact- None

styleId Style id as a string.

nowrap Indicates that the paragraph should not wrap the text to new

lines.

spacebeforeAuto Indicates that auto calculation of space before is enabled.

spaceafterAuto Indicates that auto calculation of space after is enabled.

contextualSpacing Indicates that contextual spacing is to be used, paragraphs that

have the same style will merge the spaceBefore and spaceAfter

values.

bulleted Indicates the paragraph is part of a bulleted list.

placeholder Indicates the type of placeholder, can be one of the following: 0

SlideNumber 1 Footer 2 Date

Node Description

<line> A paragraph can contain zero or more <line> elements.

<table> A paragraph can contain zero or one <table> element.

Document Filters Implementation Guide 2.4.9 <p> element

- 940/1268 -

2.4.10 <line> element

The <line> element contains the content for a single line of text in the paginated output. The <line>

may dier from what the source document denes as a line.

Attributes

Styles

None

Children

Attribute Description

width The width of the line in pixels.

height The height of the line in pixels.

left The left oset of the line in pixels.

top The top oset of the line in pixels.

Node Description

<run> A line can contain zero or more <run> elements.

<g> A line can contain zero or more <g> elements.

Document Filters Implementation Guide 2.4.10 <line> element

- 941/1268 -

2.4.11 <run> element

The <run> element groups words that are sequential and have the same style. Styles stored at the

<run> level should be applied to the words contained within.

Attributes

Styles

Attribute Description

width The width of the run in pixels.

height The height of the run in pixels.

left The left oset of the run in pixels.

top The top oset of the run in pixels.

styles Contains a semicolon delimited list of name:value pair style information

values.

Attribute Description

fontColor Contains the color to use for the run, in HTML format.

fontSize Contains the size of the font in points.

fontName Contains the font name to use for this run.

highlightColor Contains the background highlight color to use, if any, in HTML

format.

underlineColor Contains the underline color to use in HTML format.

bold Indicates the text should be rendered as bold.

italics Indicates the text should be rendered as italics.

underline Indicates the text should be rendered underlined.

strikeout Indicates the text should be rendered striked out.

allCaps Indicates the text should be rendered in all-capitals.

Document Filters Implementation Guide 2.4.11 <run> element

- 942/1268 -

Children

Attribute Description

smallCaps Indicates the text should be rendered in small-capitals.

markDel Indicates the text is marked for deletion (track-changes).

Vanish Indicates the text is marked as hidden.

superscript Indicates the text should be rendered in superscript.

subscript Indicates the text should be rendered in subscript.

scriptSizeScaler Indicates the scaler to use for either super of subscript.

charScaling Contains a character scaling multiplier.

charSpacing Contains a character spacing scaling multiplier.

charVertOsetPos Contains a vertical oset to be applied to word position.

charKerning Indicates a kerning value.

hyperlink Contains a hyperlink that should be applied to the words.

dynamicField Indicates that the content of the run should be replaced with a

dynamic eld value, can be one of the following:- None-

PageNumber- NumberOfPages- SectionNumber-

SectionNumberOfPages

dynamicFieldFormat Indicates the format to use when replacing with a dynamic eld, can

be one of the following:- decimal- upperRoman- lowerRoman-

upperLetter- lowerLetter- ordinal- cardinalText- ordinalText- hex

fontType Indicates the base font type, used when looking for font

substitutions, can be one of the following:- Unknown- TypeSans-

TypeSerif- TypeMono

direction Indicates the direction of the text, can be one of the following:- LTR-

RTF

Node Description

<word> A run can contain zero or more <word> elements.

Document Filters Implementation Guide 2.4.11 <run> element

- 943/1268 -

Example

Node Description

<g> A run can contain zero or more <g> elements.

<run styles="fontColor:#01ffff;fontSize:10;fontName:HelveticaNeueLTPro55Roman;bold:0;italics:0;underline:0;strikeout:0;allCaps:0;smallCaps:0;markDel:0;vanish:0;superScript:0;subScript:0;scriptSizeScaler:0.6;charScaling:100;charSpacing:0;charVertOffsetPos:0;charKerning:-12.75;hyperlink:href:#6.1.2.OpenDocumentFlags|

outline;bInternal:0;;">

<word left="505" top="565" width="62" height="16">Document</word>

<word left="569" top="565" width="33" height="16">Flags</word>

</run>

Document Filters Implementation Guide 2.4.11 <run> element

- 944/1268 -

2.4.12 <word> element

The <word> element represents a single word on the page. A <word> contains the pixel coordinate on

the page. Style information for the word is stored on its parent <run> .

Attributes

Styles

None

Children

None

Attribute Description

left The left oset of the word in pixels.

top The top oset of the word in pixels.

width The width of the word in pixels.

height The height of the word in pixels.

Document Filters Implementation Guide 2.4.12 <word> element

- 945/1268 -

2.4.13 <float> element

A <float> element represents an object that exists outside of the normal ow of paragraphs and text,

that are typically elements that text ows around, or are rendered above or below the text.

Attributes

Styles

Attribute Description

left The left oset of the oat in pixels.

top The top oset of the oat in pixels.

width The width of the oat in pixels.

height The height of the oat in pixels.

Style Description

width Indicates the original width of the image, in points.

height Indicates the original height of the image, in points.

left Indicates the original position of the image, in points.

top Indicates the original position of the image, in points.

distList Indicates the distance from the text, in points.

distTop Indicates the distance from the text, in points.

distRight Indicates the distance from the text, in points.

distBottom Indicates the distance from the text, in points.

degRotated Indicates any rotation that is to be applied, in degrees.

wrapType Indicates how text should wrap around the object, can be one of the

following:- Inline- Square- Tight- Through- TopAndBottom- Behind-

Infront

wrapSubType

Document Filters Implementation Guide 2.4.13 <oat> element

- 946/1268 -

Children

Style Description

Indicates extra wrapping information when wrapType = tight, can be

one of the following:- BothSides- LeftSide- RightSide- LargestSize-

TopAndBottom

anchorLeft Indicates the section that the left coordinate is anchored to, can be

one of the following:- ColumnPara- Margin- Page- InsideMargin-

OutsideMargin

anchorTop Indicates the section that the top coordinate is anchored to, can be

one of the following:- ColumnPara- Margin- Page- InsideMargin-

OutsideMargin

borderLeft Contains details (width, color, style) for the left border.

borderRight Contains details (width, color, style) for the right border.

borderTop Contains details (width, color, style) for the top border.

borderBottom Contains details (width, color, style) for the bottom border.

zIndex Contains the z-index for the element.

alignHorz Contains the alignment for the horizontal axis, can be one of the

following:- Left- Middle- Right

alignVert Contains the alignment for the vertical axis, can be one of the

following:- Top- Middle- Bottom

autoWidth Indicates the element should be auto-sized based on its content.

borderInternalVert Contains details (width, color, style) for the internal vertical borders.

borderInternalHorz Contains details (width, color, style) for the internal horizontal

borders.

horizontalRule Contains details for the horizontal rule.

Node Description

<img> A oat can have zero or more <img> elements.

Document Filters Implementation Guide 2.4.13 <oat> element

- 947/1268 -

Node Description

<p> A oat can have zero or more <p> elements.

Document Filters Implementation Guide 2.4.13 <oat> element

- 948/1268 -

2.4.14 <img> element

An <img> element contains encoded image data that is rendered on the page. The body of the node is

base-64 encoded binary data of the image.

Attributes

Styles

None

Children

None

Attribute Description

left The left oset of the header in pixels.

top The top oset of the header in pixels.

width The width of the header in pixels.

height The height of the header in pixels.

mimetype The encoding of the base-64 encoded image, image/png for example.

Document Filters Implementation Guide 2.4.14 <img> element

- 949/1268 -

2.4.15 <table> element

The <table> element represents a table on the page. Each table can have one or more rows.

Attributes

Styles

Children

Attribute Description

left The left oset of the header in pixels.

top The top oset of the header in pixels.

width The width of the header in pixels.

height The height of the header in pixels.

styles Contains a semicolon delimited list of name:value pair style information

values.

Node Description

width Indicates the width of the table, the unit of measure is dened by

widthType.

widthType Indicates the how width is applied, can be one of the following:- Auto-

Percentage- Point

indent Indicates the indentation of the table, in points.

repeatHeader Contains how may rows should be repeated when a table is split.

cellSpacing Contains the cell spacing, in points.

rightToLeft Indicates that the table is right to left.

type Indicates the type of table, can be one of the follow:- Normal (word

processing style) - text will wrap in cells.- Spreadsheet – text does not

wrap, it will span over empty cells.

Document Filters Implementation Guide 2.4.15 <table> element

- 950/1268 -

Node Description

<tr> A table can contain one or more Table Row <tr> elements.

Document Filters Implementation Guide 2.4.15 <table> element

- 951/1268 -

2.4.16 <tr> element

The <tr> element represents a row of a table. Each table can have one or more rows, and each <row>

can have one or more cells.

Attributes

Styles

Attribute Description

left The left oset of the header in pixels.

top The top oset of the header in pixels.

width The width of the header in pixels.

height The height of the header in pixels.

styles Contains a semicolon delimited list of name:value pair style information

values.

Node Description

height Contains the height of the cell, unit of measure is stored in

heightRule.

heightRule Contains the rule to use when applying height, can be one of the

following:- AtLeast- Exact- None

percentScale Contains the percentage of width to take, expresses as an integer.

percentWidth Contains the percentage of width to take, expresses as a double.

xedWidth If present, indicates that the cell should be this width in pixels.

widthType Indicates the how width is applied, can be one of the following:- Auto-

Percentage- Point

borderLeft Contains details (width, color, style) for the left border.

borderRight Contains details (width, color, style) for the right border.

Document Filters Implementation Guide 2.4.16 <tr> element

- 952/1268 -

Children

Node Description

borderTop Contains details (width, color, style) for the top border.

borderBottom Contains details (width, color, style) for the bottom border.

allowSplit Indicates whether the row scan be split across pages.

keepWithNext Indicates that the rows are to be kept together.

borderInternalVert Contains details (width, color, style) for the internal vertical borders.

borderInternalHorz Contains details (width, color, style) for the internal horizontal

borders.

Node Description

<td> A row can contain one or more Table Cell <td> elements.

Document Filters Implementation Guide 2.4.16 <tr> element

- 953/1268 -

2.4.17 <td> element

The <td> element represents a cell of a table. Each row can have one or more cells.

Attributes

Styles

Attribute Description

left The left oset of the header in pixels.

top The top oset of the header in pixels.

width The width of the header in pixels.

height The height of the header in pixels.

styles Contains a semicolon delimited list of name:value pair style information

values.

Node Description

verticalAlignment Contains the vertical alignment to apply to text within the cell, can be

one of the following:- Top- Center- Bottom

width Contains the width of the cell, unit of measure is stored in widthType.

widthType Indicates the how width is applied, can be one of the following:- Auto-

Percentage- Point

colSpan Contains how many cells this cell should span across.

rowSpan Contains how may rows this cell should span across.

backgroundColor Contains the background color for the cell, in HTML format.

borderLeft Contains details (width, color, style) for the left border.

borderRight Contains details (width, color, style) for the right border.

borderTop Contains details (width, color, style) for the top border.

borderBottom Contains details (width, color, style) for the bottom border.

Document Filters Implementation Guide 2.4.17 <td> element

- 954/1268 -

Children

Node Description

wrap Indicates where word wrap is supported on the cell.

margins Contains the margins, in points, for the cell.

borderInternalVert Contains details (width, color, style) for the internal vertical borders.

borderInternalHorz Contains details (width, color, style) for the internal horizontal

borders.

Node Description

<p> A cell can contain zero or more <p> elements.

Document Filters Implementation Guide 2.4.17 <td> element

- 955/1268 -

3. Tech Info

3.1 Supported platforms

Document Filters supports the following platforms:

AIX POWER-64

FreeBSD 10+ Intel-32

FreeBSD 10+ Intel-64

Linux ARM v7-32

Linux ARM v8-64 (AArch64)

Linux ARM v8-64 (Alpine)

Linux Intel-32

Linux Intel-64

Linux Intel-64 (Alpine)

Linux PPC32BE

Linux PPC64BE

Linux PPC64LE

MacOS M1 (ARM64)

MacOS X Intel-32

MacOS X Intel-64

Solaris Sparc 32

Solaris Sparc 64

Windows Intel-32

Windows Intel-64

For a detailed list of all supported platforms, Platform Requirement lists the required and optional

parameters.

•

Document Filters Implementation Guide 3. Tech Info

- 956/1268 -

3.2 Platform Requirements

3.2.1 Windows

Document Filters has been certied for the following:

Operating Systems

Windows 7 (x32, x64)

Windows 8 (x32, x64)

Windows 10 (x86, x64)

Windows 11 (x86, x64)

Windows Server 2008 (x32, x64)

Windows Server 2012 (x32, x64)

Windows Server 2019 (x32, x64)

Windows Server 2022 (x32, x64)

C++

The samples included with the Document Filters were built using Visual Studio 2019, but are compatible

with any edition of Visual Studio.

Java

The samples included with the Document Filters were built using Java SDK 6 Update 12, however are

compatible with Java 1.4.2 and above.

.NET (C# and VB.net)

The samples included with the Document Filters were built using Visual Studio 2019, but are compatible

with any edition and .NET Framework 2.0 and above and .NET core 2.0 and above.

Python

The Document Filters Python Module supports Python versions 2.6, 2.7, 3.3 and 3.7+. Python must be

built with the ctypes module enabled.

3.2.2 Linux

Document Filters has been certied for the following:

•

Document Filters Implementation Guide 3.2 Platform Requirements

- 957/1268 -

Operating Systems

Debian-based (Debian 10+, Ubuntu 16+) (x32, x64)

RedHat-based (RHEL 7+, CentOS 7+, Fedora 12+) (x32, x64, PPC32BE, PPC64BE, PPC64LE)

SUSE-based (SUSE LE 12+, openSUSE 12+) (x32, x64, PPC64LE)

Dependencies (all ship with system + GCC)

Sample support

C++ samples may be compiled with GCC 4.8.5 or higher.

Java samples may be compiled with Sun / Open JDK 1.8 or higher.

Python

The Document Filters Python Module supports Python versions 2.6, 2.7, 3.3 and 3.7+. Python must be

built with the ctypes module enabled.

3.2.3 Alpine Linux

Document Filters has been certied for the following:

Operating Systems

Alpine Linux 3.10 (AMD64, AARCH64)

Alpine Linux 3.11 (AMD64, AARCH64)

Alpine Linux 3.12 (AMD64, AARCH64)

Alpine Linux 3.13 (AMD64, AARCH64)

Alpine Linux 3.14 (AMD64, AARCH64)

•

Module Default Path

libdl.so.2 /lib/libdl.so.2

libpthread.so.0 /lib/libpthread.so.0

libstdc++.so.6 /usr/lib/libstdc++.so.6

libm.so.6 /lib/libm.so.6

libgcc_s.so.1 /lib/libgcc_s.so.1

libc.so.6 /lib/libc.so.6

•

Document Filters Implementation Guide 3.2.3 Alpine Linux

- 958/1268 -

Alpine Linux 3.15 (AMD64, AARCH64)

Alpine Linux 3.16 (AMD64, AARCH64)

Alpine Linux 3.17 (AMD64, AARCH64)

Alpine Linux 3.18 (AMD64, AARCH64)

Dependencies (all ship with system + GCC + libstdc++)

Sample support

C++ samples may be compiled with GCC Alpine 8.3.0 or higher.

Java samples may be compiled with Sun / Open JDK 1.4 or higher.

Python

The Document Filters Python Module supports Python 3.7+. Python must be built with the ctypes module

enabled.

3.2.4 FreeBSD

Document Filters has been certied for the following:

Operating Systems

FreeBSD 13.x (x32, x64)

FreeBSD 14.x (x32, x64)

Dependencies (all ship with system + GCC)

•

Module Default Path

libstdc++.so.6 /usr/lib/libstdc++.so.6

libgcc_s.so.1 /lib/libgcc_s.so.1

ld-musl-x86-64.so /lib/ld-musl-x86-64.so (AMD64 only)

libc.musl-x86_64.so.1 /lib/ld-musl-x86_64.so.1 (AMD64 only)

ld-musl-aarch64.so /lib/ld-musl-aarch64.so (AARCH64 only)

libc.musl-aarch64.so.1 /lib/ld-musl-aarch64.so.1 (AARCH64 only)

•

Document Filters Implementation Guide 3.2.4 FreeBSD

- 959/1268 -

Sample support

C++ samples may be compiled with GCC 4.1 or higher.

Java samples may be compiled with Sun / Open JDK 1.4 or higher.

Python

The Document Filters Python Module supports Python versions 2.6, 2.7, 3.3 and 3.7+. Python must be

built with the ctypes module enabled.

3.2.5 Solaris

Document Filters has been certied for the following:

Operating Systems

Solaris 10 (SPARC32, SPARC64)

Solaris 11 (SPARC32, SPARC64)

Dependencies (all ship with system, no external or 3rd party)

Module Default Path

libdl.so.2 /lib/libdl.so.2

libpthread.so.0 /lib/libpthread.so.0

libstdc++.so.6 /usr/lib/libstdc++.so.6 (Minimum Version: 4.1.2)

libm.so.6 /lib/libm.so.6

libgcc_s.so.1 /lib/libgcc_s.so.1 (Minimum Version: 4.1.2)

libc.so.6 /lib/libc.so.6 (Minimum Version: 2.5)

•

Module Default Path

libc.so.1 /lib/64/libc.so.1

libCrunG3.so.1 /usr/lib/64/libCrunG3.so.1

libdl.so.1 /lib/64/libdl.so.1

libgcc_s.so.1 /opt/developerstudio12.6/lib/compilers/CC-gcc/lib/sparcv9/libgcc_s.so.1

libm.so.2 /lib/64/libm.so.2

Document Filters Implementation Guide 3.2.5 Solaris

- 960/1268 -

C++ Runtime

Document Filters requires the C++14 runtime that ships with Solaris Developer Studio 12.6 released in

2017. The RPATH is congured to look for dependencies in the following order:

$ORIGIN

/opt/developerstudio12.6/lib/compilers/CC-gcc/lib

/opt/developerstudio12.6/lib/compilers/atomic

/lib

This allows you to ship the C++ runtime with your application as an alternate to installing the Solaris

Developer Studio runtime.

Sample Support

C++ samples may be compiled with Solaris Studio 12.6 or higher, GCC 4.1 or higher.

Java samples may be compiled with Sun JDK 1.4 or higher.

Python

The Document Filters Python Module supports Python versions 2.6, 2.7, 3.3 and 3.7+. Python must be

built with the ctypes module enabled.

3.2.6 macOS

Document Filters has been certied for the following:

Operating Systems

macOS 11 - Big Sur (x32, x64)

macOS 12 - Monterey (x32, x64, ARM64)

macOS 13 - Venture (x32, x64, ARM64)

macOS 14 - Sonoma (x32, x64, ARM64)

Module Default Path

libpthread.so.1 /lib/64/libpthread.so.1

librt.so.1 /lib/64/librt.so.1

libstatomic.so.1 /opt/developerstudio12.6/lib/compilers/atomic/sparcv9/libstatomic.so.1

libstdc++.so.6 /opt/developerstudio12.6/lib/compilers/CC-gcc/lib/sparcv9/libstdc++.so.6

•

Document Filters Implementation Guide 3.2.6 macOS

- 961/1268 -

Dependencies (all ship with system, no external or 3rd party)

Sample Support

C++ samples may be compiled with Apple clang 13.0.0 or higher.

Java samples may be compiled with openjdk 11.0.12 or higher.

Python

The Document Filters Python Module supports Python versions 2.6, 2.7, 3.3 and 3.7+. Python must be

built with the ctypes module enabled.

3.2.7 IBM AIX

Document Filters has been certied for the following:

Operating Systems

AIX 6.1 + (POWER64)

Dependencies (all ship with system, no external or 3rd party)

Sample Support

C++ samples may be compiled with IBM XLC, GCC 4.2 or higher.

Java samples may be compiled with Sun JDK 1.4 or higher.

Python

Module Default Path

libc++.1.dylib /usr/lib/libc++.1.dylib

libSystem.B.dylib /usr/lib/libSystem.B.dylib

•

Module Default Path

libc.a /usr/lib/libc.a

libpthreads.a /usr/lib/libpthreads.a

libpthread.a /usr/lib/libpthread.a

libcrypt.a /usr/lib/libcrypt.a

Document Filters Implementation Guide 3.2.7 IBM AIX

- 962/1268 -

The Document Filters Python Module supports Python versions 2.6 and 2.7.

Document Filters Implementation Guide 3.2.7 IBM AIX

- 963/1268 -

3.3 Platform Differences

On unsupported platforms, the PDF pages will be converted to images prior to redacting.

On unsupported platforms, the Default PDF processor will be used.

Feature

Apple DWG Subles

AutoCAD 2018+ Identication

AutoCAD 2018+ Metadata

AutoCAD 2018+ Text

AutoCAD 2018+ HiDef

PDF Redactions

PDF PDFium Text (alt)

PDF PDFium HiDef (alt)

Windows

Linux Intel

Linux PPC

Linux ARM v7

Linux ARM v8

MacOS Intel

MacOS AARCH64

AIX

Document Filters Implementation Guide 3.3 Platform Dierences

- 964/1268 -

3.4 Supported File Formats

3.4.1 Archive

Name Versions Extension Text HiDef

7-Zip 7Z

7-Zip MultiPart 7Z

7-Zip Self Extracting EXE

ACE ACE

Apple Disk Image DMG

ARJ ARJ

Bzip2 BZ2, TBZ2

ESTSoft ALZip ALZ

ESTSoft EGG EGG

GNU Zip 0.1, 1.0 GZ

ISO Disk Image ISO

Java Archive JAR

LZH LZH

Microsoft Cabinet CAB

Microsoft Oce Binder OBD

RedHat Package Manager RPM

Roshal Archive 1.5, 2.0, 2.9,

RAR

Roshal Archive (Multi-part) RAR

Roshal Archive (Solid) RAR

EXE

Document Filters Implementation Guide 3.4 Supported File Formats

- 965/1268 -

3.4.2 CAD

Name Versions Extension Text HiDef

Roshal Archive Self

Extracting

StuIt SIT

StuIt Self Extracting

Archive

SEA, EXE

StuIt X1 SITX

UNIX AR Archive A

UNIX Compress Archive Z

UNIX cpio CPIO

UNIX Tar TAR

Zip PKZip, WinZip ZIP

Zip (Multi-part) ZIP

Zip Self Extracting .exe EXE

Name Versions Extension Text HiDef

AutoCAD Drawing 2018 DWG

AutoCAD Drawing 12, 13, 14, 2000,

2002, 2004, 2005,

2006, 2007, 2008,

2009, 2010, 2012,

2013, 2014, 2015,

2016, 2017

DWG

AutoCAD Drawing

Exchange Format

DXF

Dassault Systemes

CATIA CAD

CATIA

Document Filters Implementation Guide 3.4.2 CAD

- 966/1268 -

3.4.3 Database

Name Versions Extension Text HiDef

Dassault Systemes

SolidWorks

SLDASM,

SLDDRW,

SLDPRT

Intergraph-

Microstation CAD

DGN

JT Open CAD JT

MathCAD MCD, XMCD

Parasolid Model

Part

X_T

Pro/ENGINEER

Assembly

ASM

Pro/ENGINEER

Drawing

DRW

Pro/ENGINEER

Drawing Form

FRM

Pro/ENGINEER

Model Part

PRT

STEP 3D CAD STP

Stereolithography

CAD (Binary)

STL

Stereolithography

CAD (Text)

STL

Wavefront OBJ OBJ

Name Versions Extension Text HiDef

dBASE le 3,4 DBF

dBASE III le 3,4 DB, DB3

Document Filters Implementation Guide 3.4.3 Database

- 967/1268 -

3.4.4 Email and Messaging

Name Versions Extension Text HiDef

dBASE IV le 4 DBF

ISYS Index1 IXA, IXB, IXC

Microsoft Access le 97-2016 MDB, ACCDB

Paradox Database File DB

Name Versions Extension Text HiDef

Apple Mail EMLX

Domino DXL

message

DXL

Email Message EML, EMLX

Encoded mail

message

MHT MHT

Encoded mail

message

Multipart

Alternative

Encoded mail

message

Multipart

Digest

Encoded mail

message

Multipart Mixed

Encoded mail

message

Multipart News

Group

Encoded mail

message

Multipart

Signed

Encoded mail

message

TNEF WINMAIL.DAT

Eudora Classic (1-7),

OSE

MBX

VMBX

Document Filters Implementation Guide 3.4.4 Email and Messaging

- 968/1268 -

3.4.5 Multimedia

Name Versions Extension Text HiDef

HP TRIM email

rendition

Microsoft Outlook 97-2016 MSG

Microsoft Outlook 97-2016 PST, OST

Microsoft Outlook

Express

DBX

Microsoft Outlook for

Mac

2011 OLK14

Microsoft Outlook for

Mac

2016 OLK15msgsource

Microsoft Outlook for

Mac Archive

OLM

Microsoft Outlook

Forms Template

OFT

Microsoft Outlook

MSO object

MSO

Sendmail "mbox" MBOX

Thunderbird MBOX

Name Versions Extension Text HiDef

3GP 3GP

Adobe Flash SWF

Adobe Flash Video FLV

Audio Video Interleave

(AVI)

AVI

DVD Information File IFO, BUP

DVD Video Object VOB

Document Filters Implementation Guide 3.4.5 Multimedia

- 969/1268 -

3.4.6 Other

Name Versions Extension Text HiDef

Media Exchange Format MXF

Microsoft Windows

Movie Maker

MSWMM

MPEG Video MPG

MPEG-1 Audio Layer 3 ID3v1, ID3v2 MP3

MPEG-2 Audio Layer 3 ID3v1, ID3v2 MP3

MPEG-4 Video MP4

Musical Instrument

Digital Interface (MIDI)

Standard MID, MIDI,

SMF

OGG FLAC Audio FLAC

OGG Vorbis Audio OGG

QuickTime 1.x-X MOV

Real Media RM

Waveform Audio File

Format (WAVE)

WAV, AIFF

Windows Media Audio WMT 4.0, WMA

2, 7, 8, 9

WMA

Windows Media Video WMV 7, 9 WMV

Name Versions Extension Text HiDef

Apple Double File

Apple Executable BIN

Apple iBook IBOOK

Apple PLIST Binary File PLIST

BIN HEX Encoded

Document Filters Implementation Guide 3.4.6 Other

- 970/1268 -

Name Versions Extension Text HiDef

HBX, HEX,

HQX

BitTorrent Metale TORRENT

EOT Font

EPUB Book EPUB

FujiXerox Docuworks

Java Class CLASS

Linux Executable and

Linkable Format

ELF

Log File LOG

Microsoft OneNote 2007, 2010,

2013, 2016

ONE

Microsoft Project 98-2003 MPP

Microsoft Project 2007, 2010,

2016

MPP, MPX

Microsoft Windows

Clipboard

CLIP, CLP

Microsoft Windows DLL DLL

Microsoft Windows

Executable

EXE, COM,

SYS

Microsoft Windows

Installer

MSI

Microsoft Windows

Shortcut

LNK

MO:DCA Files

Open Access II (OAII)

PCL

Document Filters Implementation Guide 3.4.6 Other

- 971/1268 -

3.4.7 Presentation

Name Versions Extension Text HiDef

Printer Command

Language

QuarkExpress

SQLite Database

Symbian Executable

SysInternals ProcMon

Logs

PML

Uniplex

UUEncode UUE

vCalendar VCS

vCard 2.1 VCF

Visual Studio SUO le SUO

Windows Resource File RES

Windows Thumbs.db DB

XXEncode XXE

Name Versions Extension Text HiDef

Apple iWork Keynote ’09 (5.x) KEY

Apple iWork Keynote 6, 7 KEY

Apple Keynote 7.x – 11.x KEY

Corel Presentation SHW

Hancom Oce

HanShow

2010, 2014 SHOW

LibreOce Impress 1.x, 2.x, 3.x, 4.x ODP

3, 4, 5 ODS

Document Filters Implementation Guide 3.4.7 Presentation

- 972/1268 -

3.4.8 Raster Image

Name Versions Extension Text HiDef

LibreOce

Presentation

Microsoft PowerPoint

for Mac

1-4, 98, 2001, v. X,

2004, 2008, 2011

PPT, PPTX

Microsoft PowerPoint

for Oce 365

PPT, PPTX

Microsoft PowerPoint

for Windows

3.0-4.0 PPT

Microsoft PowerPoint

for Windows

97-2013, 2016 PPT, PPTX

OpenOce Impress 1.x, 2.x, 3.x, 4.x ODP

StarOce Impress 3 8, 9 SXI, SDI,

SDP

Name Versions Extension Text HiDef

Adobe Photoshop 8.x, 9.x, 10.0

(CS 1-3)

PSD

Adobe Photoshop Large

Document Format

PSB

Brooktrout Fax Image

CALS Raster Type 1 CAL

Canon CR2 Raw CR2

Canon CR3 Raw CR3

Canon CRW Raw CRW

DCX DCX

DICOM Medical Image DCM

Encapsulated PostScript EPS

Document Filters Implementation Guide 3.4.8 Raster Image

- 973/1268 -

Name Versions Extension Text HiDef

Encapsulated PostScript

with Preview

EPS

FlashPix FPX

Flexible Image Transport

System

FITS

GEM Raster IMG

Graphics Interchange

Format (GIF)

87a, 89a,

Animated

GFA, GIF,

GIFF

IMNET Group 4 Image IMT

Interchange File Format IFF

Joint Photographic

Experts Group (JPEG)

JPEG, JPG,

JPE, JIF

JPEG2000 J2P, J2C, JPF

MacPaint 1BPP Image MAC

Microsoft Document

Imaging

MDI

Microsoft Paint MSP 1BPP

Image

MSP

Microsoft Windows

Bitmap

BMP

NCR Image NCR

PaintShop Pro Image PSP

PCX PCX

Portable Bitmap PBM PBM

Portable Graymap PGM PGM

Portable Network Graphic

(PNG)

1.0, 1.1, 1.2 PNG

Document Filters Implementation Guide 3.4.8 Raster Image

- 974/1268 -

3.4.9 Spreadsheets

Name Versions Extension Text HiDef

Portable Pixmap PPM PPM

Progressive JPEG JPEG, JPG

Sun Raster Image RAS

Tagged Image Format

File (TIFF)

Revision

3.0-5.0

TIF, TIFF

Targa TGA

WebP 0.4.2 WEBP

Windows Cursor CUR

Windows Icon ICO

Wireless Bitmap Image WBMP

X-Windows pixmap XPM

X-Windows xbitmap XBM

Name Versions Extension Text HiDef

Apple iWork

Numbers

09 NUMBERS

Apple iWork

Numbers

3, 4 NUMBERS

Apple Numbers 4x - 11.x NUMBERS

Comma Seperated

Vector

CSV

Framework

Spreadsheet

III FW3

Hancom Oce

HanCell

2010 - 2014 CELL

1.x, 3.x SXS, SX, ODS

Document Filters Implementation Guide 3.4.9 Spreadsheets

- 975/1268 -

3.4.10 Text and Markup

Name Versions Extension Text HiDef

IBM Lotus Symphony

Spreadsheet

LibreOce Calc 1.1 – 4.x ODS

LibreOce

Spreadsheet

3, 4, 5 ODS

Lotus 1-2-3 Through

Millennium 9.6

WK, WKS,

WK3, WK4

Lotus 1-2-3 1, 1.5, 2.2, 3.0,

4.0, 5.0

XLS

Microsoft Excel for

Mac

8.0-15.0 XLS, XLSX,

XML

Microsoft Excel for

Oce 365

XLS, XLSX

Microsoft Excel for

Windows

2.0 – 7.0 (Excel

95)

XLS

Microsoft Excel for

Windows

1997 (v.8) - 2010,

2013, 2016

XLS, XLSX,

XML

Microsoft Excel for

Windows

2007 – 2016

(Binary)

XLSB

Microsoft Works for

DOS

2 WPS

Microsoft Works for

Windows

3, 4, 6, 7 WPS

OpenOce Calc 1.1 – 4.x ODS

Quattro Pro QPW

StarOce Calc 8, 9 SXC, SXS, ODS

Document Filters Implementation Guide 3.4.10 Text and Markup

- 976/1268 -

Name Versions Extension Text HiDef

ANSI Text 7-bit, 8-bit TXT

ASCII Text 7-bit, 8-bit TXT

HTML (Codes

Revealed)

HTM, HTML

HTML (Metadata

Only)

HTM, HTML

HTML (Text Only) HTM, HTML

IBM DCA RFT, TXT,

DCA

IMNET COLD IMT

Microsoft HTML

Help

1.0, 1.1a, 1.3, 1.32,

1.33MAML

CHM

Microsoft OneNote 2007, 2010, 2013,

2016

ONE

Microsoft OneNote

TOC1

2007, 2010, 2013,

2016

ONETOC

Multi-Byte Text TXT

Rich Text Format 1.0, 1.3, 1.5, 1.6, 1.7,

1.8, 1.9.1

RTF

SGML Text SGML

Source

Transcript

Unicode UCS2BE

Unicode UCS2LE

Unicode UCS4BE

Unicode UCS4LE

Document Filters Implementation Guide 3.4.10 Text and Markup

- 977/1268 -

3.4.11 Vector Image

Name Versions Extension Text HiDef

Unicode UTF16BE

Unicode UTF16LE

Unicode UTF8

XML XML Document File XML

XML XML Record View XML

Name Versions Extension Text HiDef

Adobe Illustrator AI

Adobe InDesign 1.x-7.x INDD

AutoDesk Design Web

Format

DWF

Computer Graphics Metale CGM

Corel Draw Image CDR

Initial Graphics Exchange

Specication

IGS

Macintosh PICT Image PICT

Microsoft Visio 4.0 - 2013 VSD

Microsoft Visio 10.0 – 2013,

2016

VDX, VSDX

Microsoft Visio1 3 VSD

Microsoft XPS XPS, OXPS

Scalable Vector Graphic SVG

Scitex CT

StarView Metale SVM

EMF

Document Filters Implementation Guide 3.4.11 Vector Image

- 978/1268 -

3.4.12 Word Processor and Office

Name Versions Extension Text HiDef

Windows Enhanced Meta

File

Windows Meta File WMF

Word Perfect Graphics 1 WPG

Word Perfect Graphics 2 WPG

Name Versions Extension Text HiDef

Adobe PDF 1.0 – 1.7

(Extension 3, 5)

(Acrobat 1 - 11)

PDF

Adobe PDF

Package

PDF

Adobe PDF

Portfolio

PDF

Adobe PDF XFA

Forms

PDF

Adobe PostScript PS

Ami Pro for

Windows

AMI, SAM

Apple iWork

Pages

4.x PAGES

Apple Pages 5.x – 11.x PAGES

Framework WP FW3

Hangul v3 HWP

Hangul 96 - 2014 HWP

Hangul 2014-2020 HWPX

IBM DCA/FFT RFT, FFT

Document Filters Implementation Guide 3.4.12 Word Processor and Oice

- 979/1268 -

Name Versions Extension Text HiDef

IBM DisplayWrite 4 RFT, DCA, DW4,

DOC

IBM DisplayWrite 5 RFT, DCA,

.DW5, .DOC

IBM Lotus

Symphony

Document

1.x, 3.x ODT

JungUm2 GUL

JustSystems

Ichitaro

5, 6, 8+ JTD, JBW, JTT

LibreOce

Document

3, 4, 5 ODT

LibreOce

Writer

1.1 - 4.x ODT

Lotus Manuscript 1.0, 2.x MANU, MNU,MAN

Lotus Notes NSF

Lotus WordPro LWP

Mass 11 8 M11

Microsoft

Publisher2

PUB

Microsoft Word

for DOS

4.0 - 6.0 DOC

Microsoft Word

for Mac

1-5, 5.1, 6 DOC, DOCX

Microsoft Word

for Mac

98, 2001, v. X,

2004, 2008, 2010,

2011, 2016

DOC, DOCX,XML

Microsoft Word

for Windows

1.x, 2.x DOC

Document Filters Implementation Guide 3.4.12 Word Processor and Oice

- 980/1268 -

Name Versions Extension Text HiDef

Microsoft Word

for Windows

6.x, 95, 97, 2000,

2002, 2003, 2007,

2010, 2013, 2016

DOC, DOCX, XML

MultiMate Through 4.0 DOX

MultiMate

Advantage

DOX

OpenOce

Writer

1.1 - 4.x ODT

Professional

Write for DOS

1, 2 PW, PW1, PW2

Professional

Write Plus for

Windows

1 PW

Q&A Write 3, 4 (Classic), 5 QA, QA3

QuarkXpress QXx, QCx

QuickBooks

Backup

QBB

QuickBooks for

Windows

QBW

StarOce Writer 8, 9 SXW, SDW

TrueType Font TTF

Wang IWP IWP

Wang WP Plus IWP

Windows Write WRI

WinWord 6 DOC

WordPerfect for

DOS

3, 4, 5, 6 WPD

Document Filters Implementation Guide 3.4.12 Word Processor and Oice

- 981/1268 -

Name Versions Extension Text HiDef

WordPerfect for

Macintosh

1.0-1.0.7, 2.0, 2.1,

3.0, 3.1, 3.5, 3.5e

WPD

WordPerfect for

Windows

5.1-12.0, X3, X4,

X5, X6, X7, X8

WPD, WP5

Wordstar 2000

for DOS

1/3/2011 WS2, DOC

Wordstar for

DOS

3.x-7 WS, WSx

Wordstar for

Windows

1 WSD

Wordstar for

Windows

2 WSD

XYwrite XY

Document Filters Implementation Guide 3.4.12 Word Processor and Oice

- 982/1268 -

3.5 Document format codes

Additional codes are dened as Document Filters is enhanced to support new le formats, however

existing codes never change.

ID Description MIME Type File Type Category

2 Text (ASCII) text/plain IGR_FILETYPE_TEXT

3 Wordstar 3 or 4 application/vnd.wordstar IGR_FILETYPE_WORD_PROCESSOR

4 Multimate application/vnd.multimate IGR_FILETYPE_WORD_PROCESSOR

5 Microsoft Word application/msword IGR_FILETYPE_WORD_PROCESSOR

6 WordPerfect 5 - X4 application/vnd.wordperfect IGR_FILETYPE_WORD_PROCESSOR

7 IBM DCA/RFT application/dca-rft IGR_FILETYPE_WORD_PROCESSOR

8 Source Code text/plain IGR_FILETYPE_TEXT

9 Professional Write application/vnd.prowrite IGR_FILETYPE_WORD_PROCESSOR

10 WordPerfect 4.2 application/vnd.wordperfect IGR_FILETYPE_WORD_PROCESSOR

11 XYWrite application/vnd.xy-write IGR_FILETYPE_WORD_PROCESSOR

12 Wordstar 5 application/

vnd.wordstar;version=5

IGR_FILETYPE_WORD_PROCESSOR

13 Wordstar 2000 application/

vnd.wordstar;version=2000

IGR_FILETYPE_WORD_PROCESSOR

14 Lotus Manuscript application/vnd.lotus-manuscript IGR_FILETYPE_WORD_PROCESSOR

15 DisplayWrite 4 application/

vnd.displaywrite;version=4

IGR_FILETYPE_WORD_PROCESSOR

16 Wang IWP application/vnd.wangwp IGR_FILETYPE_WORD_PROCESSOR

18 FrameWork 3 application/vnd.framework3 IGR_FILETYPE_WORD_PROCESSOR

19 IBM FFT application/dca-t IGR_FILETYPE_WORD_PROCESSOR

20 Microsoft RTF application/rtf IGR_FILETYPE_WORD_PROCESSOR

Document Filters Implementation Guide 3.5 Document format codes

- 983/1268 -

ID Description MIME Type File Type Category

22 Open Access II application/openaccess2 IGR_FILETYPE_WORD_PROCESSOR

23 dBASE / FoxPro application/x-dbf IGR_FILETYPE_DATABASE

24 Q & A Write application/vnd.qa3 IGR_FILETYPE_WORD_PROCESSOR

25 Microsoft Word

Sub Types: [Word 2.0, Word 2003 XML Document, Word 2007, Word 2007 (DRM Protected), Word 2007 (Password Protected), Word 2007 XML, Word 6.0, Word 95, Word 97/2003, Word for Mac 5]

application/msword IGR_FILETYPE_WORD_PROCESSOR

26 DisplayWrite 5 application/

vnd.displaywrite;version=5

IGR_FILETYPE_WORD_PROCESSOR

27 Wang WP PLUS application/vnd.wangwpplus IGR_FILETYPE_WORD_PROCESSOR

29 MASS-11 PC application/vnd.mass11 IGR_FILETYPE_WORD_PROCESSOR

30 Lotus Ami Pro application/vnd.amipro IGR_FILETYPE_WORD_PROCESSOR

32 SpreadSheet/Other

Sub Types: [Microsoft Works (4), Microsoft Works (5), Lotus 1-2-3 (3), Lotus 1-2-3 (WK1), Lotus 1-2-3 (98), Lotus 1-2-3 (97), Quatro]

application/octet-stream IGR_FILETYPE_UNKNOWN

33 Best Guess (of...) application/octet-stream IGR_FILETYPE_UNKNOWN

34 Microsoft Works application/vnd.ms-works IGR_FILETYPE_WORD_PROCESSOR

35 External Image Viewer application/octet-stream IGR_FILETYPE_GRAPHIC

37 Uniplex application/vnd.uniplex IGR_FILETYPE_UNKNOWN

38 External OEM DLL application/octet-stream IGR_FILETYPE_UNKNOWN

39 Transcript text/plain IGR_FILETYPE_TEXT

40 SGML Text Only text/sgml IGR_FILETYPE_TEXT_MARKUP

43 Compuserve E-Mail application/octet-stream IGR_FILETYPE_EMAIL_MESSAGE

44 ISYS Annotation text/plain;version=isysanno IGR_FILETYPE_TEXT

45 SQL Data Source text/plain;version=sql IGR_FILETYPE_TEXT

46 Windows Write application/vnd.ms-winwrite IGR_FILETYPE_WORD_PROCESSOR

47 Microsoft PowerPoint

Sub Types: [PowerPoint 97/2003, PowerPoint 2007, PowerPoint 2007 (DRM Protected), PowerPoint 2007 (Password Protected)]

application/vnd.ms-powerpoint IGR_FILETYPE_PRESENTATION

Document Filters Implementation Guide 3.5 Document format codes

- 984/1268 -

ID Description MIME Type File Type Category

49 HTML Text Only text/html IGR_FILETYPE_TEXT_MARKUP

50 HTML Raw Codes text/html IGR_FILETYPE_TEXT_MARKUP

51 Adobe Acrobat (PDF) application/pdf IGR_FILETYPE_PUBLISHING

52 Microsoft Excel

Sub Types: [Excel 2.0, Excel 2007, Excel 2007 (DRM Protected), Excel 2007 (Password Protected), Excel 3.0, Excel 3.0 (Password Protected), Excel 4.0, Excel 4.0 (Password Protected), Excel 5.0, Excel 5.0 (Password Protected), Excel 97/2003, Excel 97/2003 (Password Protected), XML Spreadsheet 2003, Microsoft Graph 97/2003, MHTML Web Archive]

application/msexcel IGR_FILETYPE_SPREADSHEET

53 E-mail application/octet-stream IGR_FILETYPE_EMAIL_MESSAGE

54 Microsoft MSG application/vnd.ms-outlook IGR_FILETYPE_EMAIL_MESSAGE

55 AutoDesk AutoCAD application/vnd.dwg IGR_FILETYPE_CAD

56 Hangul application/x-hwp IGR_FILETYPE_WORD_PROCESSOR

58 Microsoft HTML Help (CHM) application/vnd.ms-htmlhelp IGR_FILETYPE_ARCHIVE

59 ZIP Archive application/zip IGR_FILETYPE_ARCHIVE

60 MP3 audio/mpeg IGR_FILETYPE_MULTIMEDIA_AUDIO

63 Lotus Notes application/vnd.lotus-notes IGR_FILETYPE_EMAIL_CONTAINER

64 Microsoft EML message/rfc822 IGR_FILETYPE_EMAIL_MESSAGE

65 Microsoft Web Archive (MHT) multipart/related IGR_FILETYPE_EMAIL_MESSAGE

66 Adobe Shockwave Flash application/x-shockwave-ash IGR_FILETYPE_MULTIMEDIA

67 HTML Metadata only text/plain IGR_FILETYPE_TEXT_MARKUP

68 vCard Electronic business card text/x-vcard IGR_FILETYPE_EMAIL_CONTACT

70 Microsoft Visio

Sub Types: [Visio 2013, Visio VDX]

application/vnd.visio IGR_FILETYPE_GRAPHIC_VECTOR

71 IFilter application/octet-stream IGR_FILETYPE_UNKNOWN

72 TIFF Image image/ti IGR_FILETYPE_GRAPHIC_RASTER

73 JPEG Exif image/jpeg IGR_FILETYPE_GRAPHIC_RASTER

74 Text (UTF8) text/plain;charset=utf-8 IGR_FILETYPE_TEXT

Document Filters Implementation Guide 3.5 Document format codes

- 985/1268 -

ID Description MIME Type File Type Category

75 Text (UTF16) text/plain;charset=utf-16 IGR_FILETYPE_TEXT

76 Open Document Format

Sub Types: [OpenDocument Drawing, OpenDocument Presentation, OpenDocument Spreadsheet, OpenDocument Text]

application/

vnd.oasis.opendocument.text

IGR_FILETYPE_WORD_PROCESSOR

77 XML document le text/xml IGR_FILETYPE_TEXT_MARKUP

78 Microsoft PST/OST application/vnd.ms-outlook-pst IGR_FILETYPE_EMAIL_CONTAINER

79 Sendmail MBOX application/mbox IGR_FILETYPE_EMAIL_CONTAINER

80 Microsoft OneNote application/msonenote IGR_FILETYPE_OFFICE_OTHER

81 Microsoft Document Image (MDI) image/mdi IGR_FILETYPE_GRAPHIC_RASTER

82 Windows Multimedia (WMA/WMV) video/x-ms-wmv IGR_FILETYPE_MULTIMEDIA

83 Microsoft XPS application/vnd.ms-xpsdocument IGR_FILETYPE_PUBLISHING

84 Metadata text/plain IGR_FILETYPE_TEXT

85 Log le text/log IGR_FILETYPE_TEXT

86 7ZIP Archive application/x-7z-compressed IGR_FILETYPE_ARCHIVE

87 GZ Archive application/gzip IGR_FILETYPE_ARCHIVE

88 RAR Archive application/x-rar-compressed IGR_FILETYPE_ARCHIVE

89 Apple iWork application/vnd.apple.iwork IGR_FILETYPE_WORD_PROCESSOR

90 Microsoft Project application/vnd.ms-project IGR_FILETYPE_OFFICE_OTHER

92 JustSystems Ichitaro application/vnd.ichitaro IGR_FILETYPE_WORD_PROCESSOR

93 ISO Disk Image application/x-iso9660-image IGR_FILETYPE_ARCHIVE

94 Microsoft Cabinet Archive application/vnd.ms-cab-

compressed

IGR_FILETYPE_ARCHIVE

95 Apple Disk Image application/octet-stream IGR_FILETYPE_ARCHIVE

96 HFS Partition application/octet-stream IGR_FILETYPE_ARCHIVE

97 BZIP Archive application/x-bzip IGR_FILETYPE_ARCHIVE

Document Filters Implementation Guide 3.5 Document format codes

- 986/1268 -

ID Description MIME Type File Type Category

98 CPIO UNIX Archive application/x-cpio IGR_FILETYPE_ARCHIVE

99 TAR Archive application/x-gtar IGR_FILETYPE_ARCHIVE

100 LZH Archive application/x-lzh IGR_FILETYPE_ARCHIVE

101 ARJ Archive application/x-arj-compressed IGR_FILETYPE_ARCHIVE

102 Microsoft Binder application/x-msbinder IGR_FILETYPE_ARCHIVE

103 RPM Package application/x-rpm IGR_FILETYPE_ARCHIVE

104 Microsoft Publisher application/x-mspublisher IGR_FILETYPE_PUBLISHING

105 QuickBooks Backup application/vnd.quickbooks IGR_FILETYPE_APPDATA

106 Real Media application/rn-realmedia IGR_FILETYPE_MULTIMEDIA

107 Adobe Flash Video application/x-shockwave-ash IGR_FILETYPE_MULTIMEDIA_VIDEO

108 3gp Audio audio/3gpp IGR_FILETYPE_MULTIMEDIA_AUDIO

109 DVD Video Object video/x-ms-vob IGR_FILETYPE_MULTIMEDIA

110 TrueType Font application/x-font-ttf IGR_FILETYPE_SYSTEM

111 QuickBooks for Windows application/vnd.quickbooks IGR_FILETYPE_APPDATA

112 Intergraph/Microstation CAD (DGN) application/vnd.dgn IGR_FILETYPE_CAD

113 MPEG Video video/mpeg IGR_FILETYPE_MULTIMEDIA_VIDEO

114 MPEG-4 Video video/mpeg4-generic IGR_FILETYPE_MULTIMEDIA_VIDEO

115 AIFF audio/x-ai IGR_FILETYPE_MULTIMEDIA_AUDIO

116 Ogg Vorbis Audio audio/x-oggvorbis IGR_FILETYPE_MULTIMEDIA_AUDIO

117 Ogg Flac Audio audio/x-oggac IGR_FILETYPE_MULTIMEDIA_AUDIO

118 Microsoft Bitmap (BMP) image/bmp IGR_FILETYPE_GRAPHIC_RASTER

119 Microsoft Access Database (MDB) application/x-msaccess IGR_FILETYPE_DATABASE

120 PCX Image image/x-pcx IGR_FILETYPE_GRAPHIC_RASTER

Document Filters Implementation Guide 3.5 Document format codes

- 987/1268 -

ID Description MIME Type File Type Category

121 GIF Image (GIF) image/gif IGR_FILETYPE_GRAPHIC_RASTER

122 PNG Image (PNG) image/png IGR_FILETYPE_GRAPHIC_RASTER

123 Adobe Photoshop Image (PSD) application/photoshop IGR_FILETYPE_GRAPHIC_RASTER

124 WAVE Audio audio/wave IGR_FILETYPE_MULTIMEDIA_AUDIO

125 AVI Video video/avi IGR_FILETYPE_MULTIMEDIA_VIDEO

126 Apple QuickTime application/quicktime IGR_FILETYPE_MULTIMEDIA_VIDEO

127 MIDI Audio audio/midi IGR_FILETYPE_MULTIMEDIA_AUDIO

128 Windows Metale (WMF) image/wmf IGR_FILETYPE_GRAPHIC_VECTOR

129 Windows Enhanced Metale (EMF) image/emf IGR_FILETYPE_GRAPHIC_VECTOR

130 PostScript (PS) application/postscript IGR_FILETYPE_GRAPHIC_VECTOR

131 Adobe InDesign application/x-adobe-indesign IGR_FILETYPE_PUBLISHING

132 Adobe Illustrator application/illustrator IGR_FILETYPE_PUBLISHING

133 Windows EXE/DLL (EXE,DLL) application/x-dosexec IGR_FILETYPE_SYSTEM

134 Linux ELF application/x-elf IGR_FILETYPE_SYSTEM

135 BinHex Encoded application/binhex IGR_FILETYPE_ARCHIVE

136 dBASE Database application/x-dbf IGR_FILETYPE_DATABASE

137 Paradox Database application/vnd.paradox IGR_FILETYPE_DATABASE

138 StuIt Archive application/x-stut IGR_FILETYPE_ARCHIVE

139 Corel Draw application/coreldraw IGR_FILETYPE_PUBLISHING

140 StuIt X application/x-stutx IGR_FILETYPE_ARCHIVE

141 Quark XPress application/

vnd.quark.quarkxpress

IGR_FILETYPE_PUBLISHING

142 Microsoft Installer (MSI) application/x-windows-installer IGR_FILETYPE_SYSTEM

143 ACE Archive application/x-ace-compressed IGR_FILETYPE_ARCHIVE

Document Filters Implementation Guide 3.5 Document format codes

- 988/1268 -

ID Description MIME Type File Type Category

144 Apple Bin File application/vnd.applebin IGR_FILETYPE_ARCHIVE

145 StuIt Self Extracting Archive application/x-stutsea IGR_FILETYPE_ARCHIVE

146 DVD IFO (IFO) application/vnd.ifo IGR_FILETYPE_MULTIMEDIA

147 Microsoft Movie Maker application/vnd.ms-moviemaker IGR_FILETYPE_APPDATA

148 MathCAD application/x-mathcad IGR_FILETYPE_CAD

149 BitTorrent Metale application/x-bittorrent IGR_FILETYPE_APPDATA

150 Shortcut/Link application/x-ms-shortcut IGR_FILETYPE_SYSTEM

151 AutoCAD DXF image/vnd.dxf IGR_FILETYPE_CAD

153 Outlook Express mailbox application/x-ms-outlookexpress IGR_FILETYPE_EMAIL_CONTAINER

154 Microsoft OneNote TOC application/msonenote IGR_FILETYPE_OFFICE_OTHER

155 Microsoft Outlook RTF application/x-ms-winmail IGR_FILETYPE_EMAIL_CONTAINER

156 DICOM application/dicom IGR_FILETYPE_GRAPHIC_RASTER

157 Text with ISYS markup text/plain IGR_FILETYPE_TEXT

158 Java Class (CLASS) application/java-vm IGR_FILETYPE_SYSTEM

159 ALZ Archive (ALZ) application/x-alz-compressed IGR_FILETYPE_ARCHIVE

160 EGG Archive (EGG) application/x-egg-compressed IGR_FILETYPE_ARCHIVE

161 NDOC File (NDOC) application/vnd.ndoc IGR_FILETYPE_WORD_PROCESSOR

162 ISYS Transaction File (ISTX) application/x-isys-transaction IGR_FILETYPE_SYSTEM

163 ISYS Index File (ISYS.IX*) application/x-isys-index IGR_FILETYPE_SYSTEM

164 VCalendar Electronic Calendar text/calendar IGR_FILETYPE_EMAIL_CALENDAR

165 Symbian OS File application/symbian IGR_FILETYPE_SYSTEM

166 FITS Image image/ts IGR_FILETYPE_GRAPHIC_RASTER

167 Hancom Oce Hancell application/vnd.hancell IGR_FILETYPE_SPREADSHEET

Document Filters Implementation Guide 3.5 Document format codes

- 989/1268 -

ID Description MIME Type File Type Category

168 Compress Archive (.Z) application/x-compress IGR_FILETYPE_ARCHIVE

169 UU Encoded File text/x-uuencode IGR_FILETYPE_ARCHIVE

170 JungUm File (.GUL) application/jung IGR_FILETYPE_WORD_PROCESSOR

171 Text (Multibyte) text/plain IGR_FILETYPE_TEXT

172 Text (UTF32) text/plain;charset=utf-32 IGR_FILETYPE_TEXT

173 Microsoft Windows Binary application/octet-stream IGR_FILETYPE_SYSTEM

174 Empty File application/octet-stream IGR_FILETYPE_SYSTEM

175 Corrupt File application/octet-stream IGR_FILETYPE_SYSTEM

176 Material Exchange Format (MXF) application/vnd.mxf IGR_FILETYPE_MULTIMEDIA

177 WEBP Image image/webp IGR_FILETYPE_GRAPHIC_RASTER

178 ICON Image image/vnd.microsoft.icon IGR_FILETYPE_GRAPHIC_RASTER

179 Unix AR Archive application/x-ar-compressed IGR_FILETYPE_ARCHIVE

180 StarView Metale (SVM) image/starview-metale IGR_FILETYPE_GRAPHIC_VECTOR

181 Netpbm (PPM, PBM, PGM, PNM) image/x-portable-bitmap IGR_FILETYPE_GRAPHIC_RASTER

182 XZ Archive application/x-xz IGR_FILETYPE_ARCHIVE

183 DocPack application/x-isys-docpack IGR_FILETYPE_SYSTEM

184 Macintosh PICT Image image/x-pict IGR_FILETYPE_GRAPHIC_VECTOR

185 Scalable Vector Graphic image/svg+xml IGR_FILETYPE_GRAPHIC_VECTOR

186 Microsoft Word for Mac application/msword IGR_FILETYPE_WORD_PROCESSOR

187 PCX Image image/x-dcx IGR_FILETYPE_GRAPHIC_RASTER

188 Targa Image image/x-tga IGR_FILETYPE_GRAPHIC_RASTER

189 EPS Image application/postscript IGR_FILETYPE_GRAPHIC_VECTOR

190 JPEG2000 Image image/jp2 IGR_FILETYPE_GRAPHIC_RASTER

Document Filters Implementation Guide 3.5 Document format codes

- 990/1268 -

ID Description MIME Type File Type Category

191 CALS Raster Image image/cals IGR_FILETYPE_GRAPHIC_RASTER

192 GEM Image image/gem IGR_FILETYPE_GRAPHIC_RASTER

193 WBMP Image image/wbmp IGR_FILETYPE_GRAPHIC_RASTER

194 IFF Image image/i IGR_FILETYPE_GRAPHIC_RASTER

195 Apple Pages application/vnd.apple.pages IGR_FILETYPE_WORD_PROCESSOR

196 Corel Presentation application/x-corelpresentations IGR_FILETYPE_PRESENTATION

197 CATIA CAD application/catia IGR_FILETYPE_CAD

198 Stereolithography CAD (Binary) model/x.stl-binary IGR_FILETYPE_CAD

199 Stereolithography CAD (Text) model/x.stl-ascii IGR_FILETYPE_CAD

200 STEP 3D CAD application/x-step IGR_FILETYPE_CAD

201 IGS CAD model/iges IGR_FILETYPE_CAD

202 Pro/ENGINEER Model model/prt IGR_FILETYPE_CAD

203 SolidWorks application/sldworks IGR_FILETYPE_CAD

204 JT CAD application/x-jt IGR_FILETYPE_CAD

205 Parasolid Model Part application/x-parasolid IGR_FILETYPE_CAD

206 Pro/ENGINEER Assembly application/pro-e IGR_FILETYPE_CAD

207 Pro/ENGINEER Drawing application/pro-e IGR_FILETYPE_CAD

208 Pro/ENGINEER Drawing Form application/pro-e IGR_FILETYPE_CAD

209 OBJ 3D Image text/obj-cad IGR_FILETYPE_CAD

210 Autodesk WHIP application/x-dwf IGR_FILETYPE_CAD

211 Apple Keynote application/vnd.apple.keynote IGR_FILETYPE_PRESENTATION

212 Apple Numbers application/vnd.apple.numbers IGR_FILETYPE_SPREADSHEET

213 Brooktrout Fax image/brk IGR_FILETYPE_GRAPHIC_RASTER

Document Filters Implementation Guide 3.5 Document format codes

- 991/1268 -

ID Description MIME Type File Type Category

214 JEDMICS C4 image/c4 IGR_FILETYPE_GRAPHIC_RASTER

215 MSO Object application/x-ms-object IGR_FILETYPE_GRAPHIC_RASTER

216 IMNET Medical image/vnd.imnet-c4 IGR_FILETYPE_GRAPHIC_RASTER

217 IMNET COLD image/vnd.imnet-text IGR_FILETYPE_GRAPHIC_VECTOR

218 MS Paint Image application/vnd.ms-paint IGR_FILETYPE_GRAPHIC_RASTER

219 MAC Paint Image image/x-macpaint IGR_FILETYPE_GRAPHIC_RASTER

220 FlashPix image/vnd.fpx IGR_FILETYPE_GRAPHIC_RASTER

221 Computer Graphics Metale image/cgm IGR_FILETYPE_GRAPHIC_VECTOR

222 Xxencoded File application/x-xxencode IGR_FILETYPE_ARCHIVE

223 Domino XML application/x-dxlle IGR_FILETYPE_EMAIL_MESSAGE

224 NCR Image image/ncr IGR_FILETYPE_GRAPHIC_RASTER

225 Microsoft Windows Clipboard application/x-msclip IGR_FILETYPE_SYSTEM

226 Apple Property List (Binary) application/x-plist IGR_FILETYPE_SYSTEM

227 Electronic Publication application/epub+zip IGR_FILETYPE_PUBLISHING

228 Apple iBooks Publication application/x-ibooks+zip IGR_FILETYPE_PUBLISHING

229 Quattro Pro Spreadsheet application/x-quattro-pro IGR_FILETYPE_APPDATA

230 Outlook for Mac OLM application/vnd.ms-outlook-pst IGR_FILETYPE_EMAIL_CONTAINER

231 Outlook for Mac Message Source application/vnd.ms-outlook-olk15-

msgsource

IGR_FILETYPE_EMAIL_MESSAGE

233 WordPerfect Graphics application/x-fmt/395 IGR_FILETYPE_GRAPHIC_VECTOR

234 Windows Cursor Image image/vnd.microsoft.icon IGR_FILETYPE_GRAPHIC_RASTER

235 X-Windows Bitmap image/x-xbitmap IGR_FILETYPE_GRAPHIC_RASTER

236 X-Windows Pixmap image/x-xpixmap IGR_FILETYPE_GRAPHIC_RASTER

237 Paintshop Pro image/x-paintshoppro IGR_FILETYPE_GRAPHIC_RASTER

Document Filters Implementation Guide 3.5 Document format codes

- 992/1268 -

ID Description MIME Type File Type Category

238 AutoDesk AutoCAD 2018 application/

vnd.dwg;version=2018

IGR_FILETYPE_CAD

239 SQLite DB application/vnd.sqlite IGR_FILETYPE_DATABASE

240 Fuji Xerox DocuWorks application/

vnd.fujixerox.docuworks

IGR_FILETYPE_WORD_PROCESSOR

241 SGI Image File image/sgi IGR_FILETYPE_GRAPHIC_RASTER

242 MS Embedded OpenType fonts application/vnd.ms-fontobject IGR_FILETYPE_SYSTEM

243 Kodak Photo CD image/pcd IGR_FILETYPE_GRAPHIC_RASTER

244 AFP MO:DCA application/vnd.afpc.modca IGR_FILETYPE_PUBLISHING

245 Windows Thumbnail Cache application/

vnd.microsoft.windows.thumbnail-

cache

IGR_FILETYPE_SYSTEM

246 VS Solution User Options application/vnd.ms-vs-user-

options

IGR_FILETYPE_SYSTEM

247 AppleDouble application/applele IGR_FILETYPE_SYSTEM

248 Process Monitor Log application/vnd.ms-

windows.procmon.log

IGR_FILETYPE_SYSTEM

249 Resource File application/vnd.ms-resourcele IGR_FILETYPE_SYSTEM

250 Sun Raster Image (RAS) image/x-sun-raster IGR_FILETYPE_GRAPHIC_RASTER

251 Printer Command Language application/vnd.hp-PCL IGR_FILETYPE_PUBLISHING

252 Scitex CT Image(CT) image/scitex-ct IGR_FILETYPE_GRAPHIC_RASTER

253 Canon Raw Image image/x-canon-crw IGR_FILETYPE_GRAPHIC_RASTER

254 X Window System Screen Dump image/x-xwindowdump IGR_FILETYPE_SYSTEM

256 Password Protected Oce File application/octet-stream IGR_FILETYPE_OFFICE_OTHER

257 ZIP Archive (SFX) application/x-dosexec+zip IGR_FILETYPE_ARCHIVE

258 RAR Archive (SFX) application/x-dosexec+rar IGR_FILETYPE_ARCHIVE

Document Filters Implementation Guide 3.5 Document format codes

- 993/1268 -

ID Description MIME Type File Type Category

259 7ZIP Archive (SFX) application/x-dosexec+7z IGR_FILETYPE_ARCHIVE

260 Adobe Photoshop Large Document Format (PSB) application/photoshop-psb IGR_FILETYPE_GRAPHIC_RASTER

261 WordPerfect for Mac 1 application/vnd.wordperfect IGR_FILETYPE_WORD_PROCESSOR

262 Canon Camera Raw Image 2 image/x-canon-cr2 IGR_FILETYPE_GRAPHIC_RASTER

263 Canon Camera Raw Image 3 image/x-canon-cr3 IGR_FILETYPE_GRAPHIC_RASTER

264 PDF XFA XML application/x-pdfxfa IGR_FILETYPE_PUBLISHING

265 Hancom Hangul HWPX application/hwp+zip IGR_FILETYPE_WORD_PROCESSOR

Document Filters Implementation Guide 3.5 Document format codes

- 994/1268 -

3.6 Processing Options

Name Description Applies To

ARCHIVE_

IGNORE_

CHECKSUM

Enable or disable checksum validation for

extracted archive les.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

BMP_IGNORE_

MEMORY_

LIMITS

Enable or disable enforced memory limits when

processing large images.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

BW_MODE Set the value of Black-and-White Algorithm. \[-1 ..

7\]

Type: string Default: -1

document

CAD_PAGE_

HEIGHT

Set the default page height in points for CAD

documents with unknown page information.

Type: number:pixel Default: 0

canvas

CODEPAGE Specify the default character set for documents

with unspecied encoding.

Type: number Default: 0

document

CONTAINERS_

LIST_DIR

Enable or disable the rendering of container

directories when rendering to hi-def.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

DEFAULT_LCID Set the value of locale used for date conversion.

Type: number Default: 0

document

DETECT_

MACROS

Enable or disable reporting macro presence as

meta data.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

Document Filters Implementation Guide 3.6 Processing Options

- 995/1268 -

Name Description Applies To

DOCUMENT_

FOOTERS

Enable or disable adding page footers to hi-def

output

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

DOCUMENT_

HEADERS

Enable or disable adding page headers to hi-def

output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

EMAIL_

ATTACHMENT_

LINKS

\[ClassicHTML\] When set, this replaces the

"Attachments:" value in the HTML body of an

email. For each attachment, the suble-id will be

placed where "$$$" or "$$!" is found in the

template and the result will be put in the "HREF"

attribute of an "A" tag. Using $$$ will put double

quotes around the suble-id.

Type: string

document

EMAIL_FONT_

FAMILY_

OVERRIDE

Set the value of font family to change the default

font used when rendering email messages.

Type: string

document

EMAIL_FONT_

SIZE_

OVERRIDE

Changes the default font size used when rendering

email messages.

Type: number Default: 0

document

EMAIL_

OUTPUT_

HEADER

Enable or disable the injected header of email

messages.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

ENUMERATE_

IMAGES

Enable or disable image enumeration as subles.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

Set the value of image type to output when

processing PDF with ENUMERATE_IMAGES on.

document

Document Filters Implementation Guide 3.6 Processing Options

- 996/1268 -

Name Description Applies To

ENUMERATE_

IMAGES_PDF_

TYPE

Type: string:enum Default: AUTO

Possible Values: ['JPG', 'PNG', 'PPM', 'AUTO']

EXCELMODE Set the value of output mode for spreadsheet le

processing.

Type: string:enum Default: TEXT

Possible Values: ['TEXT', 'CSV', 'TSV', 'CST']

document

EXCELMODE_

TEXT_

FALLBACK

Enable or disable string-only extraction on a

document that cannot be converted to CSV.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

EXCEL_

PAGEBREAK_

BETWEEN_

SHEETS

Enable or disable page-break markers between

sheets when exporting to CSV

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

FIRST_PAGE Set the rst page to process from.

Type: number Default: 0

document

GIF_DECODE_

ALL_FRAMES

Enable or disable decoding of all frames of a GIF.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

GIF_

INTERLACED

Enable or disable interlaced GIF creation.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

GRAPHICS_

ANTIALIAS

Enable or disable anti-aliasing support for hi-def

output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document,

canvas

Document Filters Implementation Guide 3.6 Processing Options

- 997/1268 -

Name Description Applies To

GRAPHICS_

AUTOHINT

Enable or disable auto-hinting on the canvas

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document,

canvas

GRAPHICS_

DITHER

Enable or disable dithering for lower color output

types.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document,

canvas

GRAPHICS_

TEXTEMBEDDE

DBITMAP

Enable or disable embedded text bitmap support in

hi-def output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document,

canvas

GRAPHICS_

TEXTKERNING

Enable or disable text kerning support for hi-def

output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document,

canvas

GRAPHICS_

TEXTLCD

Enable or disable text LCD support for hi-def

output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document,

canvas

GRAPHICS_

TEXTLINEAR

Enable or disable linear text support in hi-def

output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document,

canvas

GRAPHICS_

TEXTSUBPIXEL

Enable or disable sub-pixel placement of text in hi-

def output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document,

canvas

Document Filters Implementation Guide 3.6 Processing Options

- 998/1268 -

Name Description Applies To

GRAPHIC_

DESATURATE

Enable or disable converting images to grayscale.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

GRAPHIC_

DESKEW

Enable or disable deskew of slightly rotated images

with scanned text.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

GRAPHIC_

DESPECKLE

Enable or disable noise reduction using a median

lter.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

GRAPHIC_DPI Set the dots per inch value for output images. Use

AUTO to preserve original DPI.

Type: number Default: 96

document,

canvas

GRAPHIC_DPI_

MAX

Set the maximum dots per inch for auto-adjusted

graphics when GRAPHIC_DPI=Auto

Type: number Default: 0

document

GRAPHIC_DPI_

MIN

Set the maximum dots per inch for Auto mode

graphic when GRAPHIC_DPI=Auto

Type: number Default: 0

document

GRAPHIC_

EFFECT

Set the value of graphic eects applied to image

output.

Type: string:enum

Possible Values: ['GRAYSCALE,', 'DESATURATE']

canvas

GRAPHIC_

HAIRLINE_

SUBPIXEL

Enable or disable sub-pixel rendering.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

GRAPHIC_

HEIGHT

Set the height of the generated page in pixels. The

width will be determined by the aspect ratio if not

specied.

document,

canvas

Document Filters Implementation Guide 3.6 Processing Options

- 999/1268 -

Name Description Applies To

Type: number:pixel Default: -1

GRAPHIC_MAX_

WIDTH

Set the maximum image size for rasterized vector

formats like PDF and AutoCAD.

Type: number:pixel Default: 3000

document,

canvas

GRAPHIC_

OUTPUT_WITH_

ALPHA

Enable or disable inclusion of alpha channel in hi-

def output images.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

GRAPHIC_PNG_

JPEG_DPI

Enable or disable using PNG and JPEG source

image DPI for full page images.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

GRAPHIC_

ROTATE

Set the value of page rotation angle.

Type: string:enum Default: 0

Possible Values: ['0', '90', '180', '270']

document,

canvas

GRAPHIC_

WIDTH

Set the width of the generated page in pixels. If

height is not specied, it will be calculated based

on the input document's aspect ratio.

Type: number:pixel Default: -1

document,

canvas

HDHTML_

ACCESSIBILITY

Enable or disable the inclusion of accessibility

information in HTML output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

HDHTML_

IMAGE_FORMAT

Set the value of image format for embedded

images in HTML5 output.

Type: string:enum

Possible Values: ['png', 'jpg', 'jpeg', 'gif', 'auto']

canvas

HDHTML_

INCLUDE_TAB_

LEADER

Enable or disable the inclusion injected tab leaders

as separate words with a data-tableader attribute.

canvas

Document Filters Implementation Guide 3.6 Processing Options

- 1000/1268 -

Name Description Applies To

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

HDHTML_

INCLUDE_

WORD_

INDEXES

Enable or disable the inclusion word coordinates in

HTML output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

HDHTML_

OUTPUT_

BOILERPLATE

Enable or disable generation of HTML boilerplate.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

HDHTML_

OUTPUT_

INJECT_FOOTER

Set the value of HTML content to inject in the

HEAD section of generated HD-HTML.

Type: string

canvas

HDHTML_

OUTPUT_

INJECT_HEAD

Set the value of HTML content to inject in the

HEAD section of generated output.

Type: string

canvas

HDHTML_

OUTPUT_

STYLES

Enable or disable generation of style sections for

HD-HTML output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

HDHTML_TITLE Set the value of HTML title for generated HDHTML.

Type: string

canvas

HDHTML_

WORD_RUNS

Enable or disable feature that merges similar

styled words into a single run.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

HOCR Enable or disable inclusion of HOCR attributes

when producing HTML or XML les in hi-def modes.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

Document Filters Implementation Guide 3.6 Processing Options

- 1001/1268 -

Name Description Applies To

HTML_IMAGES_

SCALE_TO_FIT

Enable or disable forced downscaling of images

attached to emails and messages.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

HTML_INLINE_

IMAGES

Enable or disable embedding inline image handling

in HTML output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

HTML_MAX_

FILESIZE

Set the maximum size, in bytes, of a HTML

document for error-free processing. Larger

documents may result in errors when processed.

Type: number Default: 20971520

document

HTML_MAX_

NESTED_

TABLES

Set the value of the maximum number of nested

tables allowed before an error is raised.

Type: number Default: 150

document

HTML_RASTER_

TEXT

Enable or disable the rasterization of text from

HTML les into at images when processing.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document,

canvas

HTML_SCRIPT \[ClassicHTML\] Used in conjunction with

EMAIL_ATTACHMENT_LINKS to inject text into the

output HTML to provide supporting code for the

attachment link handling.

Type: string

document

HTML_TEXT_

OVERLAY

Enable or disable text overlays when creating hi-

def HTML output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document,

canvas

HTTP_

EXTERNAL_

IMAGES

Enable or disable image downloading for HTML

documents in hi-def mode.

document

Document Filters Implementation Guide 3.6 Processing Options

- 1002/1268 -

Name Description Applies To

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

HTTP_PROXY Set the value of HTTP proxy server to use for

downloading images in HTML documents when

external images are allowed.

Type: string

document

HTTP_PROXY_

BYPASS

Set the value of bypassed proxy servers that

should not use the proxy setting.

Type: string

document

IMAGEURL Set the value of image lename prex.

Type: string

canvas

IMAGE_

PROCESSOR

Set the value of image processor to control how

embedded images are processed.

Type: string:enum Default: builtin

Possible Values: ['builtin', 'gdi', 'gdiplus', 'gdi+']

document

IMNET_CHAR_

SPACING

Set the inter-character spacing for IMNET overlays

to a specic point value.

Type: number:point Default: 0

document

IMNET_LINE_

HEIGHT

Set the height of each line for IMNET overlays in

points.

Type: number:point Default: 0

document

IMNET_

OFFSET_X

Set the horizontal oset for IMNET overlays in

points.

Type: number:point Default: 0

document

IMNET_

OFFSET_Y

Set the vertical oset for IMNET overlays in points.

Type: number:point Default: 0

document

IMNET_

OVERLAY_DIR

Set the directory where IMNET overlays are

searched for.

Type: string

document

Document Filters Implementation Guide 3.6 Processing Options

- 1003/1268 -

Name Description Applies To

IMNET_

OVERLAY_EXTS

Set the value of IMNET overlay extensions to

search for, delimited by comma.

Type: string

document

IMNET_

OVERLAY_FILE

Set the value of overlay image.

Type: string

document

ISYS_SOURCE Set the original le path and lename of the source

document for enhanced le type identication. The

le does not need to be accessible from this

location.

Type: string

document

JPEG_ENCODER Set the value of image encoder to use for JPEG

les, applicable on Windows with WIC.

Type: string:enum Default: NATIVE

Possible Values: ['NATIVE', 'WIC']

canvas

JPEG_QUALITY Set the quality of generated JPEG images to an

integer from 1 to 100. A higher value produces a

more detailed image.

Type: number Default: 100

canvas

JPEG_

REORIENT_

PAGES

Enable or disable reorienting JPEG images to

display top-down, left-to-right.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

JSON_FORMAT_

OUTPUT

Enable or disable adding new lines and indentation

to JSON output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

JSON_IMAGE_

FORMAT

Set the value of image format for embedded

images in JSON output.

Type: string:enum Default: PNG

Possible Values: ['PNG']

canvas

Document Filters Implementation Guide 3.6 Processing Options

- 1004/1268 -

Name Description Applies To

JSON_IMAGE_

QUALITY

Set the image compression quality for embedded

images in JSON output.

Type: number Default: 90

canvas

JSON_INCLUDE_

BOOKMARKS

Controls if bookmarks should be included in JSON

output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_

BOUNDS

Enable or disable inclusion of element bounds

information in JSON output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_

FORMS

Enable or disable inclusion of page form

information in JSON output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_

IMAGES

Enable or disable including image elements in

JSON output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_

IMAGE_DATA

Enable or disable including image data in JSON

output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_

METADATA

Enable or disable inclusion of document metadata

in JSON output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_

STYLES

Enable or disable inclusion of element style

information in JSON output.

canvas

Document Filters Implementation Guide 3.6 Processing Options

- 1005/1268 -

Name Description Applies To

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

JSON_INCLUDE_

WHITESPACE

Enable or disable inclusion of whitespace words in

JSON output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_

WORDS

Enable or disable inclusion of word-level

information in JSON output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

JSON_SKIP_

EMPTY_

PARAGRAPHS

Enable or disable inclusion of empty paragraphs in

JSON output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

LAYOUT_

LOCALE

Set the value of locale used for document

processing.

Type: string

document

LIMITS_PAGE_

COUNT

Set the maximum number of pages to process. Any

excess pages will result in an error.

Type: number Default: 1000

document

LIMIT_PAGES Set the maximum number of pages to process,

ideal for generating thumbnails.

Type: number Default: -1

document

LOCALTIME_

CONVERSION

Enable or disable the conversion of local times to

UTC when no timezone is provided.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

MARKDOWN_

COMPLEX_

TABLE_STYLE

Set the style for rendering complex tables in

Markdown format.

canvas

Document Filters Implementation Guide 3.6 Processing Options

- 1006/1268 -

Name Description Applies To

Type: string:enum Default: HTML

Possible Values: ['PIPE', 'GRID', 'HTML',

'PIPE_WITH_HTML']

MARKDOWN_

FLAVOR

Set the value of Markdown avor.

Type: string:enum Default: gfm

Possible Values: ['GFM', 'GPT']

canvas

MARKDOWN_

HEADERS_

STYLE

Set the style of Markdown headers.

Type: string:enum Default: ATX

Possible Values: ['ATX', 'SETEXT']

canvas

MARKDOWN_

HR_BETWEEN_

PAGES

Enable or disable inclusion of a horizontal rule

between pages in Markdown output

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

MARKDOWN_

INCLUDE_

BOOKMARKS

Enable or disable inclusion of bookmarks in

Markdown output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

MARKDOWN_

INCLUDE_

FIELDS

Enable or disable inclusion of text marked as elds

in generated Markdown.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

MARKDOWN_

INCLUDE_

FOOTERS

Enable or disable inclusion of text marked as a

page footer when generating Markdown.

Type: string:enum Default: OFF

Possible Values: ['ON', 'OFF', 'FIRST']

canvas

MARKDOWN_

INCLUDE_

HEADERS

Enable or disable inclusion of text marked as a

page headers when generating Markdown.

Type: string:enum Default: OFF

Possible Values: ['ON', 'OFF', 'FIRST']

canvas

Document Filters Implementation Guide 3.6 Processing Options

- 1007/1268 -

Name Description Applies To

MARKDOWN_

INCLUDE_

IMAGES

Enable or disable inclusion of image elements

when generating Markdown.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

MARKDOWN_

INCLUDE_

METADATA

Enable or disable inclusion of document metadata

in Markdown output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

MARKDOWN_

LF_AFTER_

BLOCK

Enable or disable new lines after each HTML block

element when generating Markdown.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

MARKDOWN_

METADATA_

FORMAT

Set the value of Markdown format for metadata

inclusion.

Type: string:enum Default: COMMENTS

Possible Values: ['YAML', 'TOML', 'JSON',

'COMMENTS']

canvas

MARKDOWN_

PREFERRED_

LINE_LENGTH

Set the preferred line length for wrapping in

Markdown.

Type: number Default: 80

canvas

MARKDOWN_

SIMPLE_TABLE_

STYLE

Set the rendering style for simple tables in

Markdown.

Type: string:enum Default: PIPE

Possible Values: ['PIPE', 'GRID', 'HTML',

'PIPE_WITH_HTML']

canvas

MARKDOWN_

TABLE_

PADDING

Enable or disable inclusion of padding on pipe style

tables in Markdown output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

document

Document Filters Implementation Guide 3.6 Processing Options

- 1008/1268 -

Name Description Applies To

MARKUP_

OPTIONS

Set the value of track-changes markup types. Must

be combined with SHOWHIDDEN. \[INS,DEL\]

Type: string Default: DE

METADATA_

NAME_

HYPHENATE

Enable or disable the hyphenation of metadata

names for HTML output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

MSPROJECT_

FONT

Set the value of font to use when converting MS

Project.

Type: string Default: Arial

document

MSPROJECT_

FONTSIZE

Set the font size used during MS Project

conversion.

Type: number:point Default: 8

document

MSPROJECT_

PAGE_HEIGHT

Set the value of page height in points.

Type: number:point Default: 612

document

MSPROJECT_

PAGE_WIDTH

Set the value of page width in points.

Type: number:point Default: 792

document

MSPROJECT_

ZOOM

Set the value of zoom to use when converting MS

Project.

Type: string Default: auto

document

OCR Enable or disable OCR processing of images.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

OCR_CACHE Set the location of OCR cache storage.

Type: string

document

OCR_ENGINE Set the value of OCR engine to use.

Type: string Default: TESSERACT

document

OCR_

LANGUAGE

Set the value of language for Optical Character

Recognition (OCR) processing.

document

Document Filters Implementation Guide 3.6 Processing Options

- 1009/1268 -

Name Description Applies To

Type: string Default: Eng

OCR_MIN_

WIDTH

Set the value of image minimum width for OCR

processing.

Type: number Default: 1000

document

OCR_

REORIENT_

PAGES

Enable or disable re-orientation of pages based on

orientation detection for OCR.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

ODF_

USERMETA

Enable or disable adding user-dened elds as

metadata.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

OFFICE_

COMMENT_

PAGE

Set the value of the page where comments are

extracted to when using

IGR_Get_Page_Annotations.

Type: string:enum Default: rst

Possible Values: ['rst', 'last']

document

OLM_DATE_

FIELD

Set the value of ordered list of XML properties

containing document date.

Type: string:enum

Possible Values: ['', 'OPFMessageCopyModDate',

'OPFMessageCopyReceivedTime',

'OPFMessageCopySentTime']

document

PAGE_

NUMBERS

Enable or disable this inclusion of injected page

numbers in hi-def output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

Document Filters Implementation Guide 3.6 Processing Options

- 1010/1268 -

Name Description Applies To

PAGE_TEXT_

SYMBOLS_TO_

UNICODE

Enable or disable mapping of symbol fonts (such

as Wingdings) to a similar Unicode font.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

PBM_MODE Set the format of saved PBM les to ASCII or

BINARY.

Type: string:enum Default: ASCII

Possible Values: ['ASCII', 'BINARY']

canvas

PDF_

ANNOTATIONS

Set the value of PDF annotations to draw,

excluding specic types by prexing with an

exclamation point (!)

Type: string

document

PDF_

BOOKMARKS

Enable or disable whether to include bookmarks in

the output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document,

canvas

PDF_

COMPRESSION

Set the value of compression type for generated

PDF output.

Type: string:enum Default: AUTO

Possible Values: ['AUTO']

canvas

PDF_

DEFAULTDPI

Set the DPI for bitmap scaling.

Type: number Default: 96

document

PDF_

DEHYPHENATE

Enable or disable removing hyphens from word

endings to express contractions as single words.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_ENCRYPT Enable or disable to apply encryption to the

generated PDF.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

Document Filters Implementation Guide 3.6 Processing Options

- 1011/1268 -

Name Description Applies To

PDF_ENCRYPT_

PERMISSIONS

Set the value of PDF permissions (see PDF

Reference 1.7, Table 3.20)

Type: string

canvas

PDF_IMAGE_

QUALITY

Set the image quality for PDF output, with higher

values indicating higher quality.

Type: number Default: 90

document

PDF_LAYOUT_

DETECTION

Enable or disable layout detection for PDF les.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_LAYOUT_

DETECTION_

DIAGNOSTICS_

MARKUP

Enable or disable the drawing of PDF layout

detection areas on output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_LINEARIZE Enable or disable PDF output linearization for Fast

Web View.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

PDF_MAX_

IMAGE_WIDTH

Set the maximum width of output images to this

pixel value.

Type: number:pixel Default: 3200

document

PDF_META Enable or disable whether metadata is included

with PDF documents.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

PDF_MIN_

WORD_BREAK_

SPACE

Specify the minimum space between characters

that constitutes a word-break.

Type: number Default: 0.1

document

PDF_

OWNERPASSW

ORD

Set the value of owner password used to decrypt

PDF documents.

Type: string

document

Document Filters Implementation Guide 3.6 Processing Options

- 1012/1268 -

Name Description Applies To

PDF_PAGE_

NUMBERS

Enable or disable including page numbers on PDF

text-only output.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

PDF_

PHYSLAYOUT

Enable or disable whether to maintain the

document's physical layout in the output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_

PRESERVE_

ORIGINAL

Enable or disable preserving original page data

when converting PDF to PDF.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

PDF_

PRESERVE_

PAGE_SIZE

Enable or disable whether to maintain the page

size when converting from an image to PDF.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_RASTER_

TEXT

Enable or disable rendering text from PDF les as

raster images. This controls the handling of text in

PDFs.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

PDF_SET_

OWNER_

PASSWORD

Set the value of master password controlling

document edits.

Type: string

canvas

PDF_SET_

USER_

PASSWORD

Set the value of default view password.

Type: string

canvas

PDF_TABLE_

DETECTION

Enable or disable table detection.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

Document Filters Implementation Guide 3.6 Processing Options

- 1013/1268 -

Name Description Applies To

PDF_TABLE_

EDGE_MIN_

LENGTH

Set the value of minimum edge length considered

when detecting table edges in PDF les.

Type: number Default: 11

document

PDF_TABLE_

HORZ_

STRATEGY

Set the value of horizontal table detection strategy

for detecting tables in PDF les.

Type: string:enum Default: LINES

Possible Values: ['LINES']

document

PDF_TABLE_

INTERSECTION_

TOLERANCE

Set the tolerance value to determine edge

combination into cells. This value helps control the

precision of cell formation when detecting tables in

PDF les.

Type: number Default: 3

document

PDF_TABLE_

INTERSECTION_

X_TOLERANCE

Set the value of edge intersection tolerance along

the x-axis. This determines how close edges must

be to be considered intersecting when detecting

tables in PDF les.

Type: number Default: 3

document

PDF_TABLE_

INTERSECTION_

Y_TOLERANCE

Set the value of Y-axis tolerance for edge

intersection when detecting tables in PDF les.

Type: number Default: 3

document

PDF_TABLE_

JOIN_

TOLERANCE

Set the value of tolerance for joining line segments

when detecting tables in PDF les.

Type: number Default: 3

document

PDF_TABLE_

JOIN_X_

TOLERANCE

Set the value of x-axis tolerance for joining line

segments, controlling how close line ends can be

before being considered a single segment when

detecting tables in PDF les.

Type: number Default: 3

document

PDF_TABLE_

JOIN_Y_

TOLERANCE

Set the value of y-axis tolerance for joining line

segments, controlling how close line ends can be

before being considered a single segment when

detecting tables in PDF les.

document

Document Filters Implementation Guide 3.6 Processing Options

- 1014/1268 -

Name Description Applies To

Type: number Default: 3

PDF_TABLE_

MIN_CELL_

HEIGHT

Set the minimum cell height for table detection

when detecting tables in PDF les.

Type: number Default: 8

document

PDF_TABLE_

MIN_CELL_

WIDTH

Set the minimum cell width for table detection

when detecting tables in PDF les.

Type: number Default: 8

document

PDF_TABLE_

MIN_COLS

Set the minimum number of columns required for

table detection in PDF les.

Type: number Default: 2

document

PDF_TABLE_

MIN_ROWS

Set the minimum number of rows required for table

detection in PDF les.

Type: number Default: 1

document

PDF_TABLE_

SNAP_

TOLERANCE

Set the value of line tolerance to control parallel

line snapping for detecting tables in PDF les.

Type: number Default: 3

document

PDF_TABLE_

SNAP_X_

TOLERANCE

Set the value of x-axis tolerance for snapping

parallel lines when detecting tables in PDF les.

Type: number Default: 3

document

PDF_TABLE_

SNAP_Y_

TOLERANCE

Set the value of y-axis tolerance for snapping

parallel lines when detecting tables in PDF les.

Type: number Default: 3

document

PDF_TABLE_

VERT_

STRATEGY

Set the value of horizontal vertical detection

strategy for detecting tables in PDF les.

Type: string:enum Default: LINES

Possible Values: ['LINES']

document

Document Filters Implementation Guide 3.6 Processing Options

- 1015/1268 -

Name Description Applies To

PDF_TAGGED Enable or disable the creation of PDF with

accessibility information.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

PDF_

TRANSPARENT_

BACKGROUND

Enable or disable transparent background

rendering for the PDF.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_

USERPASSWOR

Set the value of password for decrypting PDF

documents.

Type: string

document

PDF_VERSION Set the value of the compliance level of generated

PDF les. Note: Image transparency is lost when

generating PDFA-1.

Type: string:enum Default: 1.7

Possible Values: ['1.7', 'A1', 'A1A', 'A1B', 'A2',

'A2U', 'PDF1.7', 'PDFA', 'PDFA1', 'PDFA1A',

'PDFA1B', 'PDFA2', 'PDFA2U']

canvas

PDF_WORD_

ORDER

Set the value of word order to "Reading" to extract

text as if read, or "Document" to match original

document structure.

Type: string:enum Default: READING

Possible Values: ['READING', 'DOCUMENT']

document

PDF_XFA_

ENABLED

Enable or disable XFA rendering

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_XFA_

ERROR

Enable or disable detection of dynamic XFA

content.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

Document Filters Implementation Guide 3.6 Processing Options

- 1016/1268 -

Name Description Applies To

PDF_XMPMETA Enable or disable whether to include XMP

metadata in the output, requiring an opening

document with a metadata ag enabled.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

PGM_MODE Set the mode for PGM le saving to ASCII or binary.

Type: string:enum Default: ASCII

Possible Values: ['ASCII', 'BINARY']

canvas

PNG_

BITSPERPIXEL

Set the value of bits-per-pixel when generating

PNG.

Type: string:enum Default: SOURCE

Possible Values: ['SOURCE', 'AUTO', '1', '8', '16',

'24', '32']

canvas

PNG_ENCODER Set the value of image encoder for JPEG les on

Windows using WIC.

Type: string:enum Default: NATIVE

Possible Values: ['NATIVE', 'WIC']

canvas

PPM_MODE Set the mode for PPM le saving to ASCII or binary.

Type: string:enum Default: ASCII

Possible Values: ['ASCII', 'BINARY']

canvas

PROCESS_

TIMEOUT

Set the time limit for processing documents, in

milliseconds.

Type: number Default: 0

document

RASTER_

DRAWINGS

Enable or disable the conversion of embedded

drawings to bitmap in vector formats.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

REDACT Set the value of redacting words on nominated

pages.

Type: string

document

Document Filters Implementation Guide 3.6 Processing Options

- 1017/1268 -

Name Description Applies To

RESAMPLE_

IMAGES

Enable or disable image resampling for vector-

based output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

SCALE Set the scale that the page is rendered.

Type: number Default: 1

document

SHOWHIDDEN Enable or disable showing normally invisible page

elements.

Type: unknown Default: "o"

document

SHOWHIDDEN_

EXCEL_REFS

Enable or disable the inclusion of hidden Excel

references.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

SLIDE_

COMMENTS

Enable or disable showing slide comments in

presentations.

Type: string:enum

Possible Values: ['OFF', 'ON', 'APPEND']

document

SLIDE_NOTES Enable or disable showing note pages in

presentations.

Type: string:enum

Possible Values: ['OFF', 'ON', 'APPEND']

document

SLIDE_NOTES_

FORMATTING

Enable or disable slide note formatting.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

SPREADSHEET_

COLLAPSE_

ROWS

Enable or disable collapsing of spreadsheet rows

with duplicates. Set to 'OFF', 'NO', or less than 1 to

disable.

Type: number Default: "100"

document

Document Filters Implementation Guide 3.6 Processing Options

- 1018/1268 -

Name Description Applies To

SPREADSHEET_

PAGEDIRECTIO

Set the value of page direction to determine how

pages are ordered when a sheet does not t on

one page.

Type: string:enum Default: OverThenDown

Possible Values: ['OverThenDown',

'DownThenOver']

SPREADSHEET_

SHEETS

Set to the sheets to render. Set to ALL or a comma-

separated list of numbers or ranges. For example,

1,2,5..7

Type: string Default: ALL

document

SVG_

COALESCE_

RUNS

Enable or disable combining similar text styles into

a single run when rendering SVG elements.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

SVG_FLATTEN_

TEXT

Enable or disable rendering of outputs text as

paths instead of text elements.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

SVG_INCLUDE_

CHAR_OFFSET

Enable or disable inclusion of character osets.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

SVG_INLINE_

IMAGES

Enable or disable embedded images as inline

elements in SVG.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

TEXT_DEFAULT_

FONT

Set the value of default font to use for non-HD

image rendering.

Type: string Default: Courier New

document

Document Filters Implementation Guide 3.6 Processing Options

- 1019/1268 -

Name Description Applies To

TEXT_DEFAULT_

FONT_SIZE

Set the default font size for non-HD images

rendering.

Type: number:point Default: 10

document

TEXT_

FALLBACK

Enable or disable text fallback rendering for

documents that do not directly support hi-def

processing.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

TEXT_

FALLBACK_

MODE

Set the value of text fallback mode to specify how

to handle metadata for non-HD formats.

Type: string:enum

Possible Values: ['', 'BODYONLY']

document

TEXT_INLINE_

LINKS

Enable or disable the writing of links in text mode

inline or separately.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

TEXT_MARGIN_

BOTTOM

Set the bottom margin to use for formats without

page or margin info, measured in points.

Type: number:point Default: 36

document

TEXT_MARGIN_

LEFT

Set the value of left margin to use for formats

without page or margin information, in points.

Type: number:point Default: 36

document

TEXT_MARGIN_

RIGHT

Set the value of right margin to use for formats

without page or margin information, in points.

Type: number:point Default: 36

document

TEXT_MARGIN_

TOP

Set the value of top margin to use for formats

without page or margin information, in points.

Type: number:point Default: 36

document

Set the character limit for text-only lines.

Type: number Default: 0

document

Document Filters Implementation Guide 3.6 Processing Options

- 1020/1268 -

Name Description Applies To

TEXT_PAGE_

CHARS_PER_

LINE

TEXT_PAGE_

FOOTER

Enable or disable inclusion of the footer when

rendering text pages.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

TEXT_PAGE_

HEIGHT

Set the page height to a specied number of

points. This value determines the page width for

formats without page information.

Type: number:point Default: 792

document

TEXT_PAGE_

LINES_PER_

PAGE

Set the line count per page for formats without

layout details.

Type: number Default: 0

document

TEXT_PAGE_

ORIENTATION

Set the page orientation to portrait or landscape.

Type: string:enum Default: PORTRAIT

Possible Values: ['PORTRAIT', 'LANDSCAPE']

document

TEXT_PAGE_

SIZE

Set the value of output page size using ISO

standard or metric page sizes. Cannot be used with

TEXT_PAGE_WIDTH or TEXT_PAGE_HEIGHT.

Type: string:enum

Possible Values: ['', 'LETTER', 'LEGAL', 'TABLOID',

'LEDGER', 'A0', 'A1', 'A2', 'A3', 'A4', 'A5', 'A6',

'A7', 'A8', 'A9', 'A10', 'B0', 'B1', 'B2', 'B3', 'B4',

'B5', 'B6', 'B7', 'B8', 'B9', 'B10', 'C0', 'C1', 'C2',

'C3', 'C4', 'C5', 'C6', 'C7', 'C8', 'C9', 'C10']

document

TEXT_PAGE_

WIDTH

Set the page width to a specied number of points.

This value determines the page width for formats

without page information.

Type: number:point Default: 612

document

TEXT_PAGE_

WORD_WRAP

Enable or disable word wrap for formats without

layout information.

document

Document Filters Implementation Guide 3.6 Processing Options

- 1021/1268 -

Name Description Applies To

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

TIFF_

BITSPERPIXEL

Set the value of bit depth to specify the number of

bits per pixel in the TIFF output.

Type: string:enum

Possible Values: ['0', '1', '2', '4', '8', '24']

canvas

TIFF_

BYTEORDER

Set the byte order of the generated TIFF image.

Type: string:enum Default: NATIVE

Possible Values: ['NATIVE', 'LE', 'BE']

canvas

TIFF_

COMPRESSION

Set the value of compression type for the

generated TIFF image.

Type: string:enum Default: LZW

Possible Values: ['NONE', 'PACKED', 'JPEG', 'LZW',

'GROUP3', 'GROUP4', 'GROUP6']

canvas

TIFF_IGNORE_

DECODE_ERR

Enable or disable feature to control error handling

for TIFF image decoding.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

TIFF_IGNORE_

MEMORY_

LIMITS

Enable or disable enforced memory limits when

processing large TIFF images.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

TIFF_

PHOTOMETRIC_

MINISBLACK

Enable or disable feature for controlling black and

white TIFF output representation.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

TIFF_

REORIENT_

PAGES

Enable or disable the reorientation of TIFF images

for top-down, left-to-right display.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

Document Filters Implementation Guide 3.6 Processing Options

- 1022/1268 -

Name Description Applies To

TIFF_SUSPECT_

DPI_RATIO_

ERROR

Enable or disable suspect DPI checks when

processing TIFF les.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

USE_MAPPED_

FONTS

Enable or disable use of actual fonts instead of

stored fonts. This aects how fonts are displayed in

generated output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

VISIO_FOOTER Enable or disable injected footer on Visio

documents

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

VISIO_RASTER_

TEXT

Enable or disable rendering Visio text in HTML

mode as raster images with transparent text

overlays.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

document

WATERMARK Set the watermark text to apply to pages when

rendering to hi-def image formats.

Type: string

canvas

WATERMARK_

COLOR

Set the value of watermark text color.

Type: string Default: #000000

canvas

WATERMARK_

DIRECTION

Set the direction of watermark text when rendering

to HD image formats.

Type: string:enum Default: LBRT

Possible Values: ['LBRT', 'LTRB', 'LR']

canvas

WATERMARK_

FONT

Set the value of font used for watermark rendering.

Type: string Default: Aria

canvas

Document Filters Implementation Guide 3.6 Processing Options

- 1023/1268 -

Name Description Applies To

WATERMARK_

OPACITY

Set the transparency level of watermark text as a

value between 0 and 1.

Type: number Default: 0.1

XML_

FORMATTED

Enable or disable formatting XML input to show

only text content.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

XML_

FORMATTED_

WITH_

ATTRIBUTES

Enable or disable the inclusion of attribute names

and values in formatted XML.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

XML_

FORMATTED_

WITH_

NODENAMES

Enable or disable including node names in

formatted XML.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

document

XML_

HEADINGS_

ONLY

Enable or disable feature extracting headings from

structured XML.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

XML_IMAGES Enable or disable inclusion of image data in

structured XML outputs. Images will be output

inline, base-64 encoded.

Type: bool Default: ON

Possible Values: ['ON', 'OFF']

canvas

XML_INCLUDE_

FORMS

Enable or disable including form elements in

structured XML output.

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

canvas

Enable or disable suppression of empty paragraphs

in XML output.

canvas

Document Filters Implementation Guide 3.6 Processing Options

- 1024/1268 -

Name Description Applies To

XML_

SUPPRESS_

EMPTY_PARA

Type: bool Default: OFF

Possible Values: ['ON', 'OFF']

Document Filters Implementation Guide 3.6 Processing Options

- 1025/1268 -

3.7 Third-Party Libraries

3.7.1 7-zip 23.01

License: LZMA-SDK-9.22

3.7.2 bcl 1.2.11

3.7.3 bzip2 1.0.8

License: bzip2-1.0.8

LZMA SDK is written and placed in the public domain by Igor Pavlov.

Some code in LZMA SDK is based on public domain code from another developers: 1)

PPMd var.H (2001): Dmitry Shkarin 2) SHA-256: Wei Dai (Crypto++ library)

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the

original LZMA SDK code, either in source code form or as a compiled binary, for

any purpose, commercial or non-commercial, and by any means.

LZMA SDK code is compatible with open source licenses, for example, you can

include it to GNU GPL or GNU LGPL code.

* This software is provided 'as-is', without any express or implied

* warranty. In no event will the authors be held liable for any damages

* arising from the use of this software.

* Permission is granted to anyone to use this software for any purpose,

* including commercial applications, and to alter it and redistribute it

* freely, subject to the following restrictions:

* 1. The origin of this software must not be misrepresented; you must not

* claim that you wrote the original software. If you use this software

* in a product, an acknowledgment in the product documentation would

* be appreciated but is not required.

* 2. Altered source versions must be plainly marked as such, and must not

* be misrepresented as being the original software.

* 3. This notice may not be removed or altered from any source

* distribution.

* Marcus Geelnard

* marcus.geelnard at home.se

--------------------------------------------------------------------------

Document Filters Implementation Guide 3.7 Third-Party Libraries

- 1026/1268 -

3.7.4 chrome 103.0.5060.123

License: Apache-2.0

This program, "bzip2", the associated library "libbzip2", and all

rights reserved.

Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions

are met:

1. Redistributions of source code must retain the above copyright

notice, this list of conditions and the following disclaimer.

2. The origin of this software must not be misrepresented; you must

not claim that you wrote the original software. If you use this

software in a product, an acknowledgment in the product

documentation would be appreciated but is not required.

3. Altered source versions must be plainly marked as such, and must

not be misrepresented as being the original software.

4. The name of the author may not be used to endorse or promote

products derived from this software without specific prior written

permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS

OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY

DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE

GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,

WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Julian Seward, [email protected]

bzip2/libbzip2 version 1.0.8 of 13 July 2019

--------------------------------------------------------------------------

// Redistribution and use in source and binary forms, with or without

// modification, are permitted provided that the following conditions are

// met:

// * Redistributions of source code must retain the above copyright

// notice, this list of conditions and the following disclaimer.

// * Redistributions in binary form must reproduce the above

// copyright notice, this list of conditions and the following disclaimer

// in the documentation and/or other materials provided with the

// distribution.

Document Filters Implementation Guide 3.7.4 chrome 103.0.5060.123

- 1027/1268 -

// * Neither the name of Google Inc. nor the names of its

// contributors may be used to endorse or promote products derived from

// this software without specific prior written permission.

// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Apache License

Version 2.0, January 2004

https://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,

and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by

the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all

other entities that control, are controlled by, or are under common

control with that entity. For the purposes of this definition,

"control" means (i) the power, direct or indirect, to cause the

direction or management of such entity, whether by contract or

otherwise, or (ii) ownership of fifty percent (50%) or more of the

outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity

exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,

including but not limited to software source code, documentation

source, and configuration files.

"Object" form shall mean any form resulting from mechanical

transformation or translation of a Source form, including but

not limited to compiled object code, generated documentation,

and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or

Object form, made available under the License, as indicated by a

(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object

form, that is based on (or derived from) the Work and for which the

editorial revisions, annotations, elaborations, or other modifications

Document Filters Implementation Guide 3.7.4 chrome 103.0.5060.123

- 1028/1268 -

represent, as a whole, an original work of authorship. For the purposes

of this License, Derivative Works shall not include works that remain

separable from, or merely link (or bind by name) to the interfaces of,

the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including

the original version of the Work and any modifications or additions

to that Work or Derivative Works thereof, that is intentionally

submitted to Licensor for inclusion in the Work by the copyright owner

or by an individual or Legal Entity authorized to submit on behalf of

the copyright owner. For the purposes of this definition, "submitted"

means any form of electronic, verbal, or written communication sent

to the Licensor or its representatives, including but not limited to

communication on electronic mailing lists, source code control systems,

and issue tracking systems that are managed by, or on behalf of, the

Licensor for the purpose of discussing and improving the Work, but

excluding communication that is conspicuously marked or otherwise

designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity

on behalf of whom a Contribution has been received by Licensor and

subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of

this License, each Contributor hereby grants to You a perpetual,

worldwide, non-exclusive, no-charge, royalty-free, irrevocable

publicly display, publicly perform, sublicense, and distribute the

Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of

this License, each Contributor hereby grants to You a perpetual,

worldwide, non-exclusive, no-charge, royalty-free, irrevocable

(except as stated in this section) patent license to make, have made,

use, offer to sell, sell, import, and otherwise transfer the Work,

where such license applies only to those patent claims licensable

by such Contributor that are necessarily infringed by their

Contribution(s) alone or by combination of their Contribution(s)

with the Work to which such Contribution(s) was submitted. If You

institute patent litigation against any entity (including a

cross-claim or counterclaim in a lawsuit) alleging that the Work

or a Contribution incorporated within the Work constitutes direct

or contributory patent infringement, then any patent licenses

granted to You under this License for that Work shall terminate

as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the

Work or Derivative Works thereof in any medium, with or without

modifications, and in Source or Object form, provided that You

meet the following conditions:

(a) You must give any other recipients of the Work or

Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices

stating that You changed the files; and

that You distribute, all copyright, patent, trademark, and

Document Filters Implementation Guide 3.7.4 chrome 103.0.5060.123

- 1029/1268 -

attribution notices from the Source form of the Work,

excluding those notices that do not pertain to any part of

the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its

distribution, then any Derivative Works that You distribute must

include a readable copy of the attribution notices contained

within such NOTICE file, excluding those notices that do not

pertain to any part of the Derivative Works, in at least one

of the following places: within a NOTICE text file distributed

as part of the Derivative Works; within the Source form or

documentation, if provided along with the Derivative Works; or,

within a display generated by the Derivative Works, if and

wherever such third-party notices normally appear. The contents

of the NOTICE file are for informational purposes only and

do not modify the License. You may add Your own attribution

notices within Derivative Works that You distribute, alongside

or as an addendum to the NOTICE text from the Work, provided

that such additional attribution notices cannot be construed

as modifying the License.

You may add Your own copyright statement to Your modifications and

may provide additional or different license terms and conditions

for use, reproduction, or distribution of Your modifications, or

for any such Derivative Works as a whole, provided Your use,

reproduction, and distribution of the Work otherwise complies with

the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,

any Contribution intentionally submitted for inclusion in the Work

by You to the Licensor shall be under the terms and conditions of

this License, without any additional terms or conditions.

Notwithstanding the above, nothing herein shall supersede or modify

the terms of any separate license agreement you may have executed

with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade

names, trademarks, service marks, or product names of the Licensor,

except as required for reasonable and customary use in describing the

origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or

agreed to in writing, Licensor provides the Work (and each

Contributor provides its Contributions) on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

implied, including, without limitation, any warranties or conditions

of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A

PARTICULAR PURPOSE. You are solely responsible for determining the

appropriateness of using or redistributing the Work and assume any

risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,

whether in tort (including negligence), contract, or otherwise,

unless required by applicable law (such as deliberate and grossly

negligent acts) or agreed to in writing, shall any Contributor be

liable to You for damages, including any direct, indirect, special,

incidental, or consequential damages of any character arising as a

result of this License or out of the use or inability to use the

Work (including but not limited to damages for loss of goodwill,

Document Filters Implementation Guide 3.7.4 chrome 103.0.5060.123

- 1030/1268 -

3.7.5 cld2

License: Apache-2.0

work stoppage, computer failure or malfunction, or any and all

other commercial damages or losses), even if such Contributor

has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing

the Work or Derivative Works thereof, You may choose to offer,

and charge a fee for, acceptance of support, warranty, indemnity,

or other liability obligations and/or rights consistent with this

License. However, in accepting such obligations, You may act only

on Your own behalf and on Your sole responsibility, not on behalf

of any other Contributor, and only if You agree to indemnify,

defend, and hold each Contributor harmless for any liability

incurred by, or claims asserted against, such Contributor by reason

of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following

boilerplate notice, with the fields enclosed by brackets "[]"

replaced with your own identifying information. (Don't include

the brackets!) The text should be enclosed in the appropriate

comment syntax for the file format. We also recommend that a

file or class name and description of purpose be included on the

same "printed page" as the copyright notice for easier

identification within third-party archives.

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

Apache License

Version 2.0, January 2004

http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,

and distribution as defined by Sections 1 through 9 of this document.

Document Filters Implementation Guide 3.7.5 cld2

- 1031/1268 -