General Info

From Tracker Software PDF SDK
Jump to: navigation, search
 
(53 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
[[Category:Editor]]
+
[[Category:Editor]]  
 
{{#customTitle:General Info}}
 
{{#customTitle:General Info}}
{{#treeOrder:before:PXV:Common}}
+
{{#treeOrder:before:PXV:CoClasses}}
{{ToReview}}  
+
  
 
== Overview ==
 
== Overview ==
  
'''PDF-XChange SDK''' provides a wide range of tools to work with PDF documents and images under OS Windows. That toolset includes features for creation and editing, searching, rendering and printing, importing and exporting PDF documents, decoding, viewing and saving images. Using your favourite programming environment with the SDK you can create your own application that would be able to work with PDF files and images – easily viewing existing documents, create new ones, etc.
+
The {{EditorSDK}} is our latest and most ambitious product offering to date - allowing 3rd party MS Windows software developers to incorporate Portable Document Format (PDF) creation and manipulation within their own software applications for provision to client End-Users. Providing a wide range of features and functions such as PDF creation and editing, searching, rendering and printing, importing and exporting PDF documents, decoding, viewing and saving images - the possibilities are almost endless and limited only by the developers imagination and creativity. Using your favourite programming environment with the SDK you can create your own application that would be able to work with PDF files and images – easily viewing and editing existing documents, create new ones, etc.
PDF-XChange SDK consists of two different libraries:
+
  
* '''PDF-XChange Core API SDK'''
+
With over 17 years of experience offering solutions to both End Users and Software Developers - specifically for Imaging and PDF file manipulation - few companies have a better pedigree and our PDF-XChange range of products has been satisfying client needs for since 2001, winning the plaudits of developers and client end users alike from the very first product releases. 
  
* '''PDF-XChange Editor SDK'''
+
This document is intended to act as resource for experienced developers and some basic knowledge of the PDF format will be required to fully benefit from the extensive features and functions available. We strongly recommend all developer to use this document in tandem we the PDF reference available freely from Adobe
 +
(see [http://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/PDF32000_2008.pdf Online PDF-Reference]) or the latest PDF specification from the ISO standards (for a fee). Please also note this product contains 1000's of functions, methods and properties - all listed here, but documented on varying degree's of detail due to the sheer volume of options and it is not possible to create an online help going into minutia of detail - so we have instead concentrated on those area's likely to be of interest to the majority and will expand as time and demand justifies us doing so. Where this document does not go into detail the Adobe reference document will in many cases act as a viable alternative and thus we have not duplicated - allowing us to
 +
concentrate most where we believe help is most needed.
  
'''PDF-XChange Core API SDK''' – this library provides all features to work with files in PDF format and some additional extensions. Unlike '''PDF-XChange Editor SDK''' this library has no UI layer. This library contains one DLL file named '''PDFXCoreAPI.x86.dll''' for 32-bits version and '''PDFXCoreAPI.x64.dll''' for 64-bits version.
 
  
'''PDF-XChange Editor SDK''' – this library includes entirely the '''PDF-XChange Core API SDK''' and additional layers that provides functionality similar to the end-user version of the '''PDF-XChange Editor'''. As this SDK has an ability to optionally load of Editor’s plugins (with some possible limitations, depends of the plugin) the set of features provided by the SDK may be dramatically increased by the plugins. This library consists of one DLL module ('''PDFXEditCore.x86.dll''' for 32-bits, or '''PDFXEditCore.x64.dll''' for 64-bits) and a mandatory file named '''Resources.dat''' that should be located in the folder with the DLL file.
+
The full {{EditorSDK}} License provides functionality in ''two'' specific libraries:
  
Both of these libraries are developed as COM servers, so, they provide a set of ActiveX object and COM interfaces which can be accessed via standard COM mechanism as well as using other methods:
+
* {{CoreAPI}} (soon to be available as a separate SDK at a lesser license fee and replacing our PDF-Tools SDK).
  
* using registration of the COM server on destination system;
+
* {{EditorSDK}} itself which always includes the license and use of the PDF-XChange Core SDK, as well as the extended functionality of the Editor SDK itself. This is not a replacement for our existing PDF-XChange Viewer SDK (which we will continue to offer - but not extend the functionality of) but is the next generation of our Developer SDK line up.
  
* use COM server via Click-Once technology: the standard registration of the COM-server isn't required, only special two manifest files must be added during installation on the client's machine;
 
  
* using a special function exported by libraries DLLs, that creates and returns a main object of the libraries; the standard registration of the COM-server isn't required and additional manifest files are not necessary too;
+
The {{CoreAPI}} – this library provides all available features to work with files in the PDF format and some additional extensions. Unlike the {{EditorSDK}} this library has no UI layer and just one DLL and requires only one DLL to be redistributed to your client end users, being provided in both 32 and 64 bit versions. The '''PDFXCoreAPI.x86.dll''' for 32-bit Windows systems and the '''PDFXCoreAPI.x64.dll''' for 64-bit Windows Installations.
  
For more information, please refer to [[PXV:RedistributionInfo]]
 
  
 +
The {{EditorSDK}} – itself also includes the entirety of the {{CoreAPI}} functionality and additional layers that provide functionality similar to that of own end-user application (created with this SDK) - the '''PDF-XChange Editor''' developers are encouraged to review this application themselves to familiarize themselves with the provided functionality and output. As this SDK has the ability to optionally load any available PDF-XChange Editor plugins (with some possible limitations, dependent on the plugin itself and the plugin authors licensing) the set of features provided by the SDK may be dramatically extended by the use of plugins. Developers can also create their own plug-ins for use by their clients or offer to other 3rd party developers or indeed to our own PDF-XChange Editor End-User clients of which their are many millions, please contact us directly for further information should you wish to create a Plug-In for use by licensed end users of the PDF-XChange Editor. 
  
 +
This library consists of a single DLL module (again offered in both 32 and 64 bit versions: '''PDFXEditCore.x86.dll''' for 32-bit and '''PDFXEditCore.x64.dll''' for 64-bit use) and a mandatory resource file named '''Resources.dat''' that should always reside in the same folder as the afore mentioned library DLL being distributed.
  
  
 
+
Please see the diagram below showing the relationship between the {{EditorSDK}} and {{CoreAPI}} and illustrating the internal arrangement and use of the API-layers:
== yy ==
+
  
 
<graphviz format='svg'>
 
<graphviz format='svg'>
Line 38: Line 36:
 
{
 
{
 
     graph [
 
     graph [
         label = "PDF-XChange SDK Structure"
+
         label = "PDF-XChange Editor SDK Structure"
 
         labelloc = t
 
         labelloc = t
 
          
 
          
Line 81: Line 79:
  
 
             PXC [label="PDF Core Layer\n[PXC]", URL="PXV:PXC", shape="folder", fillcolor="#fddaec"];
 
             PXC [label="PDF Core Layer\n[PXC]", URL="PXV:PXC", shape="folder", fillcolor="#fddaec"];
             PXS [label="PDF Structure Layer\n[PXS]", URL="PXV:PXS"];
+
             PXS [label="PDF Structures Layer\n[PXS]", URL="PXV:PXS"];
 
             AFS [label="File Systems Layer\n[AFS]", URL="PXV:AFS"];
 
             AFS [label="File Systems Layer\n[AFS]", URL="PXV:AFS"];
 
             IXC [label="Images Core Layer\n[IXC]", URL="PXV:IXC"];
 
             IXC [label="Images Core Layer\n[IXC]", URL="PXV:IXC"];
Line 99: Line 97:
 
     }
 
     }
 
}
 
}
</graphviz>
+
</graphviz>  
 +
 
 +
Both of these libraries are developed and offered as COM-servers and provide a set of ActiveX-objects and COM-interfaces which may be accessed via standard COM technology as well as using other methods:
 +
 
 +
* using registration of the COM-server on destination system;
 +
 
 +
* using COM-server via [https://msdn.microsoft.com/en-us/library/142dbbz4%28v=vs.90%29.aspx Click-Once] technology: the standard registration of the COM-server is not required, however two specific manifest files must be added during installation on a client machine;
 +
 
 +
* using a special function exported by the libraries DLL's, this creates and returns the main object of the libraries; Neither standard registration of the COM-server nor provision of the above manifest files is required when using this method for your application;
 +
 
 +
For detailed redistribution information please see [[PXV:Redistribution]].
 +
 
 +
For detailed information regarding licensing please see [[PXV:Licensing]].
  
== xx ==
+
== Installation ==
  
The above diagram shows the internal arrangement of the layers of the PDF-XChange Editor SDK and depending on your license type you will have access to some or all of its functionality. Essentially there are only 2 distinct License types.  
+
The latest release of the SDK is always available from [http://www.tracker-software.com/product/pdf-xchange-editor-sdk here].
 +
The SDK installer will install all required SDK files, and will register the COM-server (either 32 or 64-bit as appropriate for your development system hardware/OS).
  
Firstly the '''PDF-XChange Editor SDK''' license covers the entire range of functionality as represented to your users by the rich UI of the PDF-XChange Editor embedded within your own applications and controlled either in part or entirely directly by the interaction of the End User with the interface offered or by your application and the functions offered and in your programmatic control. The full Editor SDK also allows you to access and offer the NON-UI based functionality of the '''PDF-XChange Core API''' and all its creation and manipulation features.
+
Once installed successfully you may immediately begin using of the SDK to create your application in your chosen development tool. In addition, sample projects are provided for various programming languages to assist in familiarizing developers with the use of the SDK and available functionality.
  
Secondly the '''PDF-XChange Core API''' license provides access to all the NON-UI based functionality available for the creation and manipulation of files - but does not allow you to utilize or offer to your uses in anyway the UI functionality of the PDF-XChange Editor User Interface.
+
All samples are also available on a [https://github.com/tracker-software/PDFEditorSDKExamples github-repository].
  
Also please note that both SDK's are Royalty based via the purchase of Client Distribution License Packs (CDLP's) and whilst you can fully develop and test all your applications using the Evaluation SDK's prior to purchase to ensure satisfaction, prior to distribution of an application making use of this SDK to any end user client - the pre-purchase of CDLP's is required.  
+
The simple guide on how to add the PDF-XChange Editor ActiveX Control to the Windows Form Application can be found [https://youtu.be/j3I0oteI13s here]
  
 +
== Development ==
  
'''PDF-XChange <abbr title="Software Development Kit">SDK</abbr>''' consists of several infrastructure libraries:
+
'''PDF-XChange Editor <abbr title="Software Development Kit">SDK</abbr>''' provides you access to [[PXV:CoClasses|ActiveX Objects]], and  consists of several infrastructure API-layers:
  
* [[PXV:PXV_CoClasses]]
 
 
* [[PXV:PXV]]
 
* [[PXV:PXV]]
 
* [[PXV:PXC]]
 
* [[PXV:PXC]]
Line 124: Line 135:
  
  
Full index of PDF-XChange SDK types : [[IndexTypeLibrary]]
+
Full index of {{EditorSDK}} types : [[IndexTypeLibrary]]

Latest revision as of 15:48, 5 April 2017

Overview

The PDF-XChange Editor SDK is our latest and most ambitious product offering to date - allowing 3rd party MS Windows software developers to incorporate Portable Document Format (PDF) creation and manipulation within their own software applications for provision to client End-Users. Providing a wide range of features and functions such as PDF creation and editing, searching, rendering and printing, importing and exporting PDF documents, decoding, viewing and saving images - the possibilities are almost endless and limited only by the developers imagination and creativity. Using your favourite programming environment with the SDK you can create your own application that would be able to work with PDF files and images – easily viewing and editing existing documents, create new ones, etc.

With over 17 years of experience offering solutions to both End Users and Software Developers - specifically for Imaging and PDF file manipulation - few companies have a better pedigree and our PDF-XChange range of products has been satisfying client needs for since 2001, winning the plaudits of developers and client end users alike from the very first product releases.

This document is intended to act as resource for experienced developers and some basic knowledge of the PDF format will be required to fully benefit from the extensive features and functions available. We strongly recommend all developer to use this document in tandem we the PDF reference available freely from Adobe (see Online PDF-Reference) or the latest PDF specification from the ISO standards (for a fee). Please also note this product contains 1000's of functions, methods and properties - all listed here, but documented on varying degree's of detail due to the sheer volume of options and it is not possible to create an online help going into minutia of detail - so we have instead concentrated on those area's likely to be of interest to the majority and will expand as time and demand justifies us doing so. Where this document does not go into detail the Adobe reference document will in many cases act as a viable alternative and thus we have not duplicated - allowing us to concentrate most where we believe help is most needed.


The full PDF-XChange Editor SDK License provides functionality in two specific libraries:

  • PDF-XChange Core API SDK (soon to be available as a separate SDK at a lesser license fee and replacing our PDF-Tools SDK).
  • PDF-XChange Editor SDK itself which always includes the license and use of the PDF-XChange Core SDK, as well as the extended functionality of the Editor SDK itself. This is not a replacement for our existing PDF-XChange Viewer SDK (which we will continue to offer - but not extend the functionality of) but is the next generation of our Developer SDK line up.


The PDF-XChange Core API SDK – this library provides all available features to work with files in the PDF format and some additional extensions. Unlike the PDF-XChange Editor SDK this library has no UI layer and just one DLL and requires only one DLL to be redistributed to your client end users, being provided in both 32 and 64 bit versions. The PDFXCoreAPI.x86.dll for 32-bit Windows systems and the PDFXCoreAPI.x64.dll for 64-bit Windows Installations.


The PDF-XChange Editor SDK – itself also includes the entirety of the PDF-XChange Core API SDK functionality and additional layers that provide functionality similar to that of own end-user application (created with this SDK) - the PDF-XChange Editor developers are encouraged to review this application themselves to familiarize themselves with the provided functionality and output. As this SDK has the ability to optionally load any available PDF-XChange Editor plugins (with some possible limitations, dependent on the plugin itself and the plugin authors licensing) the set of features provided by the SDK may be dramatically extended by the use of plugins. Developers can also create their own plug-ins for use by their clients or offer to other 3rd party developers or indeed to our own PDF-XChange Editor End-User clients of which their are many millions, please contact us directly for further information should you wish to create a Plug-In for use by licensed end users of the PDF-XChange Editor.

This library consists of a single DLL module (again offered in both 32 and 64 bit versions: PDFXEditCore.x86.dll for 32-bit and PDFXEditCore.x64.dll for 64-bit use) and a mandatory resource file named Resources.dat that should always reside in the same folder as the afore mentioned library DLL being distributed.


Please see the diagram below showing the relationship between the PDF-XChange Editor SDK and PDF-XChange Core API SDK and illustrating the internal arrangement and use of the API-layers:

This is a graph with borders and nodes. Maybe there is an Imagemap used so the nodes may be linking to some Pages.

Both of these libraries are developed and offered as COM-servers and provide a set of ActiveX-objects and COM-interfaces which may be accessed via standard COM technology as well as using other methods:

  • using registration of the COM-server on destination system;
  • using COM-server via Click-Once technology: the standard registration of the COM-server is not required, however two specific manifest files must be added during installation on a client machine;
  • using a special function exported by the libraries DLL's, this creates and returns the main object of the libraries; Neither standard registration of the COM-server nor provision of the above manifest files is required when using this method for your application;

For detailed redistribution information please see Redistribution to Clients.

For detailed information regarding licensing please see Licensing.

Installation

The latest release of the SDK is always available from here. The SDK installer will install all required SDK files, and will register the COM-server (either 32 or 64-bit as appropriate for your development system hardware/OS).

Once installed successfully you may immediately begin using of the SDK to create your application in your chosen development tool. In addition, sample projects are provided for various programming languages to assist in familiarizing developers with the use of the SDK and available functionality.

All samples are also available on a github-repository.

The simple guide on how to add the PDF-XChange Editor ActiveX Control to the Windows Form Application can be found here

Development

PDF-XChange Editor SDK provides you access to ActiveX Objects, and consists of several infrastructure API-layers:


Full index of PDF-XChange Editor SDK types : IndexTypeLibrary