|
DesktopSDK 0.7 - PenData Library (C#) Documentation
|
   |
LSDocument Members
|
DesktopSDK 0.7 - PenData Library (C#) Documentation
|
|
The following tables list the members exposed by LSDocument.
|
|
Name |
Description |
 |
Adds a resource to the document from an external file handle. | |
|
|
Deprecated. Use AddLicense2. | |
|
|
Adds a license to the document. The KeyPair needs to be created separately. VerifyAndSetGuid will lock the license so that it works only with this particular document. Beware that changing the document after GUID locking is impossible, since that will invalidate the license. If you are unsure whether the document will be changed in the future, set the VerifyAndSetGuid to false. Note that after the document is locked, many functions will fai--such as: AddPageTemplate, DeletePageTemplate, etc. | |
|
|
Adds a page template to the document. Has pattern means that the page "uses" one page address for pages completely without pattern. This can be set to false. Hidden means that the page will not show up at printing but will be available for future use without breaking the page-to-pageaddress mapping. | |
|
|
See the AddPageTemplate function. This enables more control and allows pointing back to previous pages that share the layout. | |
|
|
Deprecated. Use AddPARange2. | |
|
|
Adds a page address range to the document (copies). Note: This does not apply a license and is automatically performed when adding a license. This function can be useful for special cases when a document should not be used for printing or in a smartpen, but rather to exchange data between systems. (This is the approach used by virtual notebooks in Livescribe Desktop). | |
|
|
Adds data to the userdata/ directory from an external file handle. | |
|
|
Calculate the true GUID of the document. This normally corresponds to the GUID written in document info but unlocking and modifying a document and saving it again will affect this "real" GUID, although the one in document info will not be updated. The one in the document info is only calculated when the first license is applied. | |
|
|
Closes the document without saving it. Operations like adding data to the AFD or changing region collections are not discarded, since certain operations carried out when the document is opened can be permanent. | |
 |
Converts a document from an older version to the current version. This operation can be slow. | |
|
|
Creates a new empty document on disk without any pages or other information. | |
|
|
Deletes a layout resource from the document. | |
|
|
Deletes a page template. | |
|
|
Delete a page address range. Do not use unless for specific purposes. | |
|
|
Deletes data in the userdata/ directory. | |
|
|
Immediately frees up the memory used by an object and its children. | |
|
|
Get the version of the document module. | |
|
|
Gets the mount type of the document. | |
|
|
Gets the number of copies that the document currently has licenses to support. | |
|
|
Gets the number of page templates in the document. | |
|
|
Gets the number of page templates with pattern in the document. | |
|
|
Gets the start and stop page address for this document. This will be the same values that can be read from the document info; however, this one is actually calculated on the fly. | |
|
|
Gets the page address for a particular page and copy in the document. | |
|
|
Gets the page and copy of the document for a particular page address. | |
|
|
Get the maximum size of the page sizes in the document. This is useful, for example, to determine the required size of a license to be applied to a document. (Due to margins, the license needs to be 512 units larger than the returned value, in order to be valid). | |
|
|
Gets the pattern file file name. | |
|
|
Get a reference to the AFD core document. From that reference, the afdContext can be retrieved. This provides lower-level access to the file. | |
|
|
Gets a reference to the document info that contains meta data about the document, such as its title. | |
|
|
Gets a reference to a page template object. Modifying the returned object will modify the source document. | |
|
|
Gets number of reserved pages. | |
|
|
Ges the total number of page instances. This value equals the number of copies times the number of page templates. | |
|
|
| |
|
|
Locks the document. A document is automatically locked when a license is added. | |
|
|
This is the overview for the LSDocument constructor overload. | |
|
|
Merges two versions of the same document. Note: The documents should not be opened when performing this operation. | |
|
|
Merges two documents to a stream. Useful if the output should not be stored on disk. | |
|
|
Removes all licenses from the document. This can be useful if the base document is to be repurposed for another use. | |
|
|
Removes a license from the document. This should never be done to a production document that has printed copies intersecting the license. | |
|
|
Saves a document to disk. Note: it only saves the basic page layout, info, and pattern information. Region collections and such need to be saved manually. | |
|
|
Saves and closes the document. | |
|
|
Saves strokes to the document for a particular smartpen and page (Use GetPAFromPageAndCopy to get the page address). | |
|
|
Sets the pattern file filename. The pattern file name is set by default when creating the document. Therefore, this function should normally not be used. | |
|
|
Set reserved pages. This enables pages to be populated in the future by preserving the page addresses for them. | |
|
|
Splits a document in different pieces. Parameters support wildcards. This is useful for splitting different smartpens into different documents. | |
|
|
Unlocks the document. Doing this without appropriate understanding is a bad idea. |
Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at support@toolsfactory.com.