Click or drag to resize

Report Methods

The Report type exposes the following members.

Methods
 NameDescription
Public methodAddChildView(ReportView, ReportViewTemplate) From a parent view, add a child view with a template
Public methodAddChildView(ReportView, String) From a parent view, add a child view with a template name
Public methodAddModel Add a default model to the report (either SQL or Standard)
Public methodAddModelHTMLView Add a model view to the report
Public methodAddOutput Add a default output to the report
Public methodAddRootView Add a root report view to the report
Public methodAddSchedule Add a schedule to the report
Public methodAddSource Add a default source to the report
Public methodAddTask Add a default task to the report
Public methodAddTask(ReportTask, ReportTaskTemplate) Add a task to the report
Public methodAddView Add a view with a template name
Public methodAttachCSSFile For a CSS File, insert the attached file name or its content according to execution context
Public methodAttachCSSFiles For CSS Files, insert the attached file names or their contents according to execution context
Public methodAttachImageFile The image file name or source of the HTML result according to execution context
Public methodAttachScriptFile For a Script File, insert the attached script file name or it content according to execution context
Public methodAttachScriptFiles For Script Files, insert the attached file names or their contents according to execution context
Public methodCancelExecution Cancel the report execution
Public methodCheckAllPromptedValues Check that all prompted values are not empty for the report. Set validation errors and cancel the report if not.
Public methodCheckLinkedTablesSources Check report sources to have all sources referenced by linked tables
Public methodCheckOnePromptedValue Check that at least one prompted value is not empty for the report. Set validation errors and cancel the report if not.
Public methodClone Clone a report
Public methodContextTranslate Translate a reference text from a given context
Public methodStatic memberCreate Create an empty report
Public methodEnumMessage Translate the enum message using the EnumMessage context
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFindView Helper to find a view from its identifier
Public methodFindViewFromName Helper to find a view from its name
Public methodFindViewFromTemplate Helper to find a view from its template name
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetImageFile The image file name of the HTML result according to execution context
Public methodGetInputRestriction Input restriction value for a given key
Public methodGetInputValueByName Returns an input value (Report Restriction) from a given name
Public methodGetModelsToExecute For a given view, fill the list of models to execute
Public methodGetReportModel Helper to get a report model from its name
Public methodGetReportNavigationFileDownloadLink Get the hyperlink string to execute the report navigation script to download a file.
Public methodGetReportNavigationScriptLink Get the hyperlink string to execute the report navigation script.
Public methodGetSort 
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGetViewFromExecId Helper to get the a view from its execution id
Public methodInit Init the editor objects
(Inherited from RootEditor)
Public methodInitDefaultValues Init the default values
(Inherited from RootEditor)
Public methodInitEditor Init the editor objects and the default values
(Inherited from RootEditor)
Public methodInitForExecution Procedure executed before any execution: set default parameters values and executes init scripts.
Public methodInitGUIDAndSchedules Init view GUIDs and clear schedule before a report Copy
Public methodInitReferences Init all references of the report: Sources, Models, Views, Taks, InputValues
Public methodIsInRestrictionView Returns true if the restriction is referenced by a Restriction View
Public methodStatic memberLoadFromFile Load a report from a file
Public methodLogExecution Log the report execution in the Log repository folder
Public methodLogMessage Log Interface implementation
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodRemoveModel Remove a report model from the report
Public methodRemoveOutput Remove an output from the report
Public methodRemoveSchedule Remove a schedule from the report
Public methodRemoveSource Remove a report source from the report
Public methodRemoveTask Remove a task from the report
Public methodRemoveView Remove a view from its parent
Public methodSaveToFile Save the current report to its file
Public methodSaveToFile(String) Save report to a given file
Public methodSetReadOnly Set all properties to readonly
(Inherited from RootEditor)
Public methodShouldSerializePrintQueries 
Public methodSynchronizeTasks Synchronize all report schedules defined in the report with the Windows Task Scheduler.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTranslate(String) Translate a reference text from the Report context
Public methodTranslate(String, Object) Translate a reference text from the Report context with args parameter
Public methodTranslateDateKeywords Translate a date keyword
Public methodTranslateDateKeywordsToEnglish Translate a date keyword in english
Public methodTranslateDisplayName Translate using the ReportDisplayName context
Public methodTranslateElement Translate using the Element context
Public methodTranslateEnumValue Translate using the Enum context
Public methodTranslateGeneral Translate using the ReportGeneral context
Public methodTranslateOutputName Translate using the ReportOutputName context
Public methodTranslateRepository Repository Translate using the ReportViewName context
Public methodTranslateToJS Translate in a JavaScript format a reference text from the Report context
Public methodTranslateViewName Translate using the ReportViewName context
Public methodUpdateEditor Update editor attributes
(Inherited from RootEditor)
Protected methodUpdateEditorAttributes Refresh properties attrivutes
(Inherited from RootEditor)
Public methodUpdateViewParameter Helper to update a view parameter
Top
See Also