Class CreateDocumentArgs
Represents the arguments passed to the CreateDocument method of the ReportsControllerBase for configuring document generation.
Inheritance
Namespace: Telerik.Reporting.Services.WebApi
Assembly: Telerik.Reporting.Services.WebApi.dll
Syntax
public class CreateDocumentArgsRemarks
This class encapsulates all the necessary parameters for creating a report document, including format settings, caching options, and interactivity configurations. Used to control how the reporting engine processes and renders the final document output.
Constructors
CreateDocumentArgs()
Declaration
public CreateDocumentArgs()Properties
ActionID
Gets or sets the server interactivity action identifier that should be triggered on an existing document to generate the new document.
Declaration
public string ActionID { get; set; }Property Value
|
System.String
A string representing the action ID that identifies the specific interactive action to perform, or null if no action is specified. |
Remarks
This property is used to specify interactive actions such as drill-down, sorting, or parameter changes that should be applied to the base document. Applicable only when BaseDocumentID is provided.
BaseDocumentID
Gets or sets the identifier of a base document from the cache that should serve as an interactivity blueprint.
Declaration
public string BaseDocumentID { get; set; }Property Value
|
System.String
A string representing the document ID of the cached base document, or null if no base document is specified. |
Remarks
This property is used for interactive report scenarios where a new document is generated based on user interactions with an existing document. Applicable only when UseCache is set to true.
DeviceInfo
Gets or sets the device-specific settings for the specified rendering format.
Declaration
public Dictionary<string, object> DeviceInfo { get; set; }Property Value
|
System.Collections.Generic.Dictionary<System.String, System.Object>
A dictionary containing format-specific configuration options where keys are setting names and values are setting values. Can be null if no specific device settings are required. |
Remarks
Device settings allow fine-tuning of the rendering output for specific formats. More info on the device setting may be found in the help chapter. Device Information Settings
Format
Gets or sets the rendering format for the document output.
Declaration
public string Format { get; set; }Property Value
|
System.String
A string representing the desired output format (e.g., "PDF", "XLSX", "DOCX", "CSV", "HTML5"). |
Remarks
Specifies which rendering extension should be used to generate the document. See the full list of built-in formats in the help article. Rendering Extensions
UseCache
Gets or sets a value indicating whether the document should be retrieved from cached resources if available.
Declaration
public bool UseCache { get; set; }Property Value
|
System.Boolean
|
Remarks
When set to true, the reporting engine will attempt to return a cached version of the document if it exists and is still valid. This can significantly improve performance for frequently requested reports.