Report Class |
public class Report : RootEditor, ReportExecutionLog
The Report type exposes the following members.
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 |
![]() | AllViews | Helper to list of all the views of the report |
![]() | Cancel | |
![]() | 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 |
![]() | 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 |
![]() | HasChart | True if the report has chart |
![]() | HasChartJSChart | True if the report has JS chart |
![]() | HasErrors | True if the execution has errors |
![]() | HasExternalViewer | True if the report result has an external viewer (different from HTML) |
![]() | HasNVD3Chart | True if the report has NVD3 chart |
![]() | 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 |
![]() | 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 |
![]() | Schedules | List of schedules of the report |
![]() | ShowExecutionMessages | Indicates if the execution messages are shown in the report |
![]() | 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 |
Name | Description | |
---|---|---|
![]() | AddChildView(ReportView, ReportViewTemplate) | From a parent view, add a child view with a template |
![]() | AddChildView(ReportView, String) | From a parent view, add a child view with a template name |
![]() | AddModel | Add a default model to the report (either SQL or Standard) |
![]() | AddModelHTMLView | Add a model view to the report |
![]() | AddOutput | Add a default output to the report |
![]() | AddRootView | Add a root report view to the report |
![]() | AddSchedule | Add a schedule to the report |
![]() | AddSource | Add a default source to the report |
![]() | AddTask | Add a default task to the report |
![]() | AddTask(ReportTask, ReportTaskTemplate) | Add a task to the report |
![]() | AddView | Add a view with a template name |
![]() | AttachCSSFile | For a CSS File, insert the attached file name or its content according to execution context |
![]() | AttachCSSFiles | For CSS Files, insert the attached file names or their contents according to execution context |
![]() | AttachImageFile | The image file name or source of the HTML result according to execution context |
![]() | AttachScriptFile | For a Script File, insert the attached script file name or it content according to execution context |
![]() | AttachScriptFiles | For Script Files, insert the attached file names or their contents according to execution context |
![]() | CancelExecution | Cancel the report execution |
![]() | CheckAllPromptedValues | Check that all prompted values are not empty for the report. Set validation errors and cancel the report if not. |
![]() | CheckLinkedTablesSources | Check report sources to have all sources referenced by linked tables |
![]() | CheckOnePromptedValue | Check that at least one prompted value is not empty for the report. Set validation errors and cancel the report if not. |
![]() | Clone | Clone a report |
![]() | ContextTranslate | Translate a reference text from a given context |
![]() ![]() | Create | Create an empty report |
![]() | EnumMessage | Translate the enum message using the EnumMessage context |
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
![]() | FindView | Helper to find a view from its identifier |
![]() | FindViewFromName | Helper to find a view from its name |
![]() | FindViewFromTemplate | Helper to find a view from its template name |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object) |
![]() | GetImageFile | The image file name of the HTML result according to execution context |
![]() | GetInputRestriction | Input restriction value for a given key |
![]() | GetInputValueByName | Returns an input value (Report Restriction) from a given name |
![]() | GetModelsToExecute | For a given view, fill the list of models to execute |
![]() | GetReportModel | Helper to get a report model from its name |
![]() | GetReportNavigationFileDownloadLink | Get the hyperlink string to execute the report navigation script to download a file. |
![]() | GetReportNavigationScriptLink | Get the hyperlink string to execute the report navigation script. |
![]() | GetSort | |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object) |
![]() | GetViewFromExecId | Helper to get the a view from its execution id |
![]() | Init |
Init the editor objects
(Inherited from RootEditor) |
![]() | InitDefaultValues |
Init the default values
(Inherited from RootEditor) |
![]() | InitEditor |
Init the editor objects and the default values
(Inherited from RootEditor) |
![]() | InitForExecution | Procedure executed before any execution: set default parameters values and executes init scripts. |
![]() | InitGUIDAndSchedules | Init view GUIDs and clear schedule before a report Copy |
![]() | InitReferences | Init all references of the report: Sources, Models, Views, Taks, InputValues |
![]() | IsInRestrictionView | Returns true if the restriction is referenced by a Restriction View |
![]() ![]() | LoadFromFile | Load a report from a file |
![]() | LogExecution | Log the report execution in the Log repository folder |
![]() | LogMessage | Log Interface implementation |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
![]() | RemoveModel | Remove a report model from the report |
![]() | RemoveOutput | Remove an output from the report |
![]() | RemoveSchedule | Remove a schedule from the report |
![]() | RemoveSource | Remove a report source from the report |
![]() | RemoveTask | Remove a task from the report |
![]() | RemoveView | Remove a view from its parent |
![]() | SaveToFile | Save the current report to its file |
![]() | SaveToFile(String) | Save report to a given file |
![]() | SetReadOnly |
Set all properties to readonly
(Inherited from RootEditor) |
![]() | ShouldSerializePrintQueries | |
![]() | SynchronizeTasks | Synchronize all report schedules defined in the report with the Windows Task Scheduler. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object) |
![]() | Translate(String) | Translate a reference text from the Report context |
![]() | Translate(String, Object) | Translate a reference text from the Report context with args parameter |
![]() | TranslateDateKeywords | Translate a date keyword |
![]() | TranslateDateKeywordsToEnglish | Translate a date keyword in english |
![]() | TranslateDisplayName | Translate using the ReportDisplayName context |
![]() | TranslateElement | Translate using the Element context |
![]() | TranslateEnumValue | Translate using the Enum context |
![]() | TranslateGeneral | Translate using the ReportGeneral context |
![]() | TranslateOutputName | Translate using the ReportOutputName context |
![]() | TranslateRepository | Repository Translate using the ReportViewName context |
![]() | TranslateToJS | Translate in a JavaScript format a reference text from the Report context |
![]() | TranslateViewName | Translate using the ReportViewName context |
![]() | UpdateEditor |
Update editor attributes
(Inherited from RootEditor) |
![]() | UpdateEditorAttributes |
Refresh properties attrivutes
(Inherited from RootEditor) |
![]() | UpdateViewParameter | Helper to update a view parameter |
Name | Description | |
---|---|---|
![]() | _dctd | (Inherited from RootEditor) |
![]() | CheckingExecution | True if the report is being tested for execution (from the Server Manager) |
![]() | CurrentModelView | Current model view used when parsing |
![]() | CurrentPage | Current page used when parsing |
![]() | CurrentView | Current view used when parsing |
![]() | CurrentViewGUID | GUID of the view to being executed |
![]() | DrillParents | List of drill parents at execution |
![]() | ExcelResult | Current Excel objects used by the ExcelRenderer |
![]() | ExecutionContext | Context of the execution: DesignerReport, DesignerOutput, TaskScheduler, WebReport, WebOutput |
![]() | ExecutionEndDate | Execution end date time |
![]() | ExecutionErrors | Execution errors after execution |
![]() | ExecutionErrorStackTrace | Execution errors stack trace after execution |
![]() | ExecutionGUID | Current identifier of the report's execution |
![]() | ExecutionInitiator | Optional initiator of the execution |
![]() | ExecutionMessages | Execution messages after execution |
![]() | ExecutionRenderingDate | Rendering date time |
![]() | ExecutionStartDate | Execution start date time |
![]() | ExecutionTriggerView | Restriction View that has triggered the execution |
![]() | FilePath | Current file path of the report |
![]() | HasNavigation | True if the report has navigation links in the result |
![]() | HTMLResultFilePath | Path of the result file in HTML after a report execution (set only for PDF conversions) |
![]() | InitScriptsExecutionMessages | Execution messages got after the init scripts executions |
![]() | InputRestrictions | Helper Dictionary to manage restrictions in the Web Report Server |
![]() | IsNavigating | True is the report execution occured after an navigation (sub-report or drill) |
![]() | JsonResult | Current Json objects used by the JsonRenderer |
![]() | LastModification | Last modification date of the report file |
![]() | LoadErrors | Error messages got during the load of the report |
![]() | NavigationLinks | List of links used for Script navigation |
![]() | OnlyBody | True if the execution generates only the report body (not headers) |
![]() | OutputToExecute | Current report output to execute |
![]() | PDFResult | Current PDF objects used by the PDFRenderer |
![]() | PreInputRestrictions | Helper Dictionary to manage restrictions in the Web Report Server |
![]() | RenderOnly | True if the report has only to be rendered |
![]() | Repository | Current repository of the report |
![]() | ResultFilePath | Path of the result file after a report execution |
![]() | SchedulesModified | True if the schedules have been modified |
![]() | SchedulesWithCurrentUser | True if the schedules have to be defined with the current user, otherwise SYSTEM is used |
![]() | SecurityContext | Current security user of the report execution |
![]() | Status | Execution status of the report |
![]() | StringTag | String that can be used at run-time for any purpose |
![]() | StringTag2 | String that can be used at run-time for any purpose |
![]() | StringTag3 | String that can be used at run-time for any purpose |
![]() | Tag | Object that can be used at run-time for any purpose |
![]() | Tag2 | Object that can be used at run-time for any purpose |
![]() | Tag3 | Object that can be used at run-time for any purpose |
![]() | TaskToExecute | Task set if only one task has to be executed |
![]() | TemplateParsingErrors | Error messages got during the parsing of the templates |
![]() | UpgradeWarnings | Warning messages in case of product upgrade |
![]() | WebUrl | URL when executed from the Web Report Server |