Installation

The package is available at nuget.org and it can be installed via package manager console by executing following command:

PM> NuGet\Install-Package GroupDocs.Annotation-Cloud

Document Annotation .NET Cloud REST API

GroupDocs.Annotation Cloud SDK for .NET is designed for efficient annotation of documents in the cloud. It provides developers with tools to manage annotations on a variety of document formats. The SDK supports operations such as adding, editing, and deleting annotations. It also includes features for extracting annotations and metadata from documents.

Document Annotations

Text Annotations - Add comments or explanations within the text.
Area Annotations - Highlight specific areas of a document for detailed notes.
Point Annotations - Mark specific points of interest in a document.
Arrow Annotations - Direct viewers’ attention to elements with arrow markers.
Strikeout/Underline Annotations - Strike through or underline text for easy reference.

Markup Features

Highlighting - Mark important sections of the text with highlights.
Redaction - Hide or censor sensitive content within documents.
Watermarking - Add watermarks to indicate ownership or status.

Annotation Management

Edit Annotations - Modify or update existing annotations in documents.
Delete Annotations - Remove unnecessary or outdated annotations.
Export Annotations - Extract and export annotations for storage or sharing.

Collaboration Features

Commenting - Enable multi-user collaboration via thread-based comments.
Version Control - Track changes to annotations with versioning tools.
Real-Time Updates - Provide real-time updates for simultaneous editing.

Security Features

Access Control - Secure document annotations with user-based access control.
Role-Based Permissions - Assign permission levels to protect sensitive annotations.
Encryption - Encrypt data during document transfer and storage.

Advanced Features

Combine Annotations - Merge multiple annotations into one document.
Layered Annotations - Use layered annotations for flexible redaction and marking.
Custom Annotation Styles - Set custom colors, opacity, and size for annotations.
API Integration - Integrate with other systems via REST APIs.
Scalable Infrastructure - Supports high‑load environments with scalable architecture.

Supported Annotation Types and Features

Area Annotation

• Mark up an area within the document page with a rectangle.
  • Allows users to highlight a specific region on a document.
  • Box dimensions can be customized to fit the area of interest.
  • Supports replies to annotations for collaborative reviews.
  • The area annotation can include additional comments.

Distance Annotation

• Measures the distance between objects in a document.
  • Enables precise measurements within document content.
  • Coordinates and dimensions can be defined for exact measurements.
  • Useful for architectural and engineering documents where distance measures are critical.

Ellipse Annotation

• Draws elliptic annotations on a document page.
  • Enables users to highlight circular or elliptic areas.
  • Customizable radius, color, and opacity for clear visibility.
  • Supports multiple replies for added comments on the marked area.

Image Annotation

• Adds an image to a specific area of the document.
  • Inserts images within a document page for visual reference.
  • Supports positioning and resizing of images.
  • Useful for adding logos, stamps, or visual marks.

Link Annotation

• Adds a hyperlink to a document.
  • Links specific text or areas of the document to external URLs.
  • Provides support for web navigation or referencing additional resources.
  • Can be styled with different colors to differentiate from the text.

Multiple Annotation

• Allows adding multiple types of annotations simultaneously.
  • Supports adding a combination of annotations (e.g., text, images, shapes) at once.
  • Useful for reviewing documents where different annotation types are needed on the same page.
  • Multiple annotations can be grouped or treated separately.

Point Annotation

• Sticks comments to a specific point in the document.
  • Comments are associated with a specific point or location within the document.
  • Ideal for collaborative document reviews where pinpointing feedback is necessary.
  • Supports color and size adjustments for better visibility.

Polyline Annotation

• Draws connected lines to form a polyline in a document.
  • Used for drawing complex shapes or marking specific paths in a document.
  • Supports multiple points connected by straight lines.
  • Allows customization of line thickness, color, and opacity.

Resource Redaction Annotation

• Fills a black rectangle in a fixed position to hide sensitive information.
  • Effectively redacts confidential information from documents.
  • The black box can be sized and positioned over any sensitive data.
  • Commonly used for legal documents, financial statements, or personal identification numbers (PINs).

Squiggly Annotation

• Adds a wavy underline to mark text.
  • Highlights text with a squiggly underline for attention.
  • Ideal for marking spelling or grammatical errors.
  • Color and line style can be adjusted to differentiate from other annotations.

Supported Annotation Formats

Getting Started with GroupDocs.Annotation Cloud

Create an Account

• Visit the Dashboard and register for a free account.

Create an API Client App

• Generate your Client ID and Client Secret from the Dashboard to authenticate API requests.

Install the SDK

• Install the SDK of your choice to integrate GroupDocs.Annotation into your application.
• For example, to install the .NET SDK:

   PM> Install-Package GroupDocs.Annotation-Cloud

Make Your First API Request

• Use your Client ID and Client Secret to make an API request. Here’s a sample for retrieving supported formats:

// For complete examples, visit https://github.com/groupdocs-annotation-cloud
string ClientId = "YourClientId";
string ClientSecret = "YourClientSecret";

var configuration = new Configuration(ClientId, ClientSecret);
var apiInstance = new InfoApi(configuration);
var response = apiInstance.GetSupportedFileFormats();

For more detailed examples and SDKs, visit the GitHub repository.

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

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 .NET. The text annotation is customizable in terms of position, font, and color.

// Adding a text annotation to a document using GroupDocs.Annotation for .NET SDK.
// Required namespaces
using GroupDocs.Annotation.Cloud.Sdk.Api;
using GroupDocs.Annotation.Cloud.Sdk.Model;
using GroupDocs.Annotation.Cloud.Sdk.Model.Requests;

// Initialize API instance
var configuration = new Configuration { ClientId = "Your_Client_Id", ClientSecret = "Your_Client_Secret" };
var apiInstance = new AnnotateApi(configuration);

// Define the file path and annotation parameters
var filePath = "path/to/document.pdf";
var textAnnotation = new AnnotationInfo
{
    PageNumber = 0, // Apply on the first page
    Type = AnnotationInfo.TypeEnum.Text, // Annotation type
    Text = "This is a text annotation.", // The text to display
    FontColor = 1201033, // RGB color for the text
    Box = new Rectangle { X = 200, Y = 200, Width = 100, Height = 50 } // Position of the annotation
};

// Create a request to add the annotation
var request = new AnnotateRequest { Name = filePath, Annotations = new List<AnnotationInfo> { textAnnotation } };
var response = apiInstance.Annotate(request);
Console.WriteLine("Annotation added: " + response);

Code Sample 2: Add Area Annotation

This code sample demonstrates how to add an area annotation (highlighting a section of a document).

// Adding an area annotation to highlight a specific section of the document.
// Required namespaces
using GroupDocs.Annotation.Cloud.Sdk.Api;
using GroupDocs.Annotation.Cloud.Sdk.Model;
using GroupDocs.Annotation.Cloud.Sdk.Model.Requests;

// Initialize API instance
var configuration = new Configuration { ClientId = "Your_Client_Id", ClientSecret = "Your_Client_Secret" };
var apiInstance = new AnnotateApi(configuration);

// Define the file path and area annotation parameters
var filePath = "path/to/document.pdf";
var areaAnnotation = new AnnotationInfo
{
    PageNumber = 0, // Apply on the first page
    Type = AnnotationInfo.TypeEnum.Area, // Annotation type
    BackgroundColor = 65535, // Highlight color (yellow)
    Box = new Rectangle { X = 100, Y = 150, Width = 200, Height = 100 } // Position and size of the area
};

// Create a request to add the area annotation
var request = new AnnotateRequest { Name = filePath, Annotations = new List<AnnotationInfo> { areaAnnotation } };
var response = apiInstance.Annotate(request);
Console.WriteLine("Area annotation added: " + response);

Code Sample 3: Remove Annotation

This code sample demonstrates how to remove an annotation from a document.

// Removing an annotation from a document using GroupDocs.Annotation for .NET SDK.
// Required namespaces
using GroupDocs.Annotation.Cloud.Sdk.Api;
using GroupDocs.Annotation.Cloud.Sdk.Model;
using GroupDocs.Annotation.Cloud.Sdk.Model.Requests;

// Initialize API instance
var configuration = new Configuration { ClientId = "Your_Client_Id", ClientSecret = "Your_Client_Secret" };
var apiInstance = new AnnotateApi(configuration);

// Define the file path and annotation ID to be removed
var filePath = "path/to/document.pdf";
var annotationId = "your_annotation_id";

// Create a request to remove the annotation
var request = new RemoveAnnotationsRequest { Name = filePath, AnnotationIds = new List<string> { annotationId } };
var response = apiInstance.RemoveAnnotations(request);
Console.WriteLine("Annotation removed: " + response);