Class MultiColSelectListValuesResult
Specific properties for each dialog type
Inheritance
Namespace: DocuWare.Platform.ServerClient
Assembly: DocuWare.Platform.ServerClient.dll
Syntax
public class MultiColSelectListValuesResult : IRelationsWithProxy
Properties
Columns
Declaration
public List<MultiColSelectListColumn> Columns { get; set; }
Property Value
Type | Description |
---|---|
List<MultiColSelectListColumn> |
FirstRelationLink
Gets the Uri of the link for the relation “first”.
Declaration
public string FirstRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “first” if it exists, or
Links
Declaration
public Link[] Links { get; set; }
Property Value
Type | Description |
---|---|
Link[] |
NextRelationLink
Gets the Uri of the link for the relation “next”.
Declaration
public string NextRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “next” if it exists, or
PrevRelationLink
Gets the Uri of the link for the relation “prev”.
Declaration
public string PrevRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “prev” if it exists, or
Rows
Declaration
public List<MultiColSelectListRow> Rows { get; set; }
Property Value
Type | Description |
---|---|
List<MultiColSelectListRow> |
SelfRelationLink
Gets the Uri of the link for the relation “self”.
Declaration
public string SelfRelationLink { get; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Returns the uri of the link for the relation “self” if it exists, or
Methods
GetMultiColSelectListValuesResultFromFirstRelation()
Calls the HTTP Get method on the link for the relation “first”.
Declaration
public MultiColSelectListValuesResult GetMultiColSelectListValuesResultFromFirstRelation()
Returns
Type | Description |
---|---|
MultiColSelectListValuesResult | The content of the response. |
GetMultiColSelectListValuesResultFromFirstRelationAsync()
Calls the HTTP Get method on the link for the relation “first” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetMultiColSelectListValuesResultFromFirstRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “first”.
GetMultiColSelectListValuesResultFromFirstRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “first” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetMultiColSelectListValuesResultFromFirstRelationAsync(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<MultiColSelectListValuesResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “first”.
GetMultiColSelectListValuesResultFromNextRelation()
Calls the HTTP Get method on the link for the relation “next”.
Declaration
public MultiColSelectListValuesResult GetMultiColSelectListValuesResultFromNextRelation()
Returns
Type | Description |
---|---|
MultiColSelectListValuesResult | The content of the response. |
GetMultiColSelectListValuesResultFromNextRelationAsync()
Calls the HTTP Get method on the link for the relation “next” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetMultiColSelectListValuesResultFromNextRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “next”.
GetMultiColSelectListValuesResultFromNextRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “next” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetMultiColSelectListValuesResultFromNextRelationAsync(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<MultiColSelectListValuesResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “next”.
GetMultiColSelectListValuesResultFromPrevRelation()
Calls the HTTP Get method on the link for the relation “prev”.
Declaration
public MultiColSelectListValuesResult GetMultiColSelectListValuesResultFromPrevRelation()
Returns
Type | Description |
---|---|
MultiColSelectListValuesResult | The content of the response. |
GetMultiColSelectListValuesResultFromPrevRelationAsync()
Calls the HTTP Get method on the link for the relation “prev” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetMultiColSelectListValuesResultFromPrevRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “prev”.
GetMultiColSelectListValuesResultFromPrevRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “prev” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetMultiColSelectListValuesResultFromPrevRelationAsync(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<MultiColSelectListValuesResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “prev”.
GetMultiColSelectListValuesResultFromSelfRelation()
Calls the HTTP Get method on the link for the relation “self”.
Declaration
public MultiColSelectListValuesResult GetMultiColSelectListValuesResultFromSelfRelation()
Returns
Type | Description |
---|---|
MultiColSelectListValuesResult | The content of the response. |
GetMultiColSelectListValuesResultFromSelfRelationAsync()
Calls the HTTP Get method on the link for the relation “self” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetMultiColSelectListValuesResultFromSelfRelationAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “self”.
GetMultiColSelectListValuesResultFromSelfRelationAsync(System.Threading.CancellationToken)
Calls the HTTP Get method on the link for the relation “self” asynchronously.
Declaration
public System.Threading.Tasks.Task<DeserializedHttpResponse<MultiColSelectListValuesResult>> GetMultiColSelectListValuesResultFromSelfRelationAsync(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<MultiColSelectListValuesResult>> | A task which runs the request. |
Remarks
This method follows the link for the relation “self”.
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 |
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.