If so you can download any of the below versions for testing. The product will function as normal except for an evaluation limitation. At the time of purchase we provide a license file via email that will allow the product to work in its full capacity. If you would also like an evaluation license to test without any restrictions for 30 days, please follow the directions provided here.
If you experience errors, when you try to download a file, make sure your network policies (enforced by your company or ISP) allow downloading ZIP and/or MSI files.
Installation
The package is available at rubygems.org and it can be installed via gem by executing the following command:
gem install groupdocs_annotation_cloud
Getting Started GroupDocs.Annotation Cloud Ruby SDK
Installation
A gem of groupdocs_annotation_cloud is available at rubygems.org. You can install it with:
gem install groupdocs_annotation_cloud
To add dependency to your app copy following into your Gemfile and run bundle install:
gem "groupdocs_annotation_cloud", "~> 23.12"
Please follow the installation procedure and then run the following code:
# Load the gem
require 'groupdocs_annotation_cloud'
# Get your app_sid and app_key at https://dashboard.groupdocs.cloud (free registration is required).
app_sid = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
app_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
# Create instance of the API class
api = GroupDocsAnnotationCloud::InfoApi.from_keys(app_sid, app_key)
# Retrieve supported file-formats
response = api.get_supported_file_formats
# Print out supported file-formats
puts("Supported file-formats:")
response.formats.each do |format|
puts("#{format.file_format} (#{format.extension})")
end
GroupDocs.Annotation Cloud API Data Models
FilesUploadResult, Error, ErrorDetails, FilesList, StorageFile, StorageExist, ObjectExist, DiscUsage, FileVersions, FileVersion, AnnotationInfo, Rectangle, Point, AnnotationReplyInfo, FileInfo, AnnotationApiLink, Link, RemoveOptions, AnnotateOptions, FormatsResult, Format, DocumentInfo, PageInfo, ConsumptionResult, PageImages, PageImage, LinkElement, PreviewOptions
Ruby Code Sample 1: Add Text Annotation
This code sample demonstrates how to add a text annotation to a document using GroupDocs.Annotation Cloud SDK for Ruby. The text annotation is customizable in terms of position, font, and color.
# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby-samples
require 'groupdocs_annotation_cloud'
$app_sid = "XXXX-XXXX-XXXX-XXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$app_key = "XXXXXXXXXXXXXXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$api = GroupDocsAnnotationCloud::AnnotateApi.from_keys($app_sid, $app_key)
$a1 = GroupDocsAnnotationCloud::AnnotationInfo.new
$a1.annotation_position = GroupDocsAnnotationCloud::Point.new
$a1.annotation_position.x = 1
$a1.annotation_position.y = 1
$a1.box = GroupDocsAnnotationCloud::Rectangle.new
$a1.box.x = 100
$a1.box.y = 100
$a1.box.width = 200
$a1.box.height = 100
$a1.page_number = 0
$a1.font_color = 1201033
$a1.font_size = 12
$a1.opacity = 0.7
$a1.type = "TextField"
$a1.text = "Text field text"
$a1.creator_name = "Anonym A."
file_info = GroupDocsAnnotationCloud::FileInfo.new()
file_info.file_path = "annotationdocs\\one-page.docx"
options = GroupDocsAnnotationCloud::AnnotateOptions.new()
options.file_info = file_info
options.annotations = [$a1]
options.output_path = "Output/output.docx"
$request = GroupDocsAnnotationCloud::AnnotateRequest.new(options)
# Executing an API.
result = $api.annotate($request)
puts("AddTextFieldAnnotation: Text Field Annotation added: " + result.href)
Ruby Code Sample 2: Add Area Annotation
This code sample demonstrates how to add an area annotation (highlighting a section of a document).
# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby-samples
require 'groupdocs_annotation_cloud'
$app_sid = "XXXX-XXXX-XXXX-XXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$app_key = "XXXXXXXXXXXXXXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$api = GroupDocsAnnotationCloud::AnnotateApi.from_keys($app_sid, $app_key)
$a1 = GroupDocsAnnotationCloud::AnnotationInfo.new
$a1.annotation_position = GroupDocsAnnotationCloud::Point.new
$a1.annotation_position.x = 1
$a1.annotation_position.y = 1
$a1.box = GroupDocsAnnotationCloud::Rectangle.new
$a1.box.x = 100
$a1.box.y = 100
$a1.box.width = 200
$a1.box.height = 100
$a1.page_number = 0
$a1.pen_color = 1201033
$a1.pen_style = "Solid"
$a1.pen_width = 1
$a1.opacity = 0.7
$a1.type = "Area"
$a1.text = "This is area annotation"
$a1.creator_name = "Anonym A."
file_info = GroupDocsAnnotationCloud::FileInfo.new()
file_info.file_path = "annotationdocs\\one-page.docx"
options = GroupDocsAnnotationCloud::AnnotateOptions.new()
options.file_info = file_info
options.annotations = [$a1]
options.output_path = "Output/output.docx"
$request = GroupDocsAnnotationCloud::AnnotateRequest.new(options)
# Executing an API.
result = $api.annotate($request)
puts("AddAreaAnnotation: Area Annotation added: " + result.href)
Ruby Code Sample 3: Remove Annotation
This code sample demonstrates how to remove an annotation from a document.
# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby-samples
require 'groupdocs_annotation_cloud'
$app_sid = "XXXX-XXXX-XXXX-XXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$app_key = "XXXXXXXXXXXXXXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$api = GroupDocsAnnotationCloud::AnnotateApi.from_keys($app_sid, $app_key)
file_info = GroupDocsAnnotationCloud::FileInfo.new()
file_info.file_path = "annotationdocs\\input.docx"
options = GroupDocsAnnotationCloud::RemoveOptions.new()
options.file_info = file_info
options.annotation_ids = [1, 2, 3]
options.output_path = "Output/output.docx"
$request = GroupDocsAnnotationCloud::RemoveAnnotationsRequest.new(options)
# Executing an API.
$response = $api.remove_annotations($request)
puts("RemoveAnnotations: Annotations deleted from document: " + $response.href)