GroupDocs.Annotation-Cloud
23.12.0
dotnet add package GroupDocs.Annotation-Cloud --version 23.12.0
NuGet\Install-Package GroupDocs.Annotation-Cloud -Version 23.12.0
<PackageReference Include="GroupDocs.Annotation-Cloud" Version="23.12.0" />
paket add GroupDocs.Annotation-Cloud --version 23.12.0
#r "nuget: GroupDocs.Annotation-Cloud, 23.12.0"
// Install GroupDocs.Annotation-Cloud as a Cake Addin #addin nuget:?package=GroupDocs.Annotation-Cloud&version=23.12.0 // Install GroupDocs.Annotation-Cloud as a Cake Tool #tool nuget:?package=GroupDocs.Annotation-Cloud&version=23.12.0
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 specific elements with arrow markers.
Strikeout/Underline Annotations
Highlight text by striking through or underlining it for easy referencing.
Markup Features
Highlighting
Mark important sections of the text with highlights.
Redaction
Completely hide or censor sensitive content within documents.
Watermarking
Protect document integrity by adding 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 to store separately or share with others.
Collaboration Features
Commenting
Enable multi-user collaboration with thread-based commenting features.
Version Control
Keep track of changes made to annotations with versioning tools.
Real-Time Updates
Implement real-time updates when multiple users are working on the same document.
Security Features
Access Control
Secure document annotations with user-based access control.
Role-Based Permissions
Assign different permission levels to users to protect sensitive annotations.
Encryption
Ensure that data is securely encrypted during document transfer and storage.
Advanced Features
Combine Annotations
Merge multiple annotations into one document.
Layered Annotations
Add and manipulate layered annotations to give flexibility in redacting and marking documents.
Custom Annotation Styles
Set custom colors, opacity, and size for annotations.
API Integration
Seamless integration with other systems and applications using 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
File Format | Description | Annotate |
---|---|---|
DOC, DOCX | Word® Document | ✔️ |
OTT | Open Document Standard Format | ✔️ |
ODT | Open Document Text File Format | ✔️ |
DOCM | Microsoft Word® Open XML Macro-Enabled Document | ✔️ |
DOT | Word® Document Template File | ✔️ |
DOTX | Word® Open XML Document Template | ✔️ |
DOTM | Word® Open XML Macro-Enabled Template File | ✔️ |
RTF | Rich Text File Format | ✔️ |
TXT | Plain Text File Format | ✔️ |
Portable Document Format | ✔️ | |
PPT, PPTX | Presentation Document Format | ✔️ |
PPSX | PowerPoint Open XML Slide Show | ✔️ |
ODP | OpenDocument Presentation File Format | ✔️ |
OTP | OpenDocument Presentation Template | ✔️ |
XLS, XLSX | Cells Document Format | ✔️ |
XLSB | Microsoft Excel® Binary Spreadsheet File | ✔️ |
XLSX | Microsoft Excel® Open XML Spreadsheet | ✔️ |
DICOM | Digital Imaging and Communication in Medicine | ✔️ |
DJVU | DjVu Format | ✔️ |
EMF/WMF | Enhanced MetaFile / Windows MetaFile | ✔️ |
CAD | Computer-Aided Design | ✔️ |
EML/EMLX | Email Markup Language | ✔️ |
HTML | Hypertext Markup Language | ✔️ |
MHTML | MIME HTML File | ✔️ |
JPEG | Joint Photographic Experts Group | ✔️ |
TIFF | Tagged Image File Format | ✔️ |
BMP | Bitmap | ✔️ |
GIF (static images without animation) | Graphics Interchange Format | ✔️ |
VSD | Microsoft Visio® Drawing | ✔️ |
VDX | Microsoft Visio® XML File Format | ✔️ |
VSS | Microsoft Visio® Stencil File Format | ✔️ |
VSDM | Microsoft Visio® Macro-Enabled Drawing File | ✔️ |
MSG | Email Message | ✔️ |
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
andClient 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
andClient 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 SDK for .NET Code Samples
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);
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net20 is compatible. net35 was computed. net40 was computed. net403 was computed. net45 was computed. net451 was computed. net452 was computed. net46 was computed. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 2.0
- Newtonsoft.Json (>= 12.0.3)
-
.NETStandard 2.0
- Newtonsoft.Json (>= 12.0.3)
- System.Diagnostics.TraceSource (>= 4.3.0)
- System.Net.Requests (>= 4.3.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
23.12.0 | 213 | 12/27/2023 |
23.4.0 | 219 | 4/14/2023 |
22.2.0 | 501 | 2/3/2022 |
21.6.0 | 366 | 6/17/2021 |
21.2.0 | 384 | 2/17/2021 |
20.10.0 | 476 | 10/14/2020 |
19.5.0 | 791 | 5/15/2019 |
18.7.0 | 725 | 12/19/2018 |
18.7.0-alpha-20181219073816 | 519 | 12/19/2018 |
18.4.0 | 989 | 5/15/2018 |
18.4.0-alpha-20180514065856 | 850 | 5/15/2018 |
17.12.0 | 1,056 | 1/24/2018 |