S4ServiceClient.annotateFileContents Method

S4ServiceClientannotateFileContents Method

A Sandcastle Documented Class Library

Annotates the contents of a single file 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 annotateFileContents(
	FileStream documentContent,
	string documentEncoding,
	SupportedMimeType documentMimeType
)

Public Function annotateFileContents ( 
	documentContent As FileStream,
	documentEncoding As String,
	documentMimeType As SupportedMimeType
) As AnnotatedDocument

public:
AnnotatedDocument^ annotateFileContents(
	FileStream^ documentContent, 
	String^ documentEncoding, 
	SupportedMimeType documentMimeType
)

member annotateFileContents : 
        documentContent : FileStream * 
        documentEncoding : string * 
        documentMimeType : SupportedMimeType -> AnnotatedDocument

Parameters

documentContent: Type: System.IOFileStream
the file whose contents will be annotated
documentEncoding: Type: SystemString
the encoding of the document file
documentMimeType: Type: Ontotext.S4.serviceSupportedMimeType
the MIME type of the document to annotated

Return Value

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

Reference

S4ServiceClient Class

Ontotext.S4.service Namespace