S4ServiceClient.annotateDocument Method

S4ServiceClientannotateDocument Method

A Sandcastle Documented Class Library

Annotates a single document with the specified MIME type. Returns an object which allows for convenient access to the annotations in the annotated document.

Namespace: Ontotext.S4.service
Assembly: S4ClientLibrary (in S4ClientLibrary.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public AnnotatedDocument annotateDocument(
	string documentText,
	SupportedMimeType documentMimeType
)

Public Function annotateDocument ( 
	documentText As String,
	documentMimeType As SupportedMimeType
) As AnnotatedDocument

public:
AnnotatedDocument^ annotateDocument(
	String^ documentText, 
	SupportedMimeType documentMimeType
)

member annotateDocument : 
        documentText : string * 
        documentMimeType : SupportedMimeType -> AnnotatedDocument

Parameters

documentText: Type: SystemString
the document content to annotate
documentMimeType: Type: Ontotext.S4.serviceSupportedMimeType
the MIME type of the document which will beannotated

Return Value

Type: AnnotatedDocument
an {@link AnnotatedDocument} containing the original content as well as the annotations produced

Reference

S4ServiceClient Class

Ontotext.S4.service Namespace