Home » Newsletter » May 2016

by Santosh Patil

Select the language for the code snippets C# Delphi Java JavaScript

If you are new to StarDocs, we suggest you read the introductory article and the getting started article first. This article builds on the steps explained in those foundational articles to avoid repetition.

The API reference documentation can be found here.

What can you accomplish in about 10 lines of code? How about creating a viewer to view multi-format documents? It's a snap to create an HTML5 document viewer using the Gnostice StarDocs Cloud and On-Premises APIs. In this article we'll show you how just that: how to create a multi-format HTML5 document viewer.

1. After authentication and uploading of the document you will get the document URL. Using the document URL you can request for a viewer. The server will create a viewer and return the viewer URL. This URL can simply be launched in a new browser window or an iframe.

// Set up connection details
var starDocs = new Gnostice.StarDocs(
  new Gnostice.ConnectionInfo(
    'https://api.gnostice.com/stardocs/v1', 
    '<API Key>', 
    '<API Secret>'),
  new Preferences(
    // Force full permissions on PDF files protected 
    // with an permissions/owner/master password
    new DocPasswordSettings(true))
);

// Authenticate
starDocs.auth.loginApp()
  .done(function(response) {
    // Upload file
    var selectedFile = document.getElementById('input').files[0];
    starDocs.storage.upload(selectedFile) 
      .done(function(response) {
        var documentUrl = response.documents[0].url;
        // View file, optionally specifying the 
        // password if the document is encrypted
        starDocs.viewer.createView(documentUrl, "password")
          .done(function(response) {
            var viewerUrl = response.viewSession.url;
            // Load viewerUrl
            // Example: $(#view-frame).attr("src", viewerUrl);
          });
      });
  });

// Set up connection details
StarDocs starDocs = new StarDocs(
  new ConnectionInfo(
    new Uri("https://api.gnostice.com/stardocs/v1"),
    "<API Key>",
    "<API Secret>"), 
  new Preferences(
    // Force full permissions on PDF files protected 
    // with an permissions/owner/master password
    new DocPasswordSettings(true))
);

// Authenticate
starDocs.Auth.loginApp();

// Upload file
DocObject docObjectBalanceSheet = starDocs.Storage.Upload(
  @"C:\Documents\BalanceSheet.pdf");

// View file, optionally specifying the password if the document 
// is encrypted
ViewResponse response = starDocs.Viewer.CreateView(docObjectBalanceSheet, "password");
// Launch browser pointing to the view url
System.Diagnostics.Process.Start(response.Url);

// Set up connection details
StarDocs starDocs = new StarDocs(
  new ConnectionInfo(
    new java.net.URI("https://api.gnostice.com/stardocs/v1"),
    "<API Key>",
    "<API Secret>"), 
  new Preferences(
    // Force full permissions on PDF files protected 
    // with an permissions/owner/master password
    new DocPasswordSettings(true))
);

// Authenticate
starDocs.auth.loginApp();

// Upload file
DocObject docObjectBalanceSheet = starDocs.storage.upload(
  "C:\\Documents\\BalanceSheet.pdf");

// View file, optionally specifying the password if the document 
// is encrypted
ViewResponse response = starDocs.viewer.createView(docObjectBalanceSheet, "password");
// Launch browser pointing to the view url
if (java.awt.Desktop.isDesktopSupported())
{
  java.awt.Desktop.getDesktop().browse(new java.net.URI(response.getUrl()));
}

var
  StarDocs: TgtStarDocsSDK;
  DocObjectBalanceSheet: TgtDocObject;
  ViewResponse: TgtCreateViewResponse;
begin
  StarDocs := nil;
  DocObjectBalanceSheet := nil;
  ViewResponse := nil;
  try
    // Set up connection details
    StarDocs := TgtStarDocsSDK.Create(nil);
    StarDocs.ConnectionSettings.ApiServerUri :=
      'http://api.gnostice.com/stardocs/v1';
    StarDocs.ConnectionSettings.ApiKey := '<API Key>';
    StarDocs.ConnectionSettings.ApiSecret := '<API Secret>';
    // Force full permissions on PDF files protected 
    // with an permissions/owner/master password
    StarDocs.Preferences.DocPassword.ForceFullPermission := True;

    // Authenticate
    StarDocs.Auth.loginApp;

    // Upload file
    DocObjectBalanceSheet := StarDocs.Storage.Upload(
      'C:\Documents\BalanceSheet.pdf', 'password');

    // View file, optionally specifying the password if the document 
    // is encrypted
    ViewResponse := StarDocs.Viewer.CreateView(DocObjectBalanceSheet);

    // Launch browser pointing to the view url
    ShellExecute(Handle, 'open', PChar(ViewResponse.Url), 
      nil, nil, SW_SHOWNORMAL);
  finally
    if Assigned(ViewResponse) then
      FreeAndNil(ViewResponse);
    if Assigned(DocObjectBalanceSheet) then
      FreeAndNil(DocObjectBalanceSheet);
    if Assigned(StarDocs) then
      FreeAndNil(StarDocs);
  end;
end;

The below screenshot shows the HTML viewer in action.



That's it! I hope that was within 10 lines :-)

2. If you wish to control the appearance and behavior of the viewer, you can pass in additional parameters when requesting for the view as shown below.

var viewerSettings = {
    // True if PDF form-filling feature should be enabled. Default is true. 
    enableFormFilling: true,
    // True if toolbar should be shown. Default is true.
    toolbarVisible: true,
    // True if full-screen button should be shown. Default is false.
    fullScreenVisible: true,
    searchControls: {
      // True if quick-search feature should be enabled. Default is true.
      enableQuickSearch: true,
      // The color of the highlight shown over the text occurrence. 
      // It should either be a color like 'red' or of the form '#{RR}{GG}{BB}' 
      // where {RR}, {GG}, {BB} are the color component values in hex
      // corresponding to red, green and blue color respectively.
      highlightColor: "yellow"
    },
    visibleNavigationControls: {
      // True if first-page navigation button should be shown. Default is true.
      firstPage: true,
      // True if last-page navigation button should be shown. Default is true.
      lastPage: true,
      // True if previous-page navigation button should be shown. Default is true.
      prevPage: true,
      // True if next-page navigation button should be shown. Default is true.
      nextPage: true,
      // True if current-page indicator should be shown. Default is true.
      pageIndicator: true,
      // True if goto-page navigation control should be shown. Default is true.
      gotoPage: true
    },
    visibleZoomControls: {
      // True if fixed-steps zoom button should be shown. Default is true.
      fixedSteps: true,
      // True if zoom-in button should be shown. Default is true.
      zoomIn: true,
      // True if zoom-out button should be shown. Default is true.
      zoomOut: true
    },
    visibleRotationControls: {
      // True if clockwise-rotation button should be shown. Default is true.
      clockwise: true,
      // True if counter-clockwise-rotation button should be shown. Default is true.
      counterClockwise: true
    },
    visibleColorInversionControls: {
      // True if color-inversion button should be shown. 
      // Color inversion is effected on all pages. Default is false.
      allPages: true
    },
    visibleFileOperationControls: {
      // True if open-new-file button should be shown. 
      // This allows the user to open any file for viewing. Default is false.
      open: true,
      // True if download button should be shown. 
      // This allows the user to download the file that is open in the viewer. 
      // Default is false.
      download: true,
      // True if print button should be shown. 
      // This allows the user to print the file that is open in the viewer. 
      // Default is false
      print: true,
      // True if save button should be shown. 
      // This allows the user to save changes made to the document. 
      // Default is false
      save: true
    }
  };
  starDocs.viewer.createView(documentUrl, "password", viewerSettings);

ViewerSettings viewerSettings = new ViewerSettings();
// True if PDF form-filling feature should be enabled. Default is true.
viewerSettings.EnableFormFilling = true;
// True if toolbar should be shown. Default is true.
viewerSettings.ToolbarVisible = true;
// True if full-screen button should be shown. Default is false.
viewerSettings.FullScreenVisible = true;
// True if quick-search feature should be enabled. Default is true.
viewerSettings.SearchControls.EnableQuickSearch = true;
// The color of the highlight shown over the text occurrence. 
// It should either be a color like 'red' or of the form '#{RR}{GG}{BB}' 
// where {RR}, {GG}, {BB} are the color component values in hex
// corresponding to red, green and blue color respectively.
viewerSettings.SearchControls.HighlightColor = new Color(0, 255, 255);
// True if first-page navigation button should be shown. Default is true.
viewerSettings.VisibleNavigationControls.FirstPage = true;
// True if last-page navigation button should be shown. Default is true.
viewerSettings.VisibleNavigationControls.LastPage = true;
// True if previous-page navigation button should be shown. Default is true.
viewerSettings.VisibleNavigationControls.PrevPage = true;
// True if next-page navigation button should be shown. Default is true.
viewerSettings.VisibleNavigationControls.NextPage = true;
// True if current-page indicator should be shown. Default is true.
viewerSettings.VisibleNavigationControls.PageIndicator = true;
// True if goto-page navigation control should be shown. Default is true.
viewerSettings.VisibleNavigationControls.GotoPage = true;
// True if fixed-steps zoom button should be shown. Default is true.
viewerSettings.VisibleZoomControls.FixedSteps = true;
// True if zoom-in button should be shown. Default is true.
viewerSettings.VisibleZoomControls.ZoomIn = true;
// True if zoom-out button should be shown. Default is true.
viewerSettings.VisibleZoomControls.ZoomOut = true;
// True if clockwise-rotation button should be shown. Default is true.
viewerSettings.VisibleRotationControls.Clockwise = true;
// True if counter-clockwise-rotation button should be shown. Default is true.
viewerSettings.VisibleRotationControls.CounterClockwise = true;
// True if color-inversion button should be shown. 
// Color inversion is effected on all pages. Default is false.
viewerSettings.VisibleColorInversionControls.AllPages = false;
// True if open-new-file button should be shown. 
// This allows the user to open any file for viewing. Default is false.
viewerSettings.VisibleFileOperationControls.Open = true;
// True if download button should be shown. 
// This allows the user to download the file that is open in the viewer. 
// Default is false.
viewerSettings.VisibleFileOperationControls.Download = true;
// True if print button should be shown. 
// This allows the user to print the file that is open in the viewer. 
// Default is false
viewerSettings.VisibleFileOperationControls.Print = true;
// True if save button should be shown. 
// This allows the user to save changes made to the document. 
// Default is false
viewerSettings.VisibleFileOperationControls.Save = true;

ViewResponse response = starDocs.Viewer.CreateView(inFile, "password", viewerSettings);

ViewerSettings viewerSettings = new ViewerSettings();
// True if PDF form-filling feature should be enabled. Default is true.
viewerSettings.setEnableFormFilling(true);
// True if toolbar should be shown. Default is true.
viewerSettings.setToolbarVisible(true);
// True if full-screen button should be shown. Default is false.
viewerSettings.setFullScreenVisible(true);
// True if quick-search feature should be enabled. Default is true.
viewerSettings.getSearchControls().setEnableQuickSearch(true);
// The color of the highlight shown over the text occurrence. 
// It should either be a color like 'red' or of the form '#{RR}{GG}{BB}' 
// where {RR}, {GG}, {BB} are the color component values in hex
// corresponding to red, green and blue color respectively.
viewerSettings.getSearchControls().setHighlightColor(new Color(0, 255, 255));
// True if first-page navigation button should be shown. Default is true.
viewerSettings.getVisibleNavigationControls().setFirstPage(true);
// True if last-page navigation button should be shown. Default is true.
viewerSettings.getVisibleNavigationControls().setLastPage(true);
// True if previous-page navigation button should be shown. Default is true.
viewerSettings.getVisibleNavigationControls().setPrevPage(true);
// True if next-page navigation button should be shown. Default is true.
viewerSettings.getVisibleNavigationControls().setNextPage(true);
// True if current-page indicator should be shown. Default is true.
viewerSettings.getVisibleNavigationControls().setPageIndicator(true);
// True if goto-page navigation control should be shown. Default is true.
viewerSettings.getVisibleNavigationControls().setGotoPage(true);
// True if fixed-steps zoom button should be shown. Default is true.
viewerSettings.getVisibleZoomControls().setFixedSteps(true);
// True if zoom-in button should be shown. Default is true.
viewerSettings.getVisibleZoomControls().setZoomIn(true);
// True if zoom-out button should be shown. Default is true.
viewerSettings.getVisibleZoomControls().setZoomOut(true);
// True if clockwise-rotation button should be shown. Default is true.
viewerSettings.getVisibleRotationControls().setClockwise(true);
// True if counter-clockwise-rotation button should be shown. Default is true.
viewerSettings.getVisibleRotationControls().setCounterClockwise(true);
// True if color-inversion button should be shown. 
// Color inversion is effected on all pages. Default is false.
viewerSettings.getVisibleColorInversionControls().setAllPages(false);
// True if open-new-file button should be shown. 
// This allows the user to open any file for viewing. Default is false.
viewerSettings.getVisibleFileOperationControls().setOpen(true);
// True if download button should be shown. 
// This allows the user to download the file that is open in the viewer. 
// Default is false.
viewerSettings.getVisibleFileOperationControls().setDownload(true);
// True if print button should be shown. 
// This allows the user to print the file that is open in the viewer. 
// Default is false
viewerSettings.getVisibleFileOperationControls().setPrint(true);
// True if save button should be shown. 
// This allows the user to save changes made to the document. 
// Default is false
viewerSettings.getVisibleFileOperationControls().setSave(true);

ViewResponse response = starDocs.viewer.createView(inFile, "password", viewerSettings);

var
  HighlightColor: TgtColor;
  ViewResponse: TgtCreateViewResponse;
begin
  HighlightColor := nil;
  ViewResponse := nil;
  try
    // Set up the initial view settings
    StarDocs.Viewer.Preferences.InitialView.ZoomMode := pzmFitPage;

    // Set up the interactive features
    // True if PDF form-filling feature should be enabled. Default is true.
    StarDocs.Viewer.Preferences.InteractiveElements.FormFields.EnableFormFilling := True;

    // True if toolbar should be shown. Default is true.
    StarDocs.Viewer.Preferences.ToolbarVisible := True;
    // True if full-screen button should be shown. Default is false.
    StarDocs.Viewer.Preferences.FullScreenVisible := True;
    // True if all pages should not be loaded when the viewer is displayed.
    // The pages are loaded as the user scrolls. Default is false.
    StarDocs.Viewer.Preferences.LazyLoading := False;
    // True if the mouse right-click context menu should not be shown. Default is false.
    StarDocs.Viewer.Preferences.DisableContextMenu := False;
    // The quality of rendering of the document pages. Default is 96.
    StarDocs.Viewer.Preferences.RenderingDpi := 128;
    // True if quick-search feature should be enabled. Default is true.
    StarDocs.Viewer.Preferences.Search.EnableQuickSearch := True;
    // The color of the highlight shown over the text occurrence. 
    HighlightColor := TgtColor.Create(255, 255, 0);
    StarDocs.Viewer.Preferences.Search.HighlightColor.Assign(
      HighlightColor);
    // True if first-page navigation button should be shown. Default is true.
    StarDocs.Viewer.Preferences.VisibleNavigationControls.FirstPage := True;
    // True if last-page navigation button should be shown. Default is true.
    StarDocs.Viewer.Preferences.VisibleNavigationControls.LastPage := True;
    // True if previous-page navigation button should be shown. Default is true.
    StarDocs.Viewer.Preferences.VisibleNavigationControls.PrevPage := True;
    // True if next-page navigation button should be shown. Default is true.
    StarDocs.Viewer.Preferences.VisibleNavigationControls.NextPage := True;
    // True if current page indicator should be shown. Default is true.
    StarDocs.Viewer.Preferences.VisibleNavigationControls.PageIndicator := True;
    // True if goto-page navigation control should be shown. Default is true.
    StarDocs.Viewer.Preferences.VisibleNavigationControls.GotoPage := True;
    // True if fixed-steps zoom button should be shown. Default is true.
    StarDocs.Viewer.Preferences.VisibleZoomControls.FixedSteps := True;
    // True if zoom-in button should be shown. Default is true.
    StarDocs.Viewer.Preferences.VisibleZoomControls.ZoomIn := True;
    // True if zoom-out button should be shown. Default is true.
    StarDocs.Viewer.Preferences.VisibleZoomControls.ZoomOut := True;
    // True if clockwise-rotation button should be shown. Default is true.
    StarDocs.Viewer.Preferences.VisibleRotationControls.Clockwise := True;
    // True if counter-clockwise-rotation button should be shown. Default is true.
    StarDocs.Viewer.Preferences.VisibleRotationControls.CounterClockwise := True;
    // True if color-inversion button should be shown. 
    // Color inversion is effected on all pages. Default is false.
    StarDocs.Viewer.Preferences.VisibleColorInversionControls.AllPages := False;
    // True if download button should be shown. 
    // This allows the user to download the file that is open in the viewer. 
    // Default is false.
    StarDocs.Viewer.Preferences.VisibleFileOperationControls.Download := True;
    // True if print button should be shown. 
    // This allows the user to print the file that is open in the viewer. 
    // Default is false
    StarDocs.Viewer.Preferences.VisibleFileOperationControls.Print := True;
    // True if save button should be shown. 
    // This allows the user to save changes made to the document. 
    // Default is false
    StarDocs.Viewer.Preferences.VisibleFileOperationControls.Save := True;

    ViewResponse := StarDocs.Viewer.CreateView(DocObjectBalanceSheet);
  finally
    if Assigned(HighlightColor) then
      FreeAndNil(HighlightColor);
    if (ViewResponse) then
      FreeAndNil(ViewResponse);
  end;
end;