DocuWare.Platform.ServerClient Namespace |
Class | Description | |
---|---|---|
AdditionalOrganizationInfo |
Additional information for organization
| |
AdhocRenderingFile |
Main class for managing adhoc rendering file.
| |
AdhocRenderingFiles |
A list of uploaded files prepared for adhoc rendering.
| |
AdhocRenderingQuery |
Specifies how a file is to be rendered.
| |
Annotation |
Annotation element. Contains all annotations for a specific page in up to 5 layers
| |
AnnotationPoint |
Define point of annotation.
| |
AnnotationRectangle |
Define rectangular annotation.
| |
AnnotationsPlacement |
Describes how to place a set of annotations and stamps on a page.
| |
AppendActionDocuments |
Cabinet specific document info needed for document append action
| |
AppendActionParameters |
Specific data for append action
| |
BatchUpdateDialogExpressionSource | ||
BatchUpdateDocumentsSource | ||
BatchUpdateIndexFieldsResult |
Structure for the result of batch update oparations.
| |
BatchUpdateProcess |
A class which contains data for batch update processes.
| |
BatchUpdateProcessData | ||
BatchUpdateResultItem | ||
BatchUpdateSource |
The base for defining a sequence of documents to be updated.
| |
BitmapStamp |
Stamp that applies an image.
| |
BitmapStampEntry |
Bitmap stamp. Png encoded image.
| |
CheckGroup | ||
CheckInActionParameters |
Parameters for CheckIn action
| |
CheckOutActionParameters |
Parameters for CheckOut action
| |
CheckOutResult |
Result from a checkout. Contains link where document can be downloaded
| |
CheckOutToFileSystemInfo |
Empty structure for checkout to file system operation
| |
ContentDivideOperationInfo |
Models a DocuWare content divide operation.
| |
ContentMergeOperationInfo |
Models a DocuWare content merge operation.
| |
ContentType | ||
ContentTypeList | ||
ContentTypeListComplexType | ||
ContentTypeListContentType | ||
ContentTypeListSchemaType | ||
ContentTypeMapping |
Maps content types to file extensions.
| |
CopyTemplateInput | ||
CopyTemplateResult | ||
CountExpression |
The expression for counting a documents.
| |
CountPlusValue |
Define unstrict count. If HasMore is true it is possible to have more items
| |
CountResult |
Result set of of item counts
| |
CountResultItem |
Result of item count
| |
CreatedInfo |
Info about creation of item.
| |
CreateFormsFileResult | ||
DecisionFormFieldValue | ||
DecisionStampPlacement | ||
DeleteEntry |
Entry that delete annotation spcified by its Id
| |
DeleteTemplatesInput | ||
DeleteTemplatesResult | ||
Dialog | ||
DialogExpression |
Query definition for a dialog result list
| |
DialogExpressionCondition |
Condition for specific database name (field)
| |
DialogField | ||
DialogFields |
List of dialog fields.
| |
DialogInfo |
General properties of any dialog.
| |
DialogInfos |
List of dialog infos.
| |
DialogProperties |
Specific properties for each dialog type
| |
DialogPropertiesResultList |
Dialog properties specific for Result List
| |
DialogPropertiesSearch |
Dialog properties specific for Search Dialog
| |
DialogPropertiesTaskList |
Dialog properties specific for Task lists
| |
DialogPropertiesTreeView |
Dialog properties specific for Tree list
| |
Document | ||
DocumentActionInfo |
Information about the action pereformed on document
| |
DocumentActionParameters |
Basic parameters for specific action
| |
DocumentAnnotations |
Descripes how to place a set of annotations and stamps on a document.
| |
DocumentAnnotationsPlacement |
Descripes how to place a set of annotations and stamps on a document.
| |
DocumentApplicationProperties |
Define application specific properties. Different applications store specific application here
| |
DocumentApplicationProperty |
Define application specific property
| |
DocumentFlags |
Define possible flags for a document
| |
DocumentIndexField | ||
DocumentIndexFieldKeywords |
List of keywords
| |
DocumentIndexFields |
List of index fields
| |
DocumentIndexFieldValue | ||
DocumentIndexFieldValueBase | ||
DocumentLink |
Define a query that link one documnet to another document from same or different file cabinet
| |
DocumentLinks |
Define all document links that a vlid for a document
| |
DocumentsQuery |
Defines a query for documents.
| |
DocumentsQueryResult |
Define a result from document query
| |
DocumentsTransferInfo |
Defines the parameters of a documents transfer.
| |
DocumentVersion |
Document version info
| |
DocumentWordSearchResult | ||
DocumentWordSearchResultSectionHits | ||
DolphinAttribute |
Marks that this link or this property or this function is available since DocuWare 6.6.
| |
DropDownList | ||
DWPoint | ||
DWRectangle | ||
DWSize | ||
EagleAttribute |
Marks that this link or this property or this function is available since DocuWare 6.7.
| |
EasyCheckoutCheckinExtensionsBase |
Some extensions for handling responses which can be stored as files.
| |
EasyCheckoutResult |
The result of a checkout operation.
| |
EasyFileUploadExtensionsBase |
Some extensions for simple file uploads.
| |
EnhanceImageParameters |
Parameters for EnhanceImage action
| |
EntryBase |
Base element for annotation entry.
| |
FieldValueStatistics |
Value with statistics.
| |
FieldValueStatisticsExpression |
The expression for field statistics.
| |
FieldValueStatisticsResult | ||
FileCabinet |
Models a DocuWare file cabinet or a web basket(document tray).
| |
FileCabinetExtensionsBase |
Extensions for the file cabinet.
| |
FileCabinetField | ||
FileCabinetFields |
List of file cabinet fields.
| |
FileCabinets |
Lsit of file cabinets or document trays(web baskets).
| |
FileCabinetTransferInfo | ||
FileDownload |
Define how a document can be downloaded
| |
FileDownloadBase |
Define how a page of a document can be downloaded
| |
FileDownloadPage | ||
FileNameExtensions |
A class to handle file name encoding
| |
FlagConditions |
Filter documents with specific flags
| |
Font | ||
FormFieldValue |
Contains the value of form field
| |
FormFieldValues |
The form field values which are applied when placing or rendering the stamp.
| |
FormInfo |
Form object used for displaying form
| |
FormsInput |
Input used to submit form and store in DocuWare
| |
FormTemplate |
Definition of the Save Template
| |
FormTemplates |
Array of form templates
| |
FoxAttribute |
Marks that this link or this property or this function is available since DocuWare 6.7.
| |
GetTemplateImageInput | ||
GetTemplateImageResult | ||
Headline | ||
HttpMethodList | ||
IntegerList |
Define a list of integers values
| |
Layer |
Layer element. Contains annotations in a specific layer. Annotation can have up to 5 layers.
| |
LineEntry |
Line/Arrow annotation
| |
LinkInvoke | ||
LinkRelation | ||
LinkRelations | ||
LockInfo |
Define how a document will be locked
| |
LogicalOperator | ||
LoginInfo |
Details abut user login
| |
MergeAnnotationsParameters |
Parameters for MergeAnnotations action
| |
MinimalVersionAttribute |
Marks the minimal version needed to have this link or this property or this function available.
| |
MultiLineTextField | ||
Notification |
A data stucture for implementing simple notifications.
| |
Notifications |
A data stucture for managing notifications.
| |
NumberField | ||
Organization |
Definition for DocuWare organization.
| |
Organizations |
List of organizations
| |
OrganizationUser |
Defines a user in specific organization
| |
OutOfOffice |
Defines when a user is out of office
| |
Page |
Gets the vertical size of a page image in pixels. In case of vector images this is the maximal pixel height which can be rendered.
| |
PageData |
Define a metadata for a page
| |
PageHits |
Contains a set pages where of words are found
| |
Pages |
Define a collection of pages
| |
PagesBlockQuery |
A query for requesting page blocks.
| |
PlatformClientConfiguration |
A interface which is used to calculate a hash to identify the machine or device the application is running.
| |
PointAndShootInfo | ||
PolyLineEntry |
PloyLine annotation. Conatins a single stroke of points.
| |
PolyLineStampEntry |
Tablet polyline stamp. Contains one or more strokes. Used as handwriting stamp
| |
QueryParamater | ||
QueryParamatersList | ||
RadioGroup | ||
RectEntry |
Rectangle or Ellipse annotation
| |
RequestDialogQuery |
Array of dialog types.
| |
ResultDialogFunction |
Function of result list
| |
ResultListQuery |
Base query definition for a result list
| |
Rights |
List of rights.
| |
Role |
Defines a DocuWare role
| |
Roles |
A collection of roles
| |
RotatePageParameters |
Parameters for RotatePage action
| |
SaveTemplateInput |
Save Template
| |
SaveTemplateResult | ||
SchemaExtensions |
Extensions.
| |
SearchPositionQuery |
Define a query for searching words in phrase
| |
Section |
Define a single section of a document
| |
SectionAnnotation |
Describes how to place a set of annotations and stamps on a section.
| |
SectionAnnotationsPlacement |
Describes how to place a set of annotations and stamps on a section.
| |
Sections |
Define all sections of a document
| |
SelectListExpression |
Query definition for a select list
| |
SelectListResult |
Select list values.
| |
ServiceConnection |
Encapsulates a connection to the platform.
| |
ServiceConnectionExtensions | ||
ServiceDescription |
Root object that define platform structure.
| |
ServiceDescriptionDocumentation | ||
ServiceDescriptionTests | ||
SortedField |
Defines a sort by a field.
| |
SortedFieldsList |
Defines a list of sorted fields.
| |
Stamp |
Models a DocuWare stamp.
| |
StampBase |
Stamp base type. Inherited by 3 types: TextStamp, BitmapStamp, PolyLineStamp
| |
StampField | ||
StampFormField |
A form field for variable text to a text stamp.
| |
StampFormFieldValues |
The form field values which are applied when placing or rendering a specific stamp.
| |
StampPlacement |
Describes how to place a stamp on a page.
| |
Stamps |
List of stamps.
| |
Stroke |
Sequence of points that define a PloyLine.
| |
StrokeStamp |
Stamp that allows you to add a signature using an electronic pen.
| |
SuggestionField | ||
SuggestionFields | ||
SuggestionValue | ||
TextEntry |
Annotation that contains text
| |
TextField | ||
TextStamp |
Stamp that applies a defined text.
| |
TextStampEntry |
Text stamp. Value contains the text.
| |
TokenDescription |
Define a purpose of the token. Can define some restrictions
| |
UpdateIndexFieldsInfo |
Structure for updating index fields, including the index fields values and the dialog used for updating.
| |
UploadedFileChunk | ||
UploadTemplateInput | ||
UploadTemplateResult | ||
User |
User details and settings
| |
UserDefinedSearchInfo |
Options for creating user defined search based on result list.
| |
UserInfo |
Information related to a user
| |
Users |
Defines a list of users
| |
UserValidation |
User details needed for validation user login
| |
ViewerDialog | ||
WebFormControl |
Base class for web form fields
| |
WebFormControls |
List of web form fields
| |
WebFormField | ||
WebFormListOptions |
List of options for a drop down
| |
WebFormOption |
An option for a check box or radio group
| |
WebFormOptions |
List of options for a check box or radio group
| |
WordSearchResult |
Define a a set of words and locations where they are found in a section
| |
WordSearchResultPageHit |
Define a a set of words and locations where they are found in a page
| |
WordSearchResultWordHit |
Define a word and specific location where it is found
| |
WordSearchResultWordHits |
Define a a set of words and locations where they are found
| |
XmlDSigContentType | ||
XmlSchema | ||
XmlSchemas | ||
Zone |
Definition of a Template Zone
| |
Zones |
Array of template Zones
|
Interface | Description | |
---|---|---|
IChunkable |
An interface for items which can be uploaded in chunks.
|
Enumeration | Description | |
---|---|---|
AlignmentType | ||
ChecksumStatusType |
Define a result from a checksum
| |
ContentDivideOperation |
Subset of content operations.
| |
ContentMergeOperation |
Subset of content operations.
| |
DialogExpressionOperation |
Supported operations for dialog expression
| |
DialogTypes |
Types of dialogs.
| |
DocumentAction |
Actions pereformed on document (ReIntellix e.g.)
| |
DocumentSourceType |
Specifies the source of documents which trigger jobs in the DocuWare Job Framework. Also used to identify the type of configuration edited in the Job Configurator (Printer Configurator, Import Configurator etc.)
| |
DWFieldType |
Type of a DocuWare file cabinet field.
Please Do Not Change order because it matches DocuWare.FileCabinet.Settings.DocuWareType
| |
DWProductTypes |
Subset of DocuWare license types.
| |
DWSystemVariableName | ||
DynamicValueType | ||
FileCabinetFieldScope |
The scope of the file cabinet field.
| |
FileDownloadType |
Define the format that will be used to download a document
| |
HttpMethod | ||
IntellixFieldTrust | ||
IntellixTrust |
Define how much the intellix result is reliable
| |
ItemChoiceType | ||
LetterCase | ||
PlatformImageFormat |
Define a supported image formats in platform
| |
QueryParamaterType | ||
ResultDialogFunctionType | ||
Right | ||
RoleTypes |
A predefined DocuWare role types
| |
SignatureStatus |
Define allowed operations when there is signature
| |
SortDirection |
Define a sort direction
| |
StampSignatureType |
Signature wise stamps.
| |
TokenUsage |
Usage of the token.
| |
VersionManagementMode | ||
VersionManagementStatus |
Define the version management status of a document
| |
ViewerDialogModes |
Mode in which the viewer is opened to display a document
| |
XmlDSigStatusType |