+
+
+ Class Report
+
+ Represents a report object.
+
+
Inheritance
+
System.Object
+
+
Report
+
+
Implements
+
+
+
ISupportInitialize
+
+
Inherited Members
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Assembly: FastReport.OpenSource.dll
+ Syntax
+
+
public class Report : Base, IFRSerializable, IParent, ISupportInitialize
+
Examples
+ This example shows how to create a report instance, load it from a file,
+register the application data, run and preview.
+Report report = new Report();
+report.Load("reportfile.frx");
+report.RegisterData(application_dataset);
+report.Show();
+This example shows how to create simple report in code.
+
Report report = new Report();
+// create the report page
+ReportPage page = new ReportPage();
+page.Name = "ReportPage1";
+// set paper width and height. Note: these properties are measured in millimeters.
+page.PaperWidth = 210;
+page.PaperHeight = 297;
+// add a page to the report
+report.Pages.Add(page);
+// create report title
+page.ReportTitle = new ReportTitleBand();
+page.ReportTitle.Name = "ReportTitle1";
+page.ReportTitle.Height = Units.Millimeters * 10;
+// create Text object and put it to the title
+TextObject text = new TextObject();
+text.Name = "Text1";
+text.Bounds = new RectangleF(0, 0, Units.Millimeters * 100, Units.Millimeters * 5);
+page.ReportTitle.Objects.Add(text);
+// create data band
+DataBand data = new DataBand();
+data.Name = "Data1";
+data.Height = Units.Millimeters * 10;
+// add data band to a page
+page.Bands.Add(data);
+
+ Constructors
+
+
+
+
+ Report()
+ Initializes a new instance of the Report class with default settings.
+
Declaration
+
+ Properties
+
+
+
+
+ Aborted
+ Gets a value indicating that report execution was aborted.
+
Declaration
+
+
public bool Aborted { get; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Boolean |
+ |
+
+
+
+
+
+
+ AutoFillDataSet
+ Gets or sets a value indicating whether it is necessary to automatically fill
+DataSet registered with RegisterData call.
+
Declaration
+
+
public bool AutoFillDataSet { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Boolean |
+ |
+
+
+
+
+
+
+
+
+ BaseReport
+ Gets or sets the base report file name.
+
Declaration
+
+
public string BaseReport { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.String |
+ |
+
+
+
+
+
+
+
+
+ Compressed
+ Gets or sets a value that specifies whether to compress the report file.
+
Declaration
+
+
public bool Compressed { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Boolean |
+ |
+
+
+
+
+
+
+
+
+ ConvertNulls
+ Gets or sets a value indicating whether the null DB value must be converted to zero, false or
+empty string depending on the data column type.
+
Declaration
+
+
public bool ConvertNulls { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Boolean |
+ |
+
+
+
+
+
+
+
+
+ Dictionary
+ Gets the report's data.
+
Declaration
+
+
public Dictionary Dictionary { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | Dictionary |
+ |
+
+
+
+
+
+
+
+
+ DoublePass
+ Gets or sets a value that specifies whether the report engine should perform the second pass.
+
Declaration
+
+
public bool DoublePass { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Boolean |
+ |
+
+
+
+
+
+
+
+
+ Engine
+ Gets a reference to the report engine.
+
Declaration
+
+
public ReportEngine Engine { get; }
+
Property Value
+
+
+
+
+
+
+ FileName
+ Gets or sets the name of a file the report was loaded from.
+
Declaration
+
+
public string FileName { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.String |
+ |
+
+
+
+
+
+
+
+
+ FinishReportEvent
+ Gets or sets a script event name that will be fired when the report is finished.
+
Declaration
+
+
public string FinishReportEvent { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.String |
+ |
+
+
+
+
+
+
+ GraphicCache
+ Gets a reference to the graphics cache for this report.
+
Declaration
+
+
public GraphicCache GraphicCache { get; }
+
Property Value
+
+
+
+
+
+
+ HasDialogs
+ Gets a value indicating that this report contains dialog forms.
+
Declaration
+
+
public bool HasDialogs { get; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Boolean |
+ |
+
+
+
+
+
+
+ InitialPageNumber
+ Gets or sets the initial page number for PageN/PageNofM system variables.
+
Declaration
+
+
public int InitialPageNumber { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Int32 |
+ |
+
+
+
+
+
+
+ MaxPages
+ Gets or sets the maximum number of generated pages in a prepared report.
+
Declaration
+
+
public int MaxPages { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Int32 |
+ |
+
+
+
+
+
+
+
+
+ Name
+ This property is not relevant to this class.
+
Declaration
+
+
public string Name { get; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.String |
+ |
+
+
+
+
+
+
+ NeedRefresh
+ Gets or sets the flag for refresh.
+
Declaration
+
+
public bool NeedRefresh { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Boolean |
+ |
+
+
+
+
+
+
+ Operation
+ Gets the report operation that is currently performed.
+
Declaration
+
+
public ReportOperation Operation { get; }
+
Property Value
+
+
+
+
+ Pages
+ Gets the pages contained in this report.
+
Declaration
+
+
public PageCollection Pages { get; }
+
Property Value
+
+
+
+ Examples
+ The following code demonstrates how to access the first report page:
+ReportPage page1 = report1.Pages[0] as ReportPage;
+
+
+
+
+ Parameters
+ Gets the collection of report parameters.
+
Declaration
+
+
public ParameterCollection Parameters { get; }
+
Property Value
+
+
+
+
+
+
+ Password
+ Gets or sets the report password.
+
Declaration
+
+
public string Password { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.String |
+ |
+
+
+
+
+
+
+
+
+ PreparedPages
+ Gets a pages of the prepared report.
+
Declaration
+
+
public PreparedPages PreparedPages { get; }
+
Property Value
+
+
+
+
+ ReferencedAssemblies
+ Gets or sets an array of assembly names that will be used to compile the report script.
+
Declaration
+
+
public string[] ReferencedAssemblies { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.String[] |
+ |
+
+
+
+
+
+
+
+
+ ReportInfo
+ Gets or sets the report information such as report name, author, description etc.
+
Declaration
+
+
public ReportInfo ReportInfo { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | ReportInfo |
+ |
+
+
+
+
+
+
+ ReportResourceString
+ Gets or sets the resource string that contains the report.
+
Declaration
+
+
public string ReportResourceString { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.String |
+ |
+
+
+
+
+
+
+
+
+ Restrictions
+ This property is not relevant to this class.
+
Declaration
+
+
public Restrictions Restrictions { get; set; }
+
Property Value
+
+
+
+
+ ScriptLanguage
+ Gets or sets the script language of this report.
+
Declaration
+
+
public Language ScriptLanguage { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | Language |
+ |
+
+
+
+
+
+
+
+
+ ScriptRestrictions
+ Gets or sets a set of permissions that will be restricted for the script code.
+
Declaration
+
+
public PermissionSet ScriptRestrictions { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Security.PermissionSet |
+ |
+
+
+
+
+
+
+
+
+ ScriptText
+ Gets or sets the report script.
+
Declaration
+
+
public string ScriptText { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.String |
+ |
+
+
+
+
+
+
+
+
+ SmoothGraphics
+ Gets or sets a value that specifies if the graphic objects such as bitmaps
+and shapes should be displayed smoothly.
+
Declaration
+
+
public bool SmoothGraphics { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Boolean |
+ |
+
+
+
+
+
+
+ StartReportEvent
+ Gets or sets a script event name that will be fired when the report starts.
+
Declaration
+
+
public string StartReportEvent { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.String |
+ |
+
+
+
+
+
+
+ StoreInResources
+ Gets or sets a value that determines whether to store the report in the application resources.
+Use this property in the MS Visual Studio IDE only.
+
Declaration
+
+
public bool StoreInResources { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Boolean |
+ |
+
+
+
+
+
+
+
+
+ Styles
+ Gets or sets the collection of styles used in this report.
+
Declaration
+
+
public StyleCollection Styles { get; set; }
+
Property Value
+
+
+
+
+ TextQuality
+ Gets or sets a value that specifies the quality of text rendering.
+
Declaration
+
+
public TextQuality TextQuality { get; set; }
+
Property Value
+
+
+
+
+
+
+ UseFileCache
+ Gets or sets a value that specifies whether to use the file cache rather than memory
+to store the prepared report pages.
+
Declaration
+
+
public bool UseFileCache { get; set; }
+
Property Value
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Boolean |
+ |
+
+
+
+ Methods
+
+
+
+
+ Abort()
+ Aborts the report execution.
+
Declaration
+
+
+
+
+ AddChild(Base)
+
+
+ Declaration
+
+
public void AddChild(Base obj)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | Base |
+ obj |
+ |
+
+
+
+
+
+
+ ApplyStyles()
+ Updates the report component's styles.
+
Declaration
+
+
public void ApplyStyles()
+
Assign(Base)
+
+
+ Declaration
+
+
public override void Assign(Base source)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | Base |
+ source |
+ |
+
+
+
+ Overrides
+
+
+
+
+ BeginInit()
+
+
+ Declaration
+
+
public void BeginInit()
+
Calc(String)
+ Calculates an expression and returns the result.
+
Declaration
+
+
public object Calc(string expression)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ expression |
+ The expression to calculate.
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Object |
+ If report is running, returns the result of calculation.
+Otherwise returns null.
+ |
+
+
+
+
+
+
+
+
+ Calc(String, Variant)
+ Calculates an expression and returns the result.
+
Declaration
+
+
public object Calc(string expression, Variant value)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ expression |
+ The expression to calculate.
+ |
+
+
+ | Variant |
+ value |
+ The value of currently printing object.
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Object |
+ If report is running, returns the result of calculation.
+Otherwise returns null.
+ |
+
+
+
+
+
+
+
+
+ CalcExpression(String, Variant)
+ Returns an expression value.
+
Declaration
+
+
protected virtual object CalcExpression(string expression, Variant value)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ expression |
+ The expression.
+ |
+
+
+ | Variant |
+ value |
+ The value of currently printing object.
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Object |
+ Returns the result of calculation.
+ |
+
+
+
+
+
+
+
+
+ CanContain(Base)
+
+
+ Declaration
+
+
public bool CanContain(Base child)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | Base |
+ child |
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Boolean |
+ |
+
+
+
+
+
+
+ Clear()
+
+
+ Declaration
+
+
public override void Clear()
+
Overrides
+
+
+
+
+ Deserialize(FRReader)
+
+
+ Declaration
+
+
public override void Deserialize(FRReader reader)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | FRReader |
+ reader |
+ |
+
+
+
+ Overrides
+
+
+
+
+ DeserializeSubItems(FRReader)
+
+
+ Declaration
+
+
protected override void DeserializeSubItems(FRReader reader)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | FRReader |
+ reader |
+ |
+
+
+
+ Overrides
+
+
+
+
+ Dispose(Boolean)
+
+
+ Declaration
+
+
protected override void Dispose(bool disposing)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.Boolean |
+ disposing |
+ |
+
+
+
+ Overrides
+
+
+
+
+ EndInit()
+
+
+ Declaration
+
+
public void EndInit()
+
EnsureInit()
+ Ensure that static constructor is called.
+
Declaration
+
+
public static void EnsureInit()
+
Export(ExportBase, Stream)
+ Exports a report. Report should be prepared using the Prepare() method.
+
Declaration
+
+
public void Export(ExportBase export, Stream stream)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | ExportBase |
+ export |
+ The export filter.
+ |
+
+
+ | System.IO.Stream |
+ stream |
+ Stream to save export result to.
+ |
+
+
+
+
+
+
+ Export(ExportBase, String)
+ Exports a report. Report should be prepared using the Prepare() method.
+
Declaration
+
+
public void Export(ExportBase export, string fileName)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | ExportBase |
+ export |
+ The export filter.
+ |
+
+
+ | System.String |
+ fileName |
+ File name to save export result to.
+ |
+
+
+
+
+
+
+ FindObject(String)
+
+
+ Declaration
+
+
public override Base FindObject(string name)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ name |
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | Base |
+ |
+
+
+
+ Overrides
+
+
+
+
+ FromFile(String)
+ Creates the report instance and loads the report from a file.
+
Declaration
+
+
public static Report FromFile(string fileName)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ fileName |
+ The name of the file to load from.
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | Report |
+ The new report instance.
+ |
+
+
+
+
+
+
+ FromStream(Stream)
+ Creates the report instance and loads the report from a stream.
+
Declaration
+
+
public static Report FromStream(Stream stream)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.IO.Stream |
+ stream |
+ The stream to load from.
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | Report |
+ The new report instance.
+ |
+
+
+
+
+
+
+ FromString(String)
+ Creates the report instance and loads the report from a string.
+
Declaration
+
+
public static Report FromString(string utf8String)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ utf8String |
+ The string that contains a stream in UTF8 encoding.
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | Report |
+ The new report instance.
+ |
+
+
+
+
+
+
+ GenerateReportAssembly(String)
+ Generates the file (.cs or .vb) that contains the report source code.
+
Declaration
+
+
public void GenerateReportAssembly(string fileName)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ fileName |
+ Name of the file.
+ |
+
+
+
+
+
+
+
+
+ GetChildObjects(ObjectCollection)
+
+
+ Declaration
+
+
public void GetChildObjects(ObjectCollection list)
+
Parameters
+
+
+
+
+ GetChildOrder(Base)
+
+
+ Declaration
+
+
public virtual int GetChildOrder(Base child)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | Base |
+ child |
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Int32 |
+ |
+
+
+
+
+
+
+ GetColumnValue(String)
+ Gets the data column's value. Automatically converts null value to 0, false or ""
+depending on the column type.
+
Declaration
+
+
public object GetColumnValue(string complexName)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ complexName |
+ The name of the data column including the datasource name.
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Object |
+ If report is running, returns the column value. Otherwise returns null.
+ |
+
+
+
+ Remarks
+
+ Examples
+ string employeeName = (string)report.GetColumnValue("Employees.FirstName");
+
+
+
+
+ GetColumnValueNullable(String)
+ Gets the data column's value. This method does not convert null values.
+
Declaration
+
+
public object GetColumnValueNullable(string complexName)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ complexName |
+ The name of the data column including the datasource name.
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Object |
+ If report is running, returns the column value.
+Otherwise returns null.
+ |
+
+
+
+
+
+
+ GetDataSource(String)
+ Gets the datasource with specified name.
+
Declaration
+
+
public DataSourceBase GetDataSource(string alias)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ alias |
+ Alias name of a datasource.
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | DataSourceBase |
+ The datasource object if found, otherwise null.
+ |
+
+
+
+
+
+
+ GetParameter(String)
+ Gets the report parameter with given name.
+
Declaration
+
+
public Parameter GetParameter(string complexName)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ complexName |
+ The name of the parameter.
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | Parameter |
+ The Parameter object if found, otherwise null.
+ |
+
+
+
+
+
+
+
+
+ GetParameterValue(String)
+ Gets a value of the parameter with given name.
+
Declaration
+
+
public object GetParameterValue(string complexName)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ complexName |
+ The name of the parameter.
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Object |
+ The parameter's value if found, otherwise null.
+ |
+
+
+
+
+
+
+
+
+ GetTotalValue(String)
+ Gets a value of the total with specified name.
+
Declaration
+
+
public Variant GetTotalValue(string name)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ name |
+ Name of total.
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | Variant |
+ The total's value if found, otherwise 0.
+ |
+
+
+
+
+
+
+
+
+ GetTotalValueNullable(String)
+ Gets a value of the total with specified name.
+
Declaration
+
+
public Variant GetTotalValueNullable(string name)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ name |
+ Name of total.
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | Variant |
+ The total's value if found, otherwise null.
+ |
+
+
+
+
+
+
+ GetVariableValue(String)
+ Gets a value of the system variable with specified name.
+
Declaration
+
+
public object GetVariableValue(string complexName)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ complexName |
+ Name of a variable.
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Object |
+ The variable's value if found, otherwise null.
+ |
+
+
+
+
+
+
+ InteractiveRefresh()
+ Refresh prepared report after intercative actions.
+
Declaration
+
+
public void InteractiveRefresh()
+
InternalInit()
+ Initializes the report's fields.
+
Declaration
+
+
protected void InternalInit()
+
InvokeEvent(String, Object[])
+ Invokes the script event handler with given name.
+
Declaration
+
+
public void InvokeEvent(string name, object[] parms)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ name |
+ The name of the script method.
+ |
+
+
+ | System.Object[] |
+ parms |
+ The method parameters.
+ |
+
+
+
+
+
+
+ Load(Stream)
+ Loads report from a stream.
+
Declaration
+
+
public void Load(Stream stream)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.IO.Stream |
+ stream |
+ The stream to load from.
+ |
+
+
+
+
+
+
+
+
+ Load(String)
+ Loads the report from a file.
+
Declaration
+
+
public void Load(string fileName)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ fileName |
+ The name of the file to load from.
+ |
+
+
+
+
+
+
+
+
+ LoadFromString(String)
+ Loads the report from a string.
+
Declaration
+
+
public void LoadFromString(string s)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ s |
+ The string that contains a stream in UTF8 or Base64 encoding.
+ |
+
+
+
+
+
+
+ LoadPrepared(Stream)
+ Loads the prepared report from a .fpx file.
+
Declaration
+
+
public void LoadPrepared(Stream stream)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.IO.Stream |
+ stream |
+ Stream to load from.
+ |
+
+
+
+
+
+
+ LoadPrepared(String)
+ Loads the prepared report from a .fpx file.
+
Declaration
+
+
public void LoadPrepared(string fileName)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ fileName |
+ File name to load form.
+ |
+
+
+
+
+
+
+ OnFinishReport(EventArgs)
+ This method fires the FinishReport event and the script code connected
+to the FinishReportEvent.
+
Declaration
+
+
public void OnFinishReport(EventArgs e)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.EventArgs |
+ e |
+ |
+
+
+
+
+
+
+ OnStartReport(EventArgs)
+ This method fires the StartReport event and the script code connected
+to the StartReportEvent.
+
Declaration
+
+
public void OnStartReport(EventArgs e)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.EventArgs |
+ e |
+ |
+
+
+
+
+
+
+ PostNameProcess(String, Int32)
+ Create name for all unnamed elements with prefix and start with number
+
Declaration
+
+
public void PostNameProcess(string prefix, int number)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ prefix |
+ Prefix for name
+ |
+
+
+ | System.Int32 |
+ number |
+ Number from which to start
+ |
+
+
+
+
+
+
+ Prepare()
+
+
+ Declaration
+
+
public bool Prepare()
+
Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Boolean |
+ true if report was prepared succesfully.
+ |
+
+
+
+
+
+
+ Prepare(Boolean)
+
+
+ Declaration
+
+
public bool Prepare(bool append)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.Boolean |
+ append |
+ Specifies whether the new report should be added to a
+report that was prepared before.
+ |
+
+
+
+ Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.Boolean |
+ true if report was prepared succesfully.
+ |
+
+
+
+
+
+ Examples
+ This example shows how to merge two reports and preview the result:
+Report report = new Report();
+report.Load("report1.frx");
+report.Prepare();
+report.Load("report2.frx");
+report.Prepare(true);
+report.ShowPrepared();
+
+
+
+
+ PreparePage(ReportPage)
+
+
+ Declaration
+
+
public void PreparePage(ReportPage page)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | ReportPage |
+ page |
+ |
+
+
+
+
+
+
+ PreparePhase1()
+
+
+ Declaration
+
+
public void PreparePhase1()
+
PreparePhase2()
+
+
+ Declaration
+
+
public void PreparePhase2()
+
Refresh()
+ Refresh the current report.
+
Declaration
+
+
public void Refresh()
+
RegisterData(DataRelation, String)
+ Registers the application data relation to use it in the report.
+
Declaration
+
+
public void RegisterData(DataRelation data, string name)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | DataRelation |
+ data |
+ The application data.
+ |
+
+
+ | System.String |
+ name |
+ The name of the data.
+ |
+
+
+
+
+
+ Examples
+ report1.Load("report.frx");
+report1.RegisterData(myDataRelation, "myRelation");
+
+
+
+
+ RegisterData(DataSet)
+ Registers the application dataset with all its tables and relations to use it in the report.
+
Declaration
+
+
public void RegisterData(DataSet data)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | DataSet |
+ data |
+ The application data.
+ |
+
+
+
+
+
+ Examples
+ report1.Load("report.frx");
+report1.RegisterData(dataSet1);
+
+
+
+
+ RegisterData(DataSet, Boolean)
+ Registers the application dataset with all its tables and relations to use it in the report and enables all its tables.
+
Declaration
+
+
public void RegisterData(DataSet data, bool enableAllTables)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | DataSet |
+ data |
+ The application data.
+ |
+
+
+ | System.Boolean |
+ enableAllTables |
+ The boolean value indicating whether all tables should be enabled.
+ |
+
+
+
+
+
+ Examples
+ report1.Load("report.frx");
+report1.RegisterData(dataSet1, true);
+
+
+
+
+ RegisterData(DataSet, String)
+ Registers the application dataset with specified name.
+
Declaration
+
+
public void RegisterData(DataSet data, string name)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | DataSet |
+ data |
+ The application data.
+ |
+
+
+ | System.String |
+ name |
+ The name of the data.
+ |
+
+
+
+
+
+ Examples
+ report1.Load("report.frx");
+report1.RegisterData(dataSet1, "NorthWind");
+
+
+
+
+ RegisterData(DataSet, String, Boolean)
+ Registers the application dataset with specified name and enables all its tables.
+
Declaration
+
+
public void RegisterData(DataSet data, string name, bool enableAllTables)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | DataSet |
+ data |
+ The application data.
+ |
+
+
+ | System.String |
+ name |
+ The name of the data.
+ |
+
+
+ | System.Boolean |
+ enableAllTables |
+ The boolean value indicating whether all tables should be enabled.
+ |
+
+
+
+
+
+ Examples
+ report1.Load("report.frx");
+report1.RegisterData(dataSet1, "NorthWind", true);
+
+
+
+
+ RegisterData(DataTable, String)
+ Registers the application data table to use it in the report.
+
Declaration
+
+
public void RegisterData(DataTable data, string name)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | DataTable |
+ data |
+ The application data.
+ |
+
+
+ | System.String |
+ name |
+ The name of the data.
+ |
+
+
+
+ Examples
+ report1.Load("report.frx");
+report1.RegisterData(dataSet1.Tables["Orders"], "Orders");
+
+
+
+
+ RegisterData(DataView, String)
+ Registers the application data view to use it in the report.
+
Declaration
+
+
public void RegisterData(DataView data, string name)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | DataView |
+ data |
+ The application data.
+ |
+
+
+ | System.String |
+ name |
+ The name of the data.
+ |
+
+
+
+ Examples
+ report1.Load("report.frx");
+report1.RegisterData(myDataView, "OrdersView");
+
+
+
+
+ RegisterData(IBaseCubeLink, String)
+ Registers the application cube link to use it in the report.
+
Declaration
+
+
public void RegisterData(IBaseCubeLink data, string name)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | IBaseCubeLink |
+ data |
+ The application data.
+ |
+
+
+ | System.String |
+ name |
+ The name of the data.
+ |
+
+
+
+ Examples
+ report1.Load("report.frx");
+report1.RegisterData(myCubeLink, "Orders");
+
+
+
+
+ RegisterData(IEnumerable, String)
+ Registers the application business object to use it in the report.
+
Declaration
+
+
public void RegisterData(IEnumerable data, string name)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.Collections.IEnumerable |
+ data |
+ Application data.
+ |
+
+
+ | System.String |
+ name |
+ Name of the data.
+ |
+
+
+
+ Examples
+ report1.Load("report.frx");
+report1.RegisterData(myBusinessObject, "Customers");
+
+
+
+
+ RegisterData(IEnumerable, String, BOConverterFlags, Int32)
+ Obsolete. Registers the application business object to use it in the report.
+
Declaration
+
+
public void RegisterData(IEnumerable data, string name, BOConverterFlags flags, int maxNestingLevel)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.Collections.IEnumerable |
+ data |
+ Application data.
+ |
+
+
+ | System.String |
+ name |
+ Name of the data.
+ |
+
+
+ | BOConverterFlags |
+ flags |
+ Not used.
+ |
+
+
+ | System.Int32 |
+ maxNestingLevel |
+ Maximum nesting level of business objects.
+ |
+
+
+
+
+
+
+
+
+ RegisterData(IEnumerable, String, Int32)
+ Registers the application business object to use it in the report.
+
Declaration
+
+
public void RegisterData(IEnumerable data, string name, int maxNestingLevel)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.Collections.IEnumerable |
+ data |
+ Application data.
+ |
+
+
+ | System.String |
+ name |
+ Name of the data.
+ |
+
+
+ | System.Int32 |
+ maxNestingLevel |
+ Maximum nesting level of business objects.
+ |
+
+
+
+
+
+
+
+
+ RemoveChild(Base)
+
+
+ Declaration
+
+
public void RemoveChild(Base obj)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | Base |
+ obj |
+ |
+
+
+
+
+
+
+ Save(Stream)
+ Saves the report to a stream.
+
Declaration
+
+
public void Save(Stream stream)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.IO.Stream |
+ stream |
+ The stream to save to.
+ |
+
+
+
+
+
+
+ Save(String)
+ Saves the report to a file.
+
Declaration
+
+
public void Save(string fileName)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ fileName |
+ The name of the file to save to.
+ |
+
+
+
+
+
+
+ SavePrepared(Stream)
+ Saves the prepared report. Report should be prepared using the Prepare() method.
+
Declaration
+
+
public void SavePrepared(Stream stream)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.IO.Stream |
+ stream |
+ Stream to save to.
+ |
+
+
+
+
+
+
+ SavePrepared(String)
+ Saves the prepared report. Report should be prepared using the Prepare() method.
+
Declaration
+
+
public void SavePrepared(string fileName)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ fileName |
+ File name to save to.
+ |
+
+
+
+
+
+
+ SaveToString()
+ Saves the report to a string.
+
Declaration
+
+
public string SaveToString()
+
Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.String |
+ The string that contains a stream.
+ |
+
+
+
+
+
+
+ SaveToStringBase64()
+ Saves the report to a string using the Base64 encoding.
+
Declaration
+
+
public string SaveToStringBase64()
+
Returns
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.String |
+ The string that contains a stream.
+ |
+
+
+
+
+
+
+ Serialize(FRWriter)
+
+
+ Declaration
+
+
public override void Serialize(FRWriter writer)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | FRWriter |
+ writer |
+ |
+
+
+
+ Overrides
+
+
+
+
+ SetChildOrder(Base, Int32)
+
+
+ Declaration
+
+
public virtual void SetChildOrder(Base child, int order)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | Base |
+ child |
+ |
+
+
+ | System.Int32 |
+ order |
+ |
+
+
+
+
+
+
+ SetParameterValue(String, Object)
+ Sets the parameter's value.
+
Declaration
+
+
public void SetParameterValue(string complexName, object value)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.String |
+ complexName |
+ The name of the parameter.
+ |
+
+
+ | System.Object |
+ value |
+ Value to set.
+ |
+
+
+
+
+
+ Examples
+ This example shows how to pass a value to the parameter with "MyParam" name:
+// load the report
+report1.Load("report.frx");
+// setup the parameter
+report1.SetParameterValue("MyParam", 10);
+// show the report
+report1.Show();
+
+
+
+
+ SetPreparedPages(PreparedPages)
+
+
+ Declaration
+
+
public void SetPreparedPages(PreparedPages pages)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | PreparedPages |
+ pages |
+ |
+
+
+
+
+
+
+ UpdateLayout(Single, Single)
+
+
+ Declaration
+
+
public virtual void UpdateLayout(float dx, float dy)
+
Parameters
+
+
+
+ | Type |
+ Name |
+ Description |
+
+
+
+
+ | System.Single |
+ dx |
+ |
+
+
+ | System.Single |
+ dy |
+ |
+
+
+
+ Events
+
+
+
+ CustomCalc
+ Occurs when calc execution is started.
+
Declaration
+
+
public event CustomCalcEventHandler CustomCalc
+
Event Type
+
+
+
+ FinishReport
+ Occurs when report execution is finished.
+
Declaration
+
+
public event EventHandler FinishReport
+
Event Type
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.EventHandler |
+ |
+
+
+
+
+
+ LoadBaseReport
+ Occurs when report is inherited and trying to load a base report.
+
Declaration
+
+
public event CustomLoadEventHandler LoadBaseReport
+
Event Type
+
+
+
+
+
+ StartReport
+ Occurs when report execution is started.
+
Declaration
+
+
public event EventHandler StartReport
+
Event Type
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ | System.EventHandler |
+ |
+
+
+
+ Implements
+
+
+
+ ISupportInitialize
+
+