Table of Contents

Class Report

Namespace
PolarStudio
Assembly
PolarStudio.dll

This class contains a report as defined in Polar Reports.

public class Report : XMLobject<ReportEngine>
Inheritance
Report
Inherited Members
Extension Methods

Fields

DesignSettings

Gets/sets the design settings. This is a string containing the html classes for various elements, like: TableClasses=table table-striped HeadingClassGroup= HeadingClassColumn= HeadingClassRow= HeadingClassColumnRow= CellClass=

public string DesignSettings

Field Value

string

Properties

AutoShow

Gets/sets a boolean indication to instantly show the results (without the need for the user to press the 'show' button).

public bool AutoShow { get; set; }

Property Value

bool

Caption

Gets/sets the caption

public string Caption { get; set; }

Property Value

string

CategoryGuid

Gets/sets the guid for the category to use.

public string CategoryGuid { get; set; }

Property Value

string

ChartCaption

Gets/sets the chart caption of the chart.

public string ChartCaption { get; set; }

Property Value

string

ChartCustomizations

A custom script that can customize the chart.

public string ChartCustomizations { get; set; }

Property Value

string

ChartType

Gets/sets the chart type.

public string ChartType { get; set; }

Property Value

string

Columns

Returns the columns.

public XMLcollection<ReportEngine, ReportColumn> Columns { get; }

Property Value

XMLcollection<ReportEngine, ReportColumn>

ConnectionGuid

Gets/sets the guid for the connection to use.

public string ConnectionGuid { get; set; }

Property Value

string

CrossTabColumnHeaders

Gets/sets the column headers for a cross-tab report.

public string CrossTabColumnHeaders { get; set; }

Property Value

string

CrossTabReport

Gets/sets if the report is a cross-tab report.

public bool CrossTabReport { get; set; }

Property Value

bool

CrossTabRowHeaders

Gets/sets the row headers for a cross-tab report.

public string CrossTabRowHeaders { get; set; }

Property Value

string

CustomModuleAutoIndent

Gets/sets if the custom module should automatically fix the indenting when saved by the user.

public bool CustomModuleAutoIndent { get; set; }

Property Value

bool

CustomModuleCompileError

Returns a compile error for the custom module if applicable.

public string CustomModuleCompileError { get; }

Property Value

string

CustomModuleSourceCode

Gets/sets the source code of the custom module

public string CustomModuleSourceCode { get; set; }

Property Value

string

CustomModuleTestExpression

Gets/sets the expression to test the custom module.

public string CustomModuleTestExpression { get; set; }

Property Value

string

Description

Gets/sets the description.

public string Description { get; set; }

Property Value

string

EnvelopMain

Gets/sets the main (first page) html envelope to create the report.

public string EnvelopMain { get; set; }

Property Value

string

EnvelopSub

Gets/sets the sub (second and further pages) html envelope to create the report.

public string EnvelopSub { get; set; }

Property Value

string

ExportSelectedColumnsOnly

Gets/sets a boolean to indicate to only export the marked columns.

public bool ExportSelectedColumnsOnly { get; set; }

Property Value

bool

Filters

Returns the filters.

public XMLcollection<ReportEngine, ReportFilter> Filters { get; }

Property Value

XMLcollection<ReportEngine, ReportFilter>

FontRotation

Gets/sets the rotation of the font in degrees of the captions shown at the x axis of the chart.

public int FontRotation { get; set; }

Property Value

int

GroupPIDs

Gets/sets the group PID's for which this report is visible. Empty means visible for all groups. The PID's are separated by semi-colons.

public string GroupPIDs { get; set; }

Property Value

string

LegendColumns

Gets/sets the max number of columns to show in the ledgend of the chart.

public int LegendColumns { get; set; }

Property Value

int

LegendPosition

Gets/sets the position of the ledgend of the chart (N, E, S, W, '')

public string LegendPosition { get; set; }

Property Value

string

LegendRows

Gets/sets the max number of rows to show in the ledgend of the chart.

public int LegendRows { get; set; }

Property Value

int

Notes

Gets/sets the notes.

public string Notes { get; set; }

Property Value

string

NumberOfFirstColumns

Returns the number of header-columns at the left of the report.

public int NumberOfFirstColumns { get; set; }

Property Value

int

Parameters

Returns the parameters.

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

Property Value

XMLcollection<ReportEngine, ReportParameter>

Published

Gets/sets a boolean indicating the report is published (available for the user).

public bool Published { get; set; }

Property Value

bool

Query

Gets/sets the query.

public string Query { get; set; }

Property Value

string

RecordCount

Returns the number of records to show on one page.

public int RecordCount { get; set; }

Property Value

int

ScaleMax

Gets/sets the max of the scale of the chart.

public object ScaleMax { get; set; }

Property Value

object

ShowInMenu

Gets/sets a boolean indicating the reports must be included in the menu of reports.

public bool ShowInMenu { get; set; }

Property Value

bool

SizeX

Gets/sets the width of the chart in pixels.

public int SizeX { get; set; }

Property Value

int

SizeY

Gets/sets the height of the chart in pixels.

public int SizeY { get; set; }

Property Value

int

SubReports

Returns the sub reports.

public XMLcollection<ReportEngine, ReportSubReportDefinition> SubReports { get; }

Property Value

XMLcollection<ReportEngine, ReportSubReportDefinition>

VisibleScript

Gets/sets a script to determine if this report is visible.

public string VisibleScript { get; set; }

Property Value

string

XML

Returns the XML for this report.

public XmlNode XML { get; }

Property Value

XmlNode

XMLdataNodeName

Gets/sets the node name of the xml data.

public string XMLdataNodeName { get; set; }

Property Value

string

XaxisCaption

Gets/sets the caption of the x axis of the chart.

public string XaxisCaption { get; set; }

Property Value

string

XaxisSpacing

Gets/sets the additional spacing of the captions on the x axis of the chart.

public object XaxisSpacing { get; set; }

Property Value

object

YaxisCaption

Gets/sets the additional spacing of the captions on the y axis of the chart.

public string YaxisCaption { get; set; }

Property Value

string

YaxisSpacing

Gets/sets the additional spacing of the captions on the x axis of the chart.

public object YaxisSpacing { get; set; }

Property Value

object

Methods

CreateReport(Context, string, ref string, ref string, bool, string, string, int, string, bool, string)

This method creates the html or text result for this report.

public string CreateReport(Context pContext, string pReportType, ref string pErrorMessage, ref string pLastExecutedQuery, bool pLimitResultSet, string pParentReportGUID = "", string pSubReportGUID = "", int pLineNumber = 0, string pAdditionalWhere = "", bool pForceAsSubReport = false, string pContainerReportPaths = "")

Parameters

pContext Context

The context.

pReportType string

The type of report to get. Use one of: 'HTML', 'XML', 'TEXT', 'EMAIL', 'EXCEL'

pErrorMessage string

A by-ref parameter that will be set to an error message if applicable.

pLastExecutedQuery string

A by-ref parameter that contains the last executed query.

pLimitResultSet bool

A boolean indicating to limit the number of returned records to 1000.

pParentReportGUID string

The GUID of the parent report.

pSubReportGUID string

The GUID of the sub-report.

pLineNumber int

The line number.

pAdditionalWhere string

An additional where.

pForceAsSubReport bool

A boolean to force the report to be rendered as sub report.

pContainerReportPaths string

A string with paths for container reports. Leave empty.

Returns

string

The text for the given type representing the report.

Eval(string, Context)

Evaluates a script expression against the custom module of this report.

public object Eval(string pExpression, Context pContext = null)

Parameters

pExpression string

The script expression to evaluate.

pContext Context

The context.

Returns

object

The result of the evaluation.

GetCategory()

Returns the category.

public ReportCategory GetCategory()

Returns

ReportCategory

The catogory (or Nothing)

GetConnectionString(Context)

Returns the connection string to use for the query of this report.

public string GetConnectionString(Context pContext)

Parameters

pContext Context

The context.

Returns

string

The connection string.

GetDataConnector(Context)

Returns a data connector to use for the query of this report.

public DataConnector GetDataConnector(Context pContext)

Parameters

pContext Context

The context.

Returns

DataConnector

A data connector.

ReportAllowed(Context)

Returns a boolean indicating if this report is allowed for the given context.

public bool ReportAllowed(Context pContext)

Parameters

pContext Context

The context.

Returns

bool

True if allowed.

ReturnParameterPopupSelectItemData(Context, Control, int, string, string)

Used internally

public object ReturnParameterPopupSelectItemData(Context pContext, Control pControl, int pMaxRecordCount, string pFilter, string pParameterName)

Parameters

pContext Context
pControl Control
pMaxRecordCount int
pFilter string
pParameterName string

Returns

object

SynchronizeColumns(Context)

This method synchronizes the columns with the query as set for this report.

public string SynchronizeColumns(Context pContext)

Parameters

pContext Context

The context.

Returns

string

An error message if applicable.