Document Class |
Namespace: DocuWare.Platform.ServerClient
[SerializableAttribute] [XmlTypeAttribute(Namespace = "http://dev.docuware.com/schema/public/services/platform")] [XmlRootAttribute(Namespace = "http://dev.docuware.com/schema/public/services/platform", IsNullable = false)] public class Document : IChunkable, IRelationsWithProxy, IRelations
The Document type exposes the following members.
Name | Description | |
---|---|---|
DeleteLockRelation | Calls the HTTP Delete method on the link for the relation “lock”. | |
DeleteLockRelationAsync | Calls the HTTP Delete method on the link for the relation “lock” asynchronously. | |
DeleteSelfRelation | Calls the HTTP Delete method on the link for the relation “self”. | |
DeleteSelfRelationAsync | Calls the HTTP Delete method on the link for the relation “self” asynchronously. | |
GetDocumentAnnotationsFromAnnotationRelation | Calls the HTTP Get method on the link for the relation “annotation”. | |
GetDocumentAnnotationsFromAnnotationRelationAsync | Calls the HTTP Get method on the link for the relation “annotation” asynchronously. | |
GetDocumentApplicationPropertiesFromAppPropertiesRelation | Calls the HTTP Get method on the link for the relation “appProperties”. | |
GetDocumentApplicationPropertiesFromAppPropertiesRelationAsync | Calls the HTTP Get method on the link for the relation “appProperties” asynchronously. | |
GetDocumentFromLatestVersionRelation | Calls the HTTP Get method on the link for the relation “latestVersion”. | |
GetDocumentFromLatestVersionRelationAsync | Calls the HTTP Get method on the link for the relation “latestVersion” asynchronously. | |
GetDocumentFromSelfRelation | Calls the HTTP Get method on the link for the relation “self”. | |
GetDocumentFromSelfRelationAsync | Calls the HTTP Get method on the link for the relation “self” asynchronously. | |
GetDocumentIndexFieldsFromFieldsRelation | Calls the HTTP Get method on the link for the relation “fields”. | |
GetDocumentIndexFieldsFromFieldsRelationAsync | Calls the HTTP Get method on the link for the relation “fields” asynchronously. | |
GetDocumentLinksFromDocumentLinksRelation | Calls the HTTP Get method on the link for the relation “documentLinks”. | |
GetDocumentLinksFromDocumentLinksRelationAsync | Calls the HTTP Get method on the link for the relation “documentLinks” asynchronously. | |
GetDocumentsQueryResultFromVersionHistoryRelation | Calls the HTTP Get method on the link for the relation “versionHistory”. | |
GetDocumentsQueryResultFromVersionHistoryRelationAsync | Calls the HTTP Get method on the link for the relation “versionHistory” asynchronously. | |
GetDocumentWordSearchResultFromPositionsRelation | Calls the HTTP Get method on the link for the relation “positions”. | |
GetDocumentWordSearchResultFromPositionsRelationAsync | Calls the HTTP Get method on the link for the relation “positions” asynchronously. | |
GetSectionsFromSectionsRelation | Calls the HTTP Get method on the link for the relation “sections”. | |
GetSectionsFromSectionsRelationAsync | Calls the HTTP Get method on the link for the relation “sections” asynchronously. | |
GetStreamFromChecksumStatusRelation | Calls the HTTP Get method on the link for the relation “checksumStatus”. | |
GetStreamFromChecksumStatusRelationAsync | Calls the HTTP Get method on the link for the relation “checksumStatus” 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. | |
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. | |
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. | |
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. | |
GetStreamFromResultListIconRelation | Calls the HTTP Get method on the link for the relation “resultListIcon”. | |
GetStreamFromResultListIconRelationAsync | Calls the HTTP Get method on the link for the relation “resultListIcon” 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. | |
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. | |
GetStreamFromXmlDSigContentRelation | Calls the HTTP Get method on the link for the relation “xmlDSigContent”. | |
GetStreamFromXmlDSigContentRelationAsync | Calls the HTTP Get method on the link for the relation “xmlDSigContent” asynchronously. | |
GetSuggestionFieldsFromSuggestionsRelation | Calls the HTTP Get method on the link for the relation “suggestions”. | |
GetSuggestionFieldsFromSuggestionsRelationAsync | Calls the HTTP Get method on the link for the relation “suggestions” asynchronously. | |
PostToAnnotationRelationForDocumentAnnotations | Calls the HTTP Post method on the link for the relation “annotation”. | |
PostToAnnotationRelationForDocumentAnnotationsAsync | Calls the HTTP Post method on the link for the relation “annotation” asynchronously. | |
PostToAppPropertiesRelationForDocumentApplicationProperties | Calls the HTTP Post method on the link for the relation “appProperties”. | |
PostToAppPropertiesRelationForDocumentApplicationPropertiesAsync | Calls the HTTP Post method on the link for the relation “appProperties” asynchronously. | |
PostToCheckInFromFileSystemRelationForDocument | Calls the HTTP Post method on the link for the relation “checkInFromFileSystem”. | |
PostToCheckInFromFileSystemRelationForDocumentAsync | Calls the HTTP Post method on the link for the relation “checkInFromFileSystem” asynchronously. | |
PostToCheckoutDocumentRelationForStream | Calls the HTTP Post method on the link for the relation “checkoutDocument”. | |
PostToCheckoutDocumentRelationForStreamAsync | Calls the HTTP Post method on the link for the relation “checkoutDocument” asynchronously. | |
PostToCheckoutToFileSystemRelationForStream | Calls the HTTP Post method on the link for the relation “checkoutToFileSystem”. | |
PostToCheckoutToFileSystemRelationForStreamAsync | Calls the HTTP Post method on the link for the relation “checkoutToFileSystem” asynchronously. | |
PostToContentRelationForStream | Calls the HTTP Post method on the link for the relation “content”. | |
PostToContentRelationForStreamAsync | 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 | Calls the HTTP Post method on the link for the relation “fileDownload” asynchronously. | |
PostToLockRelationForString | Calls the HTTP Post method on the link for the relation “lock”. | |
PostToLockRelationForStringAsync | Calls the HTTP Post method on the link for the relation “lock” asynchronously. | |
PostToPositionsRelationForDocumentWordSearchResult | Calls the HTTP Post method on the link for the relation “positions”. | |
PostToPositionsRelationForDocumentWordSearchResultAsync | Calls the HTTP Post method on the link for the relation “positions” asynchronously. | |
PostToRightsRelationForSection | Calls the HTTP Post method on the link for the relation “rights”. | |
PostToRightsRelationForSectionAsync | Calls the HTTP Post method on the link for the relation “rights” asynchronously. | |
PostToSectionsRelationForSection | Calls the HTTP Post method on the link for the relation “sections”. | |
PostToSectionsRelationForSectionAsync | Calls the HTTP Post method on the link for the relation “sections” asynchronously. | |
PostToSelfRelationForDocument | Calls the HTTP Post method on the link for the relation “self”. | |
PostToSelfRelationForDocumentAsync | Calls the HTTP Post method on the link for the relation “self” asynchronously. | |
PostToTextAnnotationRelationForStream | Calls the HTTP Post method on the link for the relation “textAnnotation”. | |
PostToTextAnnotationRelationForStreamAsync | Calls the HTTP Post method on the link for the relation “textAnnotation” asynchronously. | |
PostToVersionHistoryRelationForDocumentsQueryResult | Calls the HTTP Post method on the link for the relation “versionHistory”. | |
PostToVersionHistoryRelationForDocumentsQueryResultAsync | Calls the HTTP Post method on the link for the relation “versionHistory” asynchronously. | |
PutToClippedDocumentsRelationForDocument | Calls the HTTP Put method on the link for the relation “clippedDocuments”. | |
PutToClippedDocumentsRelationForDocumentAsync | Calls the HTTP Put method on the link for the relation “clippedDocuments” asynchronously. | |
PutToContentDivideOperationRelationForDocumentsQueryResult | Calls the HTTP Put method on the link for the relation “contentDivideOperation”. | |
PutToContentDivideOperationRelationForDocumentsQueryResultAsync | Calls the HTTP Put method on the link for the relation “contentDivideOperation” asynchronously. | |
PutToFieldsRelationForDocumentIndexFields(DocumentIndexFields) | Calls the HTTP Put method on the link for the relation “fields”. | |
PutToFieldsRelationForDocumentIndexFields(UpdateIndexFieldsInfo) | Calls the HTTP Put method on the link for the relation “fields”. | |
PutToFieldsRelationForDocumentIndexFieldsAsync(DocumentIndexFields) | Calls the HTTP Put method on the link for the relation “fields” asynchronously. | |
PutToFieldsRelationForDocumentIndexFieldsAsync(UpdateIndexFieldsInfo) | Calls the HTTP Put method on the link for the relation “fields” asynchronously. | |
PutToProcessDocumentActionRelationForDocument | Calls the HTTP Put method on the link for the relation “processDocumentAction”. | |
PutToProcessDocumentActionRelationForDocumentAsync | Calls the HTTP Put method on the link for the relation “processDocumentAction” asynchronously. | |
ToString |
Returns a String that represents this instance.
(Overrides ObjectToString.) |
Name | Description | |
---|---|---|
AddDocumentSections |
Appends one or more new sections to the specified document.
(Defined by FileCabinetExtensions.) | |
AddDocumentSectionsAsync |
Appends one or more new sections to the specified document asynchronously.
(Defined by FileCabinetExtensions.) | |
ChunkAddSection |
Adds a section to a document using chunked upload.
(Defined by FileCabinetExtensions.) | |
DeleteTResponse(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.) | |
EasyUploadFile |
Uploads the specified file as new section to the specified document.
(Defined by EasyFileUploadExtensions.) | |
GetTResponse(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.) | |
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.) | |
LockAsync(String, Int32) | Overloaded.
Locks this instance and returns a DocumentLock object which can be used to unlock this document later.
(Defined by DocumentLockExtensions.) | |
LockAsync(ActionException, String, Int32) | Overloaded.
Locks this instance and returns a DocumentLock object which can be used to unlock this document later.
(Defined by DocumentLockExtensions.) | |
SendTResponse(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, TRequest(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.) | |
UploadSectionAsync |
Appends one section to the specified document asynchronously.
(Defined by FileCabinetExtensions.) |
Name | Description | |
---|---|---|
AnnotationRelationLink | Gets the Uri of the link for the relation “annotation”. | |
ApplicationProperties |
Define application specific properties. Different applications store specific application here
| |
AppPropertiesRelationLink | Gets the Uri of the link for the relation “appProperties”. | |
CheckInFromFileSystemRelationLink | Gets the Uri of the link for the relation “checkInFromFileSystem”. | |
CheckoutDocumentRelationLink | Gets the Uri of the link for the relation “checkoutDocument”. | |
CheckoutToFileSystemRelationLink | Gets the Uri of the link for the relation “checkoutToFileSystem”. | |
ChecksumStatusRelationLink | Gets the Uri of the link for the relation “checksumStatus”. | |
ClippedDocumentsRelationLink | Gets the Uri of the link for the relation “clippedDocuments”. | |
ContentDivideOperationRelationLink | Gets the Uri of the link for the relation “contentDivideOperation”. | |
ContentRelationLink | Gets the Uri of the link for the relation “content”. | |
ContentType |
The internet media type of the document. If there is no section this value is missing.
| |
CreatedAt |
Contains creation date of the document
| |
CreatedAtSpecified | ||
DeepZoomImageRelationLink | Gets the Uri of the link for the relation “deepZoomImage”. | |
DeepZoomImageWithAnnotationRelationLink | Gets the Uri of the link for the relation “deepZoomImageWithAnnotation”. | |
DocumentLinksRelationLink | Gets the Uri of the link for the relation “documentLinks”. | |
Fields |
Fields of a document
| |
FieldsRelationLink | Gets the Uri of the link for the relation “fields”. | |
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 sum of the size of all section files and document header.
| |
Flags |
Flags of a document
| |
HasTextAnnotation |
Contains true if document has a text annotation (the first section of the document has text annotation)
| |
HasXmlDigitalSignatures |
Contains true if document contains at least one XML Digital signature
| |
HaveMoreTotalPages |
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
| |
Id |
Document identity
| |
IntellixRelationLink | Gets the Uri of the link for the relation “intellix”. | |
IntellixTrust |
Intellix status
| |
Item |
Gets or sets the DocumentIndexField with the specified field name.
| |
LastModified |
Contains last modification date of the document
| |
LastModifiedSpecified | ||
LatestVersionRelationLink | Gets the Uri of the link for the relation “latestVersion”. | |
Links | ||
LockRelationLink | Gets the Uri of the link for the relation “lock”. | |
PositionsRelationLink | Gets the Uri of the link for the relation “positions”. | |
Preview | ||
ProcessDocumentActionRelationLink | Gets the Uri of the link for the relation “processDocumentAction”. | |
ResultListIconRelationLink | Gets the Uri of the link for the relation “resultListIcon”. | |
RightsRelationLink | Gets the Uri of the link for the relation “rights”. | |
SectionCount |
The number of sections of this document. This number is equal to the sequence length of the Sections element.
| |
Sections |
Sections of the document. Contain no sections if document is DBRecord
| |
SectionsRelationLink | Gets the Uri of the link for the relation “sections”. | |
SelfRelationLink | Gets the Uri of the link for the relation “self”. | |
Suggestions |
Fields of a document
| |
SuggestionsRelationLink | Gets the Uri of the link for the relation “suggestions”. | |
TextAnnotationRelationLink | Gets the Uri of the link for the relation “textAnnotation”. | |
TextShot |
Content texthot (OCR) of the document
| |
ThumbnailRelationLink | Gets the Uri of the link for the relation “thumbnail”. | |
Title |
The title of the document, if it exists.
| |
TotalPages |
The number of pages of this section, if known. If it is unknown, this value is -1.
| |
UnclipRelationLink | Gets the Uri of the link for the relation “unclip”. | |
Version |
Version of a document
| |
VersionHistoryRelationLink | Gets the Uri of the link for the relation “versionHistory”. | |
VersionStatus |
Version management status of the document
| |
XmlDSigContentRelationLink | Gets the Uri of the link for the relation “xmlDSigContent”. |
Name | Description | |
---|---|---|
IRelationsWithProxyProxy |