• Home
  • .NET API
  • REST API
  • Extension Services
  • URL integration
  • FAQ
  • News
  • .NET API
  • .NET API Reference
  • Platform Server Client
  • DocuWare.Platform.ServerClient
  • BitmapStamp

    Show / Hide Table of Contents
    • .NET API
    • Version overview
    • Basics
      • The Platform as REST Service
      • Synchronous and Asynchronous API
      • Controlling a Request's Runtime
    • Code Examples
      • Basic operations
        • Connect to DocuWare
        • Connect to DocuWare with an App Registration
        • Get Active Organizations
        • Get File Cabinets
        • Get all Documents of a Basket or File Cabinet
        • Access Dialogs
        • Execute a Query using a dialog expression
        • Update Index Fields
        • Delete a Document
        • Download a Document
        • Upload Files
        • Easy Uploading huge Files
        • Check out to file system
        • Placing Stamps
        • Placing Annotations
        • Transfer Documents
        • Merge and Divide Documents
        • Create user and assign it to role/group
        • How to work with table fields
        • How to do explicit document locks
        • Dwx Import Export
        • Escaping Special Characters
        • Application Properties
        • Retrieve Next Sequence Element
        • Discouraged
      • Advanced operations
        • Download the Content of a Single Document
        • Edit a File
        • Batch Update
        • Partial document download
      • Workflow
        • Get Workflows
        • Access tasks
        • Confirm Workflow Task
      • Best practices
        • How to handle throttled requests
        • How to improve resilience with retry policies
    • .NET API Reference
      • Platform Server Client
        • DocuWare.Platform.Bpw.Schemas
          • ActionType
          • ActivityType
          • AssignToEntities
          • AssignToItem
          • AssignToType
          • BaseField
          • BaseForm
          • BaseSimpeWorkflowleItem
          • BpwBaseDocument
          • BpwDocument
          • BpwSelectList
          • BpwSelectListItem
          • BpwService
          • BpwSettings
          • Column
          • ColumnDefinitions
          • ColumnValue
          • CompositeData
          • ConfirmedField
          • ConfirmSimpleTaskData
          • DataType
          • Decision
          • DecisionData
          • DecisionStampFont
          • DecisionStamps
          • DecisionStampSettings
          • DescriptionForm
          • DescriptionValue
          • DocumentWorkflowHistoryStep
          • DocumentWorkflowHistorySteps
          • DocumentWorkflowMetadata
          • DocumentWorkflowMetadatas
          • Field
          • FieldEntryMask
          • FormType
          • LinkForm
          • LockParameter
          • OwnerSimpleWorkflowItem
          • OwnerSimpleWorkflowItems
          • OwnerTaskData
          • OwnerTaskDataItems
          • OwnSimpleWorkflowsData
          • PlatformEventData
          • ReassignData
          • RoleType
          • SimpleDesicion
          • SimpleTaskDecision
          • SimpleTaskField
          • SimpleTaskListItem
          • SimpleTaskListItems
          • SimpleTasksData
          • SimpleWorkflowData
          • SimpleWorkflowDatas
          • SimpleWorkflowDefinitionsData
          • SimpleWorkflowEventData
          • SingleTaskInformation
          • SingleTaskUrlParameters
          • StringParameter
          • SubstitutionList
          • SubstitutionLists
          • SubstitutionRule
          • SubstitutionRules
          • Task
          • TaskQuery
          • Tasks
          • TaskState
          • TimedLockDocument
          • UserWorkflows
          • WFBaseForm
          • Workflow
          • Workflows
        • DocuWare.Platform.ServerClient
          • ActivityTypeEnum
          • AdditionalOrganizationInfo
          • AdhocRenderingFile
          • AdhocRenderingFiles
          • AdhocRenderingQuery
          • AlignmentType
          • Annotation
          • AnnotationPoint
          • AnnotationRectangle
          • AnnotationsPlacement
          • AnyExpression
          • AppendActionDocuments
          • AppendActionParameters
          • ApplicationProperties
          • ApplicationProperty
          • AssignDataHistoryStep
          • AssignedItem
          • AssignedItemTypeEnum
          • AssignmentOperation
          • AssignmentOperationType
          • AssignToHistoryStep
          • AttachFileField
          • AttachFileInfo
          • AuditEvent
          • AutoNumberField
          • BaseDecisionOperations
          • BaseForm
          • BaseTaskOperations
          • BatchUpdateDialogExpressionSource
          • BatchUpdateDocumentsSource
          • BatchUpdateIndexFieldsResult
          • BatchUpdateProcess
          • BatchUpdateProcessData
          • BatchUpdateResultItem
          • BatchUpdateSource
          • Behavior
          • BehaviorAction
          • BehaviorCondition
          • Behaviors
          • BitmapStamp
          • BitmapStampEntry
          • BooleanConstant
          • CFSSpecificValue
          • CFSStatisticGeneral
          • CFSStatisticSpecific
          • CFSTableNames
          • CheckGroup
          • CheckInActionParameters
          • CheckInReturnDocument
          • CheckOutActionParameters
          • CheckOutResult
          • CheckOutToFileSystemInfo
          • ChecksumStatusType
          • Column
          • ColumnOptions
          • ColumnsDefinition
          • ColumnSortOrder
          • ColumnTypeEnum
          • ColumnValue
          • ColumnValues
          • ColumnValueTypeEnum
          • ColumnWidthType
          • CommonFormField
          • ComparisonType
          • ConditionHistoryStep
          • ConfigurationRight
          • ConfigurationRights
          • ConfirmedData
          • ConfirmedField
          • ContentDivideOperation
          • ContentDivideOperationInfo
          • ContentMergeOperation
          • ContentMergeOperationInfo
          • ContentType
          • ContentTypeList
          • ContentTypeListComplexType
          • ContentTypeListContentType
          • ContentTypeListSchemaType
          • ContentTypeMapping
          • Continuation
          • CopyTemplateInput
          • CopyTemplateResult
          • CountExpression
          • CountPlusValue
          • CountResult
          • CountResultItem
          • CreatedInfo
          • CreateFormsFileResult
          • CsvExpression
          • CustomFieldValidation
          • DateColumn
          • DateConstant
          • DateField
          • DateTableColumnOptions
          • DateTimeConstant
          • DecimalConstant
          • Decision
          • DecisionFormFieldValue
          • DecisionHistoryStep
          • DecisionOperations
          • Decisions
          • DecisionsStampSettings
          • DecisionStampPlacement
          • DeleteEntry
          • DeleteTemplatesInput
          • DeleteTemplatesResult
          • DescriptionFormField
          • Dialog
          • DialogExpression
          • DialogExpressionCondition
          • DialogExpressionOperation
          • DialogField
          • DialogFieldBase
          • DialogFields
          • DialogInfo
          • DialogInfos
          • DialogProperties
          • DialogPropertiesResultList
          • DialogPropertiesSearch
          • DialogPropertiesTaskList
          • DialogPropertiesTreeView
          • DialogTableFieldColumns
          • DialogTypes
          • Document
          • DocumentAction
          • DocumentActionInfo
          • DocumentActionParameters
          • DocumentAnnotations
          • DocumentAnnotationsPlacement
          • DocumentApplicationProperties
          • DocumentApplicationProperty
          • DocumentAuditEvent
          • DocumentAuditEventInformation
          • DocumentAuditEventProperty
          • DocumentAuditEventTableProperty
          • DocumentAuditEventTablePropertyColumn
          • DocumentAuditEventTablePropertyValues
          • DocumentAuditInformation
          • DocumentAuditQuery
          • DocumentFlags
          • DocumentIndexField
          • DocumentIndexFieldExtensions
          • DocumentIndexFieldKeywords
          • DocumentIndexFields
          • DocumentIndexFieldTable
          • DocumentIndexFieldTableRow
          • DocumentIndexFieldValue
          • DocumentIndexFieldValueBase
          • DocumentLink
          • DocumentLinks
          • DocumentSourceType
          • DocumentsQuery
          • DocumentsQueryExtensionsBase
          • DocumentsQueryResult
          • DocumentsQueryTableResult
          • DocumentsTransferInfo
          • DocumentVersion
          • DocumentWordSearchResult
          • DocumentWordSearchResultSectionHits
          • DolphinAttribute
          • DoubleConstant
          • DropDownList
          • DWFieldType
          • DWPoint
          • DWProductTypes
          • DWRectangle
          • DWSize
          • DWSystemVariableName
          • DynamicValueType
          • EagleAttribute
          • EasyCheckoutCheckinExtensionsBase
          • EasyCheckoutResult
          • EasyFileUploadExtensionsBase
          • EmailHistoryStep
          • EndHistoryStep
          • EnhanceImageParameters
          • EntryBase
          • ErrorHistoryStep
          • ExportConfigInput
          • ExportConfigResult
          • ExportQuery
          • ExportSettings
          • ExportTemplateInput
          • ExportTemplateResult
          • ExtendedControllerOperations
          • ExtendedDecisionOperations
          • ExtendedUserOperations
          • ExtendedUserRights
          • FieldMapping
          • FieldMappings
          • FieldMask
          • FieldValidations
          • FieldValueExpression
          • FieldValueStatistics
          • FieldValueStatisticsExpression
          • FieldValueStatisticsResult
          • FileCabinet
          • FileCabinetExtensionsBase
          • FileCabinetField
          • FileCabinetFieldBase
          • FileCabinetFields
          • FileCabinetFieldScope
          • FileCabinets
          • FileCabinetTransferInfo
          • FileDownload
          • FileDownloadBase
          • FileDownloadPage
          • FileDownloadType
          • FileNameExtensions
          • FileSource
          • FixedText
          • FlagConditions
          • Font
          • FormCondition
          • FormFieldValue
          • FormFieldValues
          • FormInfo
          • FormProperties
          • FormsInput
          • FormTemplate
          • FormTemplates
          • FormTypeEnum
          • FoxAttribute
          • FunctionExpression
          • GeckoAttribute
          • GeneralErrorDecisionHistoryStep
          • GetTemplateImageInput
          • GetTemplateImageResult
          • Group
          • Groups
          • HawkAttribute
          • Headline
          • HistoryField
          • HistoryFieldOptions
          • HistoryFormTypeEnum
          • HistoryStep
          • HistoryStepInfo
          • HistoryStepInfoBase
          • HistorySteps
          • HttpMethod
          • HttpMethodList
          • IChunkable
          • ImageField
          • IMimeTypeConverter
          • ImpalaAttribute
          • ImportConfigInput
          • ImportConfigResult
          • ImportEntryStatus
          • ImportEntryVersion
          • ImportEntryVersionStatus
          • ImportResult
          • ImportResultEntry
          • ImportSettings
          • ImportTemplateInput
          • ImportTemplateResult
          • InputDocument
          • InputFlags
          • InputSection
          • InputSections
          • Instance
          • InstanceHistory
          • IntConstant
          • IntegerList
          • IntellixFieldTrust
          • IntellixTrust
          • IResultlistTransformer
          • ItemChoiceType
          • ItemChoiceType1
          • JellyfishAttribute
          • KeywordsField
          • KoalaAttribute
          • Layer
          • LetterCase
          • LineEntry
          • LinkForm
          • LinkInvoke
          • LinkParameter
          • LinkRelation
          • LinkRelations
          • LobsterAttribute
          • LockInfo
          • LogicalOperator
          • LoginInfo
          • MergeAnnotationsParameters
          • MinimalVersionAttribute
          • MultiLineTextField
          • MultiValueField
          • NewUser
          • Notification
          • Notifications
          • NullTableResultValue
          • NumberColumn
          • NumberField
          • NumberTableColumnOptions
          • NumericHistoryFieldOptions
          • Operator
          • Organization
          • Organizations
          • OrganizationUser
          • OrientationType
          • OutOfOffice
          • OutOfOfficeHistoryStep
          • OwnWorkflow
          • OwnWorkflows
          • Page
          • PageData
          • PageHits
          • Pages
          • PagesBlockQuery
          • PlatformClientConfiguration
          • PlatformImageFormat
          • PointAndShootInfo
          • PolyLineEntry
          • PolyLineStampEntry
          • Position
          • PredefinedEntryType
          • QueryParamater
          • QueryParamatersList
          • QueryParamaterType
          • RadioGroup
          • ReadStatus
          • ReassignHistoryStep
          • ReassignmentData
          • RectEntry
          • RedirectType
          • RegionalSettings
          • RequestConfirmedData
          • RequestDataDecision
          • RequestDecision
          • RequestDecisionHistoryStep
          • RequestDecisionSettings
          • RequestDialogQuery
          • RequestEndHistoryStep
          • RequestSettings
          • RequestStartHistoryStep
          • RequestTask
          • RequestTasks
          • ResultDialogFunction
          • ResultDialogFunctionType
          • ResultListExtensions
          • ResultListQuery
          • Right
          • Rights
          • Role
          • RoleField
          • Roles
          • RoleTypes
          • RotatePageParameters
          • SaveTemplateInput
          • SaveTemplateResult
          • SchemaExtensions
          • SearchPositionQuery
          • Section
          • SectionAnnotation
          • SectionAnnotationsPlacement
          • Sections
          • SelectListExpression
          • SelectListInfo
          • SelectListInfos
          • SelectListKind
          • SelectListResult
          • SelectListType
          • SelectListValuesQuery
          • SelectListValuesResult
          • SequenceRequest
          • SequenceResult
          • ServiceConnection
          • ServiceConnectionExtensions
          • ServiceConnectionLicenseBoundData
          • ServiceConnectionLoginData
          • ServiceConnectionTokenLoginData
          • ServiceConnectionTransportData
          • ServiceDescription
          • ServiceDescriptionDocumentation
          • ServiceDescriptionStatistics
          • ServiceDescriptionTests
          • SignatureField
          • SignatureStatus
          • SingleColumnSelectListValues
          • SortDirection
          • SortedField
          • SortedFieldsList
          • SpacerField
          • Stamp
          • StampBase
          • StampConfirmedData
          • StampField
          • StampFormField
          • StampFormFieldValues
          • StampPlacement
          • Stamps
          • StampSignatureType
          • StartHistoryStep
          • StepTypeEnum
          • StopHistoryStep
          • StringConstant
          • Stroke
          • StrokeStamp
          • SubmissionOptions
          • SubstitutionList
          • SubstitutionLists
          • SubstitutionRule
          • SubstitutionRuleField
          • SubstitutionRules
          • SuggestionCellValue
          • SuggestionField
          • SuggestionFields
          • SuggestionTable
          • SuggestionTableField
          • SuggestionTableFields
          • SuggestionValue
          • SynchronizationOperation
          • SynchronizationSettings
          • SystemVariableExpression
          • TableColumnOptions
          • TableColumnsDefinition
          • TableColumnValueTypeEnum
          • TableFieldColumns
          • TableHistoryFieldOptions
          • TableResultFieldKind
          • TableResultHeader
          • TableResultRow
          • TaskDateTimeField
          • TaskFieldValue
          • TaskFieldValueBase
          • TaskFormField
          • TaskNumberField
          • TaskOperations
          • TasksQuery
          • TaskTableColumn
          • TaskTableColumnBase
          • TaskTableField
          • TaskTableNumberField
          • TaskTextField
          • TextColumn
          • TextEntry
          • TextField
          • TextHistoryFieldOptions
          • TextStamp
          • TextStampEntry
          • TextTableColumnOptions
          • TimeoutHistoryStep
          • ToggleBehaviorAction
          • TokenDescription
          • TokenUsage
          • UpdateIndexFieldsInfo
          • UploadedFileChunk
          • UploadTemplateInput
          • UploadTemplateResult
          • User
          • UserDefinedSearchInfo
          • UserField
          • UserInfo
          • Users
          • UserValidation
          • ValidationCondition
          • VersionManagementMode
          • VersionManagementStatus
          • ViewerDialog
          • ViewerDialogModes
          • WebFormControl
          • WebFormControls
          • WebFormField
          • WebFormListOptions
          • WebFormOption
          • WebFormOptions
          • WebFormOptionsRows
          • WebServiceHistoryStep
          • WFFormFieldValue
          • WordSearchResult
          • WordSearchResultPageHit
          • WordSearchResultWordHit
          • WordSearchResultWordHits
          • Workflow
          • WorkflowBehaviorOptions
          • WorkflowDocumentHistory
          • WorkflowRequests
          • Workflows
          • WorkflowStampsSettings
          • WorkflowTask
          • WorkflowTasks
          • WorkflowTasksCount
          • XmlDSigContentType
          • XmlDSigStatusType
          • XmlSchema
          • XmlSchemas
          • Zone
          • Zones
        • DocuWare.Platform.ServerClient.Content
          • BarCodeZone
          • Candidate
          • CandidateInfo
          • CellZone
          • DocumentContent
          • gridTable
          • KeyValuePair
          • KeyValuePairs
          • LanguageDetection
          • Line
          • LineStyle
          • PageContent
          • PictureZone
          • RectangleBase
          • Rotation
          • Rulerline
          • SimplePageContent
          • SimpleWord
          • Space
          • TableZone
          • TextZone
          • Word
          • Words
        • DocuWare.Platform.ServerClient.Substitutions
          • SubstitutionList
          • SubstitutionLists
          • SubstitutionRule
          • SubstitutionRules
        • DocuWare.Platform.ServerClient.WebClient
          • AnnotationTools
          • AnnotationToolSettings
          • ApplicationPreferences
          • ApplicationPreferencesHolder
          • BasketAreaPreferences
          • ContentAreaPreferences
          • FavoriteItems
          • Favorites
          • FontSettings
          • GeneralSettings
          • LayoutMode
          • MultiFCSearchConfiguration
          • MultiFCSearches
          • SizedAnnotationToolSettings
          • TextAnnotationToolSettings
          • ToolbarControlState
          • ToolbarControlType
          • ToolbarPosition
          • ToolbarVisibility
          • ViewerPreferences
          • ViewerToolbar
          • ViewerToolbarControl
          • ViewerToolbarType
          • WebClientLayout
          • WebClientPreferences
          • WebSettings
          • WorkAreaPreferences
          • WorkAreaType
          • WorkflowAreaPreferences
          • WorkInstance
        • DocuWare.Services.Http.Client
          • ErrorProcessing
      • REST Client
        • DocuWare.Services.Http
          • DeserializedHttpResponse
          • DeserializedHttpResponse<T>
          • DeserializedHttpResponseExtensions
        • DocuWare.Services.Http.Client
          • Connector
          • ContentHelper
          • Error
          • ExceptionExtensions
          • HttpClientProxy
          • HttpClientRequestException
          • IFileUploadInfo
          • IHttpClientProxy
          • IRelations
          • IRelationsWithProxy
          • Link
          • Links
          • MethodInvocation
          • RelationExtension
          • RelationsWithProxyExtensions
          • StringWriterUTF8
          • TypeReference
          • UriInvocation
          • UriPattern
          • UriTemplateDescription
          • UriTemplateDescriptions
          • UriTemplateExtensions
          • UriTemplateParameter
          • XElementWrapper
          • XmlSerializableExtensions
          • XmlSerializerRepository

    Class BitmapStamp

    Stamp that applies an image.

    Inheritance
    System.Object
    BitmapStamp
    Namespace: DocuWare.Platform.ServerClient
    Assembly: DocuWare.Platform.ServerClient.dll
    Syntax
    public class BitmapStamp : IRelationsWithProxy

    Properties

    ContentRelationLink

    Gets the Uri of the link for the relation “content”.

    Declaration
    public string ContentRelationLink { get; }
    Property Value
    Type Description
    System.String
    Remarks

    Returns the uri of the link for the relation “content” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

    Links

    Declaration
    public Link[] Links { get; set; }
    Property Value
    Type Description
    Link[]

    Methods

    GetStreamFromContentRelation()

    Calls the HTTP Get method on the link for the relation “content”.

    Declaration
    public System.IO.Stream GetStreamFromContentRelation()
    Returns
    Type Description
    System.IO.Stream

    The content of the response.

    GetStreamFromContentRelationAsync()

    Calls the HTTP Get method on the link for the relation “content” asynchronously.

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromContentRelationAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>

    A task which runs the request.

    Remarks

    This method follows the link for the relation “content”.

    GetStreamFromContentRelationAsync(System.Threading.CancellationToken)

    Calls the HTTP Get method on the link for the relation “content” asynchronously.

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromContentRelationAsync(System.Threading.CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.Threading.CancellationToken cancellationToken

    The cancellation token to cancel the request.

    Returns
    Type Description
    System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>>

    A task which runs the request.

    Remarks

    This method follows the link for the relation “content”.

    SetProxy(HttpClientProxy)

    Sets the HTTP communication proxy which is used in further HTTP communication.

    Declaration
    public void SetProxy(HttpClientProxy proxy)
    Parameters
    Type Name Description
    HttpClientProxy proxy

    The instance which is used in further HTTP communication.

    Remarks

    The HTTP proxy is used to handle the HTTP requests which are created by this instance. The proxy is used in case a request is sent to a URL which is resolved from a link.

    In This Article
    • Properties
      • ContentRelationLink
      • Links
    • Methods
      • GetStreamFromContentRelation()
      • GetStreamFromContentRelationAsync()
      • GetStreamFromContentRelationAsync(System.Threading.CancellationToken)
      • SetProxy(HttpClientProxy)
    About Us Contact Imprint Terms Data privacy
    © 2024 DocuWare Corporation powered by DocFX Back to top