Class DialogFieldBase

Namespace

DocuWare.Platform.ServerClient

Assembly

DocuWare.Platform.ServerClient.dll

Base dialog field definition

[Lobster]
public class DialogFieldBase : IRelationsWithProxy, IRelations, IHttpClientProxy

Inheritance

object

DialogFieldBase

Implements

IRelationsWithProxy

IRelations

IHttpClientProxy

Derived

DialogField

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

DialogFieldBase()

Creates a new instance of this class

public DialogFieldBase()

Properties

AllowExtendedSearch

Use extended search

public bool AllowExtendedSearch { get; set; }

Property Value

Type	Description
bool

AllowFiltering

Allow extended filtering.

public bool AllowFiltering { get; set; }

Property Value

Type	Description
bool

AssignedInternalSelectList

A value indicating whether the internal select list is assigned.

public bool AssignedInternalSelectList { get; set; }

Property Value

Type	Description
bool

CalculateSum

Determines whether the field should have calculated sum (only relevant for decimal table field columns in store and info dialogs).

[Raccoon]
public bool CalculateSum { get; set; }

Property Value

Type	Description
bool

DBFieldName

Name of field in the file cabinet.

public string DBFieldName { get; set; }

Property Value

Type	Description
string

DWFieldType

The DocuWare type of the field.

public DWFieldType DWFieldType { get; set; }

Property Value

Type	Description
DWFieldType

DlgLabel

Label (display name) of the field.

public string DlgLabel { get; set; }

Property Value

Type	Description
string

DynamicPrefillValue

Dynamic (CurrentDate, CurrentDatetime, etc.) default value of the field(s).If this element is not empty PrefilValue shoud be ignored.

[Eagle]
public List<DynamicValueType> DynamicPrefillValue { get; set; }

Property Value

Type	Description
List<DynamicValueType>

Length

Length of the field (for text fields).

public int Length { get; set; }

Property Value

Type	Description
int

Links

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

Locked

Determines whether the value of the field cannot be changed by the user.

public bool Locked { get; set; }

Property Value

Type	Description
bool

Mask

Mask(regular expression) for limiting the input options for the 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

NotEmpty

Determines whether the field can be empty, considering NotEmpty in Field settings and Field may be empty Right

public bool NotEmpty { get; set; }

Property Value

Type	Description
bool

Precision

The precision of this dialog field. This is derived from the file cabinet fields precision.

public int Precision { get; set; }

Property Value

Type	Description
int

PrefillValue

The default value of the field(s). If DynamicPrefillValue is not empty this property should be ignored.

public List<DocumentIndexFieldValue> PrefillValue { get; set; }

Property Value

Type	Description
List<DocumentIndexFieldValue>

ReadOnly

Determines whether the field is read only, considering Locked property and user rights(Modify Right for info dialog, Write Right for store dialog)

public bool ReadOnly { get; set; }

Property Value

Type	Description
bool

SampleEditText

Sample entry that matches the mask definition.

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

Property Value

Type	Description
string

SelectListInfos

Gets a list with information for all assigned select lists.

[Hawk]
public List<SelectListInfo> SelectListInfos { get; set; }

Property Value

Type	Description
List<SelectListInfo>

SelectListOnly

(Only relevant for store and info dialogs)If this flag is true, no one can allocate a new entry for this field when storing a document, unless this is contained in a selection list.

public bool SelectListOnly { get; set; }

Property Value

Type	Description
bool

SelectListType

Type of the select list.

public SelectListType SelectListType { get; set; }

Property Value

Type	Description
SelectListType

SelectListsAssigned

A value indicating whether the any select list is assigned.

public bool SelectListsAssigned { get; set; }

Property Value

Type	Description
bool

SequenceId

The unique identifier of the sequence.

public string SequenceId { get; set; }

Property Value

Type	Description
string

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.

Visible

Determines whether the field is visible.

public bool Visible { get; set; }

Property Value

Type	Description
bool

Methods

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

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