Section Class

Section Class

Define a single section of a document

Inheritance Hierarchy

SystemObject
DocuWare.Platform.ServerClientSection

Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient (in DocuWare.Platform.ServerClient.dll) Version: Version 6.9

Syntax

Copy

[XmlTypeAttribute(Namespace = "http://dev.docuware.com/schema/public/services/platform")]
[XmlRootAttribute(Namespace = "http://dev.docuware.com/schema/public/services/platform", 
	IsNullable = false)]
public class Section : IChunkable, IRelationsWithProxy, 
	IRelations, IHttpClientProxy

The Section type exposes the following members.

Constructors

	Name	Description
	Section	Creates a new instance of this class

Top

Properties

	Name	Description
	AnnotationAsSvgRelationLink	Gets the Uri of the link for the relation “annotationAsSvg”.
	ContentModified	Time when content is last modified
	ContentRelationLink	Gets the Uri of the link for the relation “content”.
	ContentType	The Internet media type of the section. If there is no section this value is missing.
	DeepZoomImageRelationLink	Gets the Uri of the link for the relation “deepZoomImage”.
	DeepZoomImageWithAnnotationRelationLink	Gets the Uri of the link for the relation “deepZoomImageWithAnnotation”.
	DocumentRelationLink	Gets the Uri of the link for the relation “document”.
	FileChunk	Contains data for a file chunk during a big file upload. This data is created on the server of every chunk request.
	FileDownloadRelationLink	Gets the Uri of the link for the relation “fileDownload”.
	FileSize	The size of the file in bytes.
	HasTextAnnotation	Contains true if the section has text annotation.
	HaveMorePages	Contains true if all pages are known so PageCount contains exact number the pages in section. If the value is set to false there are more pagesm but at least the number set in PageCount
	IconRelationLink	Gets the Uri of the link for the relation “icon”.
	Id	Identity of the section
	Links
	OriginalFileName	Time when content is last modified
	PageCount	The number of pages of this section, if known. If it is unknown, this value is -1.
	Pages	Contains one or more pages of the document, if there are pages available.
	PagesBlockRelationLink	Gets the Uri of the link for the relation “pagesBlock”.
	PositionsRelationLink	Gets the Uri of the link for the relation “positions”.
	SelfRelationLink	Gets the Uri of the link for the relation “self”.
	SignatureStatus	Define allowed operations when there is signature
	TextAnnotationRelationLink	Gets the Uri of the link for the relation “textAnnotation”.
	TextshotRelationLink	Gets the Uri of the link for the relation “textshot”.
	ThumbnailRelationLink	Gets the Uri of the link for the relation “thumbnail”.
	Thumbnails	Similar to Pages, but contains only links and page number.

Top

Methods

	Name	Description
	GetDocumentContentFromTextshotRelation	Calls the HTTP Get method on the link for the relation “textshot”.
	GetDocumentContentFromTextshotRelationAsync	Calls the HTTP Get method on the link for the relation “textshot” asynchronously.
	GetDocumentContentFromTextshotRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “textshot” asynchronously.
	GetDocumentFromDocumentRelation	Calls the HTTP Get method on the link for the relation “document”.
	GetDocumentFromDocumentRelationAsync	Calls the HTTP Get method on the link for the relation “document” asynchronously.
	GetDocumentFromDocumentRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “document” asynchronously.
	GetSectionFromSelfRelation	Calls the HTTP Get method on the link for the relation “self”.
	GetSectionFromSelfRelationAsync	Calls the HTTP Get method on the link for the relation “self” asynchronously.
	GetSectionFromSelfRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “self” asynchronously.
	GetStreamFromAnnotationAsSvgRelation	Calls the HTTP Get method on the link for the relation “annotationAsSvg”.
	GetStreamFromAnnotationAsSvgRelationAsync	Calls the HTTP Get method on the link for the relation “annotationAsSvg” asynchronously.
	GetStreamFromAnnotationAsSvgRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “annotationAsSvg” asynchronously.
	GetStreamFromContentRelation	Calls the HTTP Get method on the link for the relation “content”.
	GetStreamFromContentRelationAsync	Calls the HTTP Get method on the link for the relation “content” asynchronously.
	GetStreamFromContentRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “content” asynchronously.
	GetStreamFromDeepZoomImageRelation	Calls the HTTP Get method on the link for the relation “deepZoomImage”.
	GetStreamFromDeepZoomImageRelationAsync	Calls the HTTP Get method on the link for the relation “deepZoomImage” asynchronously.
	GetStreamFromDeepZoomImageRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “deepZoomImage” asynchronously.
	GetStreamFromDeepZoomImageWithAnnotationRelation	Calls the HTTP Get method on the link for the relation “deepZoomImageWithAnnotation”.
	GetStreamFromDeepZoomImageWithAnnotationRelationAsync	Calls the HTTP Get method on the link for the relation “deepZoomImageWithAnnotation” asynchronously.
	GetStreamFromDeepZoomImageWithAnnotationRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “deepZoomImageWithAnnotation” asynchronously.
	GetStreamFromFileDownloadRelation	Calls the HTTP Get method on the link for the relation “fileDownload”.
	GetStreamFromFileDownloadRelationAsync	Calls the HTTP Get method on the link for the relation “fileDownload” asynchronously.
	GetStreamFromFileDownloadRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “fileDownload” asynchronously.
	GetStreamFromIconRelation	Calls the HTTP Get method on the link for the relation “icon”.
	GetStreamFromIconRelationAsync	Calls the HTTP Get method on the link for the relation “icon” asynchronously.
	GetStreamFromIconRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “icon” asynchronously.
	GetStreamFromTextAnnotationRelation	Calls the HTTP Get method on the link for the relation “textAnnotation”.
	GetStreamFromTextAnnotationRelationAsync	Calls the HTTP Get method on the link for the relation “textAnnotation” asynchronously.
	GetStreamFromTextAnnotationRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “textAnnotation” asynchronously.
	GetStreamFromThumbnailRelation	Calls the HTTP Get method on the link for the relation “thumbnail”.
	GetStreamFromThumbnailRelationAsync	Calls the HTTP Get method on the link for the relation “thumbnail” asynchronously.
	GetStreamFromThumbnailRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “thumbnail” asynchronously.
	GetWordSearchResultFromPositionsRelation	Calls the HTTP Get method on the link for the relation “positions”.
	GetWordSearchResultFromPositionsRelationAsync	Calls the HTTP Get method on the link for the relation “positions” asynchronously.
	GetWordSearchResultFromPositionsRelationAsync(CancellationToken)	Calls the HTTP Get method on the link for the relation “positions” asynchronously.
	PostToContentRelationForSection	Calls the HTTP Post method on the link for the relation “content”.
	PostToContentRelationForSectionAsync(String, Stream)	Calls the HTTP Post method on the link for the relation “content” asynchronously.
	PostToContentRelationForSectionAsync(CancellationToken, String, Stream)	Calls the HTTP Post method on the link for the relation “content” asynchronously.
	PostToFileDownloadRelationForStream	Calls the HTTP Post method on the link for the relation “fileDownload”.
	PostToFileDownloadRelationForStreamAsync(FileDownload)	Calls the HTTP Post method on the link for the relation “fileDownload” asynchronously.
	PostToFileDownloadRelationForStreamAsync(CancellationToken, FileDownload)	Calls the HTTP Post method on the link for the relation “fileDownload” asynchronously.
	PostToPagesBlockRelationForPages	Calls the HTTP Post method on the link for the relation “pagesBlock”.
	PostToPagesBlockRelationForPagesAsync(PagesBlockQuery)	Calls the HTTP Post method on the link for the relation “pagesBlock” asynchronously.
	PostToPagesBlockRelationForPagesAsync(CancellationToken, PagesBlockQuery)	Calls the HTTP Post method on the link for the relation “pagesBlock” asynchronously.
	PostToPositionsRelationForWordSearchResult	Calls the HTTP Post method on the link for the relation “positions”.
	PostToPositionsRelationForWordSearchResultAsync(SearchPositionQuery)	Calls the HTTP Post method on the link for the relation “positions” asynchronously.
	PostToPositionsRelationForWordSearchResultAsync(CancellationToken, SearchPositionQuery)	Calls the HTTP Post method on the link for the relation “positions” asynchronously.
	PostToTextAnnotationRelationForStream	Calls the HTTP Post method on the link for the relation “textAnnotation”.
	PostToTextAnnotationRelationForStreamAsync(Stream)	Calls the HTTP Post method on the link for the relation “textAnnotation” asynchronously.
	PostToTextAnnotationRelationForStreamAsync(CancellationToken, Stream)	Calls the HTTP Post method on the link for the relation “textAnnotation” asynchronously.
	PutToContentRelationForSection	Calls the HTTP Put method on the link for the relation “content”.
	PutToContentRelationForSectionAsync(String, Stream)	Calls the HTTP Put method on the link for the relation “content” asynchronously.
	PutToContentRelationForSectionAsync(CancellationToken, String, Stream)	Calls the HTTP Put method on the link for the relation “content” asynchronously.
	PutToTextshotRelationForString	Calls the HTTP Put method on the link for the relation “textshot”.
	PutToTextshotRelationForStringAsync(DocumentContent)	Calls the HTTP Put method on the link for the relation “textshot” asynchronously.
	PutToTextshotRelationForStringAsync(CancellationToken, DocumentContent)	Calls the HTTP Put method on the link for the relation “textshot” asynchronously.
	SetProxy	Sets the HTTP communication proxy which is used in further HTTP communication.

Top

Extension Methods

	Name	Description
	DeleteTResponse(String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	DeleteTResponse(CancellationToken, String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	DeleteTResponse(HttpClient, String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	DeleteTResponse(HttpClient, CancellationToken, String, String)	Overloaded. Sends a HTTP DELETE message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(CancellationToken, String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(HttpClient, String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetTResponse(HttpClient, CancellationToken, String, String)	Overloaded. Sends a HTTP GET message to the specified HTTP client. (Defined by MethodInvocation.)
	GetBaseUri	Gets the base URI of the specified relations instance. (Defined by RelationsWithProxyExtensions.)
	GetLink	Gets the link by its name. (Defined by RelationExtension.)
	GetRelationUri	Gets the URI of the relation specified by the name. (Defined by RelationExtension.)
	GetRelationUriOrThrow	Gets the URI of the relation specified by the name. (Defined by RelationExtension.)
	HasRelationUri	Determines whether the specified link exists. (Defined by RelationExtension.)
	SendTResponse(HttpMethod, String, String)	Overloaded. Sends a message to the specified proxy. (Defined by MethodInvocation.)
	SendTResponse(CancellationToken, HttpMethod, String, String)	Overloaded. Sends a message to the specified proxy. (Defined by MethodInvocation.)
	SendTResponse(String, HttpMethod, HttpContent, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse(HttpMethod, HttpClient, String, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse(CancellationToken, String, HttpMethod, HttpContent, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse(CancellationToken, HttpMethod, HttpClient, String, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(CancellationToken, String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(HttpClient, String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)
	SendTResponse, TRequest(HttpClient, CancellationToken, String, HttpMethod, String, TRequest, String)	Overloaded. Sends a message to the specified HTTP client. (Defined by MethodInvocation.)

Top

Explicit Interface Implementations

	Name	Description
	IHttpClientProxyProxy

Top

Remarks

Reference

DocuWare.Platform.ServerClient Namespace

Send comments on this topic to DocuWare