Some document types like Microsoft Word, Excel, OpenOffice Text and Spreadsheet may contain comments. Your requirement to include or exclude the comments in output representation of the document may vary in different situations. GroupDocs.Viewer Cloud enables you to control the rendering of document comments.
By default, comments are not rendered into the output document. The API provides RenderComments property of HtmlOptions (or JpgViewOptions, or PdfOptions) class that enables rendering of comments.
This feature is supported for:
Microsoft Word documents
Spreadsheets
PDF documents
Presentations
The following code sample shows how to render documents with comments.
API Usage
There are steps that usage of GroupDocs.Viewer Cloud consists of:
Upload input document into cloud storage
Render document or get document info
Download rendered document from storage
Steps 1 and 3 are storage operations, please refer to this File API documentation for usage details.
Swagger UI lets you call this REST API directly from the browser.
cURL example
# First get JSON Web Token# Please get your Client Id and Client Secret from https://dashboard.groupdocs.cloud/applications. Kindly place Client Id in "client_id" and Client Secret in "client_secret" argument.curl -v "https://api.groupdocs.cloud/connect/token"\
-X POST \
-d "grant_type=client_credentials&client_id=xxxx&client_secret=xxxx"\
-H "Content-Type: application/x-www-form-urlencoded"\
-H "Accept: application/json"# cURL example to get document informationcurl -v "https://api.groupdocs.cloud/v2.0/viewer/view"\
-X POST \
-H "Content-Type: application/json"\
-H "Accept: application/json"\
-H "Authorization: Bearer <jwt token>"-d "{
'FileInfo': {
'FilePath': 'SampleFiles/with_comment.docx'
},
'ViewFormat': 'HTML',
'RenderOptions': {
'RenderComments': true
}
}"
The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.
// For complete examples and data files, please go to https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-dotnet-samplesstringMyClientSecret="";// Get Client Id and Client Secret from https://dashboard.groupdocs.cloudstringMyClientId="";// Get Client Id and Client Secret from https://dashboard.groupdocs.cloudvarconfiguration=newConfiguration(MyClientId,MyClientSecret);varapiInstance=newViewApi(configuration);varviewOptions=newViewOptions{FileInfo=newFileInfo{FilePath="SampleFiles/with_comment.docx"},ViewFormat=ViewOptions.ViewFormatEnum.HTML,RenderOptions=newRenderOptions{RenderComments=true}};varresponse=apiInstance.CreateView(newCreateViewRequest(viewOptions));
// For complete examples and data files, please go to https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-php-samples
useGroupDocs\Viewer\Model;useGroupDocs\Viewer\Model\Requests;$ClientId="";// Get Client Id and Client Secret from https://dashboard.groupdocs.cloud
$ClientSecret="";// Get Client Id and Client Secret from https://dashboard.groupdocs.cloud
$configuration=newGroupDocs\Viewer\Configuration();$configuration->setAppSid($ClientId);$configuration->setAppKey($ClientSecret);$apiInstance=newGroupDocs\Viewer\ViewApi($configuration);$viewOptions=newModel\ViewOptions();$fileInfo=newModel\FileInfo();$fileInfo->setFilePath("SampleFiles/with_comment.docx");$viewOptions->setFileInfo($fileInfo);$viewOptions->setViewFormat(Model\ViewOptions::VIEW_FORMAT_HTML);$renderOptions=newModel\HtmlOptions();$renderOptions->setRenderComments(true);$viewOptions->setRenderOptions($renderOptions);$request=newRequests\CreateViewRequest($viewOptions);$response=$apiInstance->createView($request);
// For complete examples and data files, please go to https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-java-samples
stringMyClientSecret="";// Get Client Id and Client Secret from https://dashboard.groupdocs.cloud
stringMyClientId="";// Get Client Id and Client Secret from https://dashboard.groupdocs.cloud
Configurationconfiguration=newConfiguration(MyClientId,MyClientSecret);ViewApiapiInstance=newViewApi(configuration);FileInfofileInfo=newFileInfo();fileInfo.setFilePath("SampleFiles/with_comment.docx");ViewOptionsviewOptions=newViewOptions();viewOptions.setFileInfo(fileInfo);viewOptions.setViewFormat(ViewFormatEnum.HTML);RenderOptionsrenderOptions=newRenderOptions();renderOptions.setRenderComments(true);viewOptions.setRenderOptions(renderOptions);ViewResultresponse=apiInstance.createView(newCreateViewRequest(viewOptions));
# For complete examples and data files, please go to https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-ruby-samplesrequire'groupdocs_viewer_cloud'$client_id="XXXX-XXXX-XXXX-XXXX"# Get Client Id and Client Secret from https://dashboard.groupdocs.cloud$client_secret="XXXXXXXXXXXXXXXX"# Get Client Id and Client Secret from https://dashboard.groupdocs.cloudapiInstance=GroupDocsViewerCloud::ViewApi.from_keys($client_id,$client_secret)viewOptions=GroupDocsViewerCloud::ViewOptions.newviewOptions.file_info=GroupDocsViewerCloud::FileInfo.newviewOptions.file_info.file_path="SampleFiles/with_comment.docx"viewOptions.view_format="HTML"viewOptions.render_options=GroupDocsViewerCloud::HtmlOptions.newviewOptions.render_options.render_comments=truerequest=GroupDocsViewerCloud::CreateViewRequest.new(viewOptions)response=apiInstance.create_view(request)
// For complete examples and data files, please go to https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-node-samples
global.viewer#require("groupdocs-viewer-cloud");global.clientId="XXXX-XXXX-XXXX-XXXX";// Get Client Id and Client Secret from https://dashboard.groupdocs.cloud
global.clientSecret="XXXXXXXXXXXXXXXX";// Get Client Id and Client Secret from https://dashboard.groupdocs.cloud
global.viewApi=viewer_cloud.ViewApi.fromKeys(clientId,clientSecret);letfileInfo=newviewer_cloud.FileInfo();fileInfo.filePath="SampleFiles/with_comment.docx";letviewOptions=newviewer_cloud.ViewOptions();viewOptions.fileInfo=fileInfo;viewOptions.viewFormat=viewer_cloud.ViewOptions.ViewFormatEnum.HTML;viewOptions.renderOptions=newviewer_cloud.HtmlOptions();viewOptions.renderOptions.renderComments=true;letrequest=newviewer_cloud.CreateViewRequest(viewOptions);letresponse=awaitviewApi.createView(request);
# For complete examples and data files, please go to https://github.com/groupdocs-viewer-cloud/groupdocs-viewer-cloud-python-samplesimportgroupdocs_viewer_cloudclient_id="XXXX-XXXX-XXXX-XXXX"# Get Client Id and Client Secret from https://dashboard.groupdocs.cloudclient_secret="XXXXXXXXXXXXXXXX"# Get Client Id and Client Secret from https://dashboard.groupdocs.cloudapiInstance=groupdocs_viewer_cloud.ViewApi.from_keys(client_id,client_secret)view_options=groupdocs_viewer_cloud.ViewOptions()view_options.file_info=groupdocs_viewer_cloud.FileInfo()view_options.file_info.file_path="SampleFiles/with_comment.docx"view_options.view_format="HTML"view_options.render_options=groupdocs_viewer_cloud.HtmlOptions()view_options.render_options.render_comments=Truerequest=groupdocs_viewer_cloud.CreateViewRequest(view_options)response=apiInstance.create_view(request)
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.