Class Stamp

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Models a DocuWare stamp.

public class Stamp : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

Stamp

Implements

IRelationsWithProxy

IRelations

IHttpClientProxy

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Stamp()

Creates a new instance of this class

public Stamp()

Properties

AsBitmapRelationLink

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

public string AsBitmapRelationLink { get; }

Property Value

Type	Description
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”.

public string AsSvgRelationLink { get; }

Property Value

Type	Description
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.

[Dolphin]
public bool AutomaticallyOpenNextDocument { get; set; }

Property Value

Type	Description
bool

Autosave

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

public int Autosave { get; set; }

Property Value

Type	Description
int

CloseAfterStampSet

Automatically close the window after stamp is placed in a document

public bool CloseAfterStampSet { get; set; }

Property Value

Type	Description
bool

Color

The color of the stamp content

public string Color { get; set; }

Property Value

Type	Description
string

DisplayName

The display name of the stamp.

public string DisplayName { get; set; }

Property Value

Type	Description
string

Fields

List of the stamp fields.

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

Property Value

Type	Description
List<StampField>

FormField

List of the stamp form fields.

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

Property Value

Type	Description
List<StampFormField>

HeadFont

Font for the additional items of information.

public Font HeadFont { get; set; }

Property Value

Type	Description
Font

Id

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

public string Id { get; set; }

Property Value

Type	Description
string

IsHidden

Determines whether the stamp is visible.

public bool IsHidden { get; set; }

Property Value

Type	Description
bool

Item

public object Item { get; set; }

Property Value

Type	Description
object

KeepStampActive

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

[Dolphin]
public bool KeepStampActive { get; set; }

Property Value

Type	Description
bool

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Name

The name of the stamp.

public string Name { get; set; }

Property Value

Type	Description
string

Overwrite

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

public bool Overwrite { get; set; }

Property Value

Type	Description
bool

PasswordProtected

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

[Dolphin]
public bool PasswordProtected { get; set; }

Property Value

Type	Description
bool

ShowDate

If true Date should be displayed.

[Yak]
public bool ShowDate { get; set; }

Property Value

Type	Description
bool

ShowFrame

If true Frame should be displayed.

[Yak]
public bool ShowFrame { get; set; }

Property Value

Type	Description
bool

ShowTime

If true Time should be displayed.

[Yak]
public bool ShowTime { get; set; }

Property Value

Type	Description
bool

ShowUserName

If true UserName should be displayed.

[Yak]
public bool ShowUserName { get; set; }

Property Value

Type	Description
bool

Signature

The type of the stamp signature if there is any.

public StampSignatureType Signature { get; set; }

Property Value

Type	Description
StampSignatureType

Methods

GetStreamFromAsBitmapRelation()

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

public Stream GetStreamFromAsBitmapRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromAsBitmapRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromAsBitmapRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<Stream>>	A task which runs the request.

Remarks

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

GetStreamFromAsBitmapRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromAsBitmapRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
Task<DeserializedHttpResponse<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”.

public Stream GetStreamFromAsSvgRelation()

Returns

Type	Description
Stream	The content of the response.

GetStreamFromAsSvgRelationAsync()

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromAsSvgRelationAsync()

Returns

Type	Description
Task<DeserializedHttpResponse<Stream>>	A task which runs the request.

Remarks

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

GetStreamFromAsSvgRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<Stream>> GetStreamFromAsSvgRelationAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	The cancellation token to cancel the request.

Returns

Type	Description
Task<DeserializedHttpResponse<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”.

public 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
Stream	The content of the response.

PostToAsBitmapRelationForStreamAsync(FormFieldValues)

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

public Task<DeserializedHttpResponse<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
Task<DeserializedHttpResponse<Stream>>	A task which runs the request.

Remarks

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

PostToAsBitmapRelationForStreamAsync(CancellationToken, FormFieldValues)

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

public Task<DeserializedHttpResponse<Stream>> PostToAsBitmapRelationForStreamAsync(CancellationToken cancellationToken, FormFieldValues dataToSend)

Parameters

Type	Name	Description
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
Task<DeserializedHttpResponse<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”.

public 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
Stream	The content of the response.

PostToAsSvgRelationForStreamAsync(FormFieldValues)

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

public Task<DeserializedHttpResponse<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
Task<DeserializedHttpResponse<Stream>>	A task which runs the request.

Remarks

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

PostToAsSvgRelationForStreamAsync(CancellationToken, FormFieldValues)

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

public Task<DeserializedHttpResponse<Stream>> PostToAsSvgRelationForStreamAsync(CancellationToken cancellationToken, FormFieldValues dataToSend)

Parameters

Type	Name	Description
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
Task<DeserializedHttpResponse<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.

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The HttpClient 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.