Examples for SDK v20.3

Author: SergeiTerentev

Examples/.buildpath

@@ -0,0 +1,20 @@
+# Import modules
+require './Common.rb'
+
+# This example demonstrates how to apply the watermark to the output pages
+class AddWatermark
+    def self.Run()        
+        apiInstance = GroupDocsViewerCloud::ViewApi.from_config($config)
+        viewOptions = GroupDocsViewerCloud::ViewOptions.new
+        viewOptions.file_info = GroupDocsViewerCloud::FileInfo.new
+        viewOptions.file_info.file_path = "SampleFiles/sample.docx"
+        viewOptions.view_format = "HTML"
+        viewOptions.watermark = GroupDocsViewerCloud::Watermark.new
+        viewOptions.watermark.text = "This is a watermark"
+
+        request = GroupDocsViewerCloud::CreateViewRequest.new(viewOptions)    
+        response = apiInstance.create_view(request)
+
+        puts("AddWatermark completed: " + response.pages.length.to_s)
+    end
+end

Examples/.project

@@ -0,0 +1,23 @@
+# Import modules
+require './Common.rb'
+
+# This example demonstrates how to rotate output pages when viewing a document as PDF
+class FlipRotatePages
+    def self.Run()        
+        apiInstance = GroupDocsViewerCloud::ViewApi.from_config($config)
+        viewOptions = GroupDocsViewerCloud::ViewOptions.new
+        viewOptions.file_info = GroupDocsViewerCloud::FileInfo.new
+        viewOptions.file_info.file_path = "SampleFiles/sample.docx"
+        viewOptions.view_format = "PDF"
+        viewOptions.render_options = GroupDocsViewerCloud::PdfOptions.new
+        page_rotation = GroupDocsViewerCloud::PageRotation.new
+        page_rotation.page_number = 1
+        page_rotation.rotation_angle = "On90Degree"
+        viewOptions.render_options.page_rotations = [page_rotation]
+
+        request = GroupDocsViewerCloud::CreateViewRequest.new(viewOptions)    
+        response = apiInstance.create_view(request)
+
+        puts("FlipRotatePages completed: " + response.file.path)
+    end
+end

Examples/AdvancedUsage/CommonRenderingOptions/AddWatermark.rb

@@ -0,0 +1,20 @@
+# Import modules
+require './Common.rb'
+
+# This example demonstrates how to render documents with comments
+class RenderComments
+    def self.Run()        
+        apiInstance = GroupDocsViewerCloud::ViewApi.from_config($config)
+        viewOptions = GroupDocsViewerCloud::ViewOptions.new
+        viewOptions.file_info = GroupDocsViewerCloud::FileInfo.new
+        viewOptions.file_info.file_path = "SampleFiles/with_comment.docx"
+        viewOptions.view_format = "HTML"
+        viewOptions.render_options = GroupDocsViewerCloud::HtmlOptions.new
+        viewOptions.render_options.render_comments = true
+
+        request = GroupDocsViewerCloud::CreateViewRequest.new(viewOptions)    
+        response = apiInstance.create_view(request)
+
+        puts("RenderComments completed: " + response.pages.length.to_s)
+    end
+end

Examples/AdvancedUsage/CommonRenderingOptions/FlipRotatePages.rb

@@ -0,0 +1,21 @@
+# Import modules
+require './Common.rb'
+
+# This example demonstrates how to render consecutive pages
+class RenderConsecutivePages
+    def self.Run()        
+        apiInstance = GroupDocsViewerCloud::ViewApi.from_config($config)
+        viewOptions = GroupDocsViewerCloud::ViewOptions.new
+        viewOptions.file_info = GroupDocsViewerCloud::FileInfo.new
+        viewOptions.file_info.file_path = "SampleFiles/sample.docx"
+        viewOptions.view_format = "HTML"
+        viewOptions.render_options = GroupDocsViewerCloud::HtmlOptions.new
+        viewOptions.render_options.start_page_number = 1
+        viewOptions.render_options.count_pages_to_render = 2
+
+        request = GroupDocsViewerCloud::CreateViewRequest.new(viewOptions)    
+        response = apiInstance.create_view(request)
+
+        puts("RenderConsecutivePages completed: " + response.pages.length.to_s)
+    end
+end

Examples/AdvancedUsage/CommonRenderingOptions/RenderComments.rb

@@ -0,0 +1,20 @@
+# Import modules
+require './Common.rb'
+
+# This example demonstrates how to render hidden page
+class RenderHiddenPages
+    def self.Run()        
+        apiInstance = GroupDocsViewerCloud::ViewApi.from_config($config)
+        viewOptions = GroupDocsViewerCloud::ViewOptions.new
+        viewOptions.file_info = GroupDocsViewerCloud::FileInfo.new
+        viewOptions.file_info.file_path = "SampleFiles/with_hidden_page.pptx"
+        viewOptions.view_format = "HTML"
+        viewOptions.render_options = GroupDocsViewerCloud::HtmlOptions.new
+        viewOptions.render_options.render_hidden_pages = true
+
+        request = GroupDocsViewerCloud::CreateViewRequest.new(viewOptions)    
+        response = apiInstance.create_view(request)
+
+        puts("RenderHiddenPages completed: " + response.pages.length.to_s)
+    end
+end

Examples/AdvancedUsage/CommonRenderingOptions/RenderConsecutivePages.rb

@@ -0,0 +1,20 @@
+# Import modules
+require './Common.rb'
+
+# This example demonstrates how to render documents with notes
+class RenderNotes
+    def self.Run()        
+        apiInstance = GroupDocsViewerCloud::ViewApi.from_config($config)
+        viewOptions = GroupDocsViewerCloud::ViewOptions.new
+        viewOptions.file_info = GroupDocsViewerCloud::FileInfo.new
+        viewOptions.file_info.file_path = "SampleFiles/with_notes.pptx"
+        viewOptions.view_format = "HTML"
+        viewOptions.render_options = GroupDocsViewerCloud::HtmlOptions.new
+        viewOptions.render_options.render_notes = true
+
+        request = GroupDocsViewerCloud::CreateViewRequest.new(viewOptions)    
+        response = apiInstance.create_view(request)
+
+        puts("RenderNotes completed: " + response.pages.length.to_s)
+    end
+end

Examples/AdvancedUsage/CommonRenderingOptions/RenderHiddenPages.rb

@@ -0,0 +1,20 @@
+# Import modules
+require './Common.rb'
+
+# This example demonstrates how to render selected pages
+class RenderSelectedPages
+    def self.Run()        
+        apiInstance = GroupDocsViewerCloud::ViewApi.from_config($config)
+        viewOptions = GroupDocsViewerCloud::ViewOptions.new
+        viewOptions.file_info = GroupDocsViewerCloud::FileInfo.new
+        viewOptions.file_info.file_path = "SampleFiles/sample.docx"
+        viewOptions.view_format = "HTML"
+        viewOptions.render_options = GroupDocsViewerCloud::HtmlOptions.new
+        viewOptions.render_options.pages_to_render = [2, 3]
+
+        request = GroupDocsViewerCloud::CreateViewRequest.new(viewOptions)    
+        response = apiInstance.create_view(request)
+
+        puts("RenderSelectedPages completed: " + response.pages.length.to_s)
+    end
+end

Examples/AdvancedUsage/CommonRenderingOptions/RenderNotes.rb

@@ -0,0 +1,20 @@
+# Import modules
+require './Common.rb'
+
+# This example demonstrates how to  to set custom font source when rendering documents
+class RenderWithCustomFonts
+    def self.Run()        
+        apiInstance = GroupDocsViewerCloud::ViewApi.from_config($config)
+        viewOptions = GroupDocsViewerCloud::ViewOptions.new
+        viewOptions.file_info = GroupDocsViewerCloud::FileInfo.new
+        viewOptions.file_info.file_path = "SampleFiles/with_missing_font.odg"
+        viewOptions.view_format = "HTML"
+        # NOTE: Upload fonts to the folder using storage API before rendering
+        viewOptions.fonts_path = "Fonts"
+
+        request = GroupDocsViewerCloud::CreateViewRequest.new(viewOptions)    
+        response = apiInstance.create_view(request)
+
+        puts("RenderWithCustomFonts completed: " + response.pages.length.to_s)
+    end
+end