Class Field

---

Inheritance

System.Object

WFBaseForm

BaseField

Field

Implements

IRelationsWithProxy

Inherited Members

BaseField.Value

BaseField.DataType

BaseField.AdditionalParameter

WFBaseForm.Label

WFBaseForm.Position

WFBaseForm.FormType

WFBaseForm.VariableName

Namespace: DocuWare.Platform.Bpw.Schemas

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

public class Field : BaseField, IRelationsWithProxy

Properties

Description

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

FieldMask

Declaration

public FieldEntryMask FieldMask { get; set; }

Property Value

Type	Description
FieldEntryMask

FilterGuid

Declaration

public string FilterGuid { get; set; }

Property Value

Type	Description
System.String

Id

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

IsMandatory

Declaration

public bool IsMandatory { get; set; }

Property Value

Type	Description
System.Boolean

IsMultiselect

Declaration

public bool IsMultiselect { get; set; }

Property Value

Type	Description
System.Boolean

IsReadOnly

Declaration

public bool IsReadOnly { get; set; }

Property Value

Type	Description
System.Boolean

IsSelectListOnly

Declaration

public bool IsSelectListOnly { get; set; }

Property Value

Type	Description
System.Boolean

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

MultiValue

Declaration

public List<BpwSelectListItem> MultiValue { get; set; }

Property Value

Type	Description
List<BpwSelectListItem>

SelectListGuid

Declaration

public string SelectListGuid { get; set; }

Property Value

Type	Description
System.String

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

PostToSelectListRelationForBpwSelectList(SelectListExpression)

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

Declaration

public BpwSelectList PostToSelectListRelationForBpwSelectList(SelectListExpression dataToSend)

Parameters

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

Returns

Type	Description
BpwSelectList	The content of the response.

PostToSelectListRelationForBpwSelectListAsync(SelectListExpression)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<BpwSelectList>> PostToSelectListRelationForBpwSelectListAsync(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<BpwSelectList>>	A task which runs the request.

Remarks

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

PostToSelectListRelationForBpwSelectListAsync(System.Threading.CancellationToken, SelectListExpression)

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

Declaration

public System.Threading.Tasks.Task<DeserializedHttpResponse<BpwSelectList>> PostToSelectListRelationForBpwSelectListAsync(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<BpwSelectList>>	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 override void SetProxy(HttpClientProxy proxy)

Parameters

Type	Name	Description
HttpClientProxy	proxy	The instance which is used in further HTTP communication.

Overrides

WFBaseForm.SetProxy(HttpClientProxy)

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.

Implements

IRelationsWithProxy