Welcome!

Silverlight Authors: Automic Blog, Michael Kopp, AppDynamics Blog, Kaazing Blog, Steven Mandel

Related Topics: Silverlight

Silverlight: Tutorial

PDF for Silverlight

Leveraging the power of Silverlight to view PDF documents and forms (Updated for Silverlight 3 and 4)

Using Microsoft Silverlight, developers can provide their users with content-rich web applications that are not limited to text and images, and which can now include complex graphics and better interaction with users. A useful add-on to Silverlight would be the ability to display high quality PDF documents that would be easily readable by the users as compared to displaying documents as Jpeg images. Now that PDF has become the standard format for document storage and forms processing in most corporations, we thought that Silverlight applications would benefit from the ability to natively serve PDF documents and forms.

In this paper, we will show how to use the Amyuni PDF components to dynamically view PDF documents within a Silverlight control. We will discuss how to create a Silverlight 3 control to display and interact with PDF documents. The same control can be used for viewing PDF, XPS or any type of document rather than just images. The documents would be located on the server and viewed by the client within a Silverlight object without having to download any files to the client. The framework that is presented can be easily expanded to add interactivity when the PDF files contain annotations or form fields.

View Silverlight Sample >

Requirements (Server Side)
The sample that is given is based on ASP but any programming environment that supports either ActiveX or .NET can be used. Amyuni PDF Creator 4.5 which is part of the PDF for Silverlight package is used on the server to convert PDF files into a XAML package that can be processed by the Silverlight control.

Requirements (Client Side)
Any web browser running on any operating system with the Silverlight control versions 3.0 or higher. The sample PDFSilverlightControl will be automatically downloaded to the client by the Silverlight framework. No additional components need to be downloaded or run on the client PC.

Implementation
At first glance, viewing PDF documents within a Silverlight control looked like a 15-minute job. It would be sufficient to convert the PDF document into an XPS, which is a derivative of XAML, feed the XPS to the Silverlight control, add some bells and whistles and we were done. Converting a PDF, or any document for that matter, into an XPS can easily be achieved with the Amyuni PDF Creator; all that was needed is a way to feed the XPS into the Silverlight control. We were, however, faced with a number of challenges:

  1. Silverlight supports reading only a single XAML file. There is no mechanism by which one can feed multiple pages separately, nor is there a way to feed all the resources such as images and fonts used by that page. Silverlight provides no neat way of packaging a document the same way PDF and XPS do but requires all bits and pieces of a document to be created separately on the server and downloaded programmatically using the calling application. This precludes the ability to dynamically stream a document from a server to a client, which is a basic requirement of most applications.
  2. The Javascript API for Sliverlight provides a Downloader object that can be used to asynchronously download a XAML file and other components such as fonts or images from the server. The Downloader is available through Javascript only and cannot be used in a Silverlight control which is usually coded in C#. We had to use the combination of the WebClient object to send an asynchronous request to the web server to retrieve the XAML file and then use the powerful Application.GetResourceStream() method to extract parts from the zip file. These are both new features supported versions 3 and 4 of Silverlight.

    Another area that had been developed is in the Amyuni PDF Creator control running on the server side. The PDF Creator control feature that returns a XAML file, used to operate on the source PDF file in its entirety and then return XAML for all of the pages in the file. When a PDF file is fairly large, this process is lengthy, and the client side application would just have to wait without progress notification until the server starts writing back the response to the client. Version 4.5 of the Amyuni PDF Creator control can return a subset of the total pages in the original document instead of returning all of the pages at once in the XAML file. This can be controlled by setting the “PageSequence” Document attribute to an array of pages that are requested or “PageSequenceStr” to a string representation of pages requested.
  3. The image object provided by Silverlight is limited in that it does not allow for inline image data. The only way to specify the source for an image is by using a URL. To extract an image from a PDF and set it as the source for a Silverlight image object would require extracting the image into a temporary file on the server and setting the source of the image as the temporary URL - a solution that is not feasible in any real-life situation.

The basic requirements for building a document viewer using Silverlight are:

  • The ability to feed each page separately to account for large documents and prevent having to download the whole document to the client PC before viewing it
  • The ability to package page resources such as images and fonts within the document without having to store and retrieve the resources from the server
  • The ability to use fonts that are not installed on the client PC but are embedded within the source document
  • The ability to send additional information known as document metadata to the client

Using the WebClient Object and the Application.GetResourceStream() method
In Silverlight 3 and 4, the combination of WebClient object and the static Application.GetResourceStream() method provided us with the solution to problem of retrieving a zip package from a web server and extracting each object separately on the client in the Silverlight user control. The WebClient downloads a XAML zip package that is prepared by the PDF Creator control on the server side. The downloaded zip package is stored in as a Stream in a member variable of our acPDFSilverlightControl class.

Within the ZIP package, each page description can is stored as a separate XAML file and all resources used by that page stored in a virtual folder.

Downloading the ZIP package and extracting objects from it can be asynchronous and the ZIP package dynamically created on the server and streamed back to the client without resorting to temporary files, is exactly what we needed. The basic syntax for using the WebClient object is as follows:

public void LoadFromUrl(string url)

{

// Retrieves the XAML of document packaged in a ZIP format located at the specified URL

// which can be something like:

// "http://www.amyuni.ca/PageTurnPdf/pdf.asp?PDFFile=doc.pdf" or

// "http://www.amyuni.ca/PageTurnPdf/myXAMLpackage.zip"

...

// start web download using the WebClient object

Uri uri = new Uri( url );

WebClient webClient = new WebClient();

webClient.AllowReadStreamBuffering = true; //speeds application response time

// add event listener to detect when data is available

webClient.OpenReadCompleted += new
OpenReadCompletedEventHandler(webClient_OpenReadCompleted);

// add event handler for catching download progress notifications

webClient.DownloadProgressChanged += new
DownloadProgressChangedEventHandler(webClient_DownloadProgressChanged);

// start request

webClient.OpenReadAsync(uri, webClient);

}

private void webClient_OpenReadCompleted(object sender, OpenReadCompletedEventArgs e)

{

// Start loading the document

// e.Result will contain the XAML ZIP Stream

m_zipStream = e.Result;

...

// get XAML of document

Stream stream = GetPartFromZipPackage("Document/document_1.fdoc", m_zipStream);

StreamReader sreader = new StreamReader(stream);

string sDoc = sreader.ReadToEnd();

...

// get XAML of page from the ZIP package

Stream stream = GetPartFromZipPackage("Pages/page_" + (pageNumber + 1).ToString() +
".fpage", m_zipStream);

// convert to string

StreamReader sreader = new StreamReader(stream);

string sPageXaml = sreader.ReadToEnd();

...

 

Extracting and Rendering Images
Downloading the XAML description of the page to the client is not sufficient to display the images. An additional step is needed to loop through all the image objects and set the source for every image to one of the images in the ZIP package. Each time a new page is loaded, “ProcessElements” is called. This function searches for all images on a page and sets their “ImageSource” attribute:

private void ProcessElements(object _elems)

{

// process all page elements to set:

// - the source of all image elements

// - the font of all text elements

//

for ( int i = 0; i < elems.Count; i++ )

{

UIElement elem = elems[i]; //a child UIElment

Image img = elem as Image;

...

// the Source would be a string

if (img.Source != null && img.Source.ToString() != "")

{

var src = img.Source;

if (src != null)

{

string s = src.ToString();

// set the source after removing the leading slash

Stream stream = GetPartFromZipPackage(s.Substring(1),
m_zipStream);

BitmapImage bitmap = new BitmapImage();

bitmap.SetSource(stream);

img.Source = bitmap;

}

}

...

// loop recursively through all children of the current element

ProcessElements(elem.children);

...

}

}


Rendering Text

Accurately positioning and rendering of text elements proved to be trickier than graphics and images. PDF provides a number of ways for defining text encodings and font types. Both XPS and XAML are limited to Unicode text and XAML provides much less flexibility than its counterparts for rendering text. To alleviate text issues, Amyuni PDF components provide the developers with methods to optimize the text content of a page and convert all text to Unicode. The “OptimizeDocument” method is used on the server to optimize text content before attempting to render it in a Silverlight control:

' Optimize the document to line level in order to improve the XAML export

objPdf.OptimizeDocument 1

 

When the font used in the source document is not available on the client PC, Silverlight would substitute with a different font which usually gives results that are not satisfactory. Silverlight provides a mechanism for specifying the font used to display a specific element, as long as the font is in OpenType or TrueType format. The Downloader object can be used in this case to package all the fonts used by the document. The fonts are embedded in the ZIP package as partially embedded fonts that are not usable by the end-user in order to avoid font licensing issues.

In parallel to the image processing described above, the sample viewer loops through all text objects and sets the font source for each object to be one of the fonts in the ZIP package:

// set the font source for all text elements to fonts retrieved from the ZIP package

if ( elem.GetType() == typeof(TextBlock) )

{

TextBlock tb = (TextBlock) elem;

// set the FontSource

tb.FontSource = new FontSource( m_zipStream );

...

 

The text element’s “FontFamily” attribute maps the text’s font to one of the fonts packaged in the ZIP file. This is done automatically by the Silverlight component when the requested font is not located on the end-user’s system.

Server-Side Scripts

The server-side code that converts the document into XAML and builds the ZIP package is very straight-forward and uses the Amyuni PDF Creator ActiveX:

<%

' Set the returned content type to be a ZIP package

Response.ContentType = “application/x-zip-compressed”

' Get the PDF filename requested by the user

strFilePath = Request.QueryString( “PDFFile” )

' Get the pages subset(s) string requested by the user if specified

' eg.: "1,3,10-25,4,125-100"

strPages = Request.QueryString( "Pages" )

' Create the PDF Creator ActiveX object and open the document

' This will throw an exception if the control is not installed

' or the document not found

Set objPdf = Server.CreateObject(“PDFCreactiveX.PDFCreactiveX”)

' Use OpenEx to use deferred document loading (does not load entire document)

objPdf.OpenEx Server.MapPath( strFilePath ), ““

' Set the Document attribute PageSequenceStr. If empty string, all pages will be included

objPdf.ObjectAttributeStr "Document", "PageSequenceStr", strPages

' Optimize the document to line level in order to improve the XAML export

objPdf.OptimizeDocument 1

' return the XAML attribute of the document object which is a ZIP package

Response.BinaryWrite objPdf.ObjectAttribute( “Document”, “XAML” )

Set objPdf = Nothing

%>

Expanding the Sample to View Documents other than PDF
The server-side script can easily be expanded in order to render other types of documents. To render XPS documents, the document should be loaded by the PDF Creator control and saved back into XAML to make it compatible with Silverlight. This can be done by replacing the PDF file with an XPS in the server-side script.

To render other types of documents, they should be first converted into PDF using the Amyuni PDF Converter, then streamed back to the client as a ZIP package. The PDF Converter product is available for download from: http://www.amyuni.com/en/developer/pdfconverter. A sample for converting documents into PDF on a server can be found at: http://www.amyuni.com/en/resources/technicalnotes/

More Stories By Amyuni Tech

Franc Gagnon is a technical copywriter for Amyuni Technologies–a PDF solution provider. Amyuni products are integrated into applications used worldwide. The company's software tools are the PDF engines behind several leading business applications created by large software companies such as Intuit, Sage, CaseWare and many more.

@ThingsExpo Stories
BnkToTheFuture.com is the largest online investment platform for investing in FinTech, Bitcoin and Blockchain companies. We believe the future of finance looks very different from the past and we aim to invest and provide trading opportunities for qualifying investors that want to build a portfolio in the sector in compliance with international financial regulations.
A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, whic...
Imagine if you will, a retail floor so densely packed with sensors that they can pick up the movements of insects scurrying across a store aisle. Or a component of a piece of factory equipment so well-instrumented that its digital twin provides resolution down to the micrometer.
In his keynote at 18th Cloud Expo, Andrew Keys, Co-Founder of ConsenSys Enterprise, provided an overview of the evolution of the Internet and the Database and the future of their combination – the Blockchain. Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settle...
Product connectivity goes hand and hand these days with increased use of personal data. New IoT devices are becoming more personalized than ever before. In his session at 22nd Cloud Expo | DXWorld Expo, Nicolas Fierro, CEO of MIMIR Blockchain Solutions, will discuss how in order to protect your data and privacy, IoT applications need to embrace Blockchain technology for a new level of product security never before seen - or needed.
Leading companies, from the Global Fortune 500 to the smallest companies, are adopting hybrid cloud as the path to business advantage. Hybrid cloud depends on cloud services and on-premises infrastructure working in unison. Successful implementations require new levels of data mobility, enabled by an automated and seamless flow across on-premises and cloud resources. In his general session at 21st Cloud Expo, Greg Tevis, an IBM Storage Software Technical Strategist and Customer Solution Architec...
Nordstrom is transforming the way that they do business and the cloud is the key to enabling speed and hyper personalized customer experiences. In his session at 21st Cloud Expo, Ken Schow, VP of Engineering at Nordstrom, discussed some of the key learnings and common pitfalls of large enterprises moving to the cloud. This includes strategies around choosing a cloud provider(s), architecture, and lessons learned. In addition, he covered some of the best practices for structured team migration an...
No hype cycles or predictions of a gazillion things here. IoT is here. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, an Associate Partner of Analytics, IoT & Cybersecurity at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He also discussed the evaluation of communication standards and IoT messaging protocols, data...
Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, discussed how from store operations and ...
In his session at 21st Cloud Expo, Raju Shreewastava, founder of Big Data Trunk, provided a fun and simple way to introduce Machine Leaning to anyone and everyone. He solved a machine learning problem and demonstrated an easy way to be able to do machine learning without even coding. Raju Shreewastava is the founder of Big Data Trunk (www.BigDataTrunk.com), a Big Data Training and consulting firm with offices in the United States. He previously led the data warehouse/business intelligence and B...
"IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
When shopping for a new data processing platform for IoT solutions, many development teams want to be able to test-drive options before making a choice. Yet when evaluating an IoT solution, it’s simply not feasible to do so at scale with physical devices. Building a sensor simulator is the next best choice; however, generating a realistic simulation at very high TPS with ease of configurability is a formidable challenge. When dealing with multiple application or transport protocols, you would be...
Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
We are given a desktop platform with Java 8 or Java 9 installed and seek to find a way to deploy high-performance Java applications that use Java 3D and/or Jogl without having to run an installer. We are subject to the constraint that the applications be signed and deployed so that they can be run in a trusted environment (i.e., outside of the sandbox). Further, we seek to do this in a way that does not depend on bundling a JRE with our applications, as this makes downloads and installations rat...
Widespread fragmentation is stalling the growth of the IIoT and making it difficult for partners to work together. The number of software platforms, apps, hardware and connectivity standards is creating paralysis among businesses that are afraid of being locked into a solution. EdgeX Foundry is unifying the community around a common IoT edge framework and an ecosystem of interoperable components.
DX World EXPO, LLC, a Lighthouse Point, Florida-based startup trade show producer and the creator of "DXWorldEXPO® - Digital Transformation Conference & Expo" has announced its executive management team. The team is headed by Levent Selamoglu, who has been named CEO. "Now is the time for a truly global DX event, to bring together the leading minds from the technology world in a conversation about Digital Transformation," he said in making the announcement.
In this strange new world where more and more power is drawn from business technology, companies are effectively straddling two paths on the road to innovation and transformation into digital enterprises. The first path is the heritage trail – with “legacy” technology forming the background. Here, extant technologies are transformed by core IT teams to provide more API-driven approaches. Legacy systems can restrict companies that are transitioning into digital enterprises. To truly become a lead...
Digital Transformation (DX) is not a "one-size-fits all" strategy. Each organization needs to develop its own unique, long-term DX plan. It must do so by realizing that we now live in a data-driven age, and that technologies such as Cloud Computing, Big Data, the IoT, Cognitive Computing, and Blockchain are only tools. In her general session at 21st Cloud Expo, Rebecca Wanta explained how the strategy must focus on DX and include a commitment from top management to create great IT jobs, monitor ...
"Cloud Academy is an enterprise training platform for the cloud, specifically public clouds. We offer guided learning experiences on AWS, Azure, Google Cloud and all the surrounding methodologies and technologies that you need to know and your teams need to know in order to leverage the full benefits of the cloud," explained Alex Brower, VP of Marketing at Cloud Academy, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clar...
The IoT Will Grow: In what might be the most obvious prediction of the decade, the IoT will continue to expand next year, with more and more devices coming online every single day. What isn’t so obvious about this prediction: where that growth will occur. The retail, healthcare, and industrial/supply chain industries will likely see the greatest growth. Forrester Research has predicted the IoT will become “the backbone” of customer value as it continues to grow. It is no surprise that retail is ...