Some test text!
Core / Guides
Welcome to Apryse. Currently, Ruby for the Apryse SDK is only supported on Linux.
This guide will help you build your own PDFNet Ruby wrappers by binding a free trial of the PDFNetC library to Ruby. It will also show you how to run Apryse samples and integrate the Apryse SDK into Ruby applications on Linux. Your free trial includes unlimited trial usage and support from solution engineers.
Ruby version 2.x
CMake version ≥ 2.8
SWIG 2.0.4 - 2.0.12 or SWIG 3.0.12 or SWIG 4.0.2+ (Ruby 2.7+)
Apryse SDK for Linux:
Make a directory to store the wrappers and navigate into that directory.
Clone the uncompiled PDFNet wrappers by executing
git clone https://github.com/PDFTron/PDFNetWrappers
PDFNetWrappers/PDFNetC and download the PDFNet C/C++ SDK into that directory. Ensure you obtain the right architecture for your Ruby interpreter. For example, if your interpreter is 64bit (which this guide will assume), execute
tar xvzf PDFNetC64.tar.gz, then execute
mv PDFNetC64/Headers/ .
mv PDFNetC64/Lib/ .
to move the PDFNet libraries in place.
You can delete
PDFNetC64.tar.gz to free up space.
/PDFNetC folder should be laid out like this like this:
PDFNetC ├── Headers ├── Lib ├── PDFNetC64 └── README.txt
Make a build directory inside
/PDFNetWrappers and navigate to it. This guide will assume the build directory is called Build.
cmake -D BUILD_PDFNetRuby=ON ..
If all goes well, you should get a message which reads:
Build files have been written to ~/PDFNetWrappers/Build
make followed by
sudo make install. You are now ready to run the samples or integrate Apryse SDK into your own application.
Get your Apryse trial key.
Run a specific sample
RUBYfolder in the sample, for example
Run all samples
/Samples and execute:
The tests will run one by one.
This section will show you how to use our SDK to create a simple Apryse "Hello World!" application. It will create a document with one blank page and save it as a linearized PDF in its running directory.
Navigate to your
/Samples directory and make a new directory called
myApp (if it does not exist already). This guide will assume your application is named myApp. For organization, create a new directory inside
Navigate inside that
RUBY folder and create a new Ruby file called
myApp.rb. Open it with your favorite text editor and paste this into it:
require '../../../PDFNetC/Lib/PDFNetRuby' include PDFNetRuby $stdout.sync = true PDFNet.Initialize() # PDFNet must be initialized before accessing any Apryse API doc = PDFDoc.new() page = doc.PageCreate() # Start a new page doc.PagePushBack(page) # Add the page to the document doc.Save("output.pdf", SDFDoc::E_linearized); # Save the document as a linearized PDF puts "Hello World!"
Run your application by executing
ruby myApp.rb. If all goes well, your console should output:
PDFNet is running in demo mode. Permission: write Hello World!
output.pdf that the program output in the same directory. It should be a PDF with one blank page.
Check the troubleshooting page and our PDFNetWrappers github if you run into any issues going through this document.
Get the answers you need: Support