Class DialogFieldBase
Base dialog field definition
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class DialogFieldBase : IRelationsWithProxy
Constructors
DialogFieldBase()
Creates a new instance of this class
Declaration
public DialogFieldBase()
Properties
AllowExtendedSearch
Use extended search
Declaration
public bool AllowExtendedSearch { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowFiltering
Allow extended filtering.
Declaration
public bool AllowFiltering { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AssignedInternalSelectList
A value indicating whether the internal select list is assigned.
Declaration
public bool AssignedInternalSelectList { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
CalculateSum
Determines whether the field should have calculated sum (only relevant for decimal table field columns in store and info dialogs).
Declaration
public bool CalculateSum { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
DBFieldName
Name of field in the file cabinet.
Declaration
public string DBFieldName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
DlgLabel
Label (display name) of the field.
Declaration
public string DlgLabel { get; set; }
Property Value
Type | Description |
---|---|
System.String |
DWFieldType
The DocuWare type of the field.
Declaration
public DWFieldType DWFieldType { get; set; }
Property Value
Type | Description |
---|---|
DWFieldType |
DynamicPrefillValue
Dynamic (CurrentDate, CurrentDatetime, etc.) default value of the field(s).If this element is not empty PrefilValue shoud be ignored.
Declaration
public List<DynamicValueType> DynamicPrefillValue { get; set; }
Property Value
Type | Description |
---|---|
List<DynamicValueType> |
Length
Length of the field (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[] |
Locked
Determines whether the value of the field cannot be changed by the user.
Declaration
public bool Locked { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Mask
Mask(regular expression) for limiting the input options for the 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 |
NotEmpty
Determines whether the field can be empty, considering NotEmpty in Field settings and Field may be empty Right
Declaration
public bool NotEmpty { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Precision
The precision of this dialog field. This is derived from the file cabinet fields precision.
Declaration
public int Precision { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
PrefillValue
The default value of the field(s). If DynamicPrefillValue is not empty this property should be ignored.
Declaration
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)
Declaration
public bool ReadOnly { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
SampleEditText
Sample entry that matches the mask definition.
Declaration
public string SampleEditText { get; set; }
Property Value
Type | Description |
---|---|
System.String |
SelectListInfos
Gets a list with information for all assigned select lists.
Declaration
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.
Declaration
public bool SelectListOnly { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
SelectListsAssigned
A value indicating whether the any select list is assigned.
Declaration
public bool SelectListsAssigned { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
SelectListType
Type of the select list.
Declaration
public SelectListType SelectListType { get; set; }
Property Value
Type | Description |
---|---|
SelectListType |
SequenceId
The unique identifier of the sequence.
Declaration
public string SequenceId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
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
Visible
Determines whether the field is visible.
Declaration
public bool Visible { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
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 System.Threading.Tasks.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(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “simpleSelectList” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListResult>> GetSelectListResultFromSimpleSelectListRelationAsync(System.Threading.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”.
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 System.Threading.Tasks.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(System.Threading.CancellationToken, SelectListExpression)
Calls the HTTP Post method on the link for the relation “simpleSelectList” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<SelectListResult>> PostToSimpleSelectListRelationForSelectListResultAsync(System.Threading.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 virtual void SetProxy(HttpClientProxy proxy)
Parameters
Type | Name | Description |
---|---|---|
HttpClientProxy | proxy | The |
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.