Report Properties

The Report type exposes the following members.

Properties

	Name	Description
	AllElements	List of all elements of all models of the report
	AllExecutionRestrictions	List of all restrictions involved in the execution
	AllRestrictions	List of all restrictions of all models of the report, plus the input values
	AllTasks	Helper to list of all the tasks of the report
	AllViews	Helper to list of all the views of the report
	Cancel	If true, the report execution is cancelled
	CultureInfo	Current culture of the execution
	DateKeywordsList	List of date keywords in english
	DisplayName	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 '@'.
	DisplayNameEx	The final display name of the report. It may include script execution defined in DisplayName
	DisplayResultFilePath	File path displayed to the user
	ExecutionCommonRestrictions	List of common restrictions prompted at execution
	ExecutionFullDuration	Full execution duration
	ExecutionInputValues	The current list of input values restrictions of the report at execution time
	ExecutionMessagesToDisplay	Execution messages limited for display
	ExecutionModelDuration	Duration of the model execution
	ExecutionModels	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.
	ExecutionName	Name of the report during its execution
	ExecutionProgression	Execution progression in percentage
	ExecutionProgressionMessage	Execution progression message
	ExecutionProgressionModels	Execution progression percentage for the models processing
	ExecutionProgressionModelsMessage	Execution progression percentage message for the models processing
	ExecutionProgressionTasks	Execution progression percentage for the tasks processing
	ExecutionProgressionTasksMessage	Execution progression percentage for the tasks processing
	ExecutionPromptedRestrictions	List of restrictions prompted at execution from the Report Result
	ExecutionTasks	List of tasks to be executed (actually tasks enabled)
	ExecutionView	Root view being executed
	ExecutionViewRestrictions	List of all view restrictions prompted at execution
	ExecutionViews	List of all views to parse during the report execution.
	Format	Report format
	ForOutput	True if the execution is for a report output
	GenerateHTMLDisplay	True if the html display result is being generated
	GenerationFolder	Current folder use for the file generation during execution
	GUID	Unique identifier of the report
	Guide	Optional HTML guide displayed below the prompted restrictions when the report is executed in a browser (e.g. to explain what the report does and how to fill the input values). The text can contain HTML and, if it starts with '@', is parsed with Razor (the report being the model).
	GuideHtml	The guide parsed with Razor (HTML). Razor errors are caught and returned as an HTML alert so a faulty guide cannot break the report rendering.
	HasChart	True if the report has chart
	HasChartJSChart	True if the report has JS chart
	HasEChartsChart	True if the report has ECharts chart
	HasErrors	True if the execution has errors
	HasExternalViewer	True if the report result has an external viewer (different from HTML)
	HasGauge	True if the report has a Gauge view (built with ECharts)
	HasPlotlyChart	True if the report has Plotly chart
	HasRestrictions	True if the report has restrictions to prompt
	HasScottPlotChart	True if the report has ScottPlot chart
	HasValidationErrors	After execution, indicates if the report has validation errors
	HTMLDisplayFilePath	Path of the HTML intermediate result file
	InitScript	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).
	InputValues	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.
	IsBasicHTMLWithNoOutput	True if the report is not for an output and has no external viewer
	IsExecuting	True if the report is being executed
	IsServerPaginationEnabled	True if the server pagination for DataTables is enabled
	IsTaskOnly	True if the report is a Task (a job): only its Tasks are executed, no result view is rendered.
	Kind	Kind of report: a standard Report (models and views are executed and rendered) or a Task (a job that only executes its Tasks: ETL, data transfer, maintenance, triggering other reports; no result view is produced).
	MetaInfo	Meta information that can be used for any purpose
	Models	List of models of the report
	NavigationScript	Optional Razor Script executed if script navigation links have been added in the CellScript
	OutputFolderDeviceResultFolder	Path of the folder when executed to an output device
	Outputs	List of outputs of the report
	PrintLayout	True if the print layout should be used for the HTML generation
	PrintQueries	If true, the query is printed in the report messages (for debug purpose).
	RelativeFilePath	Current file path without reports directory
	Renderer	Current renderer (if any) used for the execution
	ResultExtension	File extension of the result file
	ResultFileEncoding	Encoding of the result file
	ResultFileName	Current file name of the result file
	ResultOptionParameters	List of parameters displayed in the result options panel (tabs to show and renderer options)
	Schedules	List of schedules of the report
	ShowExecutionMessages	Indicates if the execution messages are shown in the report
	SkipExternalViewer	True if being shown in companion
	Sources	List of data sources of the report (either from repository or defined in the report itself)
	TaskFolder	Task Folder used to store the schedules of the report
	TaskHelper	Default task helper for the report
	Tasks	List of tasks of the report
	ViewGUID	The view used by default to execute the report.
	Views	List of views of the report
	WebExecutionErrors	Execution errors after execution used by the Web Report Server

Top

See Also