Class StampFormField

A form field for variable text to a text stamp.

Inheritance

System.Object

StampFormField

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class StampFormField : IRelationsWithProxy

Constructors

StampFormField()

Creates a new instance of this class

Declaration

public StampFormField()

Properties

DWFieldType

The DocuWare type of the field.

Declaration

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.

Declaration

public string Label { get; set; }

Property Value

Type	Description
System.String

Length

Lenght of the form field

Declaration

public int Length { get; set; }

Property Value

Type	Description
System.Int32

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Mask

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

Declaration

public string Mask { get; set; }

Property Value

Type	Description
System.String

MaskErrorText

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

Declaration

public string MaskErrorText { get; set; }

Property Value

Type	Description
System.String

Name

Name of the form field

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

NotEmpty

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

Declaration

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

Property Value

Type	Description
System.Boolean

Precision

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

Declaration

public int Precision { get; set; }

Property Value

Type	Description
System.Int32

SampleEditText

Sample entry that matches the mask definition.

Declaration

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

Property Value

Type	Description
System.String

SelectListsAssigned

A value indicating whether the any select list is assigned.

Declaration

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

Property Value

Type	Description
System.Boolean

SelectListValuesRelationLink

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

Declaration

public string SelectListValuesRelationLink { get; }

Property Value

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

SimpleSelectListRelationLink

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

Declaration

public string SimpleSelectListRelationLink { get; }

Property Value

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

Declaration

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.

Declaration

public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromSelectListValuesRelationAsync()

Returns

Type	Description
System.Threading.Tasks.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.

Declaration

public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromSelectListValuesRelationAsync(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<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”.

Declaration

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.

Declaration

public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromSimpleSelectListRelationAsync()

Returns

Type	Description
System.Threading.Tasks.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.

Declaration

public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromSimpleSelectListRelationAsync(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<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”.

Declaration

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.

Declaration

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
System.Threading.Tasks.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.

Declaration

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

Parameters

Type	Name	Description
System.Threading.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
System.Threading.Tasks.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”.

Declaration

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.

Declaration

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
System.Threading.Tasks.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.

Declaration

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

Parameters

Type	Name	Description
System.Threading.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
System.Threading.Tasks.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.

Declaration

public void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The System.Net.Http.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.