Click or drag to resize

Report Properties

The Report type exposes the following members.

Properties
 NameDescription
Public propertyAllExecutionRestrictions List of all restrictions involved in the execution
Public propertyAllRestrictions List of all restrictions of all models of the report, plus the input values
Public propertyAllViews Helper to list of all the views of the report
Public propertyCancel 
Public propertyCommonScripts List of scripts added to all scripts executed for the report (including tasks). This may be useful to defined common functions for the report.
Public propertyCommonScriptsHeader The header to include in razor scripts executed for this report
Public propertyCultureInfo Current culture of the execution
Public propertyDateKeywordsList List of date keywords in english
Public propertyDisplayName The report name displayed in the result. If empty, the report file name is used. The display name may contain a Razor script if it starts with '@'.
Public propertyDisplayNameEx The final display name of the report. It may include script execution defined in DisplayName
Public propertyDisplayResultFilePath File path displayed to the user
Public propertyExecutionCommonRestrictions List of common restrictions prompted at execution
Public propertyExecutionFullDuration Full execution duration
Public propertyExecutionInputValues The current list of input values restrictions of the report at execution time
Public propertyExecutionModelDuration Duration of the model execution
Public propertyExecutionModels List of model to process during the report execution. By default, only models involved in displayed views are executed, unless they have the ForceModelsLoad flag set to true.
Public propertyExecutionName Name of the report during its execution
Public propertyExecutionProgression Execution progression in percentage
Public propertyExecutionProgressionMessage Execution progression message
Public propertyExecutionProgressionModels Execution progression percentage for the models processing
Public propertyExecutionProgressionModelsMessage Execution progression percentage message for the models processing
Public propertyExecutionProgressionTasks Execution progression percentage for the tasks processing
Public propertyExecutionProgressionTasksMessage Execution progression percentage for the tasks processing
Public propertyExecutionPromptedRestrictions List of restrictions prompted at execution from the Report Result
Public propertyExecutionTasks List of tasks to be executed (actually tasks enabled)
Public propertyExecutionView Root view being executed
Public propertyExecutionViewRestrictions List of all view restrictions prompted at execution
Public propertyExecutionViews List of all views to parse during the report execution.
Public propertyFormat Report format
Public propertyForOutput True if the execution is for a report output
Public propertyGenerateHTMLDisplay True if the html display result is being generated
Public propertyGenerationFolder Current folder use for the file generation during execution
Public propertyGUID Unique identifier of the report
Public propertyHasChart True if the report has chart
Public propertyHasChartJSChart True if the report has JS chart
Public propertyHasErrors True if the execution has errors
Public propertyHasExternalViewer True if the report result has an external viewer (different from HTML)
Public propertyHasNVD3Chart True if the report has NVD3 chart
Public propertyHasPlotlyChart True if the report has Plotly chart
Public propertyHasRestrictions True if the report has restrictions to prompt
Public propertyHasScottPlotChart True if the report has ScottPlot chart
Public propertyHasValidationErrors After execution, indicates if the report has validation errors
Public propertyHTMLDisplayFilePath Path of the HTML intermediate result file
Public propertyInitScript A Razor script executed when the report is initialized for the execution. The script can be used to modify the report definition (e.g. set default values in restrictions).
Public propertyInputValues Definition of additional report input values (actually a restriction used as value only that may be prompted). Input values can then be used in the task scripts or any scripts used to generate the report.
Public propertyIsBasicHTMLWithNoOutput True if the report is not for an output and has no external viewer
Public propertyIsExecuting True if the report is being executed
Public propertyIsServerPaginationEnabled True if the server pagination for DataTables is enabled
Public propertyModels List of models of the report
Public propertyNavigationScript Optional Razor Script executed if script navigation links have been added in the CellScript
Public propertyOutputFolderDeviceResultFolder Path of the folder when executed to an output device
Public propertyOutputs List of outputs of the report
Public propertyPrintLayout True if the print layout should be used for the HTML generation
Public propertyPrintQueries If true, the query is printed in the report messages (for debug purpose).
Public propertyRelativeFilePath Current file path without reports directory
Public propertyRenderer Current renderer (if any) used for the execution
Public propertyResultExtension File extension of the result file
Public propertyResultFileEncoding Encoding of the result file
Public propertyResultFileName Current file name of the result file
Public propertySchedules List of schedules of the report
Public propertyShowExecutionMessages Indicates if the execution messages are shown in the report
Public propertySources List of data sources of the report (either from repository or defined in the report itself)
Public propertyTaskFolder Task Folder used to store the schedules of the report
Public propertyTaskHelper Default task helper for the report
Public propertyTasks List of tasks of the report
Public propertyViewGUID The view used by default to execute the report.
Public propertyViews List of views of the report
Public propertyWebExecutionErrors Execution errors after execution used by the Web Report Server
Top
See Also