Class FileCabinetFieldBase

Base file cabinet field definition

Inheritance

System.Object

FileCabinetFieldBase

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

[Lobster]
public class FileCabinetFieldBase : IRelationsWithProxy

Constructors

FileCabinetFieldBase()

Creates a new instance of this class

Declaration

public FileCabinetFieldBase()

Properties

DBFieldName

The name of the database column for the field.

Declaration

public string DBFieldName { get; set; }

Property Value

Type	Description
System.String

DisplayName

Label (display name) of the field.

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
System.String

DropLeadingBlanks

Determines whether the system will automatically remove any leading spaces. If both the Remove leading spaces and Remove leading zeros options are enabled, both leading spaces and zeros are removed: _07896 becomes 7896.

Declaration

public bool DropLeadingBlanks { get; set; }

Property Value

Type	Description
System.Boolean

DropLeadingZero

Determines whether the system will automatically remove any leading zeros. If both the Remove leading spaces and Remove leading zeros options are enabled, both leading spaces and zeros are removed: _07896 becomes 7896.

Declaration

public bool DropLeadingZero { get; set; }

Property Value

Type	Description
System.Boolean

DWFieldType

The DocuWare type of the field

Declaration

public DWFieldType DWFieldType { get; set; }

Property Value

Type	Description
DWFieldType

FieldInfoText

Description of the field.

Declaration

public string FieldInfoText { get; set; }

Property Value

Type	Description
System.String

FixedEntry

Fixed value of the field.If it's null the field has no fixed value. Not relevant for fields with "Table" DWFieldType.

Declaration

public string FixedEntry { get; set; }

Property Value

Type	Description
System.String

Length

Length of the field (only for text fields).

Declaration

public int Length { get; set; }

Property Value

Type	Description
System.Int32

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

NotEmpty

Obsolete since Lobster. Use the same property on dialog field and stamp form field.

Declaration

public bool NotEmpty { get; set; }

Property Value

Type	Description
System.Boolean

Precision

The number of decimal places that can be entered after the decimal point of a numeric and decimal fields.

Declaration

public int Precision { get; set; }

Property Value

Type	Description
System.Int32

Scope

Gets whether the field is a user or a system field.

Declaration

public FileCabinetFieldScope Scope { get; set; }

Property Value

Type	Description
FileCabinetFieldScope

SelectListRelationLink

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

Declaration

public string SelectListRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

GetSelectListResultFromSelectListRelation()

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

Declaration

public SelectListResult GetSelectListResultFromSelectListRelation()

Returns

Type	Description
SelectListResult	The content of the response.

GetSelectListResultFromSelectListRelationAsync()

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

Declaration

public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromSelectListRelationAsync()

Returns

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

Remarks

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

GetSelectListResultFromSelectListRelationAsync(CancellationToken)

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

Declaration

public Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromSelectListRelationAsync(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 “selectList”.

PostToSelectListRelationForSelectListResult(FileCabinetSelectListExpression)

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

Declaration

public SelectListResult PostToSelectListRelationForSelectListResult(FileCabinetSelectListExpression dataToSend)

Parameters

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

Returns

Type	Description
SelectListResult	The content of the response.

PostToSelectListRelationForSelectListResultAsync(FileCabinetSelectListExpression)

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

Declaration

public Task<DeserializedHttpResponse<SelectListResult>> PostToSelectListRelationForSelectListResultAsync(FileCabinetSelectListExpression dataToSend)

Parameters

Type	Name	Description
FileCabinetSelectListExpression	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 “selectList”.

PostToSelectListRelationForSelectListResultAsync(CancellationToken, FileCabinetSelectListExpression)

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

Declaration

public Task<DeserializedHttpResponse<SelectListResult>> PostToSelectListRelationForSelectListResultAsync(CancellationToken cancellationToken, FileCabinetSelectListExpression dataToSend)

Parameters

Type	Name	Description
System.Threading.CancellationToken	cancellationToken	The cancellation token to cancel the request.
FileCabinetSelectListExpression	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 “selectList”.

SetProxy(HttpClientProxy)

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

Declaration

public virtual 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.