wrApiAction Enumeration

Describe what action the Web Application user interface should take when it launched via the GetUrlParamString Method. Set the Action Property of the Api Class with one of these members.

Syntax

public enum wrApiAction : System.Enum

Members

Member	Value	Description
Default	0	If a report is loaded as the active report, execute the report (same as ExecuteReport Field). If there is no active report, launch the full user interface (same as Home Field)
EditReport	3	Open the active report into its corresponding Designer (e.g. Report Designer, Dashboard Designer, ExpressView Designer, Chained Report Wizard)
ExecuteReport	2	Execute the active report into its viewer or as an exported file. Set the output type by setting the ExportType Property of the ReportObject Class.
Home	1	Launch the full user interface, and open to the Getting Started page.
NewAdvancedReport	4	Start the Advanced Report Designer.
NewCrossTabReport	5	Start the CrossTab Report Wizard.
NewDashboardReport	7	Start the Dashboard Designer.
NewExpressReport	6	Start the Express Report Wizard.
NewExpressView	8	Start the ExpressView Designer.
ScheduledReportsManager	10	Open the Schedule Manager.
ScheduleReport	9	Start the Schedule Report Wizard to schedule the active report.

Remarks

Set an active report in the Api object for any action that requires it (e.g. EditReport, ExecuteReport, ScheduleReport) before launching the session. Otherwise, an exception will be thrown.

Example

Execute the report Development Operations\Failed Builds in the Report Viewer

ReportObject myReport = api.ReportObjectFactory.LoadFromRepository(api.ReportObjectFactory.GetReportId("Development Operations\\Failed Builds"));
myReport.ExportType = wrExportType.Html;
api.ReportObjectFactory.SaveToApi(myReport);

api.Action = wrApiAction.ExecuteReport

Start the ExpressView Designer

api.Action = wrApiAction.NewExpressView;

Inheritance Hierarchy

System.Object
   System.ValueType
      System.Enum
         WebReports.Api.wrApiAction

Reference