Class StampFormField

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

A form field for variable text to a text stamp.

public class StampFormField : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

StampFormField

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

StampFormField()

Creates a new instance of this class

public StampFormField()

Properties

DWFieldType

The DocuWare type of the field.

public DWFieldType DWFieldType { get; set; }

Property Value

Type	Description
DWFieldType

Label

The label used to represent the form field when the stamp is set on the client.

public string Label { get; set; }

Property Value

Type	Description
string

Length

Lenght of the form field

public int Length { get; set; }

Property Value

Type	Description
int

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Mask

Mask(regular expression) for limiting the input options for the form field.

public string Mask { get; set; }

Property Value

Type	Description
string

MaskErrorText

Error message to display if the input does not match the mask definition.

public string MaskErrorText { get; set; }

Property Value

Type	Description
string

Name

Name of the form field

public string Name { get; set; }

Property Value

Type	Description
string

NotEmpty

A value indicating whether the form field value must be filled.

[Lobster]
public bool NotEmpty { get; set; }

Property Value

Type	Description
bool

Precision

Gets the number of digits after the decimal point in case of a numeric field.

public int Precision { get; set; }

Property Value

Type	Description
int

SampleEditText

Sample entry that matches the mask definition.

[Dolphin]
public string SampleEditText { get; set; }

Property Value

Type	Description
string

SelectListValuesRelationLink

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

public string SelectListValuesRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

SelectListsAssigned

A value indicating whether the any select list is assigned.

[Jellyfish]
public bool SelectListsAssigned { get; set; }

Property Value

Type	Description
bool

SimpleSelectListRelationLink

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

public string SimpleSelectListRelationLink { get; }

Property Value

Type	Description
string

Remarks

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

Methods

GetSelectListResultFromSelectListValuesRelation()

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

public SelectListResult GetSelectListResultFromSelectListValuesRelation()

Returns

Type	Description
SelectListResult	The content of the response.

GetSelectListResultFromSelectListValuesRelationAsync()

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

public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromSelectListValuesRelationAsync()

Returns

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

Remarks

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

GetSelectListResultFromSelectListValuesRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromSelectListValuesRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

GetSelectListResultFromSimpleSelectListRelation()

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

public SelectListResult GetSelectListResultFromSimpleSelectListRelation()

Returns

Type	Description
SelectListResult	The content of the response.

GetSelectListResultFromSimpleSelectListRelationAsync()

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

public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromSimpleSelectListRelationAsync()

Returns

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

Remarks

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

GetSelectListResultFromSimpleSelectListRelationAsync(CancellationToken)

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

public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromSimpleSelectListRelationAsync(CancellationToken cancellationToken)

Parameters

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

Returns

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

Remarks

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

PostToSelectListValuesRelationForSelectListResult(SelectListExpression)

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

public SelectListResult PostToSelectListValuesRelationForSelectListResult(SelectListExpression dataToSend)

Parameters

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

Returns

Type	Description
SelectListResult	The content of the response.

PostToSelectListValuesRelationForSelectListResultAsync(SelectListExpression)

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

public Task<DeserializedHttpResponse<SelectListResult>> PostToSelectListValuesRelationForSelectListResultAsync(SelectListExpression dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToSelectListValuesRelationForSelectListResultAsync(CancellationToken, SelectListExpression)

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

public Task<DeserializedHttpResponse<SelectListResult>> PostToSelectListValuesRelationForSelectListResultAsync(CancellationToken cancellationToken, SelectListExpression dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToSimpleSelectListRelationForSelectListResult(SelectListExpression)

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

public SelectListResult PostToSimpleSelectListRelationForSelectListResult(SelectListExpression dataToSend)

Parameters

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

Returns

Type	Description
SelectListResult	The content of the response.

PostToSimpleSelectListRelationForSelectListResultAsync(SelectListExpression)

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

public Task<DeserializedHttpResponse<SelectListResult>> PostToSimpleSelectListRelationForSelectListResultAsync(SelectListExpression dataToSend)

Parameters

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

Returns

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

Remarks

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

PostToSimpleSelectListRelationForSelectListResultAsync(CancellationToken, SelectListExpression)

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

public Task<DeserializedHttpResponse<SelectListResult>> PostToSimpleSelectListRelationForSelectListResultAsync(CancellationToken cancellationToken, SelectListExpression dataToSend)

Parameters

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

Returns

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

Remarks

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

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.