Class ReportEngine

Namespace

PolarStudio

Assembly

PolarStudio.dll

This class is the engine that creates the reporting html and interfaces with the user's web session

public class ReportEngine : XMLparent

Inheritance

object

XMLparent

ReportEngine

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Globals.IsNumericType(object)

Fields

AllowAccessToOtherDatabases

Gets/sets if the reports can access data in other databases.

public bool AllowAccessToOtherDatabases

Field Value

bool

Properties

AdminGroupPIDs

Gets/sets the PID's of the groups that are allowed to edit the reports.

public string AdminGroupPIDs { get; set; }

Property Value

string

AllowedProtectedKeywords

Gets/sets a string of special SQL keywords in square brackets that are allowed in the query.

public string AllowedProtectedKeywords { get; set; }

Property Value

string

Categories

Returns the categories.

public XMLcollection<ReportEngine, ReportCategory> Categories { get; }

Property Value

XMLcollection<ReportEngine, ReportCategory>

Connections

Returns the custom connections.

public XMLcollection<ReportEngine, ReportConnection> Connections { get; }

Property Value

XMLcollection<ReportEngine, ReportConnection>

ExpandableReportCategories

Gets/sets a boolean indicating the categories can be explanded/closed.

public bool ExpandableReportCategories { get; set; }

Property Value

bool

Parameters

Returns the parameters

public XMLcollection<ReportEngine, ReportParameter> Parameters { get; }

Property Value

XMLcollection<ReportEngine, ReportParameter>

Reports

Returns the reports

public XMLcollection<ReportEngine, Report> Reports { get; }

Property Value

XMLcollection<ReportEngine, Report>

ShowCategoriesAsTabSheets

Gets/sets a boolean indicating categories are shown as tab sheets.

public bool ShowCategoriesAsTabSheets { get; set; }

Property Value

bool

StorageQuery

Gets/sets the query that is used for storing the xml data. Must return one field. Can also be a file name in the file system.

public string StorageQuery { get; }

Property Value

string

XML

Gets the full XML for the reports.

public string XML { get; }

Property Value

string

Methods

Initialize(BudaApplication, string, string)

Initializes the engine.

public string Initialize(BudaApplication pApplication, string pStorageQuery = "", string pAdminGroupPIDs = "")

Parameters

pApplication BudaApplication

The application to initialize the engine for.

pStorageQuery string

The query or xml file name to use for storing the xml.

pAdminGroupPIDs string

The PID's of the groups that are allowed to edit the reports.

Returns

string

An empty string