Class DialogPropertiesTreeView

Dialog properties specific for Tree list

Inheritance

System.Object

DialogProperties

DialogPropertiesTreeView

Implements

IRelationsWithProxy

Namespace: DocuWare.Platform.ServerClient

Assembly: DocuWare.Platform.ServerClient.dll

Syntax

[Dolphin]
public class DialogPropertiesTreeView : DialogProperties, IRelationsWithProxy

Constructors

DialogPropertiesTreeView()

Creates a new instance of this class

Declaration

public DialogPropertiesTreeView()

Properties

Icon

Gets a string which represents an icon name identifier.

Declaration

[Impala]
public string Icon { get; set; }

Property Value

Type	Description
System.String

Links

Declaration

public Link[] Links { get; set; }

Property Value

Type	Description
Link[]

StoreDialogId

Id of the store dialog to be used for storing documents in the tree view.

Declaration

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

Property Value

Type	Description
System.String

StoreDialogRelationLink

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

Declaration

[Dolphin]
public string StoreDialogRelationLink { get; }

Property Value

Type	Description
System.String

Remarks

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

GetDialogFromStoreDialogRelation()

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

Declaration

[Dolphin]
public Dialog GetDialogFromStoreDialogRelation()

Returns

Type	Description
Dialog	The content of the response.

GetDialogFromStoreDialogRelationAsync()

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

Declaration

[Dolphin]
public Task<DeserializedHttpResponse<Dialog>> GetDialogFromStoreDialogRelationAsync()

Returns

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

Remarks

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

GetDialogFromStoreDialogRelationAsync(CancellationToken)

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

Declaration

[Dolphin]
public Task<DeserializedHttpResponse<Dialog>> GetDialogFromStoreDialogRelationAsync(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<Dialog>>	A task which runs the request.

Remarks

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

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 System.Net.Http.HttpClient instance which is used in further HTTP communication.

Overrides

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