BinaryDOM SDK examples

BinaryDOM package contains several examples which help to understand BinaryDOM technology and start working with it. Here is a list of them with brief explanations:

BinReader
This example shows how to parse binary document using some known schema. Result of parsing can be serialized to a binary file and saved as a 'debug' output to check binary tree structure.

DocumentValidator
This example creates bitmap image document from scratch and validates it against bitmap document schema. Demonstrates binary document creation and validation techniques.

QueryExtractor
This example allows you to apply BinPath Expression query to a document. Example uses document file, schema file and query represented as a parameter in a commend line. Result of query can be serialized to a binary file and saved as a 'debug' output.

SchemaParser
This example shows how to parse and compile schemas and get all errors and warnings information. This tool could be useful in your own schemas troubleshooting.

SchemaSet
Provides an example how work with high-level BinSchemaSet class, load documents (by extension and by mime type) using this class and handle possible errors.

ExtractTextFromRTF
Example of complex data conversion operation. It uses modified RTF document schema which includes alternate view for the document. This view collects all text elements from document and uses RTFUnescape plugin to unescape non-English symbols and convert them to ANSI text. The example itself only parses a document, gets AlternateView from it and saves the result to a file. To use this example, you have to copy RTFUnescape.dll from RTFUnescape example to %CommonAppData%\Mirapalcid\BinaryDOM\Plugins folder.

RegTool
Provides an example how use registration functionality. With this example, you may check registration status, register your copy of BinaryDOM Library or extend trial period.

RTFUnescape
Provides an example how to build a data conversion plugin which could be used in AlterateView operations. This plugin should be used in conjunction with ExtractTextFromRTF example as a data conversion plugin.

DeflatePlugin
Provides an example how to build a data conversion (standard .Net deflate compression/decompression) plugin which could be used in AlterateView operations.

FuncPlugin
Provides an example how to build a function plugin which could be used in expressions. Function in this example calculates average value of a given collection of nodes.

See also: