Report Methods |
The Report type exposes the following members.
Methods| 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 |
| AttachAssets | Insert a set of client assets (CSS or Script) defined in a central manifest (see ClientAssets), honoring the same CDN / file reference / inlined-content modes as AttachCSSFile and AttachScriptFile. Each asset is referenced by a path relative to the web root / Views folder (e.g. "lib/bootstrap/..."). |
| 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 |
| AttachCSSPath | Insert a CSS file referenced by a path relative to the Views folder / web root (e.g. "lib/bootstrap/css/bootstrap.min.css"), according to the 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 |
| AttachScriptPath | Insert a Script file referenced by a path relative to the Views folder / web root (e.g. "lib/bootstrap/js/bootstrap.bundle.min.js"), according to the 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 |
| GetListingFlags | Lightweight scan of a report file (without a full load) to get the flags used for the web listing: isTask = the report Kind is Task, hasSchedule = the report defines at least one schedule. |
| GetMetaInfo | Get a meta information value from its key |
| 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 | The display order in the tree view (always 0) |
| 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. |
| InitGUIDs | Init GUIDs and clear schedule for 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 |
| SetMetaInfo | Set a meta information value from its key |
| SetReadOnly |
Set all properties to readonly
(Inherited from RootEditor) |
| 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 |
| TranslateElementDescription | Translate the effective description of an Element in the execution culture (semantic layer, shown as a result header tooltip) |
| 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 |
See Also