ClientRequest Class

Class that encapsulates a client data request and the associated options.

Inheritance Hierarchy

Namespace: Dundas.BI.Data.DataRetrieval
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.3.0.1000)

Syntax

public class ClientRequest : ClientRequestBase

Public Class ClientRequest
	Inherits ClientRequestBase

public ref class ClientRequest : public ClientRequestBase

type ClientRequest =  
    class
        inherit ClientRequestBase
    end

The ClientRequest type exposes the following members.

Constructors

	Name	Description
	ClientRequest	Initializes a new instance of the ClientRequest class.

Properties

	Name	Description
	CancelSource	Gets the cancellation source object for cancelling the request operation. (Inherited from ClientRequestBase.)
	ClientData	Gets the client data information that is returned unmodified with the result. (Inherited from ClientRequestBase.)
	ObjectId	Gets the object ID for which data is requested. (Inherited from ClientRequestBase.)
	Options	Gets the options for requesting additional information. (Inherited from ClientRequestBase.)
	Overrides	Gets or sets the optional request overrides, for customizing the data retrieval process. (Inherited from ClientRequestBase.)
	PagingOptions	Gets the paging options, when result records are retrieved in pages.
	ParameterValues	Gets the values for all the parameters defined for the business object. (Inherited from ClientRequestBase.)
	ParameterValueTextCategory	Gets or sets the value indicating whether the result should contain simplified, complete or no captions for all public parameter values. (Inherited from ClientRequestBase.)
	Progress	Gets the data retrieval progress report. (Inherited from ClientRequestBase.)
	ShapingOptions	Gets the options for shaping the result. (Inherited from ClientRequestBase.)
	ViewId	Gets or sets the view ID that contains the object for which data is requested. (Inherited from ClientRequestBase.)

Methods

	Name	Description
	Dispose	Disposes any managed or unmanaged resources used by the class. (Inherited from ClientRequestBase.)
	Dispose(Boolean)	Disposes any managed or unmanaged resources used by the class. (Inherited from ClientRequestBase.)
	Finalize	Finalizes an instance of the ClientRequestBase class. (Inherited from ClientRequestBase.)