Name 

Description 

 

AFDCoreDoc 

This class is the intermediate layer between the AFFileContext and the LSDocument. Typically, this should not be used directly unless no other way of doing things exists. It can be used for raw file IO to the document. 

 

AFFileContext 

Enables low level reading and writing to the zip file. Should be avoided in most cases. For most operations, getting a file handle in the userdata/ is sufficient. You can use the Document and LSDocument classes to get a file handle. 

 

DocumentInfo 

The document info object exists once in each AFD. Any modifications to this structure will automatically be loaded and stored when the AFD is loaded or stored. In the document info, meta data about the AFD is stored--for example, the author. 

 

Ellipse 

Describes a ellipse suspended between the upper-left corner and lower-right corner. If the two coordinates are not in this order, other functions might fail to work. 

 

FileIterator 

Enables iteration over files in a LSFile object that points to a directory. Typically, it is easier to iterate over a directory using foreach than using the iterator directly. 

 

GfxBox 

Draws a simple box on the page. A box may explicitly specify its location on the page. Alternatively, a box may be linked to a Shape bounding box. In that case, it is placed on the page so that it aligns with the bounding box. In order not to link the box to a region, you must pass the value -1 to the method. 

 

GfxClearPattern 

Clears pattern from a part of the page. 

 

GfxCMYKColor 

Changes the color of succeeding objects in the collection to the specified CMYK color. Layers of graphic elements are rendered in z-order. The lowest z-order layer is painted first, and the highest z-order layer is painted last. Consequently, the lower z-order layers are conceived of as "farther" from the human viewer of a screen (or printed page). And the higher z-order layers are "closer" to the human viewer. 

 

GfxDotcode 

Creates a dotcode object. (This is not currently used in the Livescribe Platform.) 

 

GfxDrawingArea 

Adds a DrawingArea to a part of the page. A DrawingArea object has the native coordinates of the location on the page. 

 

GfxElement 

The graphics element superclass. Subclasses include Livescribe.DesktopSDK.AFP.GfxDrawingArea GfxDrawingArea and Livescribe.DesktopSDK.AFP.GfxImage GfxImage. 

 

GfxElementIterator 

Enables in-order iteration over all the elements in the collection. There are high-level foreach() iterators available in the PenData API, and those are simpler to use. Typically, it is easier to iterate over a GraphicsCollection using foreach than using the iterator directly. 

 

GfxImage 

An image object that links to an image file. An image may explicitly specify its location on the page. Alternatively, an image may be linked to a Shape bounding box. In that case, it is placed on the page so that it aligns with the bounding box. In order not to link the image to a region, you must pass the value -1 to the method. 

 

GfxPattern 

Pattern is applied to a region from the same page and copy or from a different page and/or copy. 

 

GfxPidget 

Works like GfxPattern but enables pattern to be copied from another AFD. 

 

GfxPidgetBox 

A pidget box object draws a box with rounded corners on the page. A pidget box may explicitly specify its location on the page. Alternatively, a pidget box may be linked to a Shape bounding box. In that case, it is placed on the page so that it aligns with the bounding box. In order not to link the pidget box to a region, you must pass the value -1 to the method. 

 

GfxRGBColor 

Changes the color of succeeding objects in the graphics collection to the specified RGB color. Layers of graphics are rendered in z-order. The lowest z-order layer is painted first, and the highest z-order layer is painted last. Consequently, the lower z-order layers are conceived of as "farther" from the human viewer of a screen (or printed page). And the higher z-order layers are "closer" to the human viewer. 

 

GfxScale 

Changes the scale for the objects suceeding the scale object. This enables you to use, for example "mm," to describe the location of objects. Layers of graphics are rendered in z-order. The lowest z-order layer is painted first, and the highest z-order layer is painted last. Consequently, the lower z-order layers are conceived of as "farther" from the human viewer of a screen (or printed page). And the higher z-order layers are "closer" to the human viewer. 

 

GfxText 

A text element with specified font and other metrics. 

 

GraphicsCollection 

A graphics collection contains the visible elements of a page in an AFD. Layers of graphics are rendered in z-order. The lowest z-order layer is painted first, and the highest z-order layer is painted last. Consequently, the lower z-order layers are conceived of as "farther" from the human viewer of a screen (or printed page). And the higher z-order layers are "closer" to the human viewer. Objects that overlap will overdraw each other, whether rendering to screen or on a printer.
The most important elements are the GfxImage element and the GfxDrawingArea element. 

 

GraphicsId 

A GraphicsId is a a 64-bit number that encodes the properties of a GfxElement on a page.  

 

InputStream 

An InputStream is an interface that enables you to read bytes from an arbitrary source. For example, you can read from an AFD or a file in the local file system. 

 

Intersect 

Contains constants that are returned from RegionCollection.Intersect and Shape.Intersect methods. 

 

ItemId 

The ItemId is a super class with the common properties of RegionId and GraphicsId.  

 

KeyPair 

An encryption key pair is used to sign licenses. 

 

License 

A license is a AFP pattern license and gives rights to use a pattern range for different purposes (permissions). 

 

LineSegment 

Describes a line segment suspended between two points. 

 

LSDocument 

Encapsulates a paper document(AFD). A document consists of PageTemplates which represent the pages. A document can be printed multiple times with different pattern and these are called copies. When accessing data for a specific PageTemplate and copy, the PageInstance object is used. 

 

LSFile 

Encapsulates a file path and its context. Using this object, files can be copied between the file system and an AFD, for example, and also InputSreams and OutputStreams can be opened. 

 

Metrics 

Provides simple methods to convert between various useful scales. It also contains definitions for most international page sizes in Anoto Units (AU). 

 

OutputStream 

An OutputStream is an interface that enables writing bytes to an arbitrary target. You can write to an AFD or a file on the local file system. 

 

PageAddress 

A PageAddress is a 64-bit number that uniquely identifies a pattern page of the Livescribe pattern. The PageAddress class provides convenience methods to manipulate PageAddresses. A PageAddress is written in the format Segment.Shelf.Book.Page (Ex: 2208.1.23.2). 

 

PageInstance 

A page instance is a object that encapsulates a page and copy for a particular document. A page instance is mostly used to read strokes, dynamic regions and other things that vary between different pages of pattern. 

 

PageTemplate 

A page template is a page in a document. A document supports referencing the same template multiple times. This can enable, for example, notebooks to be created with identical left and right pages multiple times. A page template is owned by the document and stored when the document is stored. A page template object should not be created on its own. Instead, it should be created by adding a page to the document and getting back a reference to the template. 

 

PenId 

A pen ID is a 64-bit number that uniquely identifies a smartpen. When expressed in string format, it is called a "pen serial." For example: AAA-AAA-AAA-AA. The pen serial is used frequently throughout the PenData API.
A pen ID is created by Livescribe when the smartpen is manufactured. 

 

Point 

Describes the location of a point X,Y. 

 

Polygon 

A Polygon is a region which is suspended from a number of coordinates and is closed from the last to the first coordinate. 

 

Polyline 

A Polyline is a line passing through a number of coordinates. 

 

PrinterList 

A list of printers to which the current desktop computer currently has access. This class also contains static methods to generate postscript and print AFDs. Unfortunately, documentation is scarce here. Please consult the Paper Editor documentation and check the Print Dialog in the Paper Editor to see what options are available. 

 

PropertyCollection 

A property collection is a collection of key-value pairs that uses a 64-bit number as the key and a string as the value. The property collection can be used in many ways to store data. Property collections can be attached to a PageTemplate or PageInstance. There are functions in those classes to attach a property collection. The property collection is exactly the same format on disk as the property collection used in the smartpen so this class can be used to read the smartpen output. 

 

PropertyIterator 

Iterator enables in order iteration over all the elements in the collection. Typically it is easier to iterate over a PropertyCollection using foreach than using the iterator directly . 

 

Rectangle 

Encapsulates a rectangle suspended between the upper-left corner and lower-right corner. The two coordinates must be specified in this order; otherwise, functions might fail to work. 

 

RegionCollection 

The RegionCollection class provides a collection to store regions. Regions can be either (1) static regions on preprinted content or (2) dynamic regions created by the smartpen at runtime. A region collection has log(n) insert, delete, search performance. The 64-bit number used when accessing regions in a collection is the RegionId. It should be managed using the regionId class.  

 

RegionId 

A RegionId is a a 64-bit number that encodes the properties of a Region on a page.  

 

Shape 

In the underlying C++ code wrapped by the C# AFP API Wrapper, Shape is the superclass for all other shape types (for example: Rectangle, Polygon). However, in the AFP API Wrapper, shapes like Rectangle and Polygon do not actually derive from Shape. Instead, most of the classes defining a kind of shape have a implicit cast to Shape. Hence, you can use one of those objects wherever a Shape is required--without needing an explicit cast. The difference in your code will be negligible, but the class inheritance hierarchy in the C# wrapper is greatly simplified. 

 

StringList 

A string list is a list of strings. 

 

StringListIterator 

A string list iterator enables iteration of a StringList. 

 

StrokeCollection 

The StrokeCollection class is very similar to the RegionCollection class. One important difference is that in a stroke collection the 64-bit ID is the time stamp of the stroke (RTC time) and not a RegionId. Certain functions that cannot be done directly on a stroke collection object can be done using the region collection. To do this, use GetSuper() on a stroke collection to get a region collection. (There is no implicit cast here.) 

 

StrokeIterator 

Enables iteration over Stroke objects in a StrokeCollection. Typically, it is easier to iterate over a StrokeColletion using foreach than using the iterator directly. 

 

StrokeStream 

Enables reading and writing of strokes to a stream. 

 

Transaction 

A transaction is an object encapsulating a single file transfered from a smartpen. Typically, a transaction is a StrokeCollection, but it can be any type of data that the smartpen produces. Properties of a transaction are Pen, Page, low timestamp of data and high timestamp and file type. A transaction is typically acquired from a TransactionList. A transaction can also be used as a filter for selecting transactions to read or to filter a TransactionList. In those cases, wild card constants and boundaries (for example, for time stamps) should be used. As an example: TransPenIdWild selects all pens. 

 

TransactionIterator 

A transaction iterator enables iterating over Transaction objects in a TransacationList. Typically it is easier to iterate over a TransactionList using foreach than using the iterator directly. 

 

TransactionList 

A transaction list is a list of Transaction objects. It is typically used to index a set of transactions in an AFD. A Transaction is, for example, one transfer of strokes from a specific smartpen for a specific page. Note: A lot of time a you do not need to bother with TransactionList and Transaction objects directly, since StrokeCollection objects can be read by other, high-level functions--for example, in the PageInstance class. 

 

Name 

Description 

 

DocMountType 

Enables an AFD to be read from either a zip archive, or a base directory (all the files flat in the file system). 

 

DocOpenMode 

Defines if the document should be open in read-write, or read-only. Read-only is more compatible.