Class Stamp

Models a DocuWare stamp.

Inheritance

System.Object

Stamp

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class Stamp : IRelationsWithProxy

Constructors

Stamp()

Creates a new instance of this class

Declaration

public Stamp()

Properties

AsBitmapRelationLink

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

Declaration

public string AsBitmapRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “asBitmap” 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.

AsSvgRelationLink

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

Declaration

public string AsSvgRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

Returns the uri of the link for the relation “asSvg” 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.

AutomaticallyOpenNextDocument

Determines whether the stamp remains active after being stored.

Declaration

public bool AutomaticallyOpenNextDocument { get; set; }

Property Value

Type	Description
System.Boolean

Autosave

Automatically save the stamp after specified period in seconds. Value -1 mean the stamp have to be saved on user action.

Declaration

public int Autosave { get; set; }

Property Value

Type	Description
System.Int32

CloseAfterStampSet

Automatically close the window after stamp is placed in a document

Declaration

public bool CloseAfterStampSet { get; set; }

Property Value

Type	Description
System.Boolean

Color

The color of the stamp content

Declaration

public string Color { get; set; }

Property Value

Type	Description
System.String

DisplayName

The display name of the stamp.

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
System.String

Fields

List of the stamp fields.

Declaration

public List<StampField> Fields { get; set; }

Property Value

Type	Description
List<StampField>

FormField

List of the stamp form fields.

Declaration

public List<StampFormField> FormField { get; set; }

Property Value

Type	Description
List<StampFormField>

HeadFont

Font for the additional items of information.

Declaration

public Font HeadFont { get; set; }

Property Value

Type	Description
Font

Id

The id of the stamp, which is a GUID usually.

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

IsHidden

Determines whether the stamp is visible.

Declaration

public bool IsHidden { get; set; }

Property Value

Type	Description
System.Boolean

Item

Declaration

public object Item { get; set; }

Property Value

Type	Description
System.Object

KeepStampActive

Determines whether next document is opened automatically after the stamp is stored.

Declaration

public bool KeepStampActive { get; set; }

Property Value

Type	Description
System.Boolean

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Name

The name of the stamp.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

Overwrite

If this flag is true the system will overwrite existing database entries with the stamp entries.

Declaration

public bool Overwrite { get; set; }

Property Value

Type	Description
System.Boolean

PasswordProtected

If this flag is true password is needed to place the stamp.

Declaration

public bool PasswordProtected { get; set; }

Property Value

Type	Description
System.Boolean

Signature

The type of the stamp signature if there is any.

Declaration

public StampSignatureType Signature { get; set; }

Property Value

Type	Description
StampSignatureType

Methods

GetStreamFromAsBitmapRelation()

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

Declaration

public System.IO.Stream GetStreamFromAsBitmapRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromAsBitmapRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromAsBitmapRelationAsync()

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 “asBitmap”.

GetStreamFromAsBitmapRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromAsBitmapRelationAsync(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 “asBitmap”.

GetStreamFromAsSvgRelation()

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

Declaration

public System.IO.Stream GetStreamFromAsSvgRelation()

Returns

Type	Description
System.IO.Stream	The content of the response.

GetStreamFromAsSvgRelationAsync()

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromAsSvgRelationAsync()

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 “asSvg”.

GetStreamFromAsSvgRelationAsync(System.Threading.CancellationToken)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> GetStreamFromAsSvgRelationAsync(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 “asSvg”.

PostToAsBitmapRelationForStream(FormFieldValues)

Calls the HTTP Post method on the link for the relation “asBitmap”.

Declaration

public System.IO.Stream PostToAsBitmapRelationForStream(FormFieldValues dataToSend)

Parameters

Type	Name	Description
FormFieldValues	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.IO.Stream	The content of the response.

PostToAsBitmapRelationForStreamAsync(FormFieldValues)

Calls the HTTP Post method on the link for the relation “asBitmap” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToAsBitmapRelationForStreamAsync(FormFieldValues dataToSend)

Parameters

Type	Name	Description
FormFieldValues	dataToSend	The data to send. This data is written into the request body.

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 “asBitmap”.

PostToAsBitmapRelationForStreamAsync(System.Threading.CancellationToken, FormFieldValues)

Calls the HTTP Post method on the link for the relation “asBitmap” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToAsBitmapRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, FormFieldValues dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
FormFieldValues	dataToSend	The data to send. This data is written into the request body.

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 “asBitmap”.

PostToAsSvgRelationForStream(FormFieldValues)

Calls the HTTP Post method on the link for the relation “asSvg”.

Declaration

public System.IO.Stream PostToAsSvgRelationForStream(FormFieldValues dataToSend)

Parameters

Type	Name	Description
FormFieldValues	dataToSend	The data to send. This data is written into the request body.

Returns

Type	Description
System.IO.Stream	The content of the response.

PostToAsSvgRelationForStreamAsync(FormFieldValues)

Calls the HTTP Post method on the link for the relation “asSvg” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToAsSvgRelationForStreamAsync(FormFieldValues dataToSend)

Parameters

Type	Name	Description
FormFieldValues	dataToSend	The data to send. This data is written into the request body.

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 “asSvg”.

PostToAsSvgRelationForStreamAsync(System.Threading.CancellationToken, FormFieldValues)

Calls the HTTP Post method on the link for the relation “asSvg” asynchronously.

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<System.IO.Stream>> PostToAsSvgRelationForStreamAsync(System.Threading.CancellationToken cancellationToken, FormFieldValues dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
FormFieldValues	dataToSend	The data to send. This data is written into the request body.

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 “asSvg”.

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.