0% found this document useful (0 votes)

3K views

Stimulsoft Reports Programming Manual - en

Stimulsoft_Reports_Programming_Manual.En

Uploaded by

omarlicina

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

3K views

Stimulsoft Reports Programming Manual - en

Stimulsoft_Reports_Programming_Manual.En

Uploaded by

omarlicina

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 234

Table of Contents
Part I Introduction

1 Technical
...................................................................................................................................
Support
2
2 Trial License
...................................................................................................................................
Limitations
3
3 Information
...................................................................................................................................
in Web and References
3

Part II Data

1 Business
...................................................................................................................................
Objects in Net, Web, Silverlight
4
2 Business
...................................................................................................................................
Objects in WinRT
12

Part III Using WinForms Viewer

1 How to
...................................................................................................................................
Show Report?
15
2 Dot-Matrix
...................................................................................................................................
Viewer for WinForms
15
..........................................................................................................................................................
16
Setting Dot-Matrix
View er in WinForms
..........................................................................................................................................................
17
Dot-Matrix and
Escape Codes

Part IV Using WPF Viewer

1 How to
...................................................................................................................................
Show Report?
18
2 Dot-Matrix
...................................................................................................................................
Viewer for WPF
19
..........................................................................................................................................................
20
Dot-Matrix View
er Settings for WPF
21
DotMatrix and..........................................................................................................................................................
Escape Codes

Part V Using Web Designer

1 How It...................................................................................................................................
Works?
23
2 How to
...................................................................................................................................
Run Web Reports Designer?
23
3 Loading
...................................................................................................................................
Reports to Web Designer
24
4 Report
...................................................................................................................................
Preview
26
5 Changing
...................................................................................................................................
Report Settings Before Rendering
27
6 Saving
...................................................................................................................................
Reports
27
7 Web Designer
...................................................................................................................................
Settings
29
Connection .......................................................................................................................................................... 29
Main Menu .......................................................................................................................................................... 30
..........................................................................................................................................................
31
Zooming Static
Properties
..........................................................................................................................................................
32
View er Static Properties
..........................................................................................................................................................
34
Additional View er Static Properties

8 Web Designer
...................................................................................................................................
Properties
35
9 Changing
...................................................................................................................................
Web Designer Properties From Code
36
10 Web Reports
...................................................................................................................................
Designer Localization
37
11 Visible
...................................................................................................................................
Mode
37

Part VI Using Web Viewer

2003-2013 Stimulsoft

Stimulsoft Reports
1 Caching
................................................................................................................................... 38
38
RenderMode ..........................................................................................................................................................
Property
..........................................................................................................................................................
39
CacheMode Property
..........................................................................................................................................................
39
ServerTimeout Property

2 Printing
...................................................................................................................................
Reports
39
3 StiReportResponse
...................................................................................................................................
Class
40
4 Using...................................................................................................................................
Dialogs in Report
40
5 Images
...................................................................................................................................
of StiWebViewer Toolbar
41
6 Localization
...................................................................................................................................
of StiWebViewer Component
41

Part VII Using MVC Designer

1 How It...................................................................................................................................
Works?
41
2 How to
...................................................................................................................................
Run Designer?
42
3 How to
...................................................................................................................................
Load Reports in Web-Designer?
43
4 Previewing
...................................................................................................................................
Reports
43
5 Exporting
...................................................................................................................................
Reports From Preview
46
6 Showing
...................................................................................................................................
C#/VB.NET Report Code
48
7 Changing
...................................................................................................................................
Report Parameters Before Rendering
48
8 Saving
...................................................................................................................................
Reports
49
9 Localizing
...................................................................................................................................
Web Designer
51
10 Other...................................................................................................................................
Actions of Web Designer
52
11 Web Designer
...................................................................................................................................
Settings
54
.......................................................................................................................................................... 54
Actions
Connection .......................................................................................................................................................... 55
.......................................................................................................................................................... 55
Dialog Box About
.......................................................................................................................................................... 56
Dictionary
Main Menu .......................................................................................................................................................... 57
.......................................................................................................................................................... 59
Toolbars
.......................................................................................................................................................... 60
Zooming
.......................................................................................................................................................... 60
Interface
.......................................................................................................................................................... 60
Miscellaneous
.......................................................................................................................................................... 61
View er
Exporting ......................................................................................................................................................... 61
Printing ......................................................................................................................................................... 64
Toolbars ......................................................................................................................................................... 64
Buttons ......................................................................................................................................................... 64

Part VIII Using MVC Viewer

1 How It...................................................................................................................................
Works?
66
2 Showing
...................................................................................................................................
Reports
66
3 Localizing
...................................................................................................................................
Component
68
4 Using...................................................................................................................................
Themes
69
5 Using...................................................................................................................................
Basic Features
72
6 Printing
................................................................................................................................... 73
2003-2013 Stimulsoft

Contents

III

7 Viewing
...................................................................................................................................
Modes
74
8 Using...................................................................................................................................
Parameters
75
9 Viewer
...................................................................................................................................
Settings
75
.......................................................................................................................................................... 75
Actions
Connection .......................................................................................................................................................... 76
.......................................................................................................................................................... 77
Toolbar
.......................................................................................................................................................... 77
Buttons
.......................................................................................................................................................... 78
Exporting Reports
.......................................................................................................................................................... 80
Interface

Part IX Using MVC ViewerFx

1 How It...................................................................................................................................
Works?
82
2 How to
...................................................................................................................................
Show Report?
82
3 Localizing
...................................................................................................................................
Component
83
4 Using...................................................................................................................................
Themes
84
5 Viewer
...................................................................................................................................
Settings
86
.......................................................................................................................................................... 86
Actions
Connection .......................................................................................................................................................... 87
.......................................................................................................................................................... 87
Dialog Box About
.......................................................................................................................................................... 88
Toolbars
.......................................................................................................................................................... 88
Buttons
.......................................................................................................................................................... 90
Zooming
.......................................................................................................................................................... 90
Exporting
.......................................................................................................................................................... 93
Printing
.......................................................................................................................................................... 93
Interface

Part X Using Web ViewerFx

1 How to
...................................................................................................................................
Show Report?
94
2 Localization
...................................................................................................................................
of StiWebViewerFx Component
95
3 WebViewerFx
...................................................................................................................................
Settings
95
Connection .......................................................................................................................................................... 95
.......................................................................................................................................................... 96
Zooming
96
View er Static..........................................................................................................................................................
Properties

4 Properties
................................................................................................................................... 98
5 Export
...................................................................................................................................
Settings
101
6 Data................................................................................................................................... 103

Part XI Using Flex Viewer

104

1 How ...................................................................................................................................
to Show Report?
104
2 Dialog
...................................................................................................................................
Options
105
3 User...................................................................................................................................
Interface Settings
105

Part XII Using Web Designer in Silverlight

106

1 How ...................................................................................................................................
It Works?
107
2 How ...................................................................................................................................
to Run Web Reports Designer?
107
2003-2013 Stimulsoft

III

Stimulsoft Reports
3 Loading
...................................................................................................................................
Reports to Web Designer
107
4 Report
...................................................................................................................................
Preview
109
5 Web...................................................................................................................................
Designer Settings
109
Main Menu .......................................................................................................................................................... 109
Zooming .......................................................................................................................................................... 110
.......................................................................................................................................................... 111
View er

6 Changing
...................................................................................................................................
Web Designer Properties from Code
114
7 Web...................................................................................................................................
Reports Designer Localization
115
8 WCF...................................................................................................................................
Server
115

Part XIII Using Silverlight Web Viewer

116

1 How ...................................................................................................................................
to Show Report?
116
2 WebViewerSL
...................................................................................................................................
Settings
117
.......................................................................................................................................................... 117
Control Panel
.......................................................................................................................................................... 119
Navigation Panel
Zooming .......................................................................................................................................................... 119

3 Saving
...................................................................................................................................
Mode
120
.......................................................................................................................................................... 121
Export Settings

Part XIV Using HTML5 Designer

123

1 Designer
...................................................................................................................................
Properties
123
2 Working
...................................................................................................................................
With Report Code
124

Part XV Using HTML5 Viewer

125

1 Showing
...................................................................................................................................
Reports
126
2 Caching
................................................................................................................................... 126
126
RenderMode..........................................................................................................................................................
Property
..........................................................................................................................................................
127
CacheMode Property
..........................................................................................................................................................
127
ServerTimeout Property

3 StiReportResponse
...................................................................................................................................
Class
127
4 Localization
...................................................................................................................................
of StiMobileViewer Component
128
5 Settings
................................................................................................................................... 128
Zooming
Toolbar

6 Properties
................................................................................................................................... 129
7 Setting
...................................................................................................................................
Export
130
8 Defining
...................................................................................................................................
Data
132

Part XVI Using Java Viewer

133

1 Showing
...................................................................................................................................
Reports
133
2 Custom
...................................................................................................................................
Functions
133

Part XVII Using Java Viewer in Web

135

1 Installation
................................................................................................................................... 135
2003-2013 Stimulsoft

Contents

2 Creating
...................................................................................................................................
Project
136
3 Creating
...................................................................................................................................
Server
137
4 Creating
...................................................................................................................................
Sample
139
5 Creating
...................................................................................................................................
Sample Page with Report Designer
142
6 Loading,
...................................................................................................................................
Saving and Loading Custom Data
147

Part XVIII Using Java Designer

156

1 Working
...................................................................................................................................
with Report Code
156
2 Template
...................................................................................................................................
JDBC Coonections
159

Part XIX Using WinRT Viewer

160

1 How ...................................................................................................................................
to Show Report?
160
2 Saving
...................................................................................................................................
Report From Code
162

Part XX Exports

163

1 Available
...................................................................................................................................
File Formats
163
2 Export
...................................................................................................................................
Reports From Code
164
..........................................................................................................................................................
165
ExportDocument
Method
.......................................................................................................................................................... 165
Export Formats
.......................................................................................................................................................... 167
Export Service
.......................................................................................................................................................... 168
All Export Services

3 Formats
...................................................................................................................................
with Fixed Page Layout
169
PDF

.......................................................................................................................................................... 169

.........................................................................................................................................................
169
Embedded
Fonts
.........................................................................................................................................................
169
Digital Signature
.........................................................................................................................................
170
Digital Signature from Code
.........................................................................................................................................................
170
Encryption
.........................................................................................................................................
171
Using Parameters
of Encryption from Code
.........................................................................................................................................................
171
Editable Fields
......................................................................................................................................................... 172
Export Settings
......................................................................................................................................................... 173
Static Options
..........................................................................................................................................................
174
XPS
......................................................................................................................................................... 175
Export Settings
......................................................................................................................................................... 175
Static Options
..........................................................................................................................................................
175
Microsoft Pow er Point 2007/2010
.........................................................................................................................................................
176
Export Settings
......................................................................................................................................................... 176
Static Options

4 Web...................................................................................................................................
Documents
176
.......................................................................................................................................................... 176
HTML
......................................................................................................................................................... 177
Export Settings
......................................................................................................................................................... 177
Static Options
..........................................................................................................................................................
178
MHT
.........................................................................................................................................................
178
Export Settings

5 Text...................................................................................................................................
Formats
179
TXT

.......................................................................................................................................................... 179

Stimulsoft Reports
......................................................................................................................................................... 180
Export Settings
......................................................................................................................................................... 181
Static Options
.......................................................................................................................................................... 182
Word 2007/2010
......................................................................................................................................................... 182
Export Settings
......................................................................................................................................................... 182
Static Options
.......................................................................................................................................................... 183
ODT
......................................................................................................................................................... 183
Export Settings
......................................................................................................................................................... 184
Static Options

6 Spreadsheets
................................................................................................................................... 184
.......................................................................................................................................................... 184
Excel
......................................................................................................................................................... 185
Export Settings
......................................................................................................................................................... 185
Static Options
..........................................................................................................................................................
186
Excel 2007/2010
.........................................................................................................................................................
186
Export Settings
......................................................................................................................................................... 186
Static Options
..........................................................................................................................................................
187
ODS
.........................................................................................................................................................
187
Export Settings
......................................................................................................................................................... 188
Static Options

7 Data................................................................................................................................... 188
.......................................................................................................................................................... 188

CSV

Export Settings
......................................................................................................................................................... 188
Static Options
......................................................................................................................................................... 189
.......................................................................................................................................................... 189
DBF
Controlling
.........................................................................................................................................................
Exports
189
Export Settings
......................................................................................................................................................... 190
.......................................................................................................................................................... 191
XML
DIF

Controlling
.........................................................................................................................................................
Exports
191
.......................................................................................................................................................... 192

Part XXI Report Inheritance

193

1 Basic
...................................................................................................................................
Approaches
193

Part XXII Scripts

194

1 Programming
...................................................................................................................................
Language of Report
194
2 Report
...................................................................................................................................
Code
195

Part XXIII Right To Left

197

1 WinForms
...................................................................................................................................
Report Viewer
197
2 Icons
................................................................................................................................... 197
3 WPF...................................................................................................................................
Reports Designer and Viewer
202

Part XXIV Deployment

204

1 Assemblies
...................................................................................................................................
in Reports.Net
204
2 Assemblies
...................................................................................................................................
in Reports.Wpf
205
3 Assemblies
...................................................................................................................................
in Reports.Web
207

2003-2013 Stimulsoft

Contents

VII

4 Assemblies
...................................................................................................................................
in Reports Designer.Web
209
5 Assemblies
...................................................................................................................................
in Reports.Silverlight
209
6 Assemblies
...................................................................................................................................
in Reports Designer.Silverlight
211
7 Assemblies
...................................................................................................................................
in Reports.Ultimate
211
8 Assemblies
...................................................................................................................................
in Reports.Fx for Flex
215
9 Assemblies
...................................................................................................................................
in Reports.Fx for PHP
215
10 Assemblies
...................................................................................................................................
in Reports.Fx for Java
216
11 Working
...................................................................................................................................
With Assemblies
216
12 Redistributable
...................................................................................................................................
files in Reports.Net
218
13 Redistributable
...................................................................................................................................
files in Reports.Wpf
218
14 Redistributable
...................................................................................................................................
files in Reports.Web
219
15 Redistributable
...................................................................................................................................
files in Report Designer.Web
219
16 Redistributable
...................................................................................................................................
files in Reports.Silverlight
219
17 Redistributable
...................................................................................................................................
files in Reports Designer.Silverlight
219
18 Redistributable
...................................................................................................................................
files in Reports.Ultimate
220
19 Redistributable
...................................................................................................................................
files in Reports.Fx for Flex
220
20 Redistributable
...................................................................................................................................
files in Reports.Fx for PHP
221
21 Redistributable
...................................................................................................................................
files in Reports.Fx for Java
221
22 Deployment
...................................................................................................................................
in Windows
221
23 Deployment
...................................................................................................................................
in Web
221
24 Deployment
...................................................................................................................................
in Designer.Web
221
25 Deployment
...................................................................................................................................
in Wpf
222
26 Deployment
...................................................................................................................................
in Silverlight
222
27 Deployment
...................................................................................................................................
in Designer.Silverlight
222
28 Deployment
...................................................................................................................................
in PHP
222
29 Deployment
...................................................................................................................................
in Flex
222
30 Deployment
...................................................................................................................................
Reports as Files
222
31 Reports
...................................................................................................................................
as Source Code
223
32 Reports
...................................................................................................................................
as Assemblies
225
33 Standalone
...................................................................................................................................
Reports
226

Index

2003-2013 Stimulsoft

VII

Stimulsoft Reports

Introduction
We are glad to welcome you to the online version of the documentation of Stimulsoft Reports
products. The documentation describes the basics of using the API of our software. Here we will review
how to pass data from code in a report, export reports to various file formats, inherit reports, work
with the components and more:

Welcome to Stimulsoft:

Using Mobile Components:

Technical Support
Trial License Limitations
Information in Web and
References
Evaluate Trial Version

Using HTML5 Designer

Designer Properties
Using Mobile Viewer
Settings

Data:
Business Object in Net, Web,
Silverlight
Business Object in WinRT

Showing Reports in
WinForms:
How to Show Report
Dot-Matrix viewer

Using Flex Components:

Using MVC ViewerFx
Using Web ViewerFx
Using_Flex_Viewer

Showing Reports in WPF:

How to Show Report?

Reports in Web:
How to Run Web Reports
Designer?
Using Web Viewer

Using MVC Components:

Using MVC Designer
Using Mvc Viewer

Reports in Java:
Showing Reports in Java
Using Java in Web

Showing Reports in WinRT:

How to Show Report?
Saving Report From Code

Exports:
Available File Formats
Spreadsheets
More...

Report Inheritance:
Basic Approaches

Scripts:
Programming Language of Report
Report Code

Right to Left Mode:

WinForms Report Viewer
Icons

2003-2013 Stimulsoft

Introduction

WPF Reports Designer and Viewer

Reports in Silverlight:
Using Web Designer in
Silverlight
Using Silverlight Web Viewer

Deployment:
Working With Assemblies
More...

The first part of the documentation contains the description of work with visual parts of Stimulsoft
products.

1.1

Technical Support
Registered users and users who are evaluating the software may get technical support.
For technical questions, use the Email address: [email protected]
For licensing, subscription, payment questions, use Email address: [email protected]
For other questions, use Email address: [email protected]
If you have problems with our products, you may contact us through our feedback form at http://www.
stimulsoft.com/support.aspx
It is possible to send questions from the standard UI of the report designer. To do this, select the Help
menu -> Support.

If you are a registered user and you contact us for technical support, use the same Email address you
used when you purchased our product. Otherwise, it will be difficult to identify you as a registered user.
This can slow down our response. Please let us know when your Email address changes.
To solve your problem quickly, we need the following information:
- Product name and its version;
- A detailed description of the problem and how to reproduce it;
- Your operating system (98, ME, 2000, XP, Vista, Window 7 etc.), its version, and the localization of
established service packs;
- Version of Microsoft .NET Framework or other development environment and installed service packs;
- A name of your development environment and its version;
- Additional information that can help us solve the problem.

2003-2013 Stimulsoft

1.2

Stimulsoft Reports

Trial License Limitations

Trial Versions
The free trial versions of Stimulsoft Reports are fully functional and will work for an unlimited time.
The only limitation is a DEMO watermark displayed on each report page.
Registered Versions
Developer licenses come with DLL's, which work without license keys. If you have a License for
Stimulsoft products, you only need to ensure that you are using the Registered build. If your reports
are displaying a DEMO watermark, this means that you are using a trial version of the product. Log in
to your account at http://stimulsoft.com/RegisteredUsers.aspx and download the Registered version of
the product. Also, please read the following topics:
1. How to upgrade to a new version?
2. How to upgrade to the prerelease build?
3. I have installed new version but nothing changed. What can I do?
4. How to install registered non Demo version of Stimulsoft Reports?

1.3

Information in Web and References

This topic describes how to get the information about the latest news and announcements about the
software products, as well as information about known problems and issues that users are interested.
The official site of our company can be found at http://www.stimulsoft.com The website has a brief
information of the software products http://www.stimulsoft.com/Products.aspx they can be downloaded
at http://www.stimulsoft.com/Downloads.aspx where you can download a trial version of the software,
as well as weekly minor prerelease builds and various database adapters.
Live demos for testing the products online can be found at:
Stimulsoft Reports.Net http://web.stimulsoft.com
Stimulsoft Reports.Web http://webfx.stimulsoft.com (Flash).
Stimulsoft Reports.Web http://web.stimulsoft.com (Ajax).
Stimulsoft Reports.Silverlight http://websl.stimulsoft.com (Client/Server).
Stimulsoft Reports.Silverlight http://sl.stimulsoft.com (Silverlight).
Video tutorials are available at the following link http://www.stimulsoft.com/Videos.aspx
Latest company and product news are available at http://www.stimulsoft.com/AllNews.aspx
Knowledgebase with answers on critical questions is available at http://stimulsoft.helpserve.com/index.
php?_m=knowledgebase&_a=view
You may read an information on weekly prerelease builds and major versions on the Forum at the
following link http://forum.stimulsoft.com/Default.aspx?g=forum&c=2 The status of such topics is
marked as Announcement and is always shown above all forum topics. Also on the forum, you may
read and discuss various subjects regarding reporting tools.
Short messages on the latest news of our company can be read on Twitter http://twitter.com/Stimulsoft
, Facebook http://www.facebook.com/pages/Stimulsoft/166319983418027 and RSS http://www.
stimulsoft.com/rss/stimulsoft_rss_en.xml
2003-2013 Stimulsoft

Introduction

You may subscribe to the newsletters on the Home page of our website.
For getting more information about the product in other online resources, please use the search
engines.

Data

2.1

Business Objects in Net, Web, Silverlight

Business Object is a data type, which is a set of objects related to each other, using what it is possible
to present data in various structures: tables, lists, arrays, etc. These data can be passed to a reporting
tool based on them the report can be rendered. Business Objects are created, registered and passed
to the report generator from code.
Filling the Business Objects manually in .NET
This example creates a report with a business object. First we need to create the structure of the
business object. Below is a sample code to create a business object class:
public class MyObject
{
public class Category
{
public int number;
public int Number
{
get
{
return number;
}
}
public string name;
public string Name
{
get
{
return name;
}
}
public string description;
public string Description
{
get
{
return description;

2003-2013 Stimulsoft

Stimulsoft Reports

}
}
}
public Category[] list = null;
public Category[] List
{
get
{
return list;
}
}
}

Now, you should populate the business object. Below is an example of code to populate a Business
Object is with data:
MyObject obj = new MyObject();
obj.list = new MyObject.Category[2];
MyObject.Category c1 = new MyObject.Category();
c1.number = 1;
c1.name = "Cat1";
c1.description = "desc for n1";
MyObject.Category c2 = new MyObject.Category();
c2.number = 2;
c2.name = "Cat2";
c2.description = "desc for n2";
obj.list[0] = c1;
obj.list[1] = c2;
StiReport mainreport = new StiReport();
mainreport.RegBusinessObject("MyObject", obj);
mainreport.Design();

After that, the business object is created, filled with data, registered and passed to the reporting tool.
In order to create a report in the designer using business objects, you should create a data description
in the report dictionary. To do this, select MyObject (created Business Object) in the report dictionary
in and choose New Business Object... from the context menu or the menu New Item. After selecting
this command, the window will open a New Business Object, in which you should specify the Child
Business Object and select lists of data. The picture below shows the dialog New Business Object.

2003-2013 Stimulsoft

Data

After you click Ok, you will be shown the second dialog box form of the New Business Object, where
you can change the detail business object. The picture below shows the second dialog box form of the
New Business Object.

2003-2013 Stimulsoft

Stimulsoft Reports

The field Category displays the category name. When you create a business object the field is not
editable and is purely informative. Also, it may be empty, as in this case.
The field Name is used to specify the name of the business object. This field is always available for
editing, and, in this case, the name List is used.
The field Alias specifies an alias of the business object. This field is always available for editing, and,
in this case, the name List is used.
The button New Column. Pressing it a new data column will be created in the business object. It
should be noted that the data column created this way is a virtual data column and it does not contain
actual data.
The button New Calculated Column is used to insert a new calculated column into the business
object.
The button Delete is used to delete selected data columns. If you select a bookmark Columns, then
all the columns which are in the tab will be deleted.
The button Retrieve Columns is used to get the data column from the business object.
The button Get Columns from Assembly will open the dialog Open Assembly, in which you may
choose an assembly file. After selecting the file, press the button Open and, from this file, data columns
will be extracted, if they are present there.
The panel Columns consists of three fields. In these fields show a list of columns, their properties,
and a description of these properties.
Press the Ok button once the fields are filled and parameters are specified. After that, in the data
dictionary of the report a description of a new business object will be created, which can be used to
create reports. The picture below shows a report built using a business object:
2003-2013 Stimulsoft

Data

Provide the data to business objects from the data source in .NET
Created business objects that are registered and passed to the report generator, but do not contain
the actual data are called a description of business objects. Using the description of the business
object, you can create a report template (define the structure and design the report), and then, before
building, connect the real data and render a report. This is useful if you want to create reports with the
same structure and design, but with different data. Create a structural description of the business
object first. Below is a sample code to create a business object class:
public class MyObject
{
public class Category
{
public int categoryID;
public int CategoryID
{
get
{
return categoryID;
}
}
public string categoryName;
public string CategoryName
{
get
{
return categoryName;
}
}
public string description;
public string Description
{
get
{
return description;
}
}
}
public Category[] list = null;
public Category[] Categories
{

2003-2013 Stimulsoft

Stimulsoft Reports

get
{
return list;
}
}
}

You then need to create a new business object class, register and pass it to the report generator.
Below is a sample code to create and register a new business object:
MyObject.Category obj = new MyObject.Category();
int busobjLevel = 1;
StiReport report = new StiReport();
report.RegBusinessObject("Categories", obj);
report.Dictionary.SynchronizeBusinessObjects(busobjLevel);
report.Design();

Now with help of the created description of the business object, create a report template in the
designer. The picture below shows a report template created with the description of the business
object:

Once a report template is created, you can save it, for example, to the following path D:\\Report.mrt.
Because the description of the business object does not contain the actual data, in order to render a
report, you will get the real data to business objects, in our example we take the data from the
database Northwind. For a start, create a connection to the database in Visual Studio. After that, put
the code to obtain data for the business object. Getting real data for the business object occurs
immediately before the report. Here is the code to obtain data for the business object:
int busobjLevel = 1;
StiReport report = new StiReport();
report.Load("D:\\Report.mrt");
using (NorthwindDataContext context = new NorthwindDataContext())
{
var categories =

2003-2013 Stimulsoft

Data

from c in context.Categories
select new { c.CategoryID, c.CategoryName, c.Description };
report.RegBusinessObject("Categories", categories);
report.Show();
}

After that, the report generator will receive the data for the business object from the specified source,
in this case from the database Northwind. Then, the report will be rendered by the existing template.
The picture below shows the rendered report:

Business objects in Web

Creating, filling, signing and sending business objects to the Web is almost the same as in .NET. First,
create a class of the business object that is identical as in .NET. Next, create an object of the business
object class, register it manually fill data and pass them. Here are the differences that, instead of the
mainreport.Design() method, you should use the StiWebDesigner1.Design(mainreport) method.
Also perform synchronization using the mainreport.Dictionary.SynchronizeBusinessObjects(),
because in the Web designer it is not possible to create a description of the business object from the
data dictionary (the description can only be created from code). Below is a sample code to create, fill,
register and pass the business objects:
MyObject obj = new MyObject();
obj.list = new MyObject.Category[2];
MyObject.Category c1 = new MyObject.Category();
c1.number = 1;
c1.name = "Cat1";
c1.description = "desc for n1";
MyObject.Category c2 = new MyObject.Category();
c2.number = 2;
c2.name = "Cat2";
c2.description = "desc for n2";
obj.list[0] = c1;
obj.list[1] = c2;

2003-2013 Stimulsoft

Stimulsoft Reports

int busobjLevel = 1;
StiReport mainreport = new StiReport();
mainreport.RegBusinessObject("MyObject", obj);
mainreport.Dictionary.SynchronizeBusinessObjects(busobjLevel);
StiWebDesigner1.Design(mainreport);

Just as in .NET, in Web you can create a description of the business objects first, then the report
template, and then connect the data source with the real data and render a report. Create a
description of the business object. But previously you have to make the class of the business object
that is identical to the class of business object in .NET. Here is an example of writing a business object:
MyObject.Category obj = new MyObject.Category();
int busobjLevel = 1;
StiReport report = new StiReport();
report.RegBusinessObject("Categories", obj);
report.Dictionary.SynchronizeBusinessObjects(busobjLevel);
StiWebDesigner1.Design(report);

Now with the description created, design a report template identical to .NET. Once a report template is
created, you can save it, for example to the following path D:\\Report.mrt. Since the description of the
business object does not contain the actual data, in order to build a report, you should get the real
data to business objects, in this example, we take the data from the database Northwind. First, create
a connection to the database in Visual Studio. After that, write the code to obtain data for the business
object. Getting real data for the business object occurs immediately before the report. Here is the code
to obtain data for the business object:
int busobjLevel = 1;
StiReport report = new StiReport();
report.Load("D:\\Report.mrt");
using (NorthwindDataContext context = new NorthwindDataContext())
{
var categories =
from c in context.Categories
select new { c.CategoryID, c.CategoryName, c.Description };
report.RegBusinessObject("Categories", categories);
StiWebViewer1.Report = report;
}

Business objects in Silverlight

In Silverlight creating a class of the business object is identical to the creation of a Business Object in .
NET. In the Silverlight designer, as well as in the .NET one, it is possible to create a description of a
business object from the data dictionary. Getting data for business objects is the same as in .NET. The
difference is that, instead of the report.Load("*.mrt"), you should use a different code. Below is a

2003-2013 Stimulsoft

Data

sample code:
SaveFileDialog sf = new SaveFileDialog();
sf.Filter = "Files report (*.mrt)|*.mrt";
if (sf.ShowDialog() == true)
{
Stream file = sf.OpenFile();
report.Load(file);
}

2.2

Business Objects in WinRT

In order to pass the business objects in WinRT, you should use the following methods:
The method of saving a dictionary structure
The method of saving the structure of the dictionary file *.dct, for further opening it in the report
designer and creating a report. In this case, only the structure of the Dictionary is remained. The
structure contains a description of business objects. Here is the code that implements this method:
var picker = new Windows.Storage.Pickers.FileSavePicker();
picker.FileTypeChoices.Add("Files Dictionary (*.dct)", new System.
Collections.Generic.List<string>() { ".dct" });
picker.SuggestedFileName = "ReportDictionary1";
picker.SuggestedStartLocation = Windows.Storage.Pickers.
PickerLocationId.ComputerFolder;
var storageFile = await picker.PickSaveFileAsync();
if (storageFile != null)
{
StiReport report = new StiReport();
report.RegBusinessObject("Categories", "Categories", GetData());
report.Dictionary.SynchronizeBusinessObjects(3);
await report.Dictionary.SaveAsync(storageFile);
}

The method of saving a report

The method of saving to a file *.mrt, with the structure of the report dictionary. The structure of the
dictionary includes a description of the business object. Here is the code that implements this method:
var picker = new Windows.Storage.Pickers.FileSavePicker();
picker.FileTypeChoices.Add("Files report (*.mrt)", new System.
Collections.Generic.List<string>() { ".mrt" });
picker.SuggestedFileName = "Report1";
picker.SuggestedStartLocation = Windows.Storage.Pickers.
PickerLocationId.ComputerFolder;
var storageFile = await picker.PickSaveFileAsync();

2003-2013 Stimulsoft

Stimulsoft Reports

if (storageFile != null)
{
StiReport report = new StiReport();
report.RegBusinessObject("Categories", "Categories", GetData());
report.Dictionary.SynchronizeBusinessObjects(3);
await report.SaveAsync(storageFile);
}

Next, consider creating a report template with the description of the business objects, filling them with
real data and reporting.
Creating a report template with a description of the business object
To do this, open a saved report with the structure of the dictionary or open the dictionary data in the
report designer. Next, using the description, you should create a report template. For example,
dragging the business object to the page. When dragging the dialogue form Data will be invoked,
which determines the field references of the business object, the basis of the report - Data Band or
Table, as well as to add a Header Band and Footer Band to the report template. You should also edit
report components. The picture below shows the created report template:

The picture above shows that the report template is created. Since it was created with a description of
the business object that does not contain the actual data, the report can not be rendered. For
rendering a report, a business object should be filled with real data. This can be done manually by
specifying values for the fields, or to connect the data source from which the data will be delivered.
Created report template should be saved, for example, in the folder "My Documents" with the name
Report.mrt.
Filling the business object with the real data
Filling the business object in this example, will be done from the installed database. First, we need to
create a connection to this database in Visual Studio. After this, you should specify the filling code of
the business object. Filling the actual business object data directly before the report. Here is the code
to fill the business object:
Xaml:
<Page>
<viewerRT:StiViewerControl x:Name="viewerControl" />
</Page>

C#:

2003-2013 Stimulsoft

Data

StiReport report = new StiReport();

StorageFile file = await KnownFolders.PicturesLibrary.GetFileAsync("");
await report.LoadAsync(file);
using (NorthwindDataContext context = new NorthwindDataContext())
{
var categories =
from c in context.Categories
select new { c.CategoryID, c.CategoryName, c.Description };
report.RegBusinessObject("Categories", categories);
await report.RenderAsync();
viewerControl.Report = report;
}

After that, the report generator fills the business object with data from the specified data source, in this
case from the database Northwind, the table Categories. Then, the report will be rendered by the
existing template. The picture below shows the rendered report:

Using WinForms Viewer

The StiViewerControl component is used to view reports in the WinForms. The component can show a
report, zoom, save rendered reports to various formats, print reports, send them to a recipient via
Email.

2003-2013 Stimulsoft

3.1

Stimulsoft Reports

How to Show Report?

Just call only one method to show a report:
C#
StiReport report = new StiReport();
report.Load("report.mrt");
report.Show();

VB.NET
Dim Report As StiReport = New StiReport()
Report.Load("report.mrt")
Report.Show()

If the report was not rendered before showing, the Show method will render a report using the
Render method.

3.2

Dot-Matrix Viewer for WinForms

The Dot-Matrix viewer is designed to preview the report before printing it on dot matrix printer. The
Dot matrix printer is used to print only the text and characters of pseudographics. Accordingly the
viewer displays only the text and borders of objects as pseudographics characters. The picture below
shows the Dot-matrix viewer dialog box:

2003-2013 Stimulsoft

Using WinForms Viewer

The Dot-matrix viewer toolbar.

The panel displays the text of a report
The options bar of a report.

3.2.1

Setting Dot-Matrix Viewer in WinForms

The Dot-Matrix viewer can be configured from code using static properties. Depending on the value
of the static properties in the Dot-matrix viewer, these or that parameters will be specified. For
example, the AutoRefresh property. The picture below shows the Dot-Matrix viewer dialog box:

As can be seen on the picture above, the Auto Refresh property is enabled. This means that the
AutoRefresh static property of the Dot-Matrix viewer is set to true. If the AutoRefresh static property
is set to false, then the AutoRefresh property in the Dot-Matrix viewer is disabled. Add the following
code into the project code:
StiOptions.Viewer.DotMatrix.AutoRefresh = false;

Thus, the AutoRefresh property will be disabled. The picture below shows the Dot-Matrix viewer
dialog box with disabled auto refresh function:

2003-2013 Stimulsoft

Stimulsoft Reports

Most parameters can be set using the static properties.

3.2.2

Dot-Matrix and Escape Codes

For inserting the escape sequence to text the commands that may look like <#command> should be
used as seen in the code sample below:

Normal text <#b> Bold text <#/b><#i> Italic text <#/i> Again normal text

Also commands of selecting bold, italic or underlined text are automatically inserted depending on the
style of the text box font. When printing to matrix printer and exporting to text format these commands
are changed on appropriate escape sequences.
The StiEscapeCodesCollection is used for this process. It is inherited from the Hashtable class. This is
a collection of "key-value" pairs where the key is the command and value is the escape-sequence. For
different types of printers different collections with different set of command can be defined.
Collections are stored in the StiOptions.Export.Txt.EscapeCodesCollectionList static variable. By
default, the following collections will be created: "None", "EpsonFX", "Oki ML92/93". The "None"
collection is empty and used to output the text without escape codes.
Command/Collection

EpsonFX

Oki ML92/93

ESC E

ESC T

2003-2013 Stimulsoft

Using WinForms Viewer

Command/Collection

EpsonFX

Oki ML92/93

ESC F

ESC I

ESC 4

ESC 5

ESC -1

ESC H

ESC -0

ESC D

sup

ESC S0

ESC J

/sup

ESC T

ESC K

sub

ESC S1

ESC L

/sub

ESC T

ESC M

condensed

0x0F

0x1d

/condensed

0x12

0x1e

elite

ESC M

0x1c

pica

ESC P

0x1e

doublewidth

ESC W1

0x1f

/doublewidth

ESC W0

0x1e

It is possible to add new collections of change the existing ones. The selection of the required
collection is done by the name. If the collection with the name is not found then the "None" collection is
used. The collection name can be selected from the DotMatrixViewer settings and passed as an option
to the exporting and printing methods.

Using WPF Viewer

The StiWpfViewerControl component is used to view reports in Reports.Wpf. The component can
show a report, zoom, save rendered reports to various formats, print reports, send them to a recipient
via Email.

4.1

How to Show Report?

Just call one method to show a report:
C#
StiReport report = new StiReport();

2003-2013 Stimulsoft

Stimulsoft Reports

report.Load("report.mrt");
report.ShowWithWpf();

VB.NET
Dim Report As StiReport = New StiReport()
Report.Load("report.mrt")
Report.ShowWithWpf()

If the report was not rendered before showing, the ShowWithWpf method will render a report using
the RenderWithWpf method.

4.2

Dot-Matrix Viewer for WPF

The Dot-matrix viewer is designed to preview the report before printing it on dot matrix printer. The
Dot matrix printer is used to print only the text and characters of pseudographics. Accordingly the
viewer displays only the text and borders of objects as pseudographics characters. The picture below
shows the Dot-matrix viewer dialog box:

The Dot-Matrix viewer toolbar.

The panel displays the text of a report
The options bar of a report.

2003-2013 Stimulsoft

Using WPF Viewer

4.2.1

Dot-Matrix Viewer Settings for WPF

As can be seen on the picture above, the AutoRefresh property is enabled. This means that the
AutoRefresh static property of the Dot-matrix viewer is set to true. If the AutoRefresh static property is
set to false, then the AutoRefresh property in the Dot-matrix viewer is disabled. Add the following code
into the project code:
StiOptions.Viewer.DotMatrix.AutoRefresh = false;

Thus, the AutoRefresh property will be disabled. The picture below shows the Dot-matrix viewer
dialog box with disabled auto refresh function:

2003-2013 Stimulsoft

Stimulsoft Reports

Most parameters can be set using the static properties.

4.2.2

DotMatrix and Escape Codes

For inserting the escape sequence to text the commands that may look like <#command> should be
used as seen in the code sample below:
Normal text <#b> Bold text <#/b><#i> Italic text <#/i> Again normal text

EpsonFX

Oki ML92/93

ESC E

ESC T

ESC F

ESC I

2003-2013 Stimulsoft

Using WPF Viewer

Command/Collection

EpsonFX

ESC 4

ESC 5

ESC -1

ESC H

ESC -0

ESC D

sup

ESC S0

ESC J

/sup

ESC T

ESC K

sub

ESC S1

ESC L

/sub

ESC T

ESC M

condensed

0x0F

0x1d

/condensed

0x12

0x1e

elite

ESC M

0x1c

pica

ESC P

0x1e

doublewidth

ESC W1

0x1f

/doublewidth

ESC W0

0x1e

Oki ML92/93

Using Web Designer

The StiWebDesigner component is used to edit reports in the window of a browser. And there is no
need to install the .NET Framework, ActiveX components and other special plug-ins on the client
machine. The only requirements are a web browser and the Flash player. Using StiWebDesigner it is
possible to create, edit, save, view, and print reports on any computer, on any OS, where there is an
internet connection, and where there is the installed web browser and Flash Player 10.2 and higher.
StiWebDesigner is non visual ASP.NET component. It can be divided in two parts: client and server.
The client side is the graphic wrapping of the designer that is realized on Flex. The server side is the
report generator engine and, also, a module that has functions to get queries and send data on the
client side. These two parts are collected into one DLL library and represented as a non visual
component.

2003-2013 Stimulsoft

5.1

Stimulsoft Reports

How It Works?
To run the web reports designer, it is required to put theStiWebDesigner component on the ASP.NET
page and call the Design method of this component. When running the Web reports designer the
following actions occur:
The .NET component reads to the memory the client Flash application from resources and runs it.
When it is loaded, the client side, in the AJAX mode, requests from the server side all necessary
settings and the report file. The server side passes all this.
When saving a report in the preview mode, the client side sends the report file as XML in the AJAX
mode and the server side makes the premature processing of the report, and either sends it for saving
or compile it in the window of a browser.

5.2

How to Run Web Reports Designer?

For running the Web report designer it is necessary to put non visual StiWebDesigner component on
the form and, in the event handler of a control, to call the Design() method:
<cc1:StiWebDesigner ID="StiWebDesigner1" runat="server" />

C#:
protected void Button1_Click(object sender, EventArgs e)
{
StiWebDesigner1.Design();
}

VB.NET:
Protected Sub Button1_Click(ByVal sender As Object, ByVal e As
EventArgs)
StiWebDesigner1.Design()
End Sub

For loading a report in the Web designer, the method of calling can be slightly modified:
C#:
protected void Button1_Click(object sender, EventArgs e)
{
StiReport report = new StiReport();
report.Load("D:\\SimpleList.mrt");
StiWebDesigner1.Design(report);
}

VB.NET:

2003-2013 Stimulsoft

Using Web Designer

Protected Sub Button1_Click(ByVal sender As Object, ByVal e As

EventArgs)
Dim report As StiReport = New StiReport()
report.Load("D:\\SimpleList.mrt")
StiWebDesigner1.Design(report)
End Sub

It requires a bit more complicated code to call the reports designer automatically when loading a
page. It is necessary to exclude service messages which are sent by the client part of the designer to
the server part:
C#:
protected void Page_Load(object sender, EventArgs e)
{
if (Page != null)
{
string keyValue = Page.Request.QueryString.Get(
"stimulsoft_webdesigner");
if (!IsPostBack && keyValue == null)
{
StiReport report = new StiReport();
report.Load("D:\\SimpleList.mrt");
StiWebDesigner1.Design(report);
}
}
}

VB.NET:
Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
If Not Page Is Nothing Then
String keyValue = Page.Request.QueryString.Get(
"stimulsoft_webdesigner")
If Not IsPostBack And keyValue Is Nothing Then
Dim report As StiReport = New StiReport()
report.Load("D:\\SimpleList.mrt")
StiWebDesigner1.Design(report)
End If
End If
End Sub

5.3

Loading Reports to Web Designer

One of the following methods can be used to load a report to the Web designer:

2003-2013 Stimulsoft

Stimulsoft Reports

Loading a report before loading the designer;

Loading a report after loading the designer;
Loading a report from the main menu of the designer.
Loading a report before loading the designer. In this way the report (for example, from a file) is
loaded first and then the designer is loaded. The previously loaded report is specified as a parameter of
a method of calling the designer. A code below is a sample for loading a report before loading the
designer:
protected void Button1_Click(object sender, EventArgs e)
{
StiReport report = new StiReport();
report.Load("D:\\SimpleList.mrt");
StiWebDesigner1.Design(report);
}

or, as a way, the previously loaded report is assigned to the designer. In this case designer loading is
done with this report. See the code below:
protected void Button1_Click(object sender, EventArgs e)
{
StiReport report = new StiReport();
report.Load("D:\\SimpleList.mrt");
StiWebDesigner1.Report = report;
StiWebDesigner1.Design();
}

Loading a report after loading the designer is done using the GetReport event. After adding the
handler to this event, it will occur each time when a report is required for the designer. In other words,
after loading the Web designer requests a report from the server and, if the handler is added to the
GetReport event, then in this event a report can be assigned to the designer. See the code below how
to use the GetReport event:
protected void StiWebDesigner1_GetReport(object sender, StiWebDesigner.
StiGetReportEventArgs e)
{
StiReport report = new StiReport();
report.Load("D:\\SimpleList.mrt");
e.Report = report;
}

If the designer is set to the Visual mode, then the report should be loaded with way specified
below:
protected void Button1_Click(object sender, EventArgs e)
{
StiReport report = new StiReport();
report.Load("D:\\SimpleList.mrt");

2003-2013 Stimulsoft

Using Web Designer

StiWebDesigner1.Report = report;
}

5.4

Report Preview
The preview function of the edited report, in the Web designer, has two modes: HTML (preview as
HTML file) and PDF (preview as PDF file). After selecting one of two modes, a report will be shown is
the browser window. If, when report rendering, the errors occur, then alert messages will be shown in
the separate browser window. To preview a report in the web designer window can be done by
switching the Preview tab in the designer. To preview the report data are required. By default, data are
taken from the Dictionary of the edited report. If necessary, they can be overridden. There is a sample
code below using what data can be overridden:
C#:
protected void StiWebDesigner1_GetPreviewDataSet(object sender,
StiWebDesigner.StiPreviewDataSetEventArgs e)
{
DataSet data = new DataSet();
data.ReadXml("D:\\Demo.xml");
data.ReadXmlSchema("D:\\Demo.xsd");
e.PreviewDataSet = data;
}

VB.NET:
Protected Sub StiWebDesigner1_GetPreviewDataSet(ByVal sender As Object,
ByVal e As StiWebDesigner.StiPreviewDataSetEventArgs)
Dim data As DataSet = New DataSet()
data.ReadXml("D:\\Demo.xml")
data.ReadXmlSchema("D:\\Demo.xsd")
e.PreviewDataSet = data
End Sub

As seen from code, data are taken from XML and XSD files. The same way exists for other data
sources. If any connections to the database are specified in the report, they have a higher priority than
the data specified in the GetPreviewDataSet event. In order specified data be applied when rendering
the report, you should clear the list of connections:
protected void StiWebDesigner1_GetPreviewDataSet(object sender,
StiWebDesigner.StiPreviewDataSetEventArgs e)
{
e.Report.Dictionary.Databases.Clear();
DataSet data = new DataSet();
data.ReadXml("D:\\Demo.xml");

2003-2013 Stimulsoft

Stimulsoft Reports

data.ReadXmlSchema("D:\\Demo.xsd");
e.PreviewDataSet = data;
}

5.5

Changing Report Settings Before Rendering

If it is necessary before the report rendering to change the report parameters or user settings in the
report, you can add a handler to the ProcessReportBeforeRender event. This event occurs immediately
before the report rendering. For example, it is necessary to change the Report Name before report
rendering. To do this, add the handler to the ProcessReportBeforeRender event, define the value of
the ReportName property, where the value of the property is the name of the report. For example,
add the following code to the code project:
protected void StiWebDesigner1_ProcessReportBeforeRender(object sender,
StiWebDesigner.StiProcessReportBeforeRenderEventArgs e)
{
e.Report.ReportName = "Employees";
}

Now, before report rendering, the name will be changed from the existing one to Report 2010. Thus,
using the ProcessReportBeforeRender event, the user can change custom options before rendering.

5.6

Saving Reports
Two events are used for the processing of a saved report in the Web-designer. These are SaveReport
and SaveReportAs. The SaveReport event occurs when you click on the Save Report button or when
you click on the Save Report item of the main menu in the designer. The SaveReportAs event occurs
when you select the Save As item of the main menu in the designer. When the user is not signed to this
event, then, by default, a built-in Web-designer dialog box to save the report is called. If the user is
assigned to this event, then the dialog box will not appear but the event will appear, i.e. saving is done
by the server. See the code below:
C#:
protected void StiWebDesigner1_SaveReport(object sender,
StiWebDesigner.StiSaveReportEventArgs e)
{
StiReport report = e.Report;
}

VB.NET:
Protected Sub StiWebDesigner1_SaveReport(ByVal sender As Object, ByVal
e As StiWebDesigner.StiSaveReportEventArgs)

2003-2013 Stimulsoft

Using Web Designer

Dim report As StiReport = e.Report

End Sub

After that, the ways and place to save the report are identified by the user. For example, the report can
be saved to a string in the database. Below is the code to save a report to the string:
C#:
protected void StiWebDesigner1_SaveReport(object sender,
StiWebDesigner.StiSaveReportEventArgs e)
{
StiReport report = e.Report;
string str = report.SaveToString();
}

VB.NET:
Protected Sub StiWebDesigner1_SaveReport(ByVal sender As Object, ByVal
e As StiWebDesigner.StiSaveReportEventArgs)
Dim report As StiReport = e.Report
Dim str As String = report.SaveToString()
End Sub

Subscription to the SaveReportAs event is made by analogy with the SaveReport event. In the event of
saving a report you can use the ErrorCode property of the event argument. The ErrorCode property
can take numeric values. By default, this property is set to -1. This means that, when saving a report, the
report event occurs, but nothing will be output in the Web-designer. If this property is set to 0, then the
user will be notified about that the report is saved successfully. The picture below shows a notification
window which indicates successful report saving:

If the ErrorCode property will be greater than 0, then the error message is displayed with its source
code where the error is the value of the ErrorCode. The picture below shows a window with the error
code 1:

2003-2013 Stimulsoft

Stimulsoft Reports

Report saving occurs in the background mode, i.e. visually it will not be displayed. If you need to
visually manage the process of saving the report, you may change the SaveMode property of the
StiWebDesigner component on one of two values: Visible or NewWindow:
<cc1:StiWebDesigner ID="StiWebDesigner1" runat="server" OnSaveReport
="StiWebDesigner1_SaveReport" SaveMode="NewWindow" />

If the SaveMode property is set to Visible, the process of saving the report will be displayed in the
current browser window. If the property is set to NewWindow, then the process of saving the report
will be displayed in a new browser window. By default, this property is set to Hidden, i.e. the process of
saving the report is not displayed.

5.7

Web Designer Settings

Setting the Web designer can be done using the static properties, which are described in the
Stimulsoft.Report.Web.StiWebDesignerOptions class. Static properties of the Web designer can be
divided into following groups: Connection, Main menu, Zooming, Viewer, Additional.

5.7.1

Connection
The static properties described below belong to the StiWebDesignerOptions.Connection group and
responsible for option of connection the client and server sides:
Name

Description

ClientRequestTimeout

property sets time (in seconds) that the client part will wait the response
from the server side. The default value is 10 seconds.

ClientRepeatCount

property sets the number of repeats of requests of the server side to the
client side, when getting errors of obtaining data. The default value is 2
repeats.

RelativeUrls

property allows using the relative Url. If the RelativeUrls is set to false,
then the absolute Url is used. If the RelativeUrls is set to true, then the
relative Url is used. By default, the value is set to false. A sample of the
absolute and relative Urls is shown below:
http://localhost:4444/WebDesignerDemo/WebDesigner.aspx

is an

2003-2013 Stimulsoft

Using Web Designer

absolute Url, the RelativeUrls property is set to false;

/WebDesignerDemo/WebDesigner.aspx is a relative Url, the RelativeUrls
property is set to true.

5.7.2

Main Menu
The main menu of the Web designer can be setup according to user's requirements. This group of
static properties StiWebDesignerOptions.Menu allows enabling/disabling main menu or submenu
items.
Name

Description

NewEnabled

property is used to enable/disable the New menu item. If the NewEnabled

property is set to true, then this menu item is enabled and available for a
user. If this property is set to false then this submenu item is disabled and
not available for a user. By default, this property is set to true. The New
menu contains submenus such as: New Report, New Report With Wizard,
New Page.

NewReport

property is used to enable/disable the New Report submenu item. If the

NewReport property is set to true, then this submenu item is enabled and
available for a user. If this property is set to false then this submenu item
is disabled and not available for a user. By default, this property is set to
true;

NewReportWithWizar
d

property is used to enable/disable the New Report With Wizard submenu

item. If the NewReportWithWizard property is set to true, then this
submenu item is enabled and available for a user. If this property is set to
false then this submenu item is disabled and not available for a user. By
default, this property is set to true;

NewPage

property is used to enable/disable the New Page submenu item. If the

NewPage property is set to true, then this submenu item is enabled and
available for a user. If this property is set to false then this submenu item
is disabled and not available for a user. By default, this property is set to
true;

OpenReport

property is used to enable/disable the Open Report menu item. If the

OpenReport property is set to true, then this menu item is enabled and
available for a user. If this property is set to false then this submenu item
is disabled and not available for a user. By default, this property is set to
true;

SaveReport

property is used to enable/disable the Save Report menu item. If the

SaveReport property is set to true, then this menu item is enabled and
available for a user. If this property is set to false then this submenu item
is disabled and not available for a user. By default, this property is set to
true;

2003-2013 Stimulsoft

5.7.3

Stimulsoft Reports

SaveAs

property is used to enable/disable the Save As menu item. If the SaveAs

DeletePage

property is used to enable/disable the Delete Page menu item. If the

DeletePage property is set to true, then this menu item is enabled and
available for a user. If this property is set to false then this submenu item
is disabled and not available for a user. By default, this property is set to
true;

Preview

property is used to enable/disable the Preview menu item. If the Preview

property is set to true, then this menu item is enabled and available for a
user. If this property is set to false then this submenu item is disabled and
not available for a user. By default, this property is set to true. The
Preview menu item contains a submenu which contains the following items:
Preview As Pdf, Preview As Html.

PreviewAsPdf

property is used to enable/disable the Preview As Pdf submenu item. If

the PreviewAsPdf property is set to true, then this menu item is enabled
and available for a user. If this property is set to false then this submenu
item is disabled and not available for a user. By default, this property is set
to true.

PreviewAsHtml

property is used to enable/disable the Preview As Html submenu item. If

the PreviewAsHtml property is set to true, then this menu item is enabled
and available for a user. If this property is set to false then this submenu
item is disabled and not available for a user. By default, this property is set
to true.

Zooming Static Properties

The Zoom group of static properties has one static property: StiZoomMode. Depending on the values
of this property it is possible to set options of report template zoom. This property has the following
values: PageWidth, PageHeight, OnePage, Zoom25, Zoom50, Zoom75, Zoom100, Zoom150,
Zoom200.
Name

Description

PageWidth

Value sets zoom by Page Width. So the width of the report template
matches the width of the window of the web designer.

PageHeight

Value sets zoom by Page Height. So the height of the report template
matches the height of the window of the web designer.

OnePage

Value sets zoom by One Page. So the entire page of the report template
fits in the window of the web designer.

Zoom25,
Zoom75,

Zoom50, Values set zoom level of the report template which is 25%, 50%, 75%,
Zoom100, 100%, 150%, 200%.

2003-2013 Stimulsoft

Using Web Designer

Zoom150, Zoom200

5.7.4

Viewer Static Properties

A group of StiWebDesignerOptions.Viewer.Toolbar static properties is described below:
Name

Description

ShowZoom

Property is used to show/hide the zoom panel. If the ShowZoom property

is set to true, then the zoom panel will be shown. If the ShowZoom
property is set to false, then the zoom panel will be hidden. By default this
property is set to true.

ShowPrintButton

Property is used to show/hide the Print button. If the ShowPrintButton

property is set to true, then the Print button is shown. If the
ShowPrintButton property is set to true, then the Print button is hidden.
By default this property is set to true.

ShowOpenButton

Property is used to show/hide the Open button. If the ShowOpenButton

property is set to true, then the Open button is shown. If the
ShowOpenButton property is set to true, then the Open button is hidden.
By default this property is set to true.

ShowSaveButton

Property is used to show/hide the Save button. If the ShowSaveButton

property is set to true, then the Save button is shown. If the
ShowSaveButton property is set to true, then the Save button is hidden.
By default this property is set to true.

ShowSendEmailButton Property is used to show/hide the SendEmail button. If the

ShowSendEmailButton property is set to true, then the SendEmail button
is shown. If the ShowSendEmailButton property is set to true, then the
SendEmail button is hidden. By default this property is set to true.
ShowPageNewButton

Property is used to show/hide the Page New button. If the

ShowPageNewButton property is set to true, then the Page New button
is shown. If the ShowPageNewButton property is set to true, then the
Page New button is hidden. By default this property is set to true.

ShowPageDeleteButto
n

Property is used to show/hide the Page Delete button. If the

ShowPageDeleteButton property is set to true, then the Page Delete
button is shown. If the ShowPageDeleteButton property is set to true,
then the Page Delete button is hidden. By default this property is set to
true.

ShowPageSizeButton

Property is used to show/hide the Page Size button. If the

ShowPageSizeButton property is set to true, then the Page Size button is
shown. If the ShowPageSizeButton property is set to true, then the Page
Size button is hidden. By default this property is set to true.

ShowBookmarksButto

Property

2003-2013 Stimulsoft

used

show/hide

the

Bookmarks

button.

the

Stimulsoft Reports

ShowBookmarksButton property is set to true, then the Bookmarks

button is shown. If the ShowBookmarksButton property is set to true,
then the Bookmarks button is hidden. By default this property is set to
true.

ShowThumbnailsButto Property is used to show/hide the Thumbnails button. If the

n
ShowThumbnailsButton property is set to true, then the Thumbnails
button is shown. If the ShowThumbnailsButton property is set to true,
then the Thumbnails button is hidden. By default this property is set to
true.
ShowFindButton

Property is used to show/hide the Find button. If the ShowFindButton

property is set to true, then the Find button is shown. If the
ShowFindButton property is set to true, then the Find button is hidden.
By default this property is set to true.

ShowEditButton

Property is used to show/hide the Edit button. If the ShowEditButton

property is set to true, then the Edit button is shown. If the
ShowEditButton property is set to true, then the Edit button is hidden. By
default this property is set to true.

ShowFirstPageButton

Property is used to show/hide the First Page button. If the

ShowFirstPageButton property is set to true, then the First Page button
is shown. If the ShowFirstPageButton property is set to true, then the
First Page button is hidden. By default this property is set to true.

ShowPreviousPageBut
ton

Property is used to show/hide the Previous Page button. If the

ShowPreviousPageButton property is set to true, then the Previous Page
button is shown. If the ShowPreviousPageButton property is set to true,
then the Previous Page button is hidden. By default this property is set to
true.

ShowGoToPageButton Property is used to show/hide the Go to Page button. If the

ShowGoToPageButton property is set to true, then the Go to Page
button is shown. If the ShowGoToPageButton property is set to true, then
the Go to Page button is hidden. By default this property is set to true.
ShowNextPageButton

Property is used to show/hide the Next Page button. If the

ShowNextPageButton property is set to true, then the Next Page button
is shown. If the ShowNextPageButton property is set to true, then the
Next Page button is hidden. By default this property is set to true.

ShowLastPageButton

Property is used to show/hide the Last Page button. If the

ShowLastPageButton property is set to true, then the Last Page button is
shown. If the ShowLastPageButton property is set to true, then the Last
Page button is hidden. By default this property is set to true.

ShowPageViewModeSi Property is used to show/hide the Single Page button. If the

ngleButton
ShowPageViewModeSingleButton property is set to true, then the Single
Page button is shown. If the ShowPageViewModeSingleButton property
is set to true, then the Single Page button is hidden. By default this
property is set to true.

2003-2013 Stimulsoft

Using Web Designer

ShowPageViewModeC
ontinuousButton

Property is used to show/hide the Continuous button. If

ShowPageViewModeContinuousButton property is set to true, then
Continuous
button
is
shown.
If
ShowPageViewModeContinuousButton property is set to true, then
Continuous button is hidden. By default this property is set to true.

the
the
the
the

ShowPageViewModeM Property is used to show/hide the Multiple Pages button. If the

ultipleButton
ShowPageViewModeMultipleButton property is set to true, then the
Multiple
Pages
button
is
shown.
If
the
ShowPageViewModeMultipleButton property is set to true, then the
Multiple Pages button is hidden. By default this property is set to true.

5.7.5

Additional Viewer Static Properties

This group of StiWebDesignerOptions static properties allows enabling/disabling dictionary and
report template editing, showing/hiding tabs of the Web designer.
Name

Description

ModifyDictionary

Property is used to enable/disable Dictionary editing. If the

ModifyDictionary property is set to true, then editing is enabled. If the
ModifyDictionary property is set to false, then editing is disabled. By
default this property is set to true.

ModifyConnections

Property is used to enable/disable Connections editing. If the

ModifyDictionary property is set to true, then editing is enabled. If the
ModifyDictionary property is set to false, then editing is disabled. By
default this property is set to true.

ModifyDataSources

Property is used to enable/disable Data Sources editing. If the

ModifyDataSources property is set to true, then editing is enabled. If the
ModifyDataSources property is set to false, then editing is disabled. By
default this property is set to true.

ModifyVariables

Property is used to enable/disable Variables editing. If the

ModifyVariables property is set to true, then editing is enabled. If the
ModifyVariables property is set to false, then editing is disabled. By
default this property is set to true.

ModifyTemplate

Property is used to enable/disable loaded Template editing. If the

ModifyTemplate property is set to true, then editing is enabled. If the
ModifyTemplate property is set to false, then editing is disabled. By
default this property is set to true.

AllowScale

Property is used to enable/disable scale changing. If the AllowScale

property is set to true, then changing is enabled. If the AllowScale
property is set to false, then changing is disabled. By default this property
is set to true.

CodeTabVisible

Property is used to show/hide the Code tab. If the CodeTabVisible

2003-2013 Stimulsoft

Stimulsoft Reports

property is set to true, then the code tab will be shown. If the
CodeTabVisible property is set to false, then the code tab will be hidden.
By default this property is set to true.

5.8

DictionaryTabVisible

Property is used to show/hide the Dictionary tab. If the

DictionaryTabVisible property is set to true, then the code tab will be
shown. If the DictionaryTabVisible property is set to false, then the code
tab will be hidden. By default this property is set to true.

ExitButtonVisible

Property is used to show/hide the Exit button in the main menu. If the
ExitButtonVisible property is set to true, then the button tab will be
shown. If the ExitButtonVisible property is set to false, then the button
tab will be hidden. By default this property is set to true.

Web Designer Properties

Web designer properties are described below:
Name

Description

BrowserTitle

property is used to change titles of a browser. This property may get string
values. By default, the title of a browser is Report Alias, and if it is absent, it is a
Report Name.

SaveMode

If you need to show the process of saving a report, you need to set the
SaveMode property of the StiWebDesigner component to one of the following
values: Visible or NewWindow. If the SaveMode property is set to Visible,
then process will be displayed in the current window of the designer. If the
SaveMode property is set to NewWindow, then the saving process will be
shown in a new window of the browser. By defauly this property is set to Hidden,
the process of saving is not shown.

SaveAsMode

The difference of this property is that, it works when the SaveReportAs event
occurs, and the SaveMode property when the SaveReport event occurs.

DataEncryption

property is used to enable/disable data encryption. If the DataEncryption

property is set to false, then data are not decrypted. If the DataEncryption
property is set to true, then data a decrypted. By default, this property is set to
false.

DataCompressio
n

property is used to enable/disable data compression. If the DataCompression

property is set to false, then data are not compressed. If the DataCompression
property is set to true, then data are compressed. By default, this property is
set to true.

UseCache

property allows using caching on the server when loading a report. If the
UseCache property is set to true, then caching is used when loading a report, i.
e. a report is loaded to the Web designer from the server cache. If the
UseCache property is set to false, then caching is not used when loading a
report. In this case for loading the report in the Web designer the GetReport

2003-2013 Stimulsoft

Using Web Designer

event should be used. By default, this property is set to true.

ServerTimeout

property is used to define the time of a report in the report cache. By default,
this property is set to "00:10:00", this means that the report is stored 10
minutes in the server cache and then it is removed.

ExitUrl

property is used to assign Url, to what user will be redirected when closing the
Web designer via clicking the Exit button of the main menu. By default, a user
will be redirected on a page from what the Web designer is run.

ShowWizardOnSt property is used to show the report rendering wizard window when running the
artup
Web designer. If the ShowWizardOnStartup property is set to false, then,
when running the Web designer, the report rendering wizard window will not be
shown. If the ShowWizardOnStartup property is set to true, then, when running
the Web designer, the report rendering wizard window will be shown. By
default, this property is set to false.
AppCacheDirecto property is used to define the path to the directory on the server, in what,
ry
caching files of the Flash-application will occur. For this, you should set full
access of the ASP.NET application to this directory.
ShowSelectLangu Shows/hides the button to invoke the menu of selecting the localization. If this
age
property is set to true, the button is displayed. If the property is set to false, the
menu button is hidden. By default, this property is set to true.

5.9

Changing Web Designer Properties From Code

The PreInit event is used to change Web designer properties. This event occurs before initialization of
the designer, i.e. before passing Web designer properties to the client part of an application. In other
words, to change the Web designer properties from code in it necessary to add the handler to the
PreInit event. The code below shows how to add the handler to the PreInit event and set the
Localization property to en:
protected void StiWebDesignerSL1_PreInit(object sender,
StiWebDesignerSL.StiPreInitEventArgs e)
{
e.WebDesignerSL.Localization = "en";
}

Now, when running the Web designer, it will be localized in English. For example, we need to change
the browser title. By default, the browser title is the value of the Report Alias property. If the value is
not set then the Report Name is taken. To change the browser title it is necessary to add the code
below to the event:
protected void StiWebDesignerSL1_PreInit(object sender,
StiWebDesignerSL.StiPreInitEventArgs e)
{
e.WebDesignerSL.BrowserTitle = "Stimulsoft";

2003-2013 Stimulsoft

Stimulsoft Reports

}
Now, when running the Web designer, Stimulsoft word will be shown as a report title.

5.10 Web Reports Designer Localization

The Web reports designer interface can be localized in any of 24 available languages. It is necessary to
create the Localization folder in the root catalogue of your Web-project and copy all necessary .xml
localization files. After loading the web reports designer, the list of languages will be available in its
menu. The path to the Localization folder can be changed. The DirectoryLocalization property is used
for this:
<cc1:StiWebDesigner
ID="StiWebDesigner1"
DirectoryLocalization="\\Files\\Languages\\" />

runat="server"

Also, it is possible to specify which language can be used right after the web reports designer (default
localization). The following code shows how to do this. (it is necessary to specify the .xml file in the
Localization property):
<cc1:StiWebDesigner ID="StiWebDesigner1" runat="server" Localization="ru"
/>

5.11 Visible Mode

When adding a StiWebDesigner component on a page of a Web applications, it will be added as a
non-visual component and calling the designer is done using the Design () method. If you want to
place the Web designer in a specific location on a web page with a certain size, you should use the
visual designer mode. Designer mode depends on the value of the Visible property of the
StiWebDesigner component. By default, this property is set to false, so the designer will be a nonvisual component. If the Visible property set to true, it the visual designer mode will be enabled.
<cc1:StiWebDesigner ID="StiWebDesigner1" runat="server" Visible="True"
/>

If the designer is in visual mode, then the report should be loaded with the following method:
protected void Button1_Click(object sender, EventArgs e)
{
StiReport report = new StiReport();
report.Load("D:\\SimpleList.mrt");
StiWebDesigner1.Report = report;
}

If to call the Design () method in the visual mode of the designer, then loaded report is displayed on
2003-2013 Stimulsoft

Using Web Designer

the full screen in the browser.

Using Web Viewer

Stimulsoft Reports contains full set of tools to create reports and show them in Web. Basic tools are:
StiWebViewer and the StiReportResponse class. The StiWebViewer is used to show a report on a
page of browser. The StiReportResponse contains a method to render a report to the specified
format.

6.1

Caching
The StiWebViewer component can output reports in two modes: 1. Using the caching and 2. Without
caching. If the cashing is not used then it is necessary, when every page refreshing, to get data from a
report and render a report again. When using caching the rendered report is saved in cache on the
server. The next time when the page is refreshed, the previously rendered report is loaded from cache
and its re-rendering is not required. It is important to remember that every report saved in cache takes
the server memory and, if there are a lot of queries to reports, it can be a critical factor. Therefore, one
should choose choose either low requirements to the memory but high requirements to performance
or high requirements to the memory but low requirements to speed. Caching should not be used if the
end user needs a report with actual data when every refreshing. The caching process can be controlled
using the RenderMode, CacheMode, and ServerTimeOut properties.
If the caching of a report is not used then the report that was rendered using the last data when page
refreshing will be printed but not the report that is shown on the current moment. If it is necessary to
get the exact copy of a report form the browser, then it is necessary to use caching.
Notice. It should be borne in mind that if the report caching is not used, then not the report that is
shown currently will be printed, but one that will be rendered using the latest data when refreshing a
page. If it is important to get an exact copy of the report from the browser, you should use caching.

6.1.1

RenderMode Property
The RenderMode property indicates how and when a report should be rendered. All modes of the
StiWebViewer component can be divided in two categories: using the caching of a rendered report,
and without using caching of the rendered report. The modes without caching
Standard
In this mode, the report should be re-rendered every time when the page is refreshed. In addition, this
mode does not use Ajax to display the controls of the StiWebViewer and any report refresh with help
of controls of the StiWebViewer component leads to the page refresh on what the report is output.
RenderOnlyCurrentPage
Very interesting mode of the report output. In this mode, the report is rendered only to the page that
is currently displayed in the StiWebViewer component. For example, if the report consists of 100
pages (this is a big report to be output in the web), and the current page is the page number 5, the
report will be rendered only up to the page number 5. The sever memory is saved in this mode.

2003-2013 Stimulsoft

Stimulsoft Reports

Ajax
This mode uses Ajax to output a report and to update the content of the StiWebViewer component.
For example, if a user goes to the next page of a report then not the whole page of the browser on
what the StiWebViewer component is placed will be refreshed but only the next page of a report will
be sent to the browser using the post-back query. This increases the convenience of working with the
StiWebViewer component.
Modes with caching are UseCache and AjaxWithCache.
UseCache
With each refresh in the StiMobileViewer component page reloading from the server occurs, but the
report is not re-rendered but each time is loaded from the cache.
AjaxWithCache
This mode as well as the Ajax mode uses the Ajax technology to output a report and also is used for
refreshing operations of the StiWebViewer component. However, unlike the Ajax mode, this
AjaxWithCache mode does not re-render the report after each information request on the server. The
report that was earlier saved in cache is used.

6.1.2

CacheMode Property
The CacheMode property indicates what cache should be used to store reports, images, and service
information. There are two ways:
Page
A page cache will be used.
Session
A session cache will be used.

6.1.3

ServerTimeout Property
The ServerTimeout property indicates the amount of time on what it is necessary to save a report,
pictures of a report, or other data in the cache. Do not use too much time or too little time. If the time
is too large, then the used cache will be overflowed and will be automatically cleared by the server. As
a result, the report (or images of a report) will not be cached, and incorrect result of the report output
in the StiWebViewer component will occur. If the time is too small, then by the time of request to the
cache, there some necessary data may not be found. It is recommended to set the time equal to 10
minutes. But the exact time can be found experimentally, considering the parameters of the server,
users activity, etc.

6.2

Printing Reports
It is difficult to print a report from the browser. Stimulsoft Reports has three methods of printing:
Converting a report to the PDF file and passing it to the end-user for printing.

2003-2013 Stimulsoft

Using Web Viewer

Printing a report with preview in the pop-up window.

Printing without preview.
The first method is the best way. It allows printing a report more precisely. But it is required to have
installed Adobe Acrobat to print a report to the PDF format. Often this requirement is a big
disadvantage. When printing reports with preview the report generator creates a new pop-up window.
A report in the HTML format is output in this window. The end-user may format this report and print it.
In printing report without preview the report generator prints a report without preview. When choosing
the method of printing characteristics of each method should be considered.
Notice: The StiWebViewer component cannot control page parameters (page size, page
orientation, page margins) when printing using the 2 and 3 method. All parameters are controlled with
the browser.

6.3

StiReportResponse Class
A report can be shown without using the StiWebViewer component. The special Stimulsoft.Report.
Web.StiReportResponse class is used in this case. This class is a set of methods for saving a rendered
report in different formats to the stream of a page. It is possible to assign a lot of input parameters
which allows controlling the saving format of a report. For example, the following code can be used to
save a report to the PDF format to the stream of a page:
StiReport report = new StiReport();
report.Load("MyReport.mrt");
report.Render(false);
Stimulsoft.Report.Web.StiReportResponse.ResponseAsPdf(this, report);

In this code the report will be loaded first. Then this report will be rendered. Then the result of the
report rendering will be saved to the stream of a page. The following code saves a report to the Excel
2007 format.
StiReport report = new StiReport();
report.Load("MyReport.mrt");
report.Render(false);
Stimulsoft.Report.Web.StiReportResponse.ResponseAsExcel2007(this,
report);

6.4

Using Dialogs in Report

The StiWebViewer component can show reports with dialogs, but some conditions should be fulfilled:
The AjaxWithCache mode should be used or the UseCache in the RenderMode property;
If data are not received from the server then it is necessary to connect with other data using the
ReportConnect event of the StiWebViewer component and also to disconnect from data using the
ReportDisconnect event;
Besides it is impossible to run a report for rendering in the Load event of a page;
It is possible to use only one dialog form in a report.

2003-2013 Stimulsoft

6.5

Stimulsoft Reports

Images of StiWebViewer Toolbar

By default, images for the toolbar of the StiWebViewer component are saved in cache before report
viewing. Then images are output using cache. This result in additional requests to the server for
extracting images from cache and sending them to the client. This problem can be solved using the
ButtonImagesPath property of the StiWebViewer component. The first thing that should be done is to
place a folder with toolbar images on the server (they can be taken from the standard delivery of the
product). Then it is necessary to specify the path to this folder using the ButtonImagesPath property.

6.6

Localization of StiWebViewer Component

To make the StiWebViewer component "speak" another language it is necessary to copy a localization
file of the standard delivery to the sever. For example, select the "de.xml" file. Then define the path to
this file in the GlobalizationFile property of the component. For example, "Localization\de.xml".

Using MVC Designer

The StiMvcDesigner component is designed to edit report in the browser window. You do not need to
install on the client any .NET Framework, ActiveX components or other special plug-ins. All you need is
a Web browser and the Flash Player. With StiMvcDesigner you can create, edit, save, view and print
reports on any computer in any operating system where there is Internet access and a web browser
with Flash Player version 10.2 or higher. The StiMvcDesigner component can be divided into two parts:
client and server. The client side is a graphical core designed using the Flex technology. The server side
is the very core of the report generator, as well as a module that performs the function of receiving
requests and sending data to the client side of the designer. These two parts are assembled into a
single DLL, and represented in a visual ASP.NET MVC component.

7.1

How It Works?
To run the web reports designer, it is required to put the StiMvcDesigner component on the ASP.NET
page, set necessary properties and define required actions in the view controller. When running the
Web reports designer the following actions occur:
The .NET component reads to the memory the client Flash application from resources and runs it.
When it is loaded, the client side requests a report that should be returned by action set and
defined in the controller settings.
When exporting a report, the client side calls an action, which also must return the specific response.

2003-2013 Stimulsoft

Using MVC Designer

7.2

How to Run Designer?

To run the report designer on the main master-page of the application you need to place a code of
adding java-scripts, which are required for the component work properly. This code is placed in the
block <head>:
ASPX:
<head runat="server">
<%= Html.Stimulsoft().RenderMvcDesignerScripts() %>
</head>

Razor:
<head runat="server">
@Html.Stimulsoft().RenderMvcDesignerScripts()
</head>

To view the report you should add the StiMvcDesigner component to an ASP.NET page, and set it the
necessary properties, and in the view controller, to determine the necessary steps:
ASPX:
<%= Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionGetReportTemplate = "GetReportTemplate",
Width = Unit.Percentage(100),
Height = Unit.Pixel(700)
})%>

Razor:
@Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionGetReportTemplate = "GetReportTemplate",
Width = Unit.Percentage(100),
Height = Unit.Pixel(700)
})

Controller:
public ActionResult GetReportTemplate()
{
StiReport report = new StiReport();
report.Load(Server.MapPath("~/Content/SimpleList.mrt"));
return StiMvcDesigner.GetReportTemplateResult(report);
}

2003-2013 Stimulsoft

7.3

Stimulsoft Reports

How to Load Reports in Web-Designer?

For loading report templates a special action is used. It has the recommended name
GetReportTemplate:
Controller:
public ActionResult GetReportTemplate()
{
StiReport report = new StiReport();
report.Load(Server.MapPath("~/Content/SimpleList.mrt"));
return StiMvcDesigner.GetReportTemplateResult(report);
}

Controller:
public ActionResult GetReportTemplate()
{
StiReport report = new StiReportCompiledClass();
return StiMvcDesigner.GetReportTemplateResult(report);
}

Also, the report template can be downloaded from the main menu of the web designer, selecting the
item Open Report. After selecting this menu item a dialog box will appear. In this dialog box you can
specify the report template for loading.

7.4

Previewing Reports
The preview function of the edited report, in the Web designer, has two modes: HTML, PDF, XPS.
After selecting one of the viewing modes of the report, it will be rendered and displayed in the
browser window. If any errors occur when rendering a report, the notification to the user will be
displayed in a separate browser window.
To preview a report in the above formats, you must define a special action, which has the
recommended name ExportReport:
ASPX:
<%= Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionExportReport = "ExportReport"
})%>

Razor:

2003-2013 Stimulsoft

Using MVC Designer

@Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionExportReport = "ExportReport"
})

The data, sent to the controller, will be a report and information about what type of export is
requested by the designer and what preview mode is set. The report can be obtained by using the
following code:
StiReport report = StiMvcDesigner.GetReportObject(this.Request);

The specified action should return the report to the client side, prepared in the selected format:
Controller:
public FileResult ExportReport()
{
StiReport report = StiMvcDesigner.GetReportObject(this.Request);
return StiMvcDesigner.ExportReportResult(this.Request, report);
}

If you do not need to carry out any manipulation with the report sent for preview, then you can use a
simplified action code:
Controller:
public FileResult ExportReport()
{
return StiMvcDesigner.ExportReportResult(this.Request);
}

If the report requires data other than those specified in the report template, you can use the following
solution:
Controller:
public FileResult ExportReport()
{
DataSet data = new DataSet("Demo");
data.ReadXml(Server.MapPath("~/Content/Demo.xml"));
StiReport report = StiMvcDesigner.GetReportObject(this.Request);
report.Dictionary.Databases.Clear();
report.RegData(data);
return StiMvcDesigner.ExportReportResult(this.Request, report);
}

2003-2013 Stimulsoft

Stimulsoft Reports

Also, previewing report can be done in the web designer by clicking the tab Preview on the panel of
pages list. To preview the rendered report you should to define the specific action that has
recommended name GetReportSnapshot:
ASPX:
<%= Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionGetReportSnapshot = "GetReportSnapshot"
})%>

Razor:
Razor:
@Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionGetReportSnapshot = "GetReportSnapshot"
})

As in the previous form of the preview, the data sent to the data controller will be in the report. This
action should return the report to the client side, prepared in a special format. To do this, use the
following code:
Controller:
public ActionResult GetReportSnapshot()
{
return StiMvcDesigner.GetReportSnapshotResult(this.Request);
}

If the report requires data other than those specified in the report template, you can use the same
solution as in the previous form of the preview:
Controller:
public ActionResult GetReportSnapshot()
{
DataSet data = new DataSet("Demo");
data.ReadXml(Server.MapPath("~/Content/Demo.xml"));
StiReport report = StiMvcDesign.GetReportObject(this.Request);
report.Dictionary.Databases.Clear();
report.RegData(data);
return StiMvcDesigner.GetReportSnapshotResult(this.Request, report);
}

2003-2013 Stimulsoft

Using MVC Designer

7.5

Exporting Reports From Preview

The report preview provides exporting reports to various formats. Menu of exports, i.e. the list of
available export formats, is called when you click the Save button on the viewer toolbar. The picture
below shows the exporting reports menu:

To export a report to the selected format, you must define a special action, which has the
recommended name ExportReport:

2003-2013 Stimulsoft

Stimulsoft Reports

ASPX:
<%= Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionExportReport = "ExportReport"
})%>

Razor:
@Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionExportReport = "ExportReport"
})

The data, sent to the controller, will be a report and information about what type of export is
requested by the designer and what the settings are set. The report can be obtained by using the
following code:
StiReport report = StiMvcDesigner.GetReportObject(this.Request);

This action must return a report prepared in the selected format:

Controller:
public FileResult ExportReport()
{
StiReport report = StiMvcDesigner.GetReportObject(this.Request);
return StiMvcDesigner.ExportReportResult(this.Request, report);
}

If you do not need to carry out any manipulation with the report sent for exporting, you can use a
simplified action code:
Controller:
public FileResult ExportReport()
{
return StiMvcDesigner.ExportReportResult(this.Request);
}

If the report requires data other than those specified in the report template, you can use the following
solution:
Controller:
public FileResult ExportReport()
{

2003-2013 Stimulsoft

Using MVC Designer

DataSet data = new DataSet("Demo");

data.ReadXml(Server.MapPath("~/Content/Demo.xml"));
StiReport report = StiMvcDesigner.GetReportObject(this.Request);
report.Dictionary.Databases.Clear();
report.RegData(data);
return StiMvcDesigner.ExportReportResult(this.Request, report);
}

7.6

Showing C#/VB.NET Report Code

If the ShowCodeTab option of the web designer is set to true, then the tab Code will appear in the
bookmarks tab. The Code helps to view C#/VB.NET code of the compiled report. To do this, you must
define a special action, which has the recommended name GetReportCode:
ASPX:
<%= Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionGetReportCode = "GetReportCode"
})%>

Razor:
@Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionGetReportCode = "GetReportCode"
})

The report, edited at the current time, will be placed in the data transmitted to the controller. The
report code can be obtained using the following method:
Controller:
public ActionResult GetReportCode()
{
return StiMvcDesigner.GetReportCode(this.Request);
}

This action will prepare a C#/VB.NET code in the required format and send it to the client for
displaying.

7.7

Changing Report Parameters Before Rendering

If it is necessary to change the report parameters or user settings in the report before rendering the

2003-2013 Stimulsoft

Stimulsoft Reports

report, for example, Report Name. To do this set the value of the ReportName property in the preview
or export. The value of this property and will be the name of the report:
Controller:
public FileResult ExportReport()
{
StiReport report = StiMvcDesigner.GetReportObject(this.Request);
report.ReportName = "Employees";
return StiMvcDesigner.ExportReportResult(this.Request, report);
}

Now, before you render the report the name will change on Employees. Thus, using this method, you
can change parameters of the report before it is rendered.

7.8

Saving Reports
For processing the saved report in the web designer two specific actions are used. They have
recommended names, respectively, SaveReportTemplate and SaveReportTemplateAs. The action
SaveReportTemplate is invoked when clicking the button Save Report on the panel Quick Access or
selecting the item Save Report of the main menu in the designer. The action SaveReportTemplateAs is
invoked when selecting the item Save As in the main menu of the designer. If the second action is not
specified in the settings of a web designer, then, by default, the built-in dialog box of the web designer
to save the report locally is invoked. If the action is specified, the dialog is not invoked. Below is an
example of the code of the report saving action SaveReportTemplate (the code of the action
SaveReportTemplateAs will be the same):
Controller:
public ActionResult SaveReportTemplate()
{
StiReport report = StiMvcDesigner.GetReportObject(this.Request);
string packedReport = report.SavePackedReportToString();
// ...
// Here the save report code
// ...
return StiMvcDesigner.SaveReportResult(false);
}

After that, the options and where to save the report are identified by the user. For example, the report
can be saved on the server in a database or a file. This action must return a response from the server
to save the report. The response may be of three types: Boolean, Integer or String. In the first case, if
the action returns false, after saving the report, no dialog boxes will be displayed in the web designer.
If the action returns true, then, when saving the web designer, a dialog box saying successful report
saving will appear:
2003-2013 Stimulsoft

Using MVC Designer

If a string value is set, then the dialog box is output indicating that there is an error with report saving
and the error text will be output:

If to set an integer value, the user is shown an error message to save a report and an error code
where the error code is the specified value. The picture below shows an example of an error message
with code 1:

Saving a report is carried out in the background, i.e. it will not be displayed visually. If you need some
way to visually control the process of report saving, change the value of the
SaveReportTemplateMode property of the web designer to one of three values: Hidden, Visible or
NewWindow:
ASPX:
<%= Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionGetReportTemplate = "GetReportTemplate",
SaveReportTemplateMode = StiMvcDesignerOptions.SaveMode.
Visible
})%>

Razor:
@Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {

2003-2013 Stimulsoft

Stimulsoft Reports

ActionGetReportTemplate = "GetReportTemplate",
SaveReportTemplateMode = StiMvcDesignerOptions.SaveMode.
Visible
})

If the SaveReportTemplateMode property is set to Visible, then the action of report saving will be
called in the current browser window in the visible mode. If the property is set to to NewWindow, then
the action of report saving will be called in a new browser window. By default, this property is set to
Hidden, this means that the action of report saving is called in the AJAX mode and will not appear in
the browser window. The same values and behavior can be applied for the
SaveReportTemplateAsMode property.
If necessary which report is saved the previously loaded or a new one that is created in the Webdesigner, you can use the following method:
Controller:
public ActionResult SaveReportTemplate()
{
StiReport report = StiMvcDesigner.GetReportObject(this.Request);
string packedReport = report.SavePackedReportToString();
string isNewReport = StiMvcDesigner.GetNewReportFlag(this.Request);
if (isNewReport)
{
// Here the save new report code
}
else
{
// Here the save edited report code
}
return StiMvcDesigner.SaveReportResult(false);
}

7.9

Localizing Web Designer

In order to localize the interface designer in the appropriate language, use special actions, that has the
recommended name GetLocalization. This action should be required to return the client side
localization file:
ASPX:
<%= Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionGetLocalization = "GetLocalization"
})%>

2003-2013 Stimulsoft

Using MVC Designer

Razor:
@Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionGetLocalization = "GetLocalization"
})

Controller:
public ActionResult GetLocalization()
{
string path = Server.MapPath("~/Content/Localization/en.xml");
return StiMvcDesigner.GetLocalizationResult(path);
}

The interface provides a web designer possibility to select localization from the available list. In order
to download the desired localization file, you can use the following method for obtaining the name of
the localization selected in the web designer:
Controller:
public ActionResult GetLocalization()
{
string path = Server.MapPath("~/Content/Localization/");
string name = StiMvcDesigner.GetLocalizationName(this.Request);
return StiMvcDesigner.GetLocalizationResult(path + name);
}

7.10 Other Actions of Web Designer

Apart from the actions described above, there are a few actions of the web designer. These are actions
DataProcessing, GoogleDocs and ExitDesigner.
ASPX:
<%= Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionDataProcessing = "DataProcessing",
ActionGoogleDocs = "GoogleDocs",
ActionExitDesigner = "ExitDesigner"
})%>

Razor:
@Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {

2003-2013 Stimulsoft

Stimulsoft Reports

ActionDataProcessing = "DataProcessing",
ActionGoogleDocs = "GoogleDocs",
ActionExitDesigner = "ExitDesigner"
})

DataProcessing
The action DataProcessing is used to process the data on the server side requested with the web
designer. These data are processing requests, related to testing of the database connection, getting
data columns, getting images for certain report components, etc. If this action is not specified, then the
above functionality is not available. This action is defined in the view controller as follows:
Controller:
public ActionResult DataProcessing()
{
return StiMvcDesigner.DataProcessingResult(this.Request);
}

GoogleDocs
With help of the action GoogleDocs you can handle requests of the web designer for working with
cloud storage Google Docs, where you can save report templates. If this action is not specified, then
this functionality of working with Google Docs will not be available. This action is defined in the view
controller as follows:
public ActionResult GoogleDocs()
{
return StiMvcDesigner.GoogleDocsResult(this.Request);
}

ExitDesigner
The action ExitDesigner is called when pressing the Exit button in the main menu of the web designer.
If this action is not specified, then when pressing this button you will be navigated to the URL address
listed in the MainMenuExitUrl property of the web designer. If this property is also not specified, then
the Exit button will be hidden. An example of using the ExitDesigner:
public ActionResult ExitDesigner()
{
return View("MainPage");
}

An example of using the MainMenuExitUrl property:

ASPX:
<%= Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionGetReportTemplate = "GetReportTemplate",

2003-2013 Stimulsoft

Using MVC Designer

ActionGetLocalization = "GetLocalization",
MainMenuExitUrl = "http://stimulsoft.com"
})%>

Razor:
@Html.Stimulsoft().StiMvcDesigner(new StiMvcDesignerOptions() {
ActionGetReportTemplate = "GetReportTemplate",
ActionGetLocalization = "GetLocalization",
MainMenuExitUrl = "http://stimulsoft.com"
})

7.11 Web Designer Settings

Setting the web designer can be done using the properties, which are described in the
StiMvcDesignerOptions class. Properties of the designer can be divided into following groups:
Actions, Connection, Dialog Box About, Toolbars, Zooming, Interface, Dictionary, Main Menu,
Miscellaneous.

7.11.1 Actions
This group includes properties that define the name of actions in the view controller, which will call the
client side report designer using the appropriate functions. The group includes the following
properties:
Name

Description

Controller

Specifies the action method name of processing queries of the web report
designer. If the property is not specified, then the current controller will be used
for processing queries.

ActionGetReport
Template

Specifies the action method name of loading a report template.

ActionSaveRepor Specify the action method name of saving a report template.

tTemplate
ActionSaveRepor
tTemplateAs
ActionGetReport
Snapshot

Specifies the action method name of preparing a rendered report for preview.

GetReportCode

Specifies the action method name of drawing C# / VB.NET report code.

2003-2013 Stimulsoft

Stimulsoft Reports

ActionExportRep Specifies the action method name of exporting a report to the required format.
ort
ActionGetLocaliz Specifies the action method name of loading localization files for the web
ation
designer.
ActionDataProce Specifies the action method name for processing data on the server side.
ssing
ActionGoogleDo
cs

Specifies the action method name for working with the Google Docs repository.

ActionExitDesig
ner

Specifies the action method name for transition to the desired representation
when closing the web designer.

7.11.2 Connection
The properties described below are responsible for connecting the client and server sides.
Name

Description

ConnectionClien
tRequestTimeou
t

Sets time (in seconds) that the client side will wait for the response from the
server side. The default value is 20 seconds.

ConnectionClien
tRepeatCount

Sets the number of repeats of requests of the server side to the client side, when
getting errors of obtaining data. The default value is 1 repeat.

ConnectionEnabl Allows enabling logging of the requests/responses, and then saving to a text log
eDataLogger
file. By default, this property is set to false, i.e. logging of the requests/
responses, and then saving to a text log file is not performed.
ConnectionShow Used if you want to display the Cancel button in the window of getting the data.
CancelButton
It can be useful if to set long waiting time of response. By default, this property is
set to false, i.e. the button is not displayed.

7.11.3 Dialog Box About

This group includes the properties responsible for displaying additional information in the dialog box
"About". This group includes the following properties:

2003-2013 Stimulsoft

Using MVC Designer

Name

Description

AboutDialogTex
tLine1

Sets an additional text information in the dialog box in the first line.

AboutDialogTex
tLine2

Sets an additional text information in the dialog box in the second line.

AboutDialogUrl

Sets an additional URL in the dialog box, which, when clicked, will be open in a
browser window.

AboutDialogUrlT Sets an additional text for the URL in the dialog box "About". If no text is
ext
specified, the URL will be displayed as a text.

7.11.4 Dictionary
This group includes the properties responsible for enabling/disabling actions with report data
dictionary. This group includes the following properties:
Name

Description

AllowModifyDict Enables/disables the creation and editing of the report data dictionary. If the
ionary
property is set to true, the creation and editing is enabled. If, it is set to false,
then editing is disabled. By default the value is set to true.
AllowModifyCon Enables/disables creating and editing of the connections in the report data
nections
dictionary. If the property is set to true, the creation and editing is enabled. If, it
is set to false, then editing is disabled. By default the value is set to true.
AllowModifyDat
aSources

Enables/disables the creating and editing data sources in the report data
dictionary. If the property is set to true, the creation and editing is enabled. If, it
is set to false, then editing is disabled. By default the value is set to true.

AllowModifyRela Enables/disables the creating and editing relations in the report data dictionary.
tions
If the property is set to true, the creation and editing is enabled. If, it is set to
false, then editing is disabled. By default the value is set to true.
AllowModifyVari Enables/disables the creating and editing variables in the report data dictionary.
ables
If the property is set to true, the creation and editing is enabled. If, it is set to
false, then editing is disabled. By default the value is set to true.
ShowConnection Shows/hides the connection type in the report data dictionary. If the property is
Type
set to true, the connection type will be shown next to its name. If the property is
set to false, only the connection name will be displayed. By default the value is
set to true.
ShowTestConnec Shows/hides the test connection button to the database in the create connection
tionButton
dialog. If the property is set to true, the button will be shown. If the property is

2003-2013 Stimulsoft

Stimulsoft Reports

set to false, the button will be hidden. By default the value is set to true.
ShowOnlyAliasF
orBusinessObjec
t

Shows an alias when displaying business objects in the data dictionary of the
web designer. If the property is set to true, only the alias will be displayed in the
data dictionary. If the property is set to false, then the name and alias, if it is
specified, are displayed in the data dictionary. By default the value is set to true.

ShowOnlyAliasF
orDatabase

Shows only an alias when displaying connections in the data dictionary of the
web designer. If the property is set to true, only the alias will be displayed in the
data dictionary. If the property is set to false, then the name and alias, if it is
specified, are displayed in the data dictionary. By default the value is set to true.

ShowOnlyAliasF
orDataSource

Shows only an alias when displaying data sources in the data dictionary of the
web designer. If the property is set to true, only the alias will be displayed in the
data dictionary. If the property is set to false, then the name and alias, if it is
specified, are displayed in the data dictionary. By default the value is set to true.

ShowOnlyAliasF
orDataRelation

Shows only an alias when displaying relations in the data dictionary of the web
designer. If the property is set to true, only the alias will be displayed in the data
dictionary. If the property is set to false, then the name and alias, if it is specified,
are displayed in the data dictionary. By default the value is set to true.

ShowOnlyAliasF
orDataColumn

Shows only an alias when displaying data columns in the data dictionary of the
web designer. If the property is set to true, only the alias will be displayed in the
data dictionary. If the property is set to false, then the name and alias, if it is
specified, are displayed in the data dictionary. By default the value is set to true.

ShowOnlyAliasF
orVariable

Shows only an alias when displaying the report variables in the data dictionary of
the web designer. If the property is set to true, only the alias will be displayed in
the data dictionary. If the property is set to false, then the name and alias, if it is
specified, are displayed in the data dictionary. By default the value is set to true.

7.11.5 Main Menu

This group includes the properties responsible for customizing the main menu. This group includes the
following properties:
Name

Description

MainMenuShowNe
w

Enables/disables the submenu item New. If the property is set to true, the
submenu item will be enabled and available to the user. If it is set to false,
then the submenu item will be visible but not available to the user. By default,
this property is set to true. The menu item New contains a submenu, which
contains items such as: New Report, New Report With Wizard, New Page. To
disable these items individually, you can use the relevant properties described
below.

MainMenuShowNe
wReport

Enables/disables the submenu item New Report. If the property is set to true,
the submenu item will be enabled and available to the user. If it is set to false,
then the submenu item will be visible but not available to the user. By default,

2003-2013 Stimulsoft

Using MVC Designer

this property is set to true.

MainMenuShowNe
wReportWithWizar
d

Enables/disables the submenu item New Report With Wizard. If the property
is set to true, the submenu item will be enabled and available to the user. If it
is set to false, then the submenu item will be visible but not available to the
user. By default, this property is set to true.

MainMenuShowNe
wPage

Enables/disables the submenu item New Page. If the property is set to true,
the submenu item will be enabled and available to the user. If it is set to false,
then the submenu item will be visible but not available to the user. By default,
this property is set to true.

MainMenuShowOp Enables/disables the submenu item Open Report from Google Docs. If the
enReportFromGoog property is set to true, the submenu item will be enabled and available to the
leDocs
user. If it is set to false, then the submenu item will be visible but not available
to the user. By default, this property is set to true.
MainMenuShowOp
enReport

Enables/disables the submenu item Open Report. If the property is set to

true, the submenu item will be enabled and available to the user. If it is set to
false, then the submenu item will be visible but not available to the user. By
default, this property is set to true.

MainMenuShowSav
eReport

Enables/disables the submenu item Save Report. If the property is set to true,
the submenu item will be enabled and available to the user. If it is set to false,
then the submenu item will be visible but not available to the user. By default,
this property is set to true.

MainMenuShowSav
eAs

Enables/disables the submenu item Save As. If the property is set to true, the
submenu item will be enabled and available to the user. If it is set to false,
then the submenu item will be visible but not available to the user. By default,
this property is set to true.

MainMenuShowSav
eAsToGoogleDocs

Enables/disables the submenu item Save Report As to Google Docs. If the

property is set to true, the submenu item will be enabled and available to the
user. If it is set to false, then the submenu item will be visible but not available
to the user. By default, this property is set to true.

MainMenuShowDel
etePage

Enables/disables the submenu item Delete Page. If the property is set to true,
the submenu item will be enabled and available to the user. If it is set to false,
then the submenu item will be visible but not available to the user. By default,
this property is set to true.

MainMenuShowPre
view

Enables/disables the submenu item Preview. If the property is set to true, the
submenu item will be enabled and available to the user. If it is set to false,
then the submenu item will be visible but not available to the user. By default,
this property is set to true. The menu item Preview contains a submenu, which
contains items such as: Preview as PDF, Preview as HTML, Preview as XPS. To
disable these items individually, you can use the relevant properties described
below.

MainMenuShowPre
viewAsPdf

Enables/disables the submenu item Preview as PDF. If the property is set to

true, the submenu item will be enabled and available to the user. If it is set to
false, then the submenu item will be visible but not available to the user. By

2003-2013 Stimulsoft

Stimulsoft Reports

default, this property is set to true.

MainMenuShowPre
viewAsHtml

Enables/disables the submenu item Preview as HTML. If the property is set to

true, the submenu item will be enabled and available to the user. If it is set to
false, then the submenu item will be visible but not available to the user. By
default, this property is set to true.

MainMenuShowPre
viewAsXps

Enables/disables the submenu item Preview as XPS. If the property is set to

true, the submenu item will be enabled and available to the user. If it is set to
false, then the submenu item will be visible but not available to the user. By
default, this property is set to true.

MainMenuShowClo
se

Enables/disables the menu item Preview as XPS. If the property is set to true,
the menu item will be enabled and available to the user. If it is set to false,
then the menu item will be visible but not available to the user. By default, this
property is set to true.

MainMenuShowExit If the property is set to true, the button will be shown in the main menu. If it is
Button
set to false, then the button will be hidden. By default, this property is set to
true.
MainMenuExitUrl

Sets the URL address, by which the transition will be made when clicking the
button Exit. If an action ActionExitDesigner is defined, then it has more
priority.

7.11.6 Toolbars
This group includes the properties responsible for customizing the toolbar. This group includes the
following properties:
Name

Description

ShowAboutButto Shows/hides the button About. If the property is set to true, then this button will
n
be displayed. If the property is set to false the button will be hidden. By default,
this property is set to true.
ShowCodeTab

Shows/hides the tab Code in the tabs panel. If the property is set to true, then
this tab will be displayed. If the property is set to false the tab will be hidden. By
default, this property is set to true.

ShowPreviewRep Shows/hides the tab Preview in the tabs panel. If the property is set to true, then
ortTab
this tab will be displayed. If the property is set to false the tab will be hidden. By
default, this property is set to true.
ShowDictionaryT Shows/hides the tab Dictionary in the properties panel. If the property is set to
ab
true, then this tab will be displayed. If the property is set to false the tab will be
hidden. By default, this property is set to true.
ShowEventsTab

Shows/hides the tab Events in the properties panel. If the property is set to true,
then this tab will be displayed. If the property is set to false the tab will be
hidden. By default, this property is set to true.

2003-2013 Stimulsoft

Using MVC Designer

7.11.7 Zooming
With this group of properties one can modify zooming options. This group is represented by the
following properties The Zoom property. Depending on the value of the property the parameters of
zooming of the report template will be applied. This property can have numeric values in the range
from 10 to 500, which correspond to the scale from 10% to 500%. Also, the property can take values
from an enumeration StiMvcDesignerOptions.ZoomMode.
Name

Description

Default

The report is shown in zoom used in the last time when the web designer was
open.

OnePage

Sets zoom by one page. So the entire page of the report template fits in the
window of the web designer.

PageWidth

Sets zoom by page width. So the width of the report template matches the width
of the web designer window.

PageHeight

Sets zoom by page height. So the height of the report template matches the
height of the web designer window.

7.11.8 Interface
With this group of properties one can modify interface options. This group is represented by the
following properties.
Name

Description

Width

Sets the width of the component. Width units are defined in the Unit class. The
following values are available: in pixels - Unit.Pixel(), in points - Unit.Point())
in per cent - Unit.Percentage().

Height

Sets the height of the component. Height units are defined in the Unit class.
The following values are available: in pixels - Unit.Pixel(), in points - Unit.
Point()) in per cent - Unit.Percentage().

7.11.9 Miscellaneous
In addition to the properties of the major groups, there are additional, which provide certain additional
features. Consider these features in more detail:
Name

2003-2013 Stimulsoft

Description

Stimulsoft Reports

AllowModifyTe
mplate

Enables/disables editing loaded report template elements. If the property is set

to true, the editing is enabled. If the property set to false, the editing is disabled.
Creating and editing new items will be allowed regardless the property value. By
default

AutoSaveInterval Sets the time interval (in minutes), through which a web designer will
automatically call the action of saving the report. If the interval is 0 minutes, the
auto save is disabled. By default the value is set to 0 minutes.
LocalizationDire
ctory

Specifies the directory (relative or absolute), which contains the interface

localization files of the web designer. This property is used to build a list of
available locations.

SaveReportTemp Manages the process of saving the report. Can take one of the three values of
lateAsMode
the enumeration StiMvcDesignerOptions.SaveMode: Hidden, Visible or
NewWindow. If the property is set to Visible, then report saving will be called in
the current browser window in the visible mode. If the property is set to
NewWindow, then the report saving will be called in a new browser window. By
default, this property is set to Hidden, that is, the action to save a report called
in the AJAX mode and will not appear in the browser window.
RunWizardAfterL Provides the ability to display the report creation wizard when you running the
oad
web designer. If the property is set to false, then, when running the web
designer, the report wizard is not displayed. If the property is set to true, then,
when you run the web designer of rendering a report, the wizard will be
displayed. By default, this property is set to false.
BrowserTitle

Used to change the browser title. This property can take string values. If the
property is not specified, the browser title is the Report Alias, and in his absence
- the name of the report (Report Name).

7.11.10 Viewer
Setting the report viewer can be done using the properties. Properties can be divided into following
groups: Toolbars, Exporting, Printing, Buttons.

7.11.10.1 Exporting

With this group of properties one can modify exporting options. This group is represented by the
following properties.
Name

Description

ViewerShowExportDi
alog

Shows/hides the exporting dialog. If the property is set to true, the dialog
will be displayed. If it is set to false, then the dialog will be hidden. By
default, this property is set to true.

ViewerShowExportTo

Shows/hides the menu item Document File. If the property is set to true, the

2003-2013 Stimulsoft

Using MVC Designer

Document

menu item will be displayed. If it is set to false, then the menu item will be
hidden. By default, this property is set to true.

ViewerShowExportTo
Pdf

Shows/hides the menu item Adobe PDF File. If the property is set to true,
the menu item will be displayed. If it is set to false, then the menu item will
be hidden. By default, this property is set to true.

ViewerShowExportTo
Xps

Shows/hides the menu item Microsoft XPS File. If the property is set to true,
the menu item will be displayed. If it is set to false, then the menu item will
be hidden. By default, this property is set to true.

ViewerShowExportTo
Ppt

Shows/hides the menu item Microsoft PowerPoint 2007/2010 File. If the

property is set to true, the menu item will be displayed. If it is set to false,
then the menu item will be hidden. By default, this property is set to true.

ViewerShowExportTo
Html

Shows/hides the menu item HMTL File. If the property is set to true, the
menu item will be displayed. If it is set to false, then the menu item will be
hidden. By default, this property is set to true.

ViewerShowExportTo
Mht

Shows/hides the menu item MHT Web Archive. If the property is set to true,
the menu item will be displayed. If it is set to false, then the menu item will
be hidden. By default, this property is set to true.

ViewerShowExportTo
Text

Shows/hides the menu item Text File. If the property is set to true, the menu
item will be displayed. If it is set to false, then the menu item will be hidden.
By default, this property is set to true.

ViewerShowExportTo
Rtf

Shows/hides the menu item Rich Text File. If the property is set to true, the
menu item will be displayed. If it is set to false, then the menu item will be
hidden. By default, this property is set to true.

ViewerShowExportTo
Word2007

Shows/hides the menu item Microsoft Word 2007/2010 File. If the property
is set to true, the menu item will be displayed. If it is set to false, then the
menu item will be hidden. By default, this property is set to true.

ViewerShowExportTo
OpenDocumentWrite
r

Shows/hides the menu item OpenDocument Writer File. If the property is set
to true, the menu item will be displayed. If it is set to false, then the menu
item will be hidden. By default, this property is set to true.

ViewerShowExportTo
Excel

Shows/hides the menu item Microsoft Excel File. If the property is set to
true, the menu item will be displayed. If it is set to false, then the menu item
will be hidden. By default, this property is set to true.

ViewerShowExportTo
ExcelXml

Shows/hides the menu item Microsoft Excel Xml File. If the property is set to
true, the menu item will be displayed. If it is set to false, then the menu item
will be hidden. By default, this property is set to true.

ViewerShowExportTo
Excel2007

Shows/hides the menu item Microsoft Excel 2007/2010 File. If the property
is set to true, the menu item will be displayed. If it is set to false, then the
menu item will be hidden. By default, this property is set to true.

ViewerShowExportTo
OpenDocumentCalc

Shows/hides the menu item OpenDocument Calc File. If the property is set
to true, the menu item will be displayed. If it is set to false, then the menu
item will be hidden. By default, this property is set to true.

2003-2013 Stimulsoft

Stimulsoft Reports

ViewerShowExportTo
Csv

Shows/hides the menu item CSV File. If the property is set to true, the menu
item will be displayed. If it is set to false, then the menu item will be hidden.
By default, this property is set to true.

ViewerShowExportTo
Dbf

Shows/hides the menu item DBF File. If the property is set to true, the menu
item will be displayed. If it is set to false, then the menu item will be hidden.
By default, this property is set to true.

ViewerShowExportTo
Xml

Shows/hides the menu item XML File. If the property is set to true, the menu
item will be displayed. If it is set to false, then the menu item will be hidden.
By default, this property is set to true.

ViewerShowExportTo
Dif

Shows/hides the menu item Data Interchange Format (DIF) File. If the
property is set to true, the menu item will be displayed. If it is set to false,
then the menu item will be hidden. By default, this property is set to true.

ViewerShowExportTo
Sylk

Shows/hides the menu item Symbolic Link (SYLK) File. If the property is set
to true, the menu item will be displayed. If it is set to false, then the menu
item will be hidden. By default, this property is set to true.

ViewerShowExportTo
Bmp

Shows/hides the menu item BMP Image. If the property is set to true, the
menu item will be displayed. If it is set to false, then the menu item will be
hidden. By default, this property is set to true.

ViewerShowExportTo
Gif

Shows/hides the menu item GIF Image. If the property is set to true, the
menu item will be displayed. If it is set to false, then the menu item will be
hidden. By default, this property is set to true.

ViewerShowExportTo
Jpeg

Shows/hides the menu item JPEG Image. If the property is set to true, the
menu item will be displayed. If it is set to false, then the menu item will be
hidden. By default, this property is set to true.

ViewerShowExportTo
Pcx

Shows/hides the menu item PCX Image. If the property is set to true, the
menu item will be displayed. If it is set to false, then the menu item will be
hidden. By default, this property is set to true.

ViewerShowExportTo
Png

Shows/hides the menu item PNG Image. If the property is set to true, the
menu item will be displayed. If it is set to false, then the menu item will be
hidden. By default, this property is set to true.

ViewerShowExportTo
Tiff

Shows/hides the menu item TIFF Image. If the property is set to true, the
menu item will be displayed. If it is set to false, then the menu item will be
hidden. By default, this property is set to true.

ViewerShowExportTo
Metafile

Shows/hides the menu item Windows Metafile. If the property is set to true,
the menu item will be displayed. If it is set to false, then the menu item will
be hidden. By default, this property is set to true.

ViewerShowExportTo
Svg

Shows/hides the menu item Scalable Vector Graphics (SVG) File. If the
property is set to true, the menu item will be displayed. If it is set to false,
then the menu item will be hidden. By default, this property is set to true.

ViewerShowExportTo
Svgz

Shows/hides the menu item Compressed SVG (SVGZ) File. If the property is
set to true, the menu item will be displayed. If it is set to false, then the

2003-2013 Stimulsoft

Using MVC Designer

menu item will be hidden. By default, this property is set to true.

7.11.10.2 Printing

With this group of properties one can modify printing options. This group is represented by the
following properties.
Name

Description

PrintAutoPageOrient
ation

Enables/disables the automatic page orientation when printing on paper. If

the property is set to true, the automatic page orientation will be enabled. If
it is set to false, then the automatic page orientation will be disabled. By
default, this property is set to true.

PrintAllowToPdf

Shows/hides the menu item Print to PDF in the report printing dialog box. If
the property is set to true, the menu item will be displayed. If it is set to
false, then the menu item will be hidden. By default, this property is set to
true.

PrintAllowToHtml

Shows/hides the menu item Print to HTML in the report printing dialog box.
If the property is set to true, the menu item will be displayed. If it is set to
false, then the menu item will be hidden. By default, this property is set to
true.

7.11.10.3 Toolbars

This group includes properties that shows or hides the report viewer toolbars.
Name

Description

ViewerShowTool Shows/hides the main toolbar of the report viewer. If the property is set to true,
barMain
the toolbar will be displayed. If the property is set to false, the toolbar will be
hidden. By default, this property is set to true.
ViewerShowTool Shows/hides the navigation toolbar of the report viewer. If the property is set to
barNavigate
true, the toolbar will be displayed. If the property is set to false, the toolbar will
be hidden. By default, this property is set to true.
ViewerShowTool Shows/hides the toolbar of the report viewer where one can choose the mode of
barViewMode
viewing reports. If the property is set to true, the toolbar will be displayed. If the
property is set to false, the toolbar will be hidden. By default, this property is set
to true.

7.11.10.4 Buttons

This group includes the properties which show or hide the appropriate buttons on the report viewer
2003-2013 Stimulsoft

Stimulsoft Reports

toolbars:
Name

Description

ViewerShowButtonPrin Shows/hides the Print button on the toolbar. If the property is set to true,
t
the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.
ViewerShowButtonOpe Shows/hides the Open button on the toolbar. If the property is set to true,
n
the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.
ViewerShowButtonSav
e

Shows/hides the Save button on the toolbar. If the property is set to true,
the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ViewerShowButtonBoo
kmarks

Shows/hides the Bookmarks button on the toolbar. If the property is set to

true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ViewerShowButtonPara Shows/hides the Parameters button on the toolbar. If the property is set
meters
to true, the button will be displayed. If it is set to false, then the button will
be hidden. By default, this property is set to true.
ViewerShowPanelPara
meters

Shows/hides the Parameters panel on the toolbar. If the property is set to

true, the panel will be displayed. If it is set to false, then the panel will be
hidden. By default, this property is set to true.

ViewerShowButtonThu
mbnails

Shows/hides the Thumbnails button on the toolbar. If the property is set

to true, the button will be displayed. If it is set to false, then the button will
be hidden. By default, this property is set to true.

ViewerShowButtonFind Shows/hides the Find button on the toolbar. If the property is set to true,
the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.
ViewerShowButtonFull
Screen

Shows/hides the FullScreen button on the toolbar. If the property is set to

true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ViewerShowButtonFirst Shows/hides the FirstPage button on the toolbar. If the property is set to
Page
true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.
ViewerShowButtonPrev Shows/hides the PreviousPage button on the toolbar. If the property is set
iousPage
to true, the button will be displayed. If it is set to false, then the button will
be hidden. By default, this property is set to true.
ViewerShowButtonGoT
oPage

Shows/hides the GoToPage button on the toolbar. If the property is set to

true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ViewerShowButtonNex
tPage

Shows/hides the NextPage button on the toolbar. If the property is set to

true, the button will be displayed. If it is set to false, then the button will be

2003-2013 Stimulsoft

Using MVC Designer

hidden. By default, this property is set to true.

ViewerShowButtonLast Shows/hides the LastPage button on the toolbar. If the property is set to
Page
true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.
ViewerShowButtonPag
eViewModeSingle

Shows/hides the SinglePage button on the toolbar. If the property is set to

true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ViewerShowButtonPag Shows/hides the Continuous button on the toolbar. If the property is set
eViewModeContinuous to true, the button will be displayed. If it is set to false, then the button will
be hidden. By default, this property is set to true.
ViewerShowButtonPag
eViewModeMultiple

Shows/hides the MultiplePages button on the toolbar. If the property is

set to true, the button will be displayed. If it is set to false, then the button
will be hidden. By default, this property is set to true.

Using MVC Viewer

The StiMvcViewer component is designed to view reports in the web browser. You do not need to
install .NET Framework, ActiveX components or other special plug-ins on the client side. All you need is
a web browser. With StiMvcViewer one can view, print, and export reports on any computer with any
operating system. Since StiMvcViewer uses only HTML and Javascript, it can be run on devices that do
not support Flash or Silverlight - tablet PC's, smartphones. The StiMvcViewer component uses AJAX
for executing all actions (loading reports, scrolling pages, zooming etc.), that allows you to get rid of
reloading the whole page and saves web traffic. StiMvcViewer supports theming and beautiful menu
with animation.

8.1

How It Works?
To run the viewer you need to place the StiMvcViewer component on the ASP.NET page. Set the
necessary properties to the StiMvcViewer component, and, in the view controller, define the necessary
actions. The following steps occur when running the viewer:
The .NET component stores the report in the cache or server session and generates the HTML code
of the viewer.
When the viewer components are output, the Javascript is running. It requests one report page or
the entire report (depending on the selected mode) on the server side.
When exporting or printing, the report viewer calls the action that must return to a definite answer.

8.2

Showing Reports
To run the report viewer it is necessary on main master-page of the application to place a code for
adding java-scripts, which are required for the component. This code is placed in the container
<head>:

2003-2013 Stimulsoft

Stimulsoft Reports

ASPX:
<head runat="server">
<%= Html.Stimulsoft().RenderMvcViewerScripts() %>
</head>

Razor:
<head runat="server">
@Html.Stimulsoft().RenderMvcViewerScripts()
</head>

To display reports place the StiMvcViewer component on the ASP.NET page and set necessary
properties to that component, and define the necessary steps in the view controller:
ASPX:
<%= Html.Stimulsoft().StiMvcViewer(
"MvcViewer1",
new StiMvcViewerOptions() {
ActionGetReportSnapshot = "GetReportSnapshot",
ActionViewerEvent = "ViewerEvent",
Width = Unit.Percentage(100)
})%>

Razor:
@Html.Stimulsoft().StiMvcViewer(
"MvcViewer1",
new StiMvcViewerOptions() {
ActionGetReportSnapshot = "GetReportSnapshot",
ActionViewerEvent = "ViewerEvent",
Width = Unit.Percentage(100)
})

Controller:
public ActionResult GerReportSnapshot()
{
StiReport report = new StiReport();
report.Load(Server.MapPath("~/Content/SimpleList.mdc"));
return StiMvcViewer.GetReportSnapshotResult(this.HttpContext,
report);
}
public ActionResult ViewerEvent()

2003-2013 Stimulsoft

Using MVC Viewer

{
return StiMvcViewer.ViewerEventResult(this.HttpContext);
}

If the report has not been built before it is displayed, the StiMvcViewer component renders it
automatically. Thus, for displaying reports, it is allowed using report templates and reports as classes:
Controller:
public ActionResult GetReportSnapshot()
{
StiReport report = new StiReport();
report.Load(Server.MapPath("~/Content/SimpleList.mdc"));
return StiMvcViewer.GetReportSnapshotResult(this.HttpContext,
report);
}

Controller:
public ActionResult GetReportSnapshot()
{
StiReport report = new StiReportCompiledClass();
return StiMvcViewer.GetReportSnapshotResult(this.HttpContext,
report);
}

8.3

Localizing Component
In order to localize the interface of the report viewer a special Localization property is used. The value
of this property should point to the localization XML-file (relative or absolute):
ASPX:
<%= Html.Stimulsoft().StiMvcViewer(new StiMvcViewerFxOptions() {
Localization = " ~/Content/Localization/en.xml"
})%>

Razor:
@Html.Stimulsoft().StiMvcViewerFx(new StiMvcViewerFxOptions() {
Localization = " ~/Content/Localization/en.xml"
})

2003-2013 Stimulsoft

8.4

Stimulsoft Reports

Using Themes
The StiMvcViewer component has the ability to change the theme of visual controls. To change the
theme the Theme property is used, which can take one of the enumeration values StiTheme. The
property value is specified in a moment of generating scripts and viewer styles:
ASPX:
<%= Html.Stimulsoft().StiMvcViewer(new StiMvcViewerFxOptions() {
Theme = StiTheme.Office2010
})%>

Razor:
@Html.Stimulsoft().StiMvcViewerFx(new StiMvcViewerFxOptions() {
Theme = StiTheme.Office2010
})

Currently the following themes are available:

Standard theme (Default):

Office2003:

2003-2013 Stimulsoft

Using MVC Viewer

Offile2007 (black, blue, silver):

Offile2010:

2003-2013 Stimulsoft

Stimulsoft Reports

WindowsXP:

2003-2013 Stimulsoft

Using MVC Viewer

Windows7:

Additionally, the possibility to specify the font (the ToolbarFontFamily property) and the font color
(the ToolbarFontColor property) toolbar, as well as the toolbar color for the Default theme (the
ToolbarBackgroundColor property).

8.5

Using Basic Features

The main features of the report viewer are: switching between report pages, report zooming,
displaying modes of reports. All these operations are performed in the AJAX-mode without restarting
the browser page. For correct work of the operations it is necessary to define a specific action,
ActionViewerEvent:
ASPX:
<%= Html.Stimulsoft().StiMvcViewer(
"MvcViewer1",
new StiMvcViewerOptions() {
ActionViewerEvent = "ViewerEvent"
})%>

Razor:

2003-2013 Stimulsoft

Stimulsoft Reports

@Html.Stimulsoft().StiMvcViewer(
"MvcViewer1",
new StiMvcViewerOptions() {
ActionViewerEvent = "ViewerEvent"
})

Controller:
public ActionResult ViewerEvent()
{
return StiMvcViewer.ViewerEventResult(this.HttpContext);
}

This action returns the HTML report page (or a set of HTML pages), rendered with the new settings
on the viewer panel.

8.6

Printing
Print to PDF
Printing will be done by exporting the report to the PDF format. The advantages include more accurate
location and printing of report components compared to other printing options. Disadvantages required installed browser plug-in to view the PDF.
Print with Preview
Print a report will be made in the pop-up separate browser window. The report can be viewed and, if
necessary, send to a printer or copy to another location as a text or HTML code.
Print without Preview
Print a report will be made directly to the printer without preview. After selecting this menu item, a
printing dialog box is shown.
Important: It is necessary to make sure in correspondence of report page settings and page setup
of your printer (paper size, margins, padding), and check the browser print settings.
To work correctly of the printing function it is necessary to define a special action ActionPrintReport:
ASPX:
<%= Html.Stimulsoft().StiMvcViewer(
"MvcViewer1",
new StiMvcViewerOptions() {
ActionPrintReport = "PrintReport"
})%>

Razor:

2003-2013 Stimulsoft

Using MVC Viewer

@Html.Stimulsoft().StiMvcViewer(
"MvcViewer1",
new StiMvcViewerOptions() {
ActionPrintReport = "PrintReport"
})

Controller:
public ActionResult PrintReport()
{
return StiMvcViewer.PrintReportResult(this.HttpContext);
}

8.7

Viewing Modes
The StiMvcViewer component has two modes of displaying reports: with scrollbars and without
scrollbars. The ScrollbarsMode option operates this and can take values True or False. In the first
mode without scrollbars (which is set by default), the viewer displays the page or the entire report,
automatically stretching the viewing area. If you set the size by width and height, the viewer cuts the
page that goes out of bounds. In the second mode, in contrast to the first, with the event page for the
border size viewer crop will fail. Instead, the scroll bar appears, using what you can view the page or
the entire report. This mode is useful when you need a compact viewer on a web page, while not
limiting the viewing area of the report:

2003-2013 Stimulsoft

8.8

Stimulsoft Reports

Using Parameters
A special Parameters panel is implemented for working with report parameters in MvcViewer. To add
a parameter to the panel you need, in a report, to define a variable requested by the user. When
previewing a report in the viewer such a variable will be automatically added to the Parameters panel.
It supports all types of report variables (normal variables, date and time, borders, lists, and so on). To
work correctly with parameters you need to define the specific action ActionInteraction:
ASPX:
<%= Html.Stimulsoft().StiMvcViewer(
"MvcViewer1",
new StiMvcViewerOptions() {
ActionInteraction = "Interaction"
})%>

Razor:
@Html.Stimulsoft().StiMvcViewer(
"MvcViewer1",
new StiMvcViewerOptions() {
ActionInteraction = "Interaction"
})

Controller:
public ActionResult Interaction()
{
return StiMvcViewer.InteractionResult(this.HttpContext);
}

If the specified event is not defined, the parameters panel will not be displayed even if the variables,
requested by the user, are present in the report.

8.9

Viewer Settings
Setting the StiMvcViewer is performed with properties that are in the StiMvcViewerOptions class.
Properties of this class can be divided into the following categories: Action, Working with the server,
Interface, Toolbar, Buttons, Export. Consider these groups in more detail.

8.9.1

Actions
This group includes properties that define the names of actions in the view controller, which will cause
the client side report viewer using the appropriate functions.

2003-2013 Stimulsoft

Using MVC Viewer

Name

8.9.2

Description

Controller

Defines the name of the controller of processing queries of the report

viewer. If not defined, then the query will return to the current controller.

ActionGetReportSnapsh
ot

Specifies the name of the method of preparing a rendered report. If the

report caching is enabled, this action will be invoked only once when
loading a web page.

ActionViewerEvent

Specifies the name of the action method of the viewer events, such as
flipping through the report pages, selecting zoom, changing the display
mode of pages.

ActionPrintReport

Specifies the name of the action method of the report print.

ActionExportReport

Specifies the name of the action method of exporting the report to the
desired format.

ActionDesignReport

Specifies the name of the action method to navigate to the required

representation by pressing the Design button of the report viewer.

Connection
This group includes the properties that are responsible for the connecting parameters of the client and
server sides.
Name

Description

ServerTimeout

Sets time that the server will store a rendered report since the last
viewer action, by default it is set to 10 minutes.

ServerCacheAsObject

Sets the mode of saving the report as an object in the server cache.
It is enabled by default.

ServerCacheMode

Sets the mode of report caching. Can accept one of three values:
StiCacheMode.None caching is disabled, the report will be
loaded each time anew, using the ActionGetReportSnapshot
action.
StiCacheMode.Page as a storage the cache server is used
(the default value).
StiCacheMode.Session as a storage the session is used.

ServerCacheItemPriority

Provides the ability to set the priority of stored in the cache report
server. This property affects the automatic cleaning of the server's
memory in the event of its shortage. The lower the priority is, the
greater is a chance of removing information from memory.

2003-2013 Stimulsoft

8.9.3

Stimulsoft Reports

Toolbar
This group includes properties that affect displaying the toolbar and its elements:
Name

8.9.4

Description

ToolbarVisible

Shows/hides the toolbar of the report viewer. By default, the

toolbar is enabled.

ToolbarAlignment

Provides the ability to specify the alignment of controls on the

toolbar. Can take the following values:
StiContentAlignment.Default the layout will depend on
the value of the RightToLeft property (the default value).
StiContentAlignment.Left items will be docked to the left
edge.
StiContentAlignment.Center items will be placed in the
center of the panel.
StiContentAlignment.Right items will be docked to the
right edge.

ToolbarButtonCaptions

Shows/hides the toolbar buttons text in the report viewer. By

default the text for buttons is hidden.

ToolbarMenuCaptions

Shows/hides the toolbar menu text of the report viewer. By

default, the menu text is displayed.

ShowCurrentPageControl

Shows/hides the page controls of the report viewer. By default,

the property is shown.

Buttons
This group includes properties that provide the possibility to show or hide the appropriate buttons on
the report viewer toolbar:
Name

Description

ShowButtonPrint

Shows/hides the button Print. True - button is shown, false the button is hidden.

ShowButtonSave

Shows/hides the button Save. True - button is shown, false the button is hidden.

ShowButtonBookmarks

Shows/hides the button Bookmarks. True - button is shown,

false - the button is hidden.

ShowButtonFirstPage

Shows/hides the button First Page. True - button is shown,

false - the button is hidden.

ShowButtonPreviousPage

Shows/hides the button Previous Page. True - button is

shown, false - the button is hidden.

2003-2013 Stimulsoft

Using MVC Viewer

8.9.5

ShowButtonNextPage

Shows/hides the button Next Page. True - button is shown,

false - the button is hidden.

ShowButtonLastPage

Shows/hides the button Last Page. True - button is shown,

false - the button is hidden.

ShowButtonZoom

Shows/hides the button Zoom. True - button is shown, false the button is hidden.

ShowButtonViewMode

Shows/hides the button View Mode. True - button is shown,

false - the button is hidden.

ShowButtonDesign

Shows/hides the button Design. True - button is shown, false the button is hidden.

Exporting Reports
With this group of properties, you can configure the menu to exporting reports.
Name

Description

ShowExportDialog

Shows/hides the Export Options dialog boxes. If the dialog

boxes are disabled, exporting with default settings will occur.
Enabled by default.

ShowExportToDocument

Shows/hides the item Document File. True - the item is shown,

false - the item is hidden.

ShowExportToPdf

Shows/hides the item Adobe PDF File. True - the item is shown,
false - the item is hidden.

ShowExportToXps

Shows/hides the item Microsoft XPS File. True - the item is

shown, false - the item is hidden.

ShowExportToPowerPoint

Shows/hides the item Microsoft PowerPoint 2007/2010 File. True

- the item is shown, false - the item is hidden.

ShowExportToHtml

Shows/hides the item HMTL File. True - the item is shown, false the item is hidden.

ShowExportToHtml5

Shows/hides the item HMTL5 File. True - the item is shown, false
- the item is hidden.

ShowExportToMht

Shows/hides the item MHT Web Archive. True - the item is

shown, false - the item is hidden.

ShowExportToText

Shows/hides the item Text File. True - the item is shown, false the item is hidden.

ShowExportToRtf

Shows/hides the item Rich Text File. True - the item is shown,
false - the item is hidden.

ShowExportToWord2007

Shows/hides the item Microsoft Word 2007/2010 File. True - the

2003-2013 Stimulsoft

Stimulsoft Reports

item is shown, false - the item is hidden.

ShowExportToOpenDocument
Writer

Shows/hides the item OpenDocument Writer File. True - the item

is shown, false - the item is hidden.

ShowExportToExcel

Shows/hides the item Microsoft Excel File. True - the item is

shown, false - the item is hidden.

ShowExportToExcelXml

Shows/hides the item Microsoft Excel Xml File. True - the item is
shown, false - the item is hidden.

ShowExportToExcel2007

Shows/hides the item Microsoft Excel 2007/2010 File. True - the

item is shown, false - the item is hidden.

ShowExportToOpenDocumentC
alc

Shows/hides the item OpenDocument Calc File. True - the item is

shown, false - the item is hidden.

ShowExportToCsv

Shows/hides the item CSV File. True - the item is shown, false the item is hidden.

ShowExportToDbf

Shows/hides the item DBF File. True - the item is shown, false the item is hidden.

ShowExportToXml

Shows/hides the item XML File. True - the item is shown, false the item is hidden.

ShowExportToDif

Shows/hides the item Data Interchange Format (DIF) File. True the item is shown, false - the item is hidden.

ShowExportToSylk

Shows/hides the item Symbolic Link (SYLK) File. True - the item is
shown, false - the item is hidden.

ShowExportToImageBmp

Shows/hides the item BMP Image. True - the item is shown, false
- the item is hidden.

ShowExportToImageGif

Shows/hides the item GIF Image. True - the item is shown, false the item is hidden.

ShowExportToImageJpeg

Shows/hides the item JPEG Image. True - the item is shown, false
- the item is hidden.

ShowExportToImagePcx

Shows/hides the item PCX Image. True - the item is shown, false the item is hidden.

ShowExportToImagePng

Shows/hides the item PNG Image. True - the item is shown, false
- the item is hidden.

ShowExportToImageTiff

Shows/hides the item TIFF Image. True - the item is shown, false the item is hidden.

ShowExportToImageMetafile

Shows/hides the item Windows Metafile. True - the item is

shown, false - the item is hidden.

ShowExportToImageSvg

Shows/hides the item Scalable Vector Graphics (SVG) File. True the item is shown, false - the item is hidden.

ShowExportToImageSvgz

Shows/hides the item Compressed SVG (SVGZ) File. True - the

2003-2013 Stimulsoft

Using MVC Viewer

item is shown, false - the item is hidden.

8.9.6

Interface
This group includes properties represents the report viewer and its elements.
Name

Description

Theme

Provides the ability to change the viewer theme. The list of available
themes is in the StiTheme class.

ToolbarFontFamily

Provides the ability to change the font for the toolbar and menu.

ToolbarFontColor

Provides the ability to change the color of the toolbar and menu.

ToolbarBackgroundCol Provides the ability to change the color of the toolbar. Applicable only for
or
the Default theme.
Width

Specifies the width of the component in the required units, which are
defined in the Unit class. Available setting of values in pixels - Unit.Pixel(),
points - Unit.Point(), and per cent - Unit.Percentage().

Height

Specifies the height of the component in expected units, which are defined
in the Unit class. Available setting of values in pixels - Unit.Pixel(), in points
- Unit.Point(), and per cent - Unit.Percentage().

Localization

Specifies the path to the localization XML file. The path can be as an
absolute or relative.

RightToLeft

Sets the mode of displaying Right to Left the controls of the report viewer.
By default it is disabled.

ScrollbarsMode

Specifies whether the report is displayed without scrollbars or with them.

By default it is disabled.

MenuAnimation

Provides the ability to disable the animation when showing/hiding the

menu of the report viewer. Enabled by default.

MenuShowMode

Sets the menu displaying. Can take the following values:

StiShowMenuMode.Click - mapping by mouse click (it is set by
default).
StiShowMenuMode.Hover - mapping on mouseover.

MenuPrintDestination

Sets the report printing. It can take one of the following:

StiPrintDestination.Default - the menu will be displayed by providing
select the print mode (the default value).
StiPrintDestination.Pdf - printing is done via PDF.
StiPrintDestination.Direct - printing will be done directly to the printer,
the system will display a system print dialog.
StiPrintDestination.PopupWindow - printing will be done through a

2003-2013 Stimulsoft

Stimulsoft Reports

pop-up window to preview the report.

MenuViewMode

Sets the displaying mode of report pages. It can take one of the following
values:
StiWebViewMode.OnePage - shows one report page, the selected
toolbar of the report viewer (the default value).
StiWebViewMode.WholeReport - displayed at once all report pages.

MenuZoom

Provides the ability to set the display scale of the report pages.

PageAlignment

Specifies the position of a report page in the report viewer. Can take the
following values:
StiContentAlignment.Left - the page will be docked to the left edge.
StiContentAlignment.Center - the page will be centered (the default
value).
StiContentAlignment.Right - the page will be docked to the right
edge.

PageShowShadow

Provides the ability to hide the shadow of report pages. By default, the
shadow is enabled.

PageBorderColor

Provides ability to set the border color of the report page. The default
color is Color.Gray. You can select any color value. If to set the value Color.
Transparent, the borders of the report page will be displayed.

BookmarksVisible

Provides the ability to disable report tabs, even if they present in the
report. By default the property is enabled.

BookmarksPrint

Provides the ability to print the report tabs on the printer (in addition to
the report). By default, the property is disabled.

BookmarksTreeWidth

Provides the ability to set the width in pixels of the bookmarks bar. By
default the width is 180 pixels.

Using MVC ViewerFx

The StiMvcViewerFx component is used to edit reports in the window of a browser. And there is no
need to install the .NET Framework, ActiveX components and other special plug-ins on the client
machine. The only requirements are a web browser and the Flash player. Using StiMvcViewerFx it is
possible to create, edit, save, view, and print reports on any computer, on any OS, where there is an
internet connection, and where there is the installed web browser and Flash Player 10.2 and higher.
The StiMvcViewerFx component can be divided in two parts: client and server. The client side is the
graphic wrapping of the designer that is realized on Flex. The server side is the report generator
engine and, also, a module that has functions to get queries and send data on the client side. These
two parts are collected into one DLL library and represented as a non visual ASP.NET MVC
component.

2003-2013 Stimulsoft

Using MVC ViewerFx

9.1

How It Works?
To run the web reports designer, it is required to put the StiMvcViewerFx component on the ASP.NET
page, set the required properties, and define necessary actions in the view controller. When running
the report viewer the following actions occur:
The .NET component reads to the memory the client Flash application from resources and runs it.
When it is loaded, the client side requests a report that should be returned by action set and
defined in the controller settings.
When exporting a report, the client side calls an action, which also must return the specific response.

9.2

How to Show Report?

To run the report viewer on the main master-page of the application you need to place a code of
adding java-scripts, which are required for the component work properly. This code is placed in the
block <head>:
ASPX:
<head runat="server">
<%= Html.Stimulsoft().RenderMvcViewerFxScripts() %>
</head>

Razor:
<head runat="server">
@Html.Stimulsoft().RenderMvcViewerFxScripts()
</head>

To view the report you should add the StiMvcViewerFx component to an ASP.NET page, and set it the
necessary properties, and in the view controller, to determine the necessary steps:
ASPX:
<%= Html.Stimulsoft().StiMvcViewerFx(new StiMvcViewerFxOptions() {
ActionGetReportSnapshot = "GetReportSnapshot",
Width = Unit.Pixel(600),
Height = Unit.Pixel(480)
})%>

Razor:
@Html.Stimulsoft().StiMvcViewerFx(new StiMvcViewerFxOptions() {
ActionGetReportSnapshot = "GetReportSnapshot",
Width = Unit.Pixel(600),
Height = Unit.Pixel(480)
})

2003-2013 Stimulsoft

Stimulsoft Reports

Controller:
public ActionResult GetReportSnapshot()
{
StiReport report = new StiReport();
report.Load(Server.MapPath("~/Content/SimpleList.mdc"));
return StiMvcViewerFx.GetReportSnapshotResult(report);
}

If the report was not rendered before showing, then the StiMvcViewerFx component renders it
automatically. Thus, to display the report it is allowed to use report templates and reports as classes:
Controller:
public ActionResult GetReportSnapshot()
{
StiReport report = new StiReport();
report.Load(Server.MapPath("~/Content/SimpleList.mdc"));
return StiMvcViewerFx.GetReportSnapshotResult(report);
}

Controller:
public ActionResult GetReportSnapshot()
{
StiReport report = new StiReportCompiledClass();
return StiMvcViewerFx.GetReportSnapshotResult(report);
}

9.3

Localizing Component
In order to localize the interface of the report viewer in the language you need, use the special
operation, that has the recommended name GetLocalization. This operation must return the required
localization file to the client side:
ASPX:
2003-2013 Stimulsoft

Using MVC ViewerFx

<%= Html.Stimulsoft().StiMvcViewerFx(new StiMvcViewerFxOptions() {

ActionGetLocalization = "GetLocalization"
})%>

Razor:
@Html.Stimulsoft().StiMvcViewerFx(new StiMvcViewerFxOptions() {
ActionGetLocalization = "GetLocalization"
})

Controller:
public ActionResult GetLocalization()
{
string path = Server.MapPath("~/Content/Localization/en.xml");
return StiMvcViewerFx.GetLocalizationResult(path);
}

9.4

Using Themes
In the StiMvcViewerFx component you may change the theme of visual controls. The Theme property
is used to change the theme. The property can take one of the enumeration values of
StiMvcViewerFxOptions.Themes. Currently the following themes are available:
Blue

2003-2013 Stimulsoft

Stimulsoft Reports

Silver

Black

2003-2013 Stimulsoft

Using MVC ViewerFx

9.5

Viewer Settings
Setting the StiMvcViewerFx component can be done using the properties, which are described in the
StiMvcViewerFxOptions class. Properties of StiMvcViewerFx can be divided into following groups:
Actions, Connection, Dialog Box About, Toolbars, Buttons, Zooming, Exporting, Printing, Interface.

9.5.1

Actions
This group includes properties that define the name of actions in the view controller, which will call the
client side report viewer using the appropriate functions. The group includes the following properties:
Name
Controller

Description
Defines a name of the query processing controller of the report viewer. If the
property is not specified, then the current controller will be used for processing
queries.

ActionGetRep Defines the action method name of preparing the rendered report.
ortSnapshot
ActionGetLoc Defines the action method name of loading a localization file for a web designer.
alization
ActionExport

2003-2013 Stimulsoft

Defines the action method name of exporting a report to the required format.

Stimulsoft Reports

Report
ActionExitVie Defines the name of the action method for transition to the desired view when
wer
exiting the report viewer.

9.5.2

Connection
The properties described below are responsible for connecting the client and server sides.
Name

Description

ConnectionClien
tRequestTimeou
t

Sets time (in seconds) that the client side will wait for the response from the
server side. The default value is 20 seconds.

ConnectionClien
tRepeatCount

Sets the number of repeats of requests of the server side to the client side, when
getting errors of obtaining data. The default value is 1 repeat.

9.5.3

Dialog Box About

This group includes the properties responsible for displaying additional information in the dialog box
"About". This group includes the following properties:
Name

Description

AboutDialogTex
tLine1

Sets an additional text information in the dialog box in the first line.

AboutDialogTex
tLine2

Sets an additional text information in the dialog box in the second line.

AboutDialogUrl

Sets an additional URL in the dialog box, which, when clicked, will be open in a
browser window.

2003-2013 Stimulsoft

Using MVC ViewerFx

AboutDialogUrlT Sets an additional text for the URL in the dialog box "About". If no text is
ext
specified, the URL will be displayed as a text.

9.5.4

Toolbars
This group includes properties that shows or hides the report viewer toolbars.
Name

Description

ShowToolbarMai
n

Shows/hides the main toolbar of the report viewer. If the property is set to true,
the toolbar will be displayed. If the property is set to false, the toolbar will be
hidden. By default, this property is set to true.

ShowToolbarNavi Shows/hides the navigation toolbar of the report viewer. If the property is set to
gate
true, the toolbar will be displayed. If the property is set to false, the toolbar will
be hidden. By default, this property is set to true.
ShowToolbarView Shows/hides the toolbar of the report viewer where one can choose the mode
Mode
of viewing reports. If the property is set to true, the toolbar will be displayed. If
the property is set to false, the toolbar will be hidden. By default, this property
is set to true.

9.5.5

Buttons
This group includes the properties which show or hide the appropriate buttons on the report viewer
toolbars:
Name

Description

ShowButtonPrint

Shows/hides the Print button on the toolbar. If the property is set to true,
the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ShowButtonOpen

Shows/hides the Open button on the toolbar. If the property is set to true,
the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ShowButtonSave

ShowButtonBookmark
s

Shows/hides the Bookmarks button on the toolbar. If the property is set to

true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ShowButtonParameter Shows/hides the Parameters button on the toolbar. If the property is set to

2003-2013 Stimulsoft

Stimulsoft Reports

true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ShowPanelParameters

Shows/hides the Parameters panel on the toolbar. If the property is set to

true, the panel will be displayed. If it is set to false, then the panel will be
hidden. By default, this property is set to true.

ShowButtonThumbnai
ls

Shows/hides the Thumbnails button on the toolbar. If the property is set to

true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ShowButtonFind

Shows/hides the Find button on the toolbar. If the property is set to true,
the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ShowButtonFullScreen

Shows/hides the FullScreen button on the toolbar. If the property is set to

true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ShowButtonExit

Shows/hides the Exit button. If the property is set to true, then the button
will be displayed. If it is set to false the button will be hidden. By default,
this property is set to true.

ShowButtonAbout

Shows/hides the About button. If the property is set to true, then the
button will be displayed. If it is set to false the button will be hidden. By
default, this property is set to true.

ShowButtonFirstPage

Shows/hides the FirstPage button on the toolbar. If the property is set to

true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ShowButtonPreviousP
age

Shows/hides the PreviousPage button on the toolbar. If the property is set

to true, the button will be displayed. If it is set to false, then the button will
be hidden. By default, this property is set to true.

ShowButtonGoToPage

Shows/hides the GoToPage button on the toolbar. If the property is set to

true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ShowButtonNextPage

Shows/hides the NextPage button on the toolbar. If the property is set to

true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ShowButtonLastPage

Shows/hides the LastPage button on the toolbar. If the property is set to

true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ShowButtonPageView
ModeSingle

Shows/hides the SinglePage button on the toolbar. If the property is set to

true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

ShowButtonPageView
ModeContinuous

Shows/hides the Continuous button on the toolbar. If the property is set to

true, the button will be displayed. If it is set to false, then the button will be
hidden. By default, this property is set to true.

2003-2013 Stimulsoft

Using MVC ViewerFx

ShowButtonPageView
ModeMultiple

9.5.6

Shows/hides the MultiplePages button on the toolbar. If the property is set

to true, the button will be displayed. If it is set to false, then the button will
be hidden. By default, this property is set to true.

Zooming
With this group of properties one can modify zooming options. This group is represented by the following
properties.
The Zoom property. Depending on the value of the property the parameters of zooming of the
report template will be applied. This property can have numeric values in the range from 20 to 200,
which correspond to the scale from 20% to 200%. Also, the property can take values from an
enumeration StiMvcViewerFxOptions.ZoomMode.
Name

Description

Default

The report is shown in zoom used in the last time when the web viewer was
open.

OnePage

Sets zoom by one page. So the entire page of the report template fits in the
window of the web viewer.

TwoPages

Sets zoom by two pages. So two report pages will be shown by width and height
of the report viewer.

PageWidth

Sets zoom by page width. So the width of the report template matches the width
of the web viewer window.

PageHeight

Sets zoom by page height. So the height of the report template matches the
height of the web viewer window.

The ZoomShow property. Shows/hides the zooming control from the report viewer. If the property
is set to true, the control will be displayed. If it is set to false, then the control will be hidden. By
default, this property is set to true.

9.5.7

Exporting
With this group of properties one can modify exporting options. This group is represented by the
following properties.
Name

Description

ShowExportDialog

Shows/hides the exporting dialog. If the property is set to true, the dialog
will be displayed. If it is set to false, then the dialog will be hidden. By
default, this property is set to true.

2003-2013 Stimulsoft

Stimulsoft Reports

ShowExportToDocum Shows/hides the menu item Document File. If the property is set to true, the
ent
menu item will be displayed. If it is set to false, then the menu item will be
hidden. By default, this property is set to true.
ShowExportToPdf

ShowExportToXps

ShowExportToPpt

Shows/hides the menu item Microsoft PowerPoint 2007/2010 File. If the

property is set to true, the menu item will be displayed. If it is set to false,
then the menu item will be hidden. By default, this property is set to true.

ShowExportToHtml

ShowExportToMht

ShowExportToText

ShowExportToRtf

ShowExportToWord2
007

ShowExportToOpenD
ocumentWriter

ShowExportToExcel

ShowExportToExcelX
ml

ShowExportToExcel20 Shows/hides the menu item Microsoft Excel 2007/2010 File. If the property
07
is set to true, the menu item will be displayed. If it is set to false, then the
menu item will be hidden. By default, this property is set to true.
ShowExportToOpenD
ocumentCalc

Shows/hides the menu item OpenDocument Calc File. If the property is set
to true, the menu item will be displayed. If it is set to false, then the menu

2003-2013 Stimulsoft

Using MVC ViewerFx

item will be hidden. By default, this property is set to true.

ShowExportToCsv

ShowExportToDbf

ShowExportToXml

ShowExportToDif

ShowExportToSylk

ShowExportToBmp

ShowExportToGif

ShowExportToJpeg

ShowExportToPcx

ShowExportToPng

ShowExportToTiff

ShowExportToMetafil Shows/hides the menu item Windows Metafile. If the property is set to true,
e
the menu item will be displayed. If it is set to false, then the menu item will
be hidden. By default, this property is set to true.
ShowExportToSvg

ShowExportToSvgz

Shows/hides the menu item Compressed SVG (SVGZ) File. If the property is

2003-2013 Stimulsoft

Stimulsoft Reports

set to true, the menu item will be displayed. If it is set to false, then the
menu item will be hidden. By default, this property is set to true.

9.5.8

Printing
With this group of properties one can modify printing options. This group is represented by the
following properties.

9.5.9

Name

Description

PrintAutoPag
eOrientation

Enables/disables the automatic page orientation when printing on paper. If the

property is set to true, the automatic page orientation will be enabled. If it is set to
false, then the automatic page orientation will be disabled. By default, this property
is set to true.

PrintAllowTo
Pdf

Shows/hides the menu item Print to PDF in the report printing dialog box. If the
property is set to true, the menu item will be displayed. If it is set to false, then the
menu item will be hidden. By default, this property is set to true.

PrintAllowTo
Html

Shows/hides the menu item Print to HTML in the report printing dialog box. If the
property is set to true, the menu item will be displayed. If it is set to false, then the
menu item will be hidden. By default, this property is set to true.

Interface
With this group of properties one can modify interface options. This group is represented by the
following properties.
Name

Description

Width

Sets the width of the component. Width units are defined in the Unit class. The following
values are available: in pixels - Unit.Pixel(), in points - Unit.Point()) in per cent - Unit.
Percentage().

Height

Sets the height of the component. Height units are defined in the Unit class. The
following values are available: in pixels - Unit.Pixel(), in points - Unit.Point()) in per
cent - Unit.Percentage().

Theme

Sets the UI theme. It can take one of the values of StiMvcViewerFxOptions.Themes.

The following UI themes are available: Blue, Silver, Black. The default one is Black.

Backgrou
ndColor

Sets the background color of the report viewer. The default value if the background is
Color.White.

2003-2013 Stimulsoft

Using Web ViewerFx

The StiWebViewerFx component is delivered in Stimulsoft Reports.Web. This component is used to
show reports in a web browser.

10.1 How to Show Report?

Put the StiWebViewerFx component on a web page. Then you need to use the following code to show
a report:
C#:
StiReport report = new StiReport();
report.Load("report.mrt");
StiWebViewerFx1.Report = report;

VB.NET:
Dim Report As StiReport = New StiReport()
Report.Load("report.mrt")
StiWebViewerFx1.Report = Report

If the report was not rendered before showing, then the WebViewerFx component renders it
automatically. Loading a report after loading the viewer is done using the OnGetReport event. After
subscription to this event, it will occur each time when the viewer needs a report. In other words, after
loading WebViewerFx requests the report from the server and, if the subscription to the OnGetReport
event is done, then, in this event, the report can be assigned to the designer. Below is a code example,
using the OnGetReport event:
protected void StiWebViewerFx1_GetReport(object sender, StiWebViewerFx.
StiOnGetReportEventArgs e)
{
StiReport report = new StiReport();
report.Load("D:\\SimpleList.mrt");
e.Report = report;
}

If the report has not been rendered before being displayed, the WebViewerFx component renders it
automatically.
If it is required to show WebViewerFx to the entire browser window, you can use the following
method:
StiReport report = new StiReport();

2003-2013 Stimulsoft

Stimulsoft Reports

report.Load("report.mrt");
StiWebViewerFx1.View(report);

In this case, in the entire region in the current browser window a viewer will be displayed. All other
items are located on the .aspx page will not be displayed.

10.2 Localization of StiWebViewerFx Component

To make the StiWebViewerFx component to "speak" another language it is necessary to copy a
localization file of the standard delivery to the server to "Localization" folder. For example, select the
"de.xml" file. Then define the name of default localization:
<cc1:StiWebViewerFx ID="StiWebViewerFx1" runat="server" Localization
="en" />

10.3 WebViewerFx Settings

Setting the WebViewerFx can be done using the static properties, which are described in the
StiWebViewerFxOptions. class. Static properties of the WebViewerFx can be divided into following
groups: Connection, Zooming and Toolbar.

10.3.1 Connection
The static properties described below belong to the StiWebViewerFxOptions.Connection group and
responsible for connecting the client and server sides:
Name

Description

ClientRequestTimeout

property sets time (in seconds) that the client part will wait the response
from the server side. The default value is 10 seconds.

ClientRepeatCount

property sets the number of repeats of requests of the server side to the
client side, when getting errors of obtaining data. The default value is 2
repeats.

RelativeUrls

Using Web ViewerFx

property is set to true.

10.3.2 Zooming
The group of static properties Zoom has one StiZoomMode static property. Depending on the values
of this property it is possible to set report template zoom. This property has the following values:
PageWidth, PageHeight, OnePage, Zoom25, Zoom50, Zoom75, Zoom100, Zoom150, Zoom200.
Name

Description

Default

Value sets previously saved report zoom in WebViewerFx. So, if a report

was saved with 37% zoom then, when opening it the next time, the report
is shown in 37% zoom.

PageWidth

Value sets zoom by Page Width. So the width of the report template
matches the width of the web viewer window.

OnePage

Value sets zoom by One Page. So the entire page of the report template
fits in the window of the web viewer.

TwoPages

Value sets zoom by Two Pages. So two report pages will be shown by
width and height in the WebViewerFx.

Zoom25,
Zoom50, Value sets zoom level of the report template which is 25%, 50%, 75%,
Zoom75,
Zoom100, 100%, 150%, 200%.
Zoom150, Zoom200

10.3.3 Viewer Static Properties

A group of StiWebViewerFxOptions.Toolbar static properties of the WebViewerFx is described
below:
Name

Description

ShowZoom

Property is used to show/hide the zoom panel. If the ShowZoom property

is set to true, then the zoom panel will be shown. If the ShowZoom
property is set to false, then the zoom panel will be hidden. By default this
property is set to true.

ShowPrintButton

Property is used to show/hide the Print button. If the ShowPrintButton

property is set to true, then the Print button is shown. If the
ShowPrintButton property is set to true, then the Print button is hidden.
By default this property is set to true.

ShowOpenButton

Property is used to show/hide the Open button. If the ShowOpenButton

property is set to true, then the Open button is shown. If the
ShowOpenButton property is set to true, then the Open button is hidden.

2003-2013 Stimulsoft

Stimulsoft Reports

By default this property is set to true.

ShowSaveButton

Property is used to show/hide the Save button. If the ShowSaveButton

property is set to true, then the Save button is shown. If the
ShowSaveButton property is set to true, then the Save button is hidden.
By default this property is set to true.

ShowSendEMailButton Property is used to show/hide the SendEMail button. If the

ShowSendEMailButton property is set to true, then the SendEMail button
is shown. If the ShowSendEMailButton property is set to true, then the
SendEMail button is hidden. By default this property is set to true.
ShowPageNewButton

Property is used to show/hide the Page New button. If the

ShowPageDeleteButto
n

Property is used to show/hide the Page Delete button. If the

ShowPageSizeButton

Property is used to show/hide the Page Size button. If the

ShowBookmarksButto
n

Property is used to show/hide the Bookmarks button. If the

ShowBookmarksButton property is set to true, then the Bookmarks
button is shown. If the ShowBookmarksButton property is set to true,
then the Bookmarks button is hidden. By default this property is set to
true.

ShowThumbnailsButto Property is used to show/hide the Thumbnails button. If the

Property is used to show/hide the Find button. If the ShowFindButton

property is set to true, then the Find button is shown. If the
ShowFindButton property is set to true, then the Find button is hidden.
By default this property is set to true.

ShowEditButton

Property is used to show/hide the Edit button. If the ShowEditButton

property is set to true, then the Edit button is shown. If the
ShowEditButton property is set to true, then the Edit button is hidden. By
default this property is set to true.

ShowFirstPageButton

Property is used to show/hide the First Page button. If the

ShowFirstPageButton property is set to true, then the First Page button
is shown. If the ShowFirstPageButton property is set to true, then the

2003-2013 Stimulsoft

Using Web ViewerFx

First Page button is hidden. By default this property is set to true.

ShowPreviousPageBut
ton

Property is used to show/hide the Previous Page button. If the

ShowGoToPageButton Property is used to show/hide the Go to Page button. If the

Property is used to show/hide the Next Page button. If the

ShowLastPageButton

Property is used to show/hide the Last Page button. If the

ShowPageViewModeSi Property is used to show/hide the Single Page button. If the

Property is used to show/hide the Continuous button. If

the
the
the
the

ShowPageViewModeM Property is used to show/hide the Multiple Pages button. If the

10.4

Properties
The properties of WebViewerFx are described below:
The ServerTimeout property is used to define time of storing a report in the server cache. By
default, this property is set to "00:10:00", this means that the report is stored 10 minutes in the server
cache and then it is removed.
The Background property is used to change the background color. By default, this property is set to
White, this means that the background color is white. It is also possible to set any color in the

2003-2013 Stimulsoft

Stimulsoft Reports

#rrggbb format and transparent color.

The DataEncryption property is used to enable/disable data encryption. If the DataEncryption
property is set to false, then data are not encrypted. If the DataEncryption property is set to true,
then data are encrypted. By default, this property is set to false.
The DataCompression property is used to enable/disable data compression. If the
DataCompression property is set to false, then data are not compressed. If the DataCompression
property is set to true, then data are compressed. By default, this property is set to true.
The AppCacheDirectory property is used to indicate the path to the directory on the server, to what
file caching of the Flash-application will occur. For this you need to set full access of the ASP.NET
application to this folder.
The LocalizationDirectory property is used to specify the path to the folder where localization .xml
files are stored. The folder should be placed in the root directory of the project. A code sample for
specifying the path to the folder with localization files is shown below (for example, the Languages
folder):
<cc1:StiWebDesigner ID="StiWebViewerFx1" runat="server"
DirectoryLocalization="Files/Languages" />

The Localization property is used to specify the ability to localize the WebViewerFx UI in any of 26
languages available. The Localization property should be set to the value. The value is the .xml file in
the Localization folder of the root directory in the project). By default, this property is set to "en", this
means that the UI is localized in English. A code sample for setting the Localization property of the
WebViewerFx UI to English language ("en") is shown below:
<cc1:StiWebDesigner ID="StiWebViewerFx1" runat="server" Localization="ru"
/>

The ImageQuality property is used to change the quality of images in the report. depending on the
value of this property it is possible to change the image file size and image quality. If the
ImageQuality property is set to Low, then the file size and quality will be low. If the ImageQuality
property is set to Normal, then the file size and quality will have optimal ratio between size and quality.
If the ImageQuality property is set to High, then the file size and quality will be the highest.
The ThemeName property is used to change the style the theme of the WebViewerFx. If the
ThemeName property is set to Blue, then the style of the viewer will be as shown on the picture below:

2003-2013 Stimulsoft

Using Web ViewerFx

100

If the ThemeName property is set to Silver, then the style of the viewer will look as shown on the
picture below:

If the ThemeName property is set to Black, then the style of the viewer will look as shown on the
picture below:

2003-2013 Stimulsoft

101

Stimulsoft Reports

10.5 Export Settings

It is possible to customize a list of export formats. In other words, it is possible to hide unused export
formats. Customization of the export formats list can be done by using the WebViewerFx properties.
For example - export to HTML. Availability of this format in the list of formats for export depends on
the value of the ShowExportToHtml property. The picture below shows the full list of formats:

2003-2013 Stimulsoft

Using Web ViewerFx

102

As seen in the picture above the Html format is shown in the list of formats, and this means that the
ShowExportToHtml property is set to true. If the set this property to false (code below):
<cc1:StiWebViewerFx ID=" StiWebViewerFx1" runat="server"
ShowExportToHtml="False" />

then the HTML format will not be shown in the list of export formats. The picture below shows a list of
formats without HTML:
2003-2013 Stimulsoft

103

Stimulsoft Reports

By default, all export formats are shown.

10.6 Data
To preview the report data are required. By default, data are taken from the Dictionary of the edited
report. If necessary, they can be overridden. To do this you need to add the handler to the GetDataSet
event. There is a sample code below using what data can be overridden:
2003-2013 Stimulsoft

Using Web ViewerFx

104

C#:
protected void StiWebDesigner1_GetDataSet(object sender,
StiWebDesigner.StiPreviewDataSetEventArgs e)
{
DataSet data = new DataSet();
data.ReadXml("D:\\Demo.xml");
data.ReadXmlSchema("D:\\Demo.xsd");
e.DataSet = data;
}

VB.NET:
Protected Sub StiWebDesigner1_GetDataSet(ByVal sender As Object, ByVal
e As StiWebDesigner.StiPreviewDataSetEventArgs)
Dim data As DataSet = New DataSet()
data.ReadXml("D:\\Demo.xml")
data.ReadXmlSchema("D:\\Demo.xsd")
e.DataSet = data
End Sub

As seen from code, data are taken from XML and XSD files. The same way exists for other data
sources.

Using Flex Viewer

The Viewer.Fx component is delivered with Stimulsoft Reports.Fx. This component is used to show
reports in Flex applications.

11.1 How to Show Report?

Put the Viewer.Fx on the scene of a Flex application:
<viewer:StiViewerFx id="viewerFx" Left="0" right="0" bottom="0" />

Create, load and assign a report:

var report: StiReport = new StiReport();
report.loadDocumentFromString(documentString);
viewerFx.report = report;

Important: documentString: String - .mdc file loaded as a string.

2003-2013 Stimulsoft

105

Stimulsoft Reports

Also, there is another way to show a report instead of placing Viewer.Fx on the scene of a Flex
application:
var report: StiReport = new StiReport();
report.loadDocumentFromString(documentString);
report.showDialog();

Important: report.show() - showing ViewerFx on the working space of the application.

11.2 Dialog Options

If a report is shown in the dialog window, i.e. ability to set parameters of dialog window.
var report: StiReport = new StiReport();
report.loadDocumentFromString(documentString);
report.showDialog(rectangle: Rectangle, title: String, allowResize:
Boolean, allowDrag: Boolean);

In example 4 parameters are described:

Rectangle (position and dialog window size), is set as Rectangle (x, y, width, height), where x,y
are indents from the top left corner of the application. By default Rectangle (10, 10, application.width
- 20, application.height - 20);
title - is the window title. If the title is not set, then the window will have the "Viewer" title.
allowResize - this parameter allows changing window size. It may have two values: true and false.
By default, the value is set to false, i.e. it is impossible to change window size.
allowDrag - this parameter allows dragging dialog window. It may have two values: true and false.
The default value is false, i.e. it is impossible to drag the dialog viewer window.
A sample of setting parameters:
var rect: Rectangle = new Rectangle(100, 100, 900, 600);
report.showDialog(rect, "Customized ViewerFx", true, true);

As seen from the sample:

Indent from the top left corner is 100 by x, y axes. Width 900, height 600.
The name of the dialog box is "Customized ViewerFx".
Changing size of the dialog window of viewer - possible.
Dragging the dialog window - possible.

11.3 User Interface Settings

It is possible to setup user interface, i.e. it is possible to hide some buttons or panels. On the picture
above only 4 buttons of 9 are shown. The code below shows how to get this result:

2003-2013 Stimulsoft

Using Flex Viewer

106

StiOptions.viewer.toolbar.showOpenButton = false;
StiOptions.viewer.toolbar.showSaveButton = false;
StiOptions.viewer.toolbar.showThumbnailsButton = false;
StiOptions.viewer.toolbar.showBookmarksButton = false;
StiOptions.viewer.toolbar.showFindButton = false;

In other words each button has the show function. This function has two values: true or false. The
default value of this function is true.
The list of available buttons
On the toolbar:
StiOptions.viewer.toolbar.showPrintButton - Print button;
StiOptions.viewer.toolbar.showOpenButton - Open button;
StiOptions.viewer.toolbar.showSaveButton - Save button
StiOptions.viewer.toolbar.showBookmarksButton - Bookmark button;
StiOptions.viewer.toolbar.showThumbnailsButton - Thumbnails button;
StiOptions.viewer.toolbar.showFindButton - Find button;
StiOptions.viewer.toolbar.showCloseButton - Close button.
On the Navigation toolbar:
StiOptions.viewer.toolbar.showFirstPageButton - First Page button;
StiOptions.viewer.toolbar.showPreviousPageButton - Previous Page button;
StiOptions.viewer.toolbar.showGoToPageButton - GoToPage button;
StiOptions.viewer.toolbar.showNextPageButton - Next Page button;
StiOptions.viewer.toolbar.showLastPageButton - Last Page button.
On the View Page toolbar:
StiOptions.viewer.toolbar.showPageViewModeSingleButton - Single Page button;
StiOptions.viewer.toolbar.showPageViewModeContinuousButton - Continuous Page button;
StiOptions.viewer.toolbar.showPageViewModeMultipleButton - Multiple Page button.
Also it is possible to disable the Zoom panel, see the following:
StiOptions.viewer.toolbar.showZoom = false

Using Web Designer in Silverlight

The StiWebDesignerSL component is designed to edit reports in a window of a browser. You do not
need to install .NET Framework, ActiveX components or other special plug-ins on the client. All you
need is a Web browser and Silverlight Runtime. With StiWebDesignerSL it is possible to create, edit,
save, view and print reports on any computer with any operating system, where there is Internet access
and a Web browser with installed Silverlight Runtime version 4. StiWebDesignerSL is an ASP.NET
component. It can be divided into two parts: client and server. Client side is a graphical part of the
designer, realized under the Silverlight technology. Server side is a report engine and a module that
performs the functions of receiving requests and passing data to the client side of the designer. These

2003-2013 Stimulsoft

107

Stimulsoft Reports

two parts are assembled into a single dll library and presented as a component.

12.1 How It Works?

To run the web reports designer, it is required to put the StiWebDesignerSL component on the ASP.
NET page. Then, in the PageLoad event of a page, you need to assign a report to the Report property
of a component. An ASP.NET component will read the Silverlight-client application into memory from
resources and run it. Being loaded, the client side will request all necessary settings and a report file
from the server side. The server part will pass this. When you save or preview the report, the client side
sends the report as an XML the file, and server will perform preliminary processing of the report, and
transfer this file for saving, or compiles it and displays in a browser window.

12.2 How to Run Web Reports Designer?

For running the Web report designer it is necessary to put non visual StiWebDesignerSL component
on the form and, in the event handler of a control, to call the Design() method:
ASP.NET:
<cc1:StiWebDesignerSL ID="StiWebDesignerSL1" runat="server" />

C#:
protected void Page_Load(object sender, EventArgs e)
{
StiReport report = new StiReport();
StiWebDesignerSL1.Report = myReport;
}

For loading a report in the Web designer, the method of calling can be slightly modified:
C#:
protected void Page_Load(object sender, EventArgs e)
{
StiReport report = new StiReport();
report.Load("D:\\SimpleList.mrt");
StiWebDesignerSL1.Design(report);
}

12.3 Loading Reports to Web Designer

One of the following methods can be used to load a report to the Web designer:

2003-2013 Stimulsoft

Using Web Designer in Silverlight

108

Loading a report before loading the designer;

Loading a report after loading the designer;
Loading a report from the main menu of the designer.
Loading a report before loading the designer. In this way the report (for example, from a file) is
loaded first and then the designer is loaded. The previously loaded report is specified as a parameter
of a method of calling the designer. A code below is a sample for loading a report before loading the
designer:
protected void Button1_Click(object sender, EventArgs e)
{
StiReport report = new StiReport();
report.Load("D:\\SimpleList.mrt");
StiWebDesignerSL1.Design(report);
}

Loading a report after loading the designer is done using the GetReport event. After adding the
handler to this event, it will occur each time when a report is required for the designer. In other words,
after loading the Web designer requests a report from the server and, if the handler is added to the
GetReport event, then in this event a report can be assigned to the designer. See the code below how
to use the GetReport event:
protected void StiWebDesignerSL1_GetReport(object sender,
StiWebDesignerSL.StiGetReportEventArgs e)
{
StiReport report = new StiReport();
report.Load("D:\\SimpleList.mrt");
e.Report = report;
}

Loading a report from the main menu of the designer. A report can be loaded by selecting the
Open Report menu item. After selecting this menu item the dialog box for specifying a report for
loading will appear. Also the designer supports loading reports and other report items (for example,
images) using Drag&Drop.

2003-2013 Stimulsoft

109

12.4

Stimulsoft Reports

Report Preview
You can preview the report in the window of the Web-designer by selecting the Preview tab in the
designer. The picture below shows tabs of the Web-designer:

Data are required to preview a rendered report. By default, data specified in the Dictionary of the
edited report are taken. If it is necessary, they can be overridden. Below is a sample code with which
overrides the data:
protected void StiWebDesignerSL1_GetPreviewDataSet(object sender,
StiWebDesignerSL.StiPreviewDataSetEventArgs e)
{
DataSet data = new DataSet();
data.ReadXml("D:\\Demo.xml");
data.ReadXmlSchema("D:\\Demo.xsd");
e.PreviewDataSet = data;
}

As can be seen from the code, the data is taken from XML and XSD files. In the same way you can
substitute the data from other data sources.

12.5 Web Designer Settings

Setting the Web designer can be done using the static properties, which are described in the
Stimulsoft.Report.Web.StiWebDesignerSLOptions class. Static properties of the Web designer can
be divided into following groups: Main menu, Zooming, Viewer.

12.5.1 Main Menu

The main menu of the Web designer can be setup according to user's requirements. This group of
static properties StiWebDesignerSLOptions.Menu allows enabling/disabling the main menu or
submenu items
Name

Description

SaveReportAsPag
eEnabled

property enables/disables the Save Report As... menu item. If the

SaveReportAsPageEnabled property is set to true, then the menu item is
enabled and can be available for a user. If false then it is disabled and cannot
be available for a user. By default the property is set to true;

OpenReportEnabl
ed

property enables/disables the Open Report menu item. If the

OpenReportEnabled property is set to true, then the menu item is enabled

2003-2013 Stimulsoft

Using Web Designer in Silverlight

110

and can be available for a user. If false then it is disabled and cannot be
available for a user. By default the property is set to true;
CloseEnabled

property enables/disables the Close menu item. If the CloseEnabled property

is set to true, then the menu item is enabled and can be available for a user. If
false then it is disabled and cannot be available for a user. By default the
property is set to true;

SavePageAsEnabl
ed

property enables/disables the Save Page As... menu item. If the

SavePageAsEnabled property is set to true, then the menu item is enabled and
can be available for a user. If false then it is disabled and cannot be available
for a user. By default the property is set to true;

OpenPageEnabled property enables/disables the Open Page... menu item. If the

OpenPageEnabled property is set to true, then the menu item is enabled and
can be available for a user. If false then it is disabled and cannot be available
for a user. By default the property is set to true;
DeletePageEnable property enables/disables the Delete Page menu item. If the
d
DeletePageEnabled property is set to true, then the menu item is enabled and
can be available for a user. If false then it is disabled and cannot be available
for a user. By default the property is set to true;
NewEnabled

property enables/disables the New menu item. If the NewEnabled property is

set to true, then the menu item is enabled and can be available for a user. If
false then it is disabled and cannot be available for a user. By default the
property is set to true. The New menu item contains the submenu, where the
submenu item are present. They are: New Report, New Report With Wizard,
New Page. The picture below is shows the submenu of the New item:

ReportEnabled

property enables/disables the Report menu item. If the ReportEnabled

property is set to true, then the menu item is enabled and can be available for
a user. If false then it is disabled and cannot be available for a user. By default
the property is set to true. This menu item contains the submenu shown on the
picture below:

DesignerEnabled

property enables/disables the Designer menu item. If the DesignerEnabled

OptionsEnabled

property enables/disables the Options menu item. If the OptionsEnabled

property is set to true, then the menu item is enabled and can be available for
a user. If false then it is disabled and cannot be available for a user. By default
the property is set to true.

12.5.2 Zooming
The properties of the StiWebDesignerSL Zoom panel are described below:

2003-2013 Stimulsoft

111

Stimulsoft Reports

Name

Description

ShowPageViewContin
uousModeButton

Property is used to show/hide the Continuous button. If the

ShowPageViewContinuousModeButton property is set to true, then the
Continuous
button
will
be
shown.
If
the
ShowPageViewContinuousModeButton property is set to false, then the
Continuous button will be hidden. By default, this property is set to true.

ShowPageViewMultipl Property is used to show/hide the Multiple

eModeButton
ShowPageViewMultipleModeButton property is
Multiple
Pages
button
will
be
ShowPageViewMultipleModeButton property is
Multiple Pages button will be hidden. By default,
true.

Pages button. If the

set to true, then the
shown.
If
the
set to false, then the
this property is set to

ShowSliderZoomContr Property is used to show/hide the Zoom slider. If the ShowZoom property
ol
is set to true, then the Zoom slider will be shown. If the ShowZoom
property is set to false, then the Zoom slider will be hidden. By default,
this property is set to true.
ZoomMode

Is used to change report zoom. This property has the following values:
Default, OnePage, TwoPages, PageWidth:
The Default value sets previously saved zoom of a report in
WebDesignerSL. So, if a report was saved with 37% zoom then, when
opening it next time, 37% zoom of a report showing remains;
The PageWidth value sets zoom by Page Width. So the width of the
report template matches the width of the window of the web designer;
The PageHeight value sets zoom by Page Height. So the height of the
report template matches the height of the window of the web designer;
The OnePage value sets zoom by One Page. So the entire page of the
report template fits in the window of the web designer.

Zoom

Provides an opportunity to zoom in the designer. This property can take

any value from 0 to 100, where the value of the Zoom is the zoom
percentage. For example, if the Zoom property is set to 70, the zoom in
the designer will be equal to 70 percent.

12.5.3 Viewer
The group of static StiWebDesignerSLOptions.Viewer. properties allows setting the viewer. The list of
properties is represented below.
Name
ShowMainToolBar

Description
Property is used to show/hide the Tool Bar. If the ShowMainToolBar
property is set to true, then the Tool Bar panel will be shown. If the
ShowMainToolBar property is set to false, then the Tool Bar panel will be
hidden. By default the property is set to true.

2003-2013 Stimulsoft

Using Web Designer in Silverlight

112

ShowPrintButton

Property is used to show/hide the Print button. If the ShowPrintButton

property is set to true, then the Print button will be shown. If the
ShowPrintButton property is set to false, then the Print button will be
hidden. By default the property is set to true.

ShowReportOpenButt
on

Property is used to show/hide the Open button. If the

ShowReportOpenButton property is set to true, then the Open button will
be shown. If the ShowReportOpenButton property is set to false, then the
Open button will be hidden. By default the property is set to true.

ShowReportSaveButto
n

Property is used to show/hide the Save button. If the

ShowReportSaveButton property is set to true, then the Save button will
be shown. If the ShowReportSaveButton property is set to false, then the
Save button will be hidden. By default the property is set to true.

ShowPageNewButton

Property is used to show/hide the Page New button. If the

ShowPageNewButton property is set to true, then the Page New button
will be shown. If the ShowPageNewButton property is set to false, then
the Page New button will be hidden. By default the property is set to true.

ShowPageDeleteButto
n

Property is used to show/hide the Page Delete button. If the

ShowPageDeleteButton property is set to true, then the Page Delete
button will be shown. If the ShowPageDeleteButton property is set to
false, then the Page Delete button will be hidden. By default the property
is set to true.

ShowPageDesignButto Property is used to show/hide the Edit button. If the

n
ShowPageDesignButton property is set to true, then the Edit button will
be shown. If the ShowPageDesignButton property is set to false, then the
Edit button will be hidden. By default the property is set to true.
ShowPageSizeButton

Property is used to show/hide the Page Size button. If the

ShowPageSizeButton property is set to true, then the Page Size button
will be shown. If the ShowPageSizeButton property is set to false, then
the Page Size button will be hidden. By default the property is set to true.

ShowBookmarksPanel

Property is used to show/hide the Bookmarks panel. If the

ShowBookmarksButton property is set to true, then the Bookmarks
panel will be shown. If the ShowBookmarksButton property is set to false,
then the Bookmarks panel will be hidden. By default the property is set to
true.

ShowToolFindButton

Property is used to show/hide the Find button. If the

ShowToolFindButton property is set to true, then the Find button will be
shown. If the ShowToolFindButton property is set to false, then the Find
button will be hidden. By default the property is set to true.

ShowFullScreenButton Property is used to show/hide the Full Screen button. If the

2003-2013 Stimulsoft

113

Stimulsoft Reports

ShowZoomOnePageBu Property is used to show/hide the One Page button. If the

tton
ShowZoomOnePageButton property is set to true, then the One Page
button will be shown. If the ShowZoomOnePageButton property is set to
false, then the One Page button will be hidden. By default the property is
set to true.
ShowZoomTwoPagesB Property is used to show/hide the Two Pages button. If the
utton
ShowZoomTwoPagesButton property is set to true, then the Two Pages
button will be shown. If the ShowZoomTwoPagesButton property is set to
false, then the Two Pages button will be hidden. By default the property is
set to true.
ShowZoomPageWidth
Button

Property is used to show/hide the Page Width button. If the

ShowZoomPageWidthButton property is set to true, then the Page
Width button will be shown. If the ShowZoomPageWidthButton property
is set to false, then the Page Width button will be hidden. By default the
property is set to true.

ShowToolEditorButton Property is used to show/hide the Tool Editor button. If the

ShowToolEditorButton property is set to true, then the Tool Editor
button will be shown. If the ShowToolEditorButton property is set to false
, then the Tool Editor button will be hidden. By default the property is set
to true.
ShowDocumentButton Property is used to show/hide the Document button. If the
ShowDocumentButton property is set to true, then the Document button
will be shown. If the ShowDocumentButton property is set to false, then
the Document button will be hidden. By default the property is set to true.
ShowPdfButton

Property is used to show/hide the Export to PDF button . If the

ShowPdfButton property is set to true, then the Tool Editor button will
be shown. If the ShowPdfButton property is set to false, then the Tool
Editor button will be hidden. By default the property is set to true.

ShowFirstPageButton

Property is used to show/hide the First Page button. If the

ShowFirstPageButton property is set to true, then the First Page button
will be shown. If the ShowFirstPageButton property is set to false, then
the First Page button will be hidden. By default the property is set to true.

ShowPageLastButton

Property is used to show/hide the Last Page button. If the

ShowPageLastButton property is set to true, then the Last Page button
will be shown. If the ShowPageLastButton property is set to false, then
the Last Page button will be hidden. By default the property is set to true.

ShowPageGoToButton Property is used to show/hide the Go to Page button. If the

ShowPageGoToButton property is set to true, then the Go to Page
button will be shown. If the ShowPageGoToButton property is set to false
, then the Go to Page button will be hidden. By default the property is set
to true.
ShowPageNextButton

Property is used to show/hide the Next Page button. If the

ShowPageNextButton property is set to true, then the Next Page
property is set to false, then the ShowPageNextButton property is set to

2003-2013 Stimulsoft

Using Web Designer in Silverlight

114

false, then the Next Page button will be hidden. By default the property is
set to true.
ShowPreviousPageBut
ton

Property is used to show/hide the Previous Page button. If the

ShowPreviousPageButton property is set to true, then the Previous Page
button will be shown. If the ShowPreviousPageButton property is set to
false, then the Previous Page button will be hidden. By default the
property is set to true.

ShowPageViewSingle
ModeButton

Property is used to show/hide the Single Page button. If the

ShowPageViewSingleModeButton property is set to true, then the Single
Page button will be shown. If the ShowPageViewSingleModeButton
property is set to false, then the Single Page button will be hidden. By
default the property is set to true.

ShowPageViewContin
uousModeButton

Property is used to show/hide the Continuous button. If the

ShowPageViewMultipl Property is used to show/hide the Multiple

eModeButton
ShowPageViewMultipleModeButton property is
Multiple
Pages
button
will
be
ShowPageViewMultipleModeButton property is
Multiple Pages button will be hidden. By default
true.

Pages button. If the

set to true, then the
shown.
If
the
set to false, then the
the property is set to

Property is used to change the report zoom in the viewer. This property
can have any value from 0 to 100, where the Zoom value is zoom in
percent.

12.6 Changing Web Designer Properties from Code

2003-2013 Stimulsoft

115

Stimulsoft Reports

12.7 Web Reports Designer Localization

The Web designer can be localized in 26 languages. It is necessary to change the value of the
Localization property. The localization file will be applied right after loading the Web designer. See the
code that can be used to change the localization:
<cc1:StiWebDesignerSL ID="StiWebDesignerSL1" runat="server" Localization
="ru" />

12.8 WCF Server

When designing a report, a user may process events via the WCF server. For this you need to set the
UseWCFService property to true:
Stimulsoft.Report.StiOptions.Silverlight.WCFService.UseWCFService =
true;

When the UseWCFService property is set to true, a user may use the following events:
Stimulsoft.Report.StiOptions.Silverlight.WCFService.WCFRenderReport

The WCFRenderReport event occurs when rendering a report;

Stimulsoft.Report.StiOptions.Silverlight.WCFService.WCFTestConnection

The WCFTestConnection event occurs when clicking the Test Connection button;

2003-2013 Stimulsoft

Using Web Designer in Silverlight

116

Stimulsoft.Report.StiOptions.Silverlight.WCFService.WCFBuildObjects

The WCFBuildObjects event occurs when returning the list tables from the created data source;
Stimulsoft.Report.StiOptions.Silverlight.WCFService.WCFRetrieveColumns

The WCFRetrieveColumns event occurs when returning the list of data columns for the table;
Stimulsoft.Report.StiOptions.Silverlight.WCFService.
WCFOpeningReportInDesigner

The WCFOpeningReportInDesigner event occurs when clicking the Open Report button in the main
menu;
Stimulsoft.Report.StiOptions.Engine.GlobalEvents.SavingReportInDesigner

The SavingReportInDesigner event occurs when saving a report;

Stimulsoft.Report.StiOptions.Silverlight.WCFService.WCFExportDocument

The WCFExportDocument event occurs when exporting a report by means of the server. In order to
make available a menu with exports in the viewer by means of the server, you must set the
ShowReportSaveToServerButton property to true:
Stimulsoft.Report.StiOptions.Viewer.Elements.
ShowReportSaveToServerButton = true;

Using Silverlight Web Viewer

The StiWebViewerSL component is delivered as a part of Stimulsoft Reports.WebSL. The component
is used for showing reports in the web browser.

13.1 How to Show Report?

Put the StiWebViewerSL component on a web page. Then you need to use the following code to show
a report:
Stimulsoft.Report.StiReport report = new Stimulsoft.Report.StiReport();
report.Load("Simple_List.mrt");
WebViewerSL1.Report = report;

2003-2013 Stimulsoft

117

Stimulsoft Reports

If the report was not rendered before showing, then the WebViewerSL component renders it
automatically. Also the viewer supports loading reports using the Drag&Drop.

13.2 WebViewerSL Settings

Setting the WebViewerSL can be done using the properties, which are described in the
StiWebViewerSL class.

13.2.1 Control Panel

A list of properties for customizing the WebViewerSL toolbar:
Name

Description

ShowMainToolBar

Property is used to show/hide the Tool Bar. If the ShowMainToolBar

property is set to true, then the Tool Bar panel will be shown. If the
ShowMainToolBar property is set to false, then the Tool Bar panel will be
hidden. By default the property is set to true.

ShowPrintButton

Property is used to show/hide the Print button. If the ShowPrintButton

property is set to true, then the Print button will be shown. If the
ShowPrintButton property is set to false, then the Print button will be
hidden. By default the property is set to true.

ShowReportOpenButt
on

Property is used to show/hide the Open button. If the

ShowReportSaveButto
n

Property is used to show/hide the Save button. If the

ShowPageNewButton

Property is used to show/hide the Page New button. If the

ShowPageDeleteButto
n

Property is used to show/hide the Page Delete button. If the

ShowPageDesignButto Property is used to show/hide the Edit button. If the

n
ShowPageDesignButton property is set to true, then the Edit button will

2003-2013 Stimulsoft

Using Silverlight Web Viewer

118

be shown. If the ShowPageDesignButton property is set to false, then the

Edit button will be hidden. By default the property is set to true.
ShowPageSizeButton

Property is used to show/hide the Page Size button. If the

ShowBookmarksPanel

Property is used to show/hide the Bookmarks panel. If the

ShowToolFindButton

Property is used to show/hide the Find button. If the

ShowFullScreenButton Property is used to show/hide the Full Screen button. If the

ShowFullScreenButton property is set to true, then the Full Screen
button will be shown. If the ShowFullScreenButton property is set to false
, then the Full Screen button will be hidden. By default the property is set
to true.
ShowZoomOnePageBu Property is used to show/hide the One Page button. If the
tton
ShowZoomOnePageButton property is set to true, then the One Page
button will be shown. If the ShowZoomOnePageButton property is set to
false, then the One Page button will be hidden. By default the property is
set to true.
ShowZoomTwoPagesB Property is used to show/hide the Two Pages button. If the
utton
ShowZoomTwoPagesButton property is set to true, then the Two Pages
button will be shown. If the ShowZoomTwoPagesButton property is set to
false, then the Two Pages button will be hidden. By default the property is
set to true.
ShowZoomPageWidth
Button

Property is used to show/hide the Page Width button. If the

ShowToolEditorButton Property is used to show/hide the Tool Editor button. If the

2003-2013 Stimulsoft

119

Stimulsoft Reports

13.2.2 Navigation Panel

The properties of the WebViewerSL navigation panel are described below.
Name

Description

ShowFirstPageButton

Property is used to show/hide the First Page button. If the

ShowPageLastButton

Property is used to show/hide the Last Page button. If the

ShowPageGoToButton Property is used to show/hide the Go to Page button. If the

Property is used to show/hide the Next Page button. If the

ShowPageNextButton property is set to true, then the Next Page
property is set to false, then the ShowPageNextButton property is set to
false, then the Next Page button will be hidden. By default the property is
set to true.

ShowPreviousPageBut
ton

Property is used to show/hide the Previous Page button. If the

13.2.3 Zooming
The properties of the WebViewerSL Zoom panel are described below:
Name

Description

ShowPageViewSingle
ModeButton

Property is used to show/hide the Single Page button. If the

ShowPageViewContin
uousModeButton

Property is used to show/hide the Continuous button. If the

ShowPageViewContinuousModeButton property is set to true, then the

2003-2013 Stimulsoft

Using Silverlight Web Viewer

120

Continuous
button
will
be
shown.
If
the
ShowPageViewContinuousModeButton property is set to false, then the
Continuous button will be hidden. By default the property is set to true.
ShowPageViewMultipl Property is used to show/hide the Multiple
eModeButton
ShowPageViewMultipleModeButton property is
Multiple
Pages
button
will
be
ShowPageViewMultipleModeButton property is
Multiple Pages button will be hidden. By default
true.

Pages button. If the

set to true, then the
shown.
If
the
set to false, then the
the property is set to

Is used to change report zoom. This property has the following values:
Default, OnePage, TwoPages, PageWidth.
The Default value sets previously saved zoom of a report in
WebViewerSL. So, if a report was saved with 37% zoom then, when
opening it next time, 37% zoom of a report showing remains;
The PageWidth value sets zoom by Page Width. So the width of the
report template matches the width of the window of the web designer;
The OnePage value sets zoom by One Page. So the entire page of the
report template fits in the window of the web viewer;
The TwoPages value sets zoom by Two Pages. So two pages of a
report fit by height and width the window of the WebViewerSL.

Zoom

Property is used to change the report zoom in the viewer. This property
can have any value from 0 to 100, where the Zoom value is zoom in
percent.For example, if the Zoom property is set to 70, the zoom in the
viewer will be equal to 70 percent.

13.3 Saving Mode

When you export a report to any format, saving the report will take place in one of the following saving
modes: Client or Server. Using the SaveMode property it is possible to change the mode of saving. If
the SaveMode property id set to Client, then the report will be saved on the client side of the
WebViewerSL application by means of Silverlight without a server. If the SaveMode property is set to
Server, then saving the report will take place directly on the server, and after saving the report will be
transferred to the client side. Depending on the value of the SaveMode property user will see different
the lists of export formats. The picture below shows lists of exports in various saving modes:

2003-2013 Stimulsoft

121

Stimulsoft Reports

13.3.1 Export Settings

A report opened in WebViewerSL can be exported to many different formats. The list of formats for
export can be customized. In other words, you can hide unused export formats. Customization of the
list of formats of exports can be made by means of WebViewerSL properties. For example the HTML
format, in the Client saving mode. Showing of this format in the list of formats for export depends on
the value of the ShowHtmlButton property. The picture below shows the complete list of formats in
the Client save mode:

2003-2013 Stimulsoft

Using Silverlight Web Viewer

122

As can be seen from the picture above, the HTML format is displayed in the list of formats that
corresponds to the ShowHtmlButton property set to true. If you set this property to false:
<cc1:StiWebViewerSL
="False" />

ID="StiWebViewerSL1"

runat="server"

ShowHtmlButton

then the HTML will not be displayed in the list of formats for exporting. The picture below shows a list
of formats for exporting without the Html format:

2003-2013 Stimulsoft

123

Stimulsoft Reports

By default, all available formats are listed for exporting.

Using HTML5 Designer

The HTML5 Report Designer is a Web-service. This designer is used to create and edit reports on
mobile devices using a browser. Designer's interface provides the user with easy operation, a huge set
of tools, components, and facilities to develop reports, their visual design and preview.

14.1 Designer Properties

Name

Description

InterfaceType

Defines the control way in the designer. If it is set to Touch, a

defined method is touching. If this property is set to Mouse, then
the control is carried out using the mouse device. If the property is
set to UserSelection, then the user himself defines which control
method to choose.

UseRelativeUrls

Defines a way of using an absolute or relative URL-address for

getting images.

2003-2013 Stimulsoft

Using HTML5 Designer

124

GlobalizationFile

Defines a path to the globalization file.

ImageFormat

Defines the format of used images.

CacheMode

Defines for the report generator which report cache to use to store
images and service information. You can choose one of the
following options:
Page
Uses the page cache.
Session
Uses the session cache.

ServerTimeout

Determines the storage time of the report in the server cache. By

default, this property is set to "00:20:00", equivalent to 20 minutes
of storing the report in the cache, i.e. after 20 minutes, the report
will automatically be removed from the server cache.

ImagesPath

Defines the path to the viewer and designer images.

14.2 Working With Report Code

In this topic, we will consider examples of a report from the code of the mobile report designer.
Loading the report
To load a report in the designer, you need to assign the Report property of the designer, for example,
from a file. If the Report property is not assigned, the designer will be loaded blank and ready to
create a report. Here is the code to load the report:
protected void Page_Load(object sender, EventArgs e)
{
if (Page != null && !Page.IsPostBack)
{
StiReport report = new StiReport();
report.Load("D:\\Result.mrt");
StiMobileDesigner1.Report = report;
}
}

The main events of the report designer

Usually loadable report template does not contain the actual data. Therefore, before you render a
report, connecting the data source for the report. You can do this using OnCreateReport and
OnLoadReport events of the report designer:
<StiMobileDesigner ID="StiMobileDesigner1
OnSaveReport="StiMobileDesigner1_SaveReport"
OnLoadReport="StiMobileDesigner1_GetDataSetOnLoad"
OnCreateReport="StiMobileDesigner1_GetDataSetOnCreate />

2003-2013 Stimulsoft

125

Stimulsoft Reports

Below is a sample code of connecting data in the method of the OnLoadReport event:
protected void StiMobileDesigner1_GetDataSetOnLoad(object sender,
StiMobileDesigner.StiGetDataSetOnLoadEventArgs e)
{
DataSet data = new DataSet();
data.ReadXml(Server.MapPath(string.Empty) + "\\Data\\Demo.xml");
e.Report.RegData(data);
}

Below is a sample code of connecting data in the method of the OnCreateReport event:
protected void StiMobileDesigner1_GetDataSetOnCreate(object sender,
StiMobileDesigner.StiGetDataSetOnCreateEventArgs e)
{
DataSet data = new DataSet();
data.ReadXmlSchema(Server.MapPath(string.Empty) + "\\Data\\Demo.xsd"
);
data.ReadXml(Server.MapPath(string.Empty) + "\\Data\\Demo.xml");
e.Report.RegData(data);
e.Report.Dictionary.Synchronize();
}

Saving a report
After creating or editing a report template, you can save changes. This can be done using the
OnSaveReport event, assigning a saving method. The following example describes a method to store
the report code to a *.mrt file:
protected void StiMobileDesigner1_SaveReport(object sender,
StiMobileDesigner.StiSaveReportEventArgs e)
{
StiReport report = e.Report;
report.Save("D:\\Result.mrt");
}

Using HTML5 Viewer

The HTML5 Viewer is used to display reports on mobile devices. The component is able to display
reports, zoom them, save to various formats and also print.

2003-2013 Stimulsoft

Using HTML5 Viewer

126

15.1 Showing Reports

Add the StiMobileViewer component on the HTML page:
<cc1:StiMobileViewer ID="StiMobileViewer1" runat="server" />

Create, load and assign a report:

protected void Page_Load(object sender, EventArgs e)
{
StiReport report = new StiReport();
report.Load("D:\\SimpleList.mrt");
StiWebViewer1.Report = report;
}

15.2 Caching
The StiMobileViewer component can output reports in two modes: 1. Using the caching and 2.
Without caching. If the cashing is not used then it is necessary, when every page refreshing, to get data
from a report and render a report again. When using caching the rendered report is saved in cache on
the server. The next time when the page is refreshed, the previously rendered report is loaded from
cache and its re-rendering is not required. It is important to remember that every report saved in
cache takes the server memory and, if there are a lot of queries to reports, it can be a critical factor.
Therefore, one should choose choose either low requirements to the memory but high requirements to
performance or high requirements to the memory but low requirements to speed. Caching should not
be used if the end user needs a report with actual data when every refreshing. The caching process can
be controlled using the RenderMode, CacheMode, and ServerTimeOut properties. If the caching of a
report is not used then the report that was rendered using the last data when page refreshing will be
printed but not the report that is shown on the current moment. If it is necessary to get the exact copy
of a report form the browser, then it is necessary to use caching.

15.2.1 RenderMode Property

The RenderMode property indicates how and when a report should be rendered. All modes of the
StiMobileViewer component can be divided in two categories: using the caching of a rendered report,
and without using caching of the rendered report.
The modes without caching
RenderOnlyCurrentPage
Very interesting mode of the report output. In this mode, the report is rendered only to the page that
is currently displayed in the StiMobileViewer component. For example, if the report consists of 100
pages (this is a big report to be output in the web), and the current page is the page number 5, the
report will be rendered only up to the page number 5. The sever memory is saved in this mode.
Ajax
This mode uses Ajax to output a report and to update the content of the StiMobileViewer component.
2003-2013 Stimulsoft

127

Stimulsoft Reports

For example, if a user goes to the next page of a report then not the whole page of the browser on
what the StiMobileViewer component is placed will be refreshed but only the next page of a report
will be sent to the browser using the post-back query. This increases the convenience of working with
the StiMobileViewer component.
Modes with caching are UseCache and AjaxWithCache.
UseCache
With each refresh in the StiMobileViewer component page reloading from the server occurs, but the
report is not re-rendered but each time is loaded from the cache.
AjaxWithCache
This mode as well as the Ajax mode uses the Ajax technology to output a report and also is used for
refreshing operations of the StiMobileViewer component. However, unlike the Ajax mode, this
AjaxWithCache mode does not re-render the report after each information request on the server. The
report that was earlier saved in cache is used.

15.2.2 CacheMode Property

The CacheMode property indicates what cache should be used to store reports, images, and service
information. There are two ways:
Page
A page cache will be used.
Session
A session cache will be used.

15.2.3 ServerTimeout Property

The ServerTimeout property indicates the amount of time on what it is necessary to save a report,
pictures of a report, or other service information in the cache. Do not use too much time or too little
time. If the time is too large, then the used cache will be overflowed and will be automatically cleared
by the server. As a result, the report (or images of a report) will not be cached, and incorrect result of
the report output in the StiMobileViewer component will occur. If the time is too small, then by the
time of request to the cache, there some necessary data may not be found. It is recommended to set
the time equal to 10 minutes. But the exact time can be found experimentally, considering the
parameters of the server, users activity, etc.

15.3 StiReportResponse Class

A report can be shown without using the StiMobileViewer component. The special Stimulsoft.Report.
Mobile.StiReportResponse class is used in this case. This class is a set of methods for saving a
rendered report in different formats to the stream of a page. It is possible to assign a lot of input
parameters which allows controlling the saving format of a report. For example, the following code can
be used to save a report to the PDF format to the stream of a page:
StiReport report = new StiReport();

2003-2013 Stimulsoft

Using HTML5 Viewer

128

report.Load("MyReport.mrt");
report.Render(false);
Stimulsoft.Report.Mobile.StiReportResponse.ResponseAsPdf(this, report);

In this code the report will be loaded first. Then this report will be rendered. Then the result of the
report rendering will be saved to the stream of a page. The following code saves a report to the Excel
2007 format.
StiReport report = new StiReport();
report.Load("MyReport.mrt");
report.Render(false);
Stimulsoft.Report.Mobile.StiReportResponse.ResponseAsExcel2007(this,
report);

15.4

Localization of StiMobileViewer Component

To make the StiMobileViewer component "speak" another language it is necessary to copy a
localization file of the standard delivery to the Localization folder. For example, select the "de.xml"
file. Then define the default localization name.
<cc1:StiMobileViewer ID="StiMobileViewer1" runat="server"
GlobalizationFile="en.xml" />

15.5 Settings
Setting the HTML5 Viewer can be done using properties. Properties of HTML5 Viewer can be divided
into the following groups: Zooming and Toolbar.

15.5.1 Zooming
The Zooming group of properties is represented by one property ZoomPercent. The ZoomPercent
property value will be any number from 2 to 403. This number corresponds to the zooming percentage
of the report in the viewer.

15.5.2 Toolbar
The group of static properties StiMobileViewerOptions.Toolbar allows setting the toolbox of the
HTML5 Viewer.
Name

2003-2013 Stimulsoft

Description

129

Stimulsoft Reports

ShowZoom

Property is used to show/hide the zoom panel. If the ShowZoom

property is set to true, then the zoom panel will be shown. If the
ShowZoom property is set to false, then the zoom panel will be hidden.
By default this property is set to true.

ShowPrintButton

Property is used to show/hide the Print button. If the ShowPrintButton

property is set to true, then the Print button is shown. If the
ShowPrintButton property is set to true, then the Print button is hidden.
By default this property is set to true.

ShowSave

Property is used to show/hide the Save button. If the ShowSave

property is set to true, then the Save button is shown. If the ShowSave
property is set to true, then the Save button is hidden. By default this
property is set to true.

ShowBookmarksButton

Property is used to show/hide the Bookmarks button. If the

ShowFirstButton

Property is used to show/hide the First Page button. If the

ShowFirstButton property is set to true, then the First Page button is
shown. If the ShowFirstButton property is set to true, then the First Page
button is hidden. By default this property is set to true.

ShowPreviousButton

Property is used to show/hide the Previous Page button. If the

ShowPreviousButton property is set to true, then the Previous Page
button is shown. If the ShowPreviousButton property is set to true, then
the Previous Page button is hidden. By default this property is set to
true.

ShowNextButton

Property is used to show/hide the Next Page button. By default this

property is set to true.

ShowLastButton

Property is used to show/hide the Last Page button. By default this

property is set to true.

ShowViewMode

Property is used to show/hide the Single Page button. By default this

property is set to true.

ShowAboutButton

Property is used to show/hide the About button. By default this

property is set to true.

ShowInterfaceTypeButt
on

Property is used to show/hide the Control button. By default this

property is set to true.

15.6 Properties
The properties of HTML5 Viewer are described below:
The ServerTimeout property is used to define time of storing a report in the server cache. By
2003-2013 Stimulsoft

Using HTML5 Viewer

130

default, this property is set to "00:10:00", this means that the report is stored 10 minutes in the
server cache and then it is removed.
The BackColor property is used to change the background color. By default, this property is set to
White, this means that the background color is white. It is also possible to set any color in the
#rrggbb format and transparent color.
The GlobalizationFile property is used to localize the HTML5 Viewer. To do this, you must specify
the value of the GlobalizationFile property, where the value is .xml file in the folder \Localization of
the root user project. By default, this property is set to "en", which means the English localization.
Below is a sample code where the property is set to "ru", which corresponds to Russian localizations
of HTML5 Viewer:
<cc1:StiWebDesigner ID="StiWebViewerFx1" runat="server" Localization="ru.
xml" />

The ImageQuality property is used to change the quality of images in the report. depending on the
value of this property it is possible to change the image file size and image quality. If the
ImageQuality property is set to Low, then the file size and quality will be low. If the ImageQuality
property is set to Normal, then the file size and quality will have optimal ratio between size and
quality. If the ImageQuality property is set to High, then the file size and quality will be the highest.

15.7 Setting Export

It is possible to customize a list of export formats. In other words, it is possible to hide unused export
formats. Customization of the export formats list can be done by using the Mobile Viewer properties.
For example, the export to HTML. Availability of this format in the list of formats for export depends
on the value of the ShowExportToHtml property. The picture below shows the full list of formats:

2003-2013 Stimulsoft

131

Stimulsoft Reports

As seen in the picture above the HTML format is shown in the list of formats, and this means that the
ShowExportToHtml property is set to true. If the set this property to false (code below):
<cc1:StiMobileViewer
ID="
ShowExportToHtml="False" />

StiMobileViewer"

runat="server"

then the HTML format will not be shown in the list of export formats. The picture below shows a list of
formats without the HTML option:

2003-2013 Stimulsoft

Using HTML5 Viewer

132

By default, all export formats are shown.

15.8 Defining Data

Data are needed for rendering a report. By default, the data are taken which the specified in the
Dictionary of the the report. If you want to override the data, you should subscribe to the
GetReportData event. Here is an example of a code used to override data:
protected void StiMobileViewer1_GetReportData(object sender,
StiReportDataEventArgs e)
{
DataSet data = new DataSet();
data.ReadXml(appDirectory + "\\Data\\Demo.xml");
e.Report.RegData(data);
}

As can be seen from the code, the data are taken from the XML and XSD files. The same way, you can
put the data from other data sources.

2003-2013 Stimulsoft

133

Stimulsoft Reports

Using Java Viewer

The StiViewerFx component is delivered as a part of StimulsoftReports.Fx for Java. This component is
used to display reports in Java applications. To run the viewer you will need to place the StiViewerFx
component on the Frame and set necessary properties to it. For running the report viewer it requires
the Java 1.5 platform or higher.

16.1 Showing Reports

Add the StiViewerFx component on the required component (for example on JFx):
StiViewerFx viewerfx = new StiViewerFx(parentFrame);
fx.add(viewerfx);

where the JFrameparentFrame is a main Frame of the application. For better showing StiViewerFx, the
parent component must have BoxLayoutManager. For loading and showing the report use the
following method:
viewerfx.getStiViewModel().loadDocumentFile(documentFile,
showProgress);

where the argument documentFile is a file of mdc documents, and the boolean value showProgress
provides the ability to define whether to show the loading progress of the document (if it is set to true
then the process is displayed, if false - it is not displayed.) It is also possible to display a report in the
form of a dialog box, you can use the method:
StiViewerFx viewerfx = new StiViewerFx(parentFrame);
JDialogviewerPopup = viewerfx.createPopup(parentFrame, modal);
viewerPopup.setVisible(true);

where the argument parentFrame is a frame from which the dialog is displayed, and the Boolean value
modal - dialog modality. The method returns JDialog, which subsequently can make the necessary
manipulations, such as resizing, changing dialog parameters, visibility, etc.

16.2 Custom Functions

In addition to the standard (built-in) functions, there is an ability to define your own (custom) functions.
To do this, we have the list customFunctions implemented in the class StiReport. Before rendering a
report all required functions must be added in it. Classes of user-defined functions must implement the
interface
com.stimulsoft.report.StiCustomFunction.
The
description
of
the
interface
StiCustomFunction:
public String getFunctionName() the function class should return the name of the custom
2003-2013 Stimulsoft

Using Java Viewer

134

function. Register is taken into account. Do not use the names of existing built-in functions, methods,
variables, reserved words as true/false/null, etc.
public List<Class> getParametersList() the function class should return a list of classes of
variables used in the custom function.
public Object invoke(List<Object> args) there must be a realization of a custom function.
An example of using on the base of Samples\webfx\. Suppose you need to implement a custom
substring function. In the class my.actions.MyRenderReportAction write the following:

public StiReport render(StiReport report) throws IOException, StiException

{
report.getCustomFunctions().add(new StiCustomFunction() {
public Object invoke(List<Object> args) {
return ((String) args.get(0)).substring((Integer)args.get
(1), (Integer) args.get(2));
}
public List<Class> getParametersList() {
return new ArrayList<Class>(Arrays.asList(String.class,
Integer.class, Integer.class));
}
public String getFunctionName() {
return "substring";
}
});
return super.render(report);
}

Now you can use a custom substring function in a report:

2003-2013 Stimulsoft

135

Stimulsoft Reports

Using Java Viewer in Web

Using a report designer and viewer in the Web application. Flexible setup of an application using the
configuration file. Loading and saving reports from the file system or a database. Ability to override
mechanisms for loading and saving reports. Ability to use a set of custom JSP tags.

17.1 Installation
Installation:
Download and install Java SE version 1.5 or higher (for the version 1.5 jaxb-impl and jaxb-api
libraries are required).
Download and install EclipsePlatform.
Download an archive with jar files on stimulsoft.com.

2003-2013 Stimulsoft

Using Java Viewer in Web

136

17.2 Creating Project

Creating a Web project:
Launch the Eclipse IDE, choose File> New> Project. In the project wizards open the Web type and in
the drop-down list select Dynamic Web Project wizard and click Next (See the picture below):

In the window opened fill in the Project name (e.g. sti_fx_web, as shown in the picture below). Then
configure the web server, on which the application will run.

2003-2013 Stimulsoft

137

Stimulsoft Reports

17.3 Creating Server

Target a runtime:
Under Target Runtime, you see <None>, as shown in the picture below, because you haven't created a
runtime yet for Apache Tomcat. Click New Runtime to open the New Target Runtime Wizard. Select
2003-2013 Stimulsoft

Using Java Viewer in Web

138

Apache Tomcat of the correct version from a list. Check Create a new local server as shown on Figure
3, then click Next.

Then define the Tomcat installation directory, in which Apache Tomcat is installed, or in which one
needs to install it, as shown in the picture. If it is not installed, then click Download and Install. After all
fields are specified, click Finish.

2003-2013 Stimulsoft

139

17.4

Stimulsoft Reports

Creating Sample
In order to verify the project and the Tomcat server, create a simple JSP and deploy it on Tomcat. To
do this, one can create a new JSP, by choosing File> New> Other, or one can use the context menu,
right-click the project name in the Project Explorer and select New> JSP file. In the next window (see
the picture) define the directory Web Content, and in the File name write index.jsp. Click Finish to
create pages using the default template.

2003-2013 Stimulsoft

Using Java Viewer in Web

140

Now open the index.jsp and edit it so that it displays the current date. The code page is specified in
the code:
<!DOCTYPEhtmlPUBLIC"-//W3C//DTD HTML 4.01 Transitional//EN">
<%@
page
language="java"
contentType="text/html;
charset=UTF-8"
pageEncoding="UTF-8" %>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>stimulsoft reports</title>
</head>
<body>
<%java.util.Date date = new java.util.Date();%>

2003-2013 Stimulsoft

141

Stimulsoft Reports

<h1>
This index.jsp.<br>
<%=date.toString()%>
</h1>
</body>
</html>

Now deploy it on the server. For this one need to use the context menu, right-click the project name,
select Run> Run as> Run on server. Define a previously created server and click Finish.

2003-2013 Stimulsoft

Using Java Viewer in Web

142

As a result, you receive the following (see the picture below). This page will be available from any
browser at http://localhost:8080/{ProjectName} (where the {ProjectName} name of the created
project, in our case sti_fx_web).

17.5 Creating Sample Page with Report Designer

Create a simple page with a report designer. To do this, put the following libraries into the
WebContent\WEB-INF\lib\ directory: stimulsoft.lib.jar, stimulsoft.reports-base.jar, stimulsoft.reportsreport.jar, stimulsoft.reports-flex.jar, stimulsoft.reports-web.jar. As a result, one can see the following
(picture below):

2003-2013 Stimulsoft

143

Stimulsoft Reports

Next, open the web.xml for editing, it should look like in Listing 2:
<?xml version="1.0" encoding="UTF-8" ?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/
xml/ns/javaee/webapp_2_5.xsd"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee"
id="WebApp_ID" version="2.5">
<display-name>sti_webviewer</display-name>
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>

<servlet>
<servlet-name>StimulsoftResource</servlet-name>
<servlet-class>com.stimulsoft.web.servlet.StiWebResourceServlet</
servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>StimulsoftResource</servlet-name>
<url-pattern>/stimulsoft_web_resource</url-pattern>
</servlet-mapping>
<servlet>
<servlet-name>StimulsoftAction</servlet-name>
<servlet-class>com.stimulsoft.webviewer.servlet.
StiWebViewerActionServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>StimulsoftAction</servlet-name>

2003-2013 Stimulsoft

Using Java Viewer in Web

144

<url-pattern>/stimulsoft_webviewer_action</url-pattern>
</servlet-mapping>
</web-app>

Leave unchanged the remaining web.xml blocks, which defines the servlets required for working. Then,
edit the index.jsp (see the code below).
<!DOCTYPEhtmlPUBLIC"-//W3C//DTD HTML 4.01 Transitional//EN">
<%@
page
language="java"
contentType="text/html;
charset=UTF-8"
pageEncoding="UTF-8" %>
<%@ taglib uri="http://stimulsoft.com/designer" prefix="stidesignerfx" %>
<%@ taglib uri="http://stimulsoft.com/viewer" prefix="stiviewerfx" %>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Stimulsoft Reports.Fx for Java</title>
</head>
<body>
<h1 align="center">My first report!</h1>
<stidesignerfx:iframe
width="100%" height="90%" align="middle"
styleClass="" frameborder="0" styleId=""
marginheight="4" marginwidth="10" name="stiviewer"
scrolling="no" style="" title=""/>
</body>
</html>

Add taglib directives in the JSP (Listing 5). They will work with custom tags on the page.
<%@ taglib uri="http://stimulsoft.com/designer" prefix="stidesignerfx" %>
<%@ taglib uri="http://stimulsoft.com/viewer" prefix="stiviewerfx" %>

Add a tag <stidesignerfx:iframe/>, an analog of an html tag iframe with the support of all its attributes.
See the following as a result of the application deployment, (see the picture below):

2003-2013 Stimulsoft

145

Stimulsoft Reports

Description of custom tags:

There is a division into two components: DesignerFx and ViewerFx, it can be seen from Listing 5.
Consider a DesignerFx component. For a ViewerFx it works the same way. Tags:
<stidesignerfx:link text="a link for jumping to the Designer"/>
<stidesignerfx:button value="a button for jumping to the Designer"/>
<stidesignerfx:frame title="analog of the html tag frame which contains a Designer"/>
<stidesignerfx:iframe title="analog of the html tag iframe which contains a Designer"/
>

All these are analogs of similar HTML tags, supporting all the attributes. A list of standard attributes is
expanded for displaying the report and setting variables for the report. The report = "SimpleList.mrt"

2003-2013 Stimulsoft

Using Java Viewer in Web

146

attribute opens the report with the name SimpleList.mrt. Variables in the Report can be passed in two
ways:
Set the value of a variableStr attribute as a string in the following format: "Variable1 = value1 &
Variable2 = value2". In this case, two variables Variable1 with a value1 and Variable2 with a value2 in
the report will be passed. For example, you need to edit the index.jsp file to open a report with the
name MyFirstReport.mrt by clicking the button and the MyVar report variable has the stidesignerfx
value (Listing 6).
<!DOCTYPEhtmlPUBLIC"-//W3C//DTD HTML 4.01 Transitional//EN">
<%@ page contentType="text/html;charset=UTF-8" import="java.util.*" %>
<%@ taglib uri="http://stimulsoft.com/designer" prefix="stidesignerfx" %>
<%@ taglib uri="http://stimulsoft.com/viewer" prefix="stiviewerfx" %>
<html>
<head>
<title>Report</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
<stidesignerfx:button value="Run the report designer" report="MyFirstReport.
mrt" variableStr="MyVar=stidesignerfx" />
</body>
</html>

It is also possible to pass parameters to a report as a Map <String, String>. Redesign our
webpage as follows (Listing 6). In this case, a report with the name MyFirstReport.mrt will be loaded in
a report and two parameters will be passed into it:
<!DOCTYPEhtmlPUBLIC"-//W3C//DTD HTML 4.01 Transitional//EN">
<%@ page contentType="text/html;charset=UTF-8" import="java.util.*" %>
<%@ taglib uri="http://stimulsoft.com/designer" prefix="stidesignerfx" %>
<%@ taglib uri="http://stimulsoft.com/viewer" prefix="stiviewerfx" %>
<html>
<head>
<title>Report</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
<%
Map<String, String>variableMap= new HashMap<String, String>();
variableMap.put("Variable1", "var1");
variableMap.put("Variable2", "var2");
request.setAttribute("myMap", variableMap);
%>
<stidesignerfx:iframe report="MyFirstReport.mrt" variableMap="myMap"
width="100%" height="100%" align="right"

2003-2013 Stimulsoft

147

Stimulsoft Reports

styleClass="" frameborder="0" styleId=""

marginheight="1" marginwidth="1" name="stidesignerfx"
scrolling="no" style="" title="report" />
</body>
</html>

Data here are passed as a HashMap, this parameter should be set to the request or session, and the
key under which it will be there should be passed to the tag as a variableMap attribute. Applying two
attributes variableMap and variableStr is not allowed.

17.6 Loading, Saving and Loading Custom Data

Before running, the application should be configured. For configuration the
ApplicationInitializer class that is specified in the web.xml is used. The code init reports:

my.servlet.

package my.servlet;
import java.io.IOException;
import java.util.Properties;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import
import
import
import
import
import

my.actions.MyLoadAction;
my.actions.MyLoadDataAction;
my.actions.MyLocalizationAction;
my.actions.MyMailAction;
my.actions.MyRenderReportAction;
my.actions.MySaveAction;

import com.stimulsoft.base.exception.StiException;
import com.stimulsoft.flex.StiFlexConfig;
/**
* Application initialization.
*/
public class ApplicationInitializer implements ServletContextListener {
@Override
public void contextInitialized(final ServletContextEvent event) {
try {
// configuration application
StiFlexConfig stiConfig = initConfigWithoutDir();
//
--------------------------------------------------------// need to override the standard methods
// another comment

2003-2013 Stimulsoft

Using Java Viewer in Web

148

stiConfig.setLoadClass(MyLoadAction.class);
stiConfig.setSaveClass(MySaveAction.class);
stiConfig.setLoadDataClass(MyLoadDataAction.class);
stiConfig.setMailAction(MyMailAction.class);
stiConfig.setLocalizationAction(MyLocalizationAction.
class);
stiConfig.setRenderReportAction(MyRenderReportAction.
class);
//
--------------------------------------------------------StiFlexConfig.init(stiConfig);
// set variable in servlet context attribute
// Map<String, String> myVariableMap = new HashMap<String,
String>();
// myVariableMap.put("Variable1", "myVariableMap");
// event.getServletContext().setAttribute("myMap",
myVariableMap);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
@Override
public void contextDestroyed(final ServletContextEvent event) {
// empty
}
public StiFlexConfig initConfigWithoutDir() throws StiException,
IOException {
Properties properties = new Properties();
// load your own Properties;
// InputStream inStream = getClass().getResourceAsStream
("RESOURCE_PATH");
// properties.load(inStream);
return new StiFlexConfig(properties);
}
}

In which the main application directory with the file stimulsoft.properties will be defined. In order to
make your own reports saving or loading, it is necessary to specify these classes in a configuration, just
the same wayasyou canspecifyaclassto load datafromxml. Classes are as follow: Listing
MyLoadAction.java
package my.actions;
import java.io.InputStream;
import com.stimulsoft.flex.StiLoadAction;

2003-2013 Stimulsoft

149

Stimulsoft Reports

import com.stimulsoft.flex.utils.StiSaveLoadFileReport;
public class MyLoadAction extends StiLoadAction {
@Override
public InputStream load(String repotrName) {
System.out.println("must override this method to specify your own
load repotr");
return new StiSaveLoadFileReport().getReport(repotrName);
}
}

Listing MySaveAction.java:
package my.actions;
import com.stimulsoft.flex.StiSaveAction;
import com.stimulsoft.flex.utils.StiOperationResult;
import com.stimulsoft.flex.utils.StiSaveLoadFileReport;
public class MySaveAction extends StiSaveAction {
@Override
public StiOperationResult save(String report, String reportName,
boolean newReportFlag) {
System.out.println("must override this method to specify your own
save report");
return new StiSaveLoadFileReport().save(report, reportName,
newReportFlag);
}
}

Listing MyLoadDataAction.java:
package my.actions;
import
import
import
import

java.sql.Connection;
java.sql.DriverManager;
java.sql.SQLException;
java.util.Properties;

import com.stimulsoft.flex.StiLoadDataAction;
public class MyLoadDataAction extends StiLoadDataAction {
@Override
protected String getConnectionString() {
System.out.println("must override this method to specify your own

2003-2013 Stimulsoft

Using Java Viewer in Web

150

connection string");
// return
// "Data Source=localhost\\SQLEXPRESS;Initial Catalog=Mybase;User
ID=UserName; Password=Password;";
return super.getConnectionString();
}
@Override
protected String getUserName() {
System.out.println("must override this method to specify your own
user name");
// return "UserName";
return super.getUserName();
}
@Override
protected String getPassword() {
System.out.println("must override this method to specify your own
password");
// return "Password";
return super.getPassword();
}
@Override
protected String getQuery() {
System.out.println("my Query " + super.getQuery());
return super.getQuery();
}
@Override
public Connection getConnection() throws ClassNotFoundException,
SQLException {
System.out.println("must override this method to specify your own
connection");
boolean overrideByConnectionString = getConnectionString() !=
null
&& getConnectionString().equals("needOverride");
boolean overrideByDataSource = getDataSourceName() != null
&& getDataSourceName().equals("DataSourceOverride");
if (overrideByConnectionString || overrideByDataSource) {
Class.forName("com.microsoft.sqlserver.jdbc.SQLServerDriver");
Properties info = new Properties();
info.setProperty("user", "test");
info.setProperty("password", "test");
String connectionString = "jdbc:sqlserver://localhost\
\SQLEXPRESS1:1433;databaseName=mybase;";
return DriverManager.getConnection(connectionString, info);
} else {
return super.getConnection();
}
}

2003-2013 Stimulsoft

151

Stimulsoft Reports

Listing MyLocalizationAction.java:
package my.actions;
import
import
import
import
import
import
import
import

java.io.BufferedInputStream;
java.io.File;
java.io.FileInputStream;
java.io.FileNotFoundException;
java.io.InputStream;
java.util.ArrayList;
java.util.Iterator;
java.util.List;

import
import
import
import
import

com.stimulsoft.base.exception.StiException;
com.stimulsoft.base.utils.StiXmlMarshalUtil;
com.stimulsoft.flex.StiLocalizationAction;
com.stimulsoft.flex.StiLocalizationInfo;
com.stimulsoft.lib.io.StiFileUtil;

public class MyLocalizationAction extends StiLocalizationAction {

@Override
public List<StiLocalizationInfo> getLocalizations() throws
StiException, FileNotFoundException {
System.out.println("must override this method to specify your own
Localizations");
List<StiLocalizationInfo> list = new
ArrayList<StiLocalizationInfo>();
File localizationDir = getLocalizationDir();
if (localizationDir.exists()) {
Iterator<File> iterateLocalization = StiFileUtil.iterateFiles
(localizationDir,
new String[] { "xml" }, false);
for (; iterateLocalization.hasNext();) {
File fileLoc = iterateLocalization.next();
InputStream is = new BufferedInputStream(new
FileInputStream(fileLoc));
StiLocalizationInfo localization = StiXmlMarshalUtil.
unmarshal(is,
StiLocalizationInfo.class);
localization.setKey(fileLoc.getName());
list.add(localization);
}
}
return list;
}
@Override

2003-2013 Stimulsoft

Using Java Viewer in Web

152

protected File getLocalizationDir() {

System.out.println("must override this method to specify your own
LocalizationDir");
return new File("Localization");
}
@Override
public InputStream getLocalization(String key) throws StiException,
FileNotFoundException {
System.out.println("must override this method to specify your own
load Localization");
File file = new File(getLocalizationDir(), key);
return new BufferedInputStream(new FileInputStream(file));
}
}

Listing MyMailAction.java:
package my.actions;
import java.util.Properties;
import
import
import
import
import
import
import
import
import
import
import

javax.mail.BodyPart;
javax.mail.Message;
javax.mail.MessagingException;
javax.mail.Multipart;
javax.mail.Session;
javax.mail.Transport;
javax.mail.internet.InternetAddress;
javax.mail.internet.MimeBodyPart;
javax.mail.internet.MimeMessage;
javax.mail.internet.MimeMultipart;
javax.mail.internet.PreencodedMimeBodyPart;

import com.stimulsoft.base.mail.StiMailProperties;
import com.stimulsoft.flex.StiMailAction;
import com.stimulsoft.flex.interactionObject.StiMailData;
/**
* MyMailAction.
*
* @Copyright Stimulsoft
*
*/
public class MyMailAction extends StiMailAction {
@Override
public void init(StiMailData mailData, StiMailProperties mailConf) {
System.out.println("must override this method to specify your own
init");

2003-2013 Stimulsoft

153

Stimulsoft Reports

this.mailData = mailData;
this.mailConf = mailConf;
session = getSession();
}
@Override
protected Session getSession() {
System.out.println("must override this method to specify your own
Session");
Properties props = getProperties();
return Session.getInstance(props);
}
@Override
protected Properties getProperties() {
System.out.println("must override this method to specify your own
mail Properties");
Properties props = new Properties();
props.put("mail.smtp.auth", "true");
props.put("mail.smtp.starttls.enable", "true");
return props;
}
@Override
protected Message getMessage() throws MessagingException {
System.out.println("must override this method to specify your own
mail Message");
Message message = new MimeMessage(session);
message.setRecipients(Message.RecipientType.TO, InternetAddress.
parse(mailConf.getFrom()));
message.setRecipients(Message.RecipientType.CC,
InternetAddress.parse(mailConf.getRecipients()));
message.setSubject(mailConf.getSubject());
BodyPart text = getTextPart();
BodyPart body = getFilePart();
Multipart mp = new MimeMultipart();
mp.addBodyPart(text);
mp.addBodyPart(body);
message.setContent(mp);
return message;
}
@Override
protected BodyPart getTextPart() throws MessagingException {
System.out.println("must override this method to specify your own
mail TextPart");
MimeBodyPart text = new MimeBodyPart();

2003-2013 Stimulsoft

Using Java Viewer in Web

154

text.setText(mailConf.getBody(), "UTF-8", "plain");

return text;
}
@Override
protected BodyPart getFilePart() throws MessagingException {
System.out.println("must override this method to specify your own
mail FilePart");
PreencodedMimeBodyPart body = new PreencodedMimeBodyPart("base64"
);
body.setFileName(mailData.getFileName());
body.setContent(mailData.getData(), mailData.getMIMEType());
return body;
}
private Transport getTransport() throws MessagingException {
System.out.println("must override this method to specify your own
mail Transport");
Transport transport = session.getTransport("smtp");
transport.connect(mailConf.getHost(), mailConf.getSmtpPort(),
mailConf.getUserName(),
mailConf.getPassword());
return transport;
}
@Override
public void sendMessage() throws MessagingException {
System.out.println("must override this method to specify your own
send Message");
Message message = getMessage();
Transport transport = getTransport();
transport.sendMessage(message, message.getAllRecipients());
transport.close();
}
}

Listing MyRenderReportAction.java:
package my.actions;
import java.io.IOException;
import com.stimulsoft.base.exception.StiException;
import com.stimulsoft.flex.StiRenderReportAction;
import com.stimulsoft.report.StiReport;
public class MyRenderReportAction extends StiRenderReportAction {
@Override
public StiReport render(StiReport report) throws IOException,

2003-2013 Stimulsoft

155

Stimulsoft Reports

StiException {
System.out.println("must override this method to specify your own
render report");
return report.render();
}
}

Template JDBC connections

jdbc.driver={myDriver};
jdbc.url={myConnectionUrl};
jdbc.username={myUserName };
jdbc.password={ myUserPassword };

An example for a SQLServer:

jdbc.driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;
jdbc.url=
jdbc:sqlserver://[serverName[\instanceName][:portNumber]][;
property=value[;property=value]];
jdbc.username={myUserName };
jdbc.password={ myUserPassword };

http://msdn.microsoft.com/en-us/library/ms378428
An example for a Oracle:
jdbc.driver=oracle.jdbc.driver.OracleDriver
jdbc.url=jdbc:oracle:thin:@[HOST][:PORT]:SID;
jdbc.username={myUserName };
jdbc.password={ myUserPassword };

http://www.orafaq.com/wiki/JDBC
An example for a postgresql:
jdbc.driver= org.postgresql.Driver
jdbc.url= jdbc:postgresql://[host]:[port]/[database]
jdbc.username={myUserName };
jdbc.password={ myUserPassword };

http://jdbc.postgresql.org/documentation/80/connect.html

2003-2013 Stimulsoft

Using Java Designer

156

Using Java Designer

The Java designer will be described in this section.

18.1 Working with Report Code

Create a sample page with report webdesigner
Create a simple page with a report webdesigner. To do this, put the following libraries into the
WebContent\WEB-INF\lib\ directory: stimulsoft.lib.jar, stimulsoft.reports-base.jar, stimulsoft.reportsreport.jar, stimulsoft.reports-flex.jar, stimulsoft.reports-web.jar, stimulsoft.reports-webdesigner.jar .
Next, edit web.xml it should look like in Listing 1:
Listing 1. Contents of web.xml
<?xml version="1.0" encoding="UTF-8" ?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/
ns/javaee/webapp_2_5.xsd"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee"
id="WebApp_ID" version="2.5">
<display-name>sti_webdesigner</display-name>
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>

<servlet>
<servlet-name>StimulsoftResource</servlet-name>
<servlet-class>com.stimulsoft.web.servlet.StiWebResourceServlet</
servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>StimulsoftResource</servlet-name>
<url-pattern>/stimulsoft_web_resource</url-pattern>
</servlet-mapping>
<servlet>
<servlet-name>StimulsoftDesignerAction</servlet-name>
<servlet-class>com.stimulsoft.webdesigner.servlet.
StiWebDesignerActionServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>StimulsoftDesignerAction</servlet-name>
<url-pattern>/stimulsoft_webdesigner_action</url-pattern>
</servlet-mapping>
</web-app>
Leave unchanged the remaining web.xml blocks, which defines the servlets required for working. Then,
edit the index.jsp (Listing 2).
Listing 2. Contents of index.jsp
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/
2003-2013 Stimulsoft

157

Stimulsoft Reports

DTD/xhtml1-strict.dtd">
<%@page import="java.io.FileOutputStream"%>
<%@page import="java.io.FileInputStream"%>
<%@page import="com.stimulsoft.report.utils.data.StiDataColumnsUtil"%>
<%@page import="com.stimulsoft.report.dictionary.StiDataColumnsCollection"%>
<%@page import="com.stimulsoft.report.dictionary.StiDataColumn"%>
<%@page import="com.stimulsoft.report.utils.data.StiSqlField"%>
<%@page import="com.stimulsoft.report.dictionary.dataSources.StiDataTableSource"%>
<%@page import="com.stimulsoft.report.utils.data.StiXmlTable"%>
<%@page import="com.stimulsoft.report.utils.data.StiXmlTableFildsRequest"%>
<%@page import="com.stimulsoft.webdesigner.StiWebDesigerHandler"%>
<%@page import="com.stimulsoft.webdesigner.StiWebDesignerOptions"%>
<%@page
import="com.stimulsoft.report.dictionary.databases.StiXmlDatabase"%>
<%@page import="java.io.File"%>
<%@page import="com.stimulsoft.report.StiSerializeManager"%>
<%@page import="com.stimulsoft.report.StiReport"%>
<%@page language="java" contentType="text/html; charset=utf-8"
pageEncoding="UTF-8"%>
<%@taglib uri="http://stimulsoft.com/webdesigner" prefix="stiwebdesigner"%>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Stimulsoft Webdesigner for Java</title>
<stiwebdesigner:resources />
<style type="text/css">
</style>
</head>
<body>
<%
final String reportPath = request.getSession().getServletContext().
getRealPath("/reports/Master-Detail.mrt");
final String xmlPath = request.getSession().
getServletContext().getRealPath("/data/Demo.xml");
final String xsdPath = request.getSession().
getServletContext().getRealPath("/data/Demo.xsd");
final String savePath = request.getSession().
getServletContext().getRealPath("/save/");
StiWebDesignerOptions options = new StiWebDesignerOptions();
StiWebDesigerHandler handler = new StiWebDesigerHandler(){
public StiReport getEditedReport(HttpServletRequest
request){
try{
StiReport report = StiSerializeManager.
deserializeReport(new File(reportPath));
report.getDictionary().getDatabases().add(new
StiXmlDatabase("Demo", xsdPath, xmlPath));
return report;
} catch (Exception e){
e.printStackTrace();
}
return null;
}

2003-2013 Stimulsoft

Using Java Designer

158

public void onOpenReportTemplate(StiReport report,

HttpServletRequest request){
report.getDictionary().getDatabases().add(new
StiXmlDatabase("Demo", xsdPath, xmlPath));
}
public void onNewReportTemplate(StiReport report,
HttpServletRequest request){
report.getDictionary().getDatabases().add(new
StiXmlDatabase("Demo", xsdPath, xmlPath));
try{
// In new report if you want to use wizard, you
must populate report with datasources
StiXmlTableFildsRequest tables =
StiDataColumnsUtil.parceXSDSchema(new FileInputStream(xsdPath));
for (StiXmlTable table : tables.getTables()){
StiDataTableSource tableSource = new
StiDataTableSource("Demo." + table.getName(), table.getName(), table.getName());
tableSource.setColumns(new
StiDataColumnsCollection());
for (StiSqlField field : table.getColumns()){
StiDataColumn column = new StiDataColumn
(field.getName(), field.getName(), field.getSystemType());
tableSource.getColumns().add(column);
}
tableSource.setDictionary(report.
getDictionary());
report.getDictionary().getDataSources().add
(tableSource);
}
} catch (Exception e){
e.printStackTrace();
}
}
public void onSaveReportTemplate(StiReport report, String
reportName, HttpServletRequest request){
try{
FileOutputStream fos = new FileOutputStream
(savePath + reportName + ".mrt");
StiSerializeManager.serializeReport(report,
fos);
fos.close();
} catch (Exception e){
e.printStackTrace();
}
}
};
pageContext.setAttribute("handler", handler);
pageContext.setAttribute("options", options);
%>
<stiwebdesigner:webdesigner
handler="${handler}" options="${options}" />
2003-2013 Stimulsoft

159

Stimulsoft Reports

</body>
</html>
Add taglib directives in the JSP. They will work with custom tags on the page.
Listing 3. Custom Stimulsoft tag
<%@ taglib uri="http://stimulsoft.com/webdesigner" prefix="stiwebdesigner"%>
Add a tag <stiwebdesigner:resources /> , tag used to load necessary resources (css & js) for
webdesigner, it havent any attributes, it must be placed inside HTML <head> tag.
Description of webdesigner tag
<stiwebdesigner:webdesigner handler="${handler}" report="${report}" />
This tag contains next attributes:
handler [required] com.stimulsoft.webdesigner.StiWebDesigerHandler object to handle
webdesigner;
options [optional] StiWebdesignerOptions object to customize webdesigner. If not present
default options are used;
designerID [optional] String value identifier of webdesigner HTML element. If more than one
webdesigner present in HTML page each webdesigner must have different identifier.
Description of StiWebDesigerHandler
To handle designer events, class that implement StiWebDesigerHandler must be created and setup in
stiwebdesigner tag. Occured on opening {@link StiReport}.
public StiReport getEditedReport(HttpServletRequest request);
Occurred on loading webdesinger. Here must present implementation of loading report and
population it with Database\Data sources (if required).
public void onOpenReportTemplate(StiReport report, HttpServletRequest request);
Occurred on opening StiReport. Method intended for populate report with Database\Data sources
(if required).
public void onNewReportTemplate(StiReport report, HttpServletRequest request);
Occurred on new StiReport. Method intended for populate report with Database\Data sources (if
required).
In new report if you want to use wizard, you must populate report with datasources.
public void onSaveReportTemplate(StiReport report, String reportName,
HttpServletRequest request);
Occurred on save StiReport. Method must implement saving StiReport.

18.2 Template JDBC Coonections

jdbc.driver={myDriver};
2003-2013 Stimulsoft

Using Java Designer

160

jdbc.url={myConnectionUrl};
jdbc.username={myUserName };
jdbc.password={ myUserPassword };

An example for a SQLServer:

jdbc.driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;
jdbc.url= jdbc:sqlserver://[serverName[\instanceName][:portNumber]][;
property=value[;property=value]];
jdbc.username={myUserName };
jdbc.password={ myUserPassword };

http://jdbc.postgresql.org/documentation/80/connect.html

Using WinRT Viewer

ViewerRT is used to display reports in the WinRT components. The component can display a report,
zoom it, save rendered reports to various exporting formats and print them.

19.1 How to Show Report?

Add the following code to display the rendered report (*.mdc, *.mdz, *.mdx):
XAML:

2003-2013 Stimulsoft

161

Stimulsoft Reports

C#:
namespace Demo.RT
{
public sealed partial class BlankPage : Page
{
#region Handlers
async private void BlankPage_Loaded(object sender,
RoutedEventArgs e)
{
StorageFolder folder = Windows.Storage.KnownFolders.
DocumentsLibrary;
StorageFile storageFile = await folder.GetFileAsync(
"SimpleList.mdc");
StiReport report = new StiReport();
await report.LoadDocumentAsync(storageFile);
viewerControl.Report = report;
}
#endregion
public BlankPage()
{
this.InitializeComponent();
this.Loaded += BlankPage_Loaded;
}
}
}

If the report has not been rendered, i.e. the report template is saved (*.mrt, *.mrz, *.mrx), then enter the
following code:
XAML:
<Page x:Class="Demo.RT.BlankPage"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:viewerRT="using:Stimulsoft.Report.Viewer.RT">
<viewerRT:StiViewerControl x:Name="viewerControl"/>
</Page>

2003-2013 Stimulsoft

Using WinRT Viewer

162

C#:
namespace Demo.RT
{
public sealed partial class BlankPage : Page
{
#region Handlers
async private void BlankPage_Loaded(object sender,
RoutedEventArgs e)
{
StorageFolder folder = Windows.Storage.KnownFolders.
DocumentsLibrary;
StorageFile storageFile = await folder.GetFileAsync
("SimpleList.mrt");
StiReport report = new StiReport();
await report.LoadAsync(storageFile);
await report.RenderAsync();
viewerControl.Report = report;
}
#endregion
public BlankPage()
{
this.InitializeComponent();
this.Loaded += BlankPage_Loaded;
}
}
}

You can open a rendered report by clicking the Open button.

19.2 Saving Report From Code

The report can be saved from the project code. Here is an example of the code to save a report:
XAML:
<Page x:Class="Demo.RT.BlankPage">
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:viewerRT="using:Stimulsoft.Report.Viewer.RT">
<viewerRT:StiViewerControl x:Name="viewerControl"/>
</Page>

C#:
2003-2013 Stimulsoft

163

Stimulsoft Reports

namespace Demo.RT
{
public sealed partial class BlankPage : Page
{
#region Handlers
async private void buttonSaveReport_Click(object sender,
RoutedEventArgs e)
{
StiReport report = new StiReport();
StorageFolder folder = Windows.Storage.KnownFolders.
DocumentsLibrary;
StorageFile storageFile = await folder.CreateFileAsync
("Report1.mdc");
await report.SaveDocumentAsync(storageFile);
}
#endregion
public BlankPage()
{
this.InitializeComponent();
this.Loaded += BlankPage_Loaded;
}
}
}

Exports
This section describes principles of saving rendered reports to different formats, basic characteristics
of methods for export, export optimization guidelines data structure which are used in export
methods. Stimulsoft Reports supports great many export formats to save rendered reports. Many
clients think that there are too many formats. But when you need to get file of definite format type,
write only one string of code and the format is not PDF, HTML or RTF, only Stimulsoft Reports may
help. We do not think that too many export formats in our report generator is disadvantage and
continually work on adding new formats. The more exports the better, as they say.

20.1 Available File Formats

A list of supported file formats is represented in the table below. All exports are joined into groups.
Export Name
PDF (Portable Document Format)
XPS (XML Paper Specification)

2003-2013 Stimulsoft

Exports

164

HTML (HyperText Markup Language)

HTML5 (HyperText Markup Language)
MHTML (MIME HTML)
TXT (Text File)
RTF (Rich Text)
Microsoft Word 2007/2010
ODT (Open Document Text)
Microsoft Excel
Microsoft Excel Xml
Microsoft Excel 2007/2010
Microsoft Power Point 2007/2010
ODS (Open Document Spreadsheet)
CSV (Comma Separated Values)
DBF (DataBase File)
XML (eXtensible Markup Language)
DIF (Data Interchange Format)
SYLK (Symbolic Link)
BMP (Bitmap)
GIF (Graphics Interchange Format)
PNG (Portable Network Graphics)
TIFF (Tagged Image File Format)
JPEG (Joint Photographic Experts Group)
PCX (PCExchange)
WMF (Windows MetaFile)
SVG (Scalable Vector Graphics)

20.2 Export Reports From Code

Stimulsoft Reports offers many ways of exporting rendered reports to other formats. Each method of
export to other format has several settings. For exporting rendered reports Stimulsoft Reports uses a
system of services. This means that all objects which are used in export are represented in the
collection of services and when it is necessary to export a report, the report generator searches the
appropriate service in the collection of services. There are two ways of exporting rendered formats to
2003-2013 Stimulsoft

165

Stimulsoft Reports

other formats from code: using the ExportDocument method of the StiReport class, and using direct
creating or getting from a collection of services the required export service.

20.2.1 ExportDocument Method

The ExportDocument method is a simplified wrapping for report exports. There is no need to get the
required export service. All you need is to define the export type, pass parameters of export and
define the folder where the file should be saved. For example:
StiPdfExportSettings pdfSettings = new StiPdfExportSettings();
report.ExportDocument(StiExportFormat.Pdf, "MyReport.Pdf",
pdfSettings);

The following code id used to export reports to PDF. The PDF file will be placed in the MyReport.Pdf.
The export parameters can be passed using the StiPdfExportSettings object type. This class is
described in the description of the PDF format. If there is no need to change export parameters then it
is possible to use the short code line:
report.ExportDocument(StiExportFormat.Pdf, "MyReport.Pdf");

In this case the export parameters are not passed and the report generator will use parameters which
are set by default for each export. Besides, the result of export can be placed in the stream. For
example:
MemoryStream stream = new MemoryStream();
report.ExportDocument(StiExportFormat.Pdf, stream);

Notice: The ExportDocument method does not call the Render method automatically. Before calling
the ExportDocument method it is necessary to render a report or load a previously rendered report.
As you can see, no services in examples were not created and samples contain simple code. All work
by creating services and checking parameters can be done using the ExportDocument method.
The code above requires connection the following namespaces from assemblies Stimulsoft.Reports.
dll:
Stimulsoft.Report

20.2.2 Export Formats

The StiExportFormat enumeration describes export formats. Brief information of exports is
represented below.

2003-2013 Stimulsoft

Exports

Formats

166

Description

Formats which are used for representing documents and allows for easy viewing and printing:
PDF

export to Adobe PDF.

XPS

export to Microsoft XPS.

Web formats:

Html

export to Html by default. This element duplicates the HtmlTable

mode.

HtmlTable

export to Html using the Html Table element, to create a report

structure.

HtmlSpan

export to Html using the Html Span element, to create a report

structure.

HtmlDiv

export to Html using the Html Div element, to create a report

structure.

Mht

export to WebArchive. This format is supported only in Microsoft

IE.
Text formats:

Text

export to Text.

Rtf

export to Rich Text Format by default. This element duplicates

the HtmlTable mode.

RtfTable

export to Rich Text Format using the Rtf Table element, to create
a report structure.

RtfFrame

export to Rich Text Format using the Rtf Frame element, to create
a report structure.

RtfWinWord

export to Rich Text Format using the Microsoft Word graphic

element, to create a report structure.

RtfTabbedText

export to Rich Text Format using the symbols of tabulation, to

create a report structure.

Word2007

export to Microsoft Word 2007. This format is supported

starting with Microsoft Office 2007.

Odt

export to the OpenDocument Writer file.

Spreadsheets:

Excel

export to Microsoft Excel. The file is created using the BIFF

(Binary Interchange File Format).

ExcelXml

export to Microsoft Excel Xml. The file is created using the Xml.
This format is supported starting with Microsoft Office 2003.

Excel2007

export to Microsoft Excel 2007. This format is supported starting

2003-2013 Stimulsoft

167

Stimulsoft Reports

with Microsoft Office 2007.

Ods

export to OpenDocument Calc file.

Export as data:

Csv

export to CSV (Comma Separated Value).

Dbf

export to dBase/FoxPro.

Xml

export to Xml as data. This format is a saved DataSet.

Dif

export to DIF (Data Interchange Format).

Sylk

export to SYLK (Symbolic Link).

Export as image:

ImageGif

export to GIF.

ImageBmp

export to BMP.

ImagePcx

export to PCX.

ImagePng

export to PNG.

ImageTiff

export to TIFF.

ImageJpeg

export to JPEG.

ImageEmf

export to Windows Metafile.

20.2.3 Export Service

The way to create the export service is shown below. See the code:
StiPdfExportService service = new StiPdfExportService();
StiPdfExportSettings settings = new StiPdfExportSettings();
MemoryStream stream = new MemoryStream();
service.ExportPdf(report, stream, settings);

If you exported from the WinForms Viewer, then you should notice, than for each export the special
form for setting parameters of export is shown. This form can be called from the code. The code
below how to do it for the export to the PDF:
service.Export(report, "MyReport.pdf");

This code will call the dialog form for setting parameters of export. If a user clicks "OK", then the file
will be created. If to click the "Cancel" button, then the file creation will be interrupted.
Notice: The name of the method for the report export with dialog forms differs from the name of
the export method without parameters.

2003-2013 Stimulsoft

Exports

168

The export service of a report contains yet another ability. The report can be sent via Email. For
example:
bool sendEMail = true;
service.Export(report, "MyReport.pdf", sendEMail);

This code will call the dialog form for setting parameters of reports, and if a user clicks "OK", then the
reporting tool will call the Email client and will create a new Email letter, the exported report will be
attached to the Email letter. The code above requires connection of the following names from the
Stimulsoft.Report.dll assemblies:
Stimulsoft.Report
Stimulsoft.Report.Export

20.2.4 All Export Services

The StiExportFormat enumeration describes export formats. Brief information of exports is
represented below.
Export services to Adobe PDF and Microsoft XPS:
StiPdfExportService
StiXpsExportService
Export services to HTML and MHT:
StiHtmlExportService
StiMhtExportService
Export services to Microsoft Excel and Open Document Calc:
StiExcelXmlExportService
StiExcelExportService
StiExcel2007ExportService
StiOdsExportService
Export services to text formats:
StiTxtExportService
StiRtfExportService
StiWord2007ExportService
StiOdtExportService
Export services to data:
StiCsvExportService
StiDbfExportService
StiXmlExportService
StiDifExportService
StiSylkExportService

2003-2013 Stimulsoft

169

Stimulsoft Reports

Export services to graphic formats:

StiBmpExportService
StiGifExportService
StiJpegExportService
StiPcxExportService
StiPngExportService
StiTiffExportService
StiEmfExportService

20.3 Formats with Fixed Page Layout

Stimulsoft Reports supports two exports with fixed page layout. What is the fixed page layout? This
means that all elements of a page can be placed at any part of a page. In this case, if to change a
position of one element then other components position will not be changed. These are formats to
PDF (Portable Document Format), Microsoft Power Point 2007/2010 and XPS (XML Paper
Specification).

20.3.1 PDF
PDF (Portable Document Format) is a file format created by Adobe Systems for document exchange
used to create electronic editions using the Adobe Acrobat package. The PDF format is a file text
format that is used to publish documents on any platform and OS. The PDF document contains one or
more pages. Each page may contain any components: text, graphic and illustrations, information, that
provides navigation across the document.
Export to PDF is based on the "Adobe Portable Document Format, Version 1.3, second edition", using
some elements of latest format specifications.

20.3.1.1 Embedded Fonts

By default all embedded fonts are optimized. Characters which are not used in a report are excluded. It
allows decreasing the size of a file. But, for correct work of the editable field, the font should be
complete. Therefore, for fonts, which are used in editable fields, optimization is not done. This
increases the output file size. If Asian languages are used, the file size can be 15-20mb.
If by some reasons the font optimization is not working correct it can be forcibly disabled using the
static property:
StiOptions.Export.Pdf.ReduceFontFileSize = false;
20.3.1.2 Digital Signature

Digital signature is a requisite of an electronic document used to protect this document from
2003-2013 Stimulsoft

Exports

170

falsification. This document is a result of cryptographic conversion of information using the closed key
of the electronic signature and allows identifying the owner of the certificate of the key of the signature.
Digital signatures are often used to implement electronic signatures

20.3.1.2.1 Digital Signature from Code

The StiPdfExportSettings class is used to control digital signature. It has the following properties:
public
public
public
public

bool UseDigitalSignature
bool UseLocalMachineCertificates
bool GetCertificateFromCryptoUI
string SubjectNameString

By default:
UseDigitalSignature = false;
UseLocalMachineCertificates = true;
GetCertificateFromCryptoUI = true;
SubjectNameString = string.Empty;

A sample how to use these properties is shown below:

StiReport report = new StiReport();
report.Load("c:\\test.mrt");
report.Render(false);
StiPdfExportSettings settings = new StiPdfExportSettings();
settings.UseDigitalSignature = true;
settings.GetCertificateFromCryptoUI = false;
settings.UseLocalMachineCertificates = true;
settings.SubjectNameString = "John Smith <[email protected]>";
report.ExportDocument(StiExportFormat.Pdf, "c:\\test.pdf", settings);

20.3.1.3 Encryption

A PDF document can be encoded to protect the content from unauthorized access. A user may set the
following parameters of encryption:
User password;
Owner password;
Access permission;
Key length.

2003-2013 Stimulsoft

171

Stimulsoft Reports

20.3.1.3.1 Using Parameters of Encryption from Code

Using the StiPdfExportSettings class it is possible to set the encryption parameters from code. The
following properties of this class are used:
public
public
public
public

string PasswordInputUser
string PasswordInputOwner
StiUserAccessPrivileges UserAccessPrivileges
StiPdfEncryptionKeyLength KeyLength

The StiUserAccessPrivileges enumeration contains the following elements (flags):

None,
PrintDocument,
ModifyContents,
CopyTextAndGraphics,
AddOrModifyTextAnnotations,
All
The StiPdfEncryptionKeyLength enumeration contains the following elements:
Bit40,
Bit128
By default the values set as follow:
PasswordInputUser = string.Empty;
PasswordInputOwner = string.Empty;
UserAccessPrivileges = StiUserAccessPrivileges.All;
KeyLength = StiPdfEncryptionKeyLength.Bit40;

An example of using:
StiReport report = new StiReport();
report.Load("c:\\test.mrt");
report.Render(false);
StiPdfExportSettings settings = new StiPdfExportSettings();
settings.PasswordInputUser = "user";
settings.PasswordInputOwner = "owner";
settings.UserAccessPrivileges = StiUserAccessPrivileges.PrintDocument;
settings.KeyLength = StiPdfEncryptionKeyLength.Bit128;
report.ExportDocument(StiExportFormat.Pdf, "c:\\test.pdf", settings);

20.3.1.4 Editable Fields

To enable the export of editable fields it is necessary to set the static property

2003-2013 Stimulsoft

Exports

172

StiOptions.Export.Pdf.AllowEditablePdf = true;

Editable fields in the PDF-file has two conditions:

First a condition before editing, it is shown when opening the file. This condition corresponds to
the type of a text box in the preview.
Second - the type in the mode of field editing, and after editing. In this condition it is impossible to
set the vertical alignment of the text (always Top) and some parameters of a font. Therefore, after
editing a field, even if the contents is not changed, the type of this field can be change.
If it is necessary to have the MultiLine editable field, then it is necessary to set the WordWrap
property of the text box to true.

20.3.1.5 Export Settings

The export parameters of the PDF export are described in the StiPdfExportSettings class. The
description of all class properties are in the table below.
Name

Type

Description

ImageQuality

float

image quality; may have values from 0.0 (the lowest quality) to
1.0 (the highest quality); by default 0.75

ImageResolution

float

image resolution dpi; can take any value, by default 100

EmbeddedFonts

bool

embed font files into the PDF file; is true then all fonts are
embedded into the file and this file will have the same look on
any computer (there is no need to embed additional fonts); if
false then fonts are not embedded; by default true

StandardPdfFonts

bool

use standard fonts which are embedded in Adobe Acrobat

Reader and there is no need to embed them into the file; all
fonts are changed on standard fonts (Courier, Helvetica, TimesRoman); by default false

Compressed

bool

compress the PDF file; decreases the file size by compressing

the text information (images are always compressed); by default
true

UseUnicode

bool

writes a text in the Unicode; if false then 190 symbols can be

written, and a lot of problems with native language symbols
may occur; if true then any symbols can be used; by default true

ExportRtfTextAsImage bool

export RichText objects as images; if false then export tries to

convert RichText objects into PDF primitives; if true the RichText
is written as an image; by default false

PasswordInputUser

string

user password (see Encryption); by default empty string

PasswordInputOwner

string

owner password (see Encryption); by default empty string

2003-2013 Stimulsoft

173

Stimulsoft Reports

UserAccessPrivileges

enum

user access privileges

StiUserAccessPrivileges.All

(see

Encryption);

KeyLength

enum

key
length
(see
Encryption);
StiPdfEncryptionKeyLength.Bit40

UseDigitalSignature

bool

use digital signature of a document; by default false

GetCertificateFromCry
ptoUI

bool

get the certificate from the Crypto interface; if false then a

certificate is searched by certificate identifier without using the
interface; by default true

SubjectNameString

string

certificate identifier; this is a certificate name (empty string) or a

part of a name (substring); by default empty string

UseLocalMachineCerti
ficates

bool

search certificates on the local machine; if false then certificate is

searched in the store of the current user; by default false

CreatorString

string

the "Creator" field in the document description (application

name that created the original file); if it is not set (empty string)
then the StiOptions.Export.Pdf static property is used.
CreatorString; by default empty string

KeywordsString

string

the "Keywords" field in the document description (application

name that created the original file); if it is not set (empty string)
then the StiOptions.Export.Pdf.KeywordsString static property is
used; by default empty string

ImageCompressionMe enum
thod

image compression method - JPEG (with quality loss) or Flate

(without
quality
loss);
by
default
StiPdfImageCompressionMethod.Jpeg

default
default

If the UseUnicode is used then, for Acrobat Reader 5.0, it is necessary to use the Embedded fonts =
true. If the UseUnicode + encoding is used, then it is necessary to use the Embedded fonts = true.
The following should be done to compress file:
enable Compressed;
disable Embedded fonts;
if Embedded fonts is required then enable the ReduceFontFileSize.

20.3.1.6 Static Options

Except the StiPdfExportSettings class, parameters of export to PDF are also set using the static
properties. All properties are described in the table below. To access to export properties it is
necessary to add the StiOptions.Export.Pdf... prefix.
For example, StiOptions.Export.Pdf.
DivideSegmentPages.
Name
DivideSegmentPages

Type
bool

Description
divide segmented pages into separate pages; if false then are

2003-2013 Stimulsoft

Exports

Name

Type

174

Description
exported "as is" without dividing; by default true

ConvertDigitsToArabic

bool

convert ASCII digits Arabic; by default false

ArabicDigitsType

enum

Select Arabic digits type; by default Standard

ReduceFontFileSize

bool

optimize embedded fonts - eliminate symbols which are not

met in a report; if false then fonts are not changed; by default
true

AllowEditablePdf

bool

export editable fonts as editable PDF objects (in this case

fonts which are used in editable fields are not optimized); if
false then editable fields are exported as simple text; by
default false

AllowImageComparer

bool

use the image comparer, e.g. replace image duplicates (see

Common export settings); if false then an image is exported
"as is"; by default true

AllowImageTransparency

bool

use transparency in export images; by default true

AllowInheritedPageResou
rces

bool

store resources of pages in the parent dictionary and inherit

from it; if false then resources of pages are specified in each
page; this property is critical for some programs of PDF files
processing; by default true

AllowExtGState

bool

use command to control transparency when creating a

document; if false then commands are not used; this property
is critical for some programs of PDF files processing; by
default true

CreatorString

string

the "Creator" field in document description (application name,

which created the original document); by default the
"Stimulsoft Reports.Net" string

KeywordsString

string

the "Keywords" field in document description (keywords); by

default empty string

20.3.2 XPS
XPS (XML Paper Specification) is the open graphic format of fixed page layout on the base XML (more
precisely XAML-based) used to store printed output as electronic documents. This format was
developed by Microsoft as alternative to the PDF format.
The XPS document format consists of structured XML markup that defines the layout of a document
and the visual appearance of each page, along with rendering rules for distributing, archiving,
rendering, processing and printing the documents. The markup language for XPS is a subset of XAML
that allows including vector graphic elements, using XAML to mark up the WPF-primitives.
The XPS is a ZIP-archive that contains the files which make up the document. The archive includes page
2003-2013 Stimulsoft

175

Stimulsoft Reports

mark up (one file per each page of a document), text, embedded fonts, raster images, 2D vector
graphics and other information.

20.3.2.1 Export Settings

The export parameters of the XPS export are described in the StiXpsExportSettings class. The
description of all class properties are in the table below.
Name

Type

Description

ImageQuality

float

image quality; may have values from 0.0 (the lowest

quality) to 1.0 (the highest quality); by default 0.75

ImageResolution

float

image quality; may have values from 0.0 (the lowest

quality) to 1.0 (the highest quality), by default 100

20.3.2.2 Static Options

Besides the StiXpsExportSettings class, the parameters of export to XPS are also set using the static
properties. All properties are described in the table below. To access to export properties it is
necessary to add the StiOptions.Export.Xps... prefix. For example, StiOptions.Export.Xps.
ReduceFontFileSize.
Name

Type

Description

ReduceFontFileSize

bool

optimize embedded fonts - exclude symbols which are not

met in a report; if false then fonts are not changed; by
default true

AllowImageComparer

bool

use the image comparer, e.g. replace image duplicates (see

Common export settings); if false then an image is exported
"as is"; by default true

AllowImageTransparency

bool

use the transparency in exporting images; by default true

20.3.3 Microsoft Power Point 2007/2010

Microsoft PowerPoint is a presentation program developed by Microsoft. It is a part of the Microsoft
Office suite. PowerPoint presentations consist of a number of individual pages or "slides". Slides may
contain text, graphics, movies, and other objects, which may be arranged on the slide. The presentation
can be printed, displayed on a PC, or navigated through at the command of the presenter. In Stimulsoft
Reports each report page corresponds to one slide.

2003-2013 Stimulsoft

Exports

176

20.3.3.1 Export Settings

The export parameters of the PPT export are described in the StiPpt2007ExportSettings class. The
description of all class properties are in the table below.
Name

Type

Description

ImageQuality

float

image quality; may have values from 0.0 (the lowest

quality) to 1.0 (the highest quality); by default 0.75

ImageResolution

float

image quality; may have values from 0.0 (the lowest

quality) to 1.0 (the highest quality), by default 100

20.3.3.2 Static Options

Besides the StiPpt2007ExportSettings class, the parameters of the export to PPT are also set using the
static properties. All properties are described in the table below. To access to export properties it is
necessary to add the StiOptions.Export.Ppt2007... prefix. For example, StiOptions.Export.Ppt2007.
ReduceFontFileSize.
Name
AllowImageComparer

20.4

Type
bool

Description
use the image comparer, e.g. replace image duplicates (see
Common export settings); if false then an image is exported
"as is"; by default true

Web Documents
There are two formats HTML (HyperText Markup Language), HTML5 and MHTML (MIME HTML) are
described in this chapter. The first and second formats are used for web page layout. The second
format is a web page archive format used to bind resources together with the HTML code into a single
file.

20.4.1 HTML
HTML (HyperText Markup Language) is the predominant markup language for Web pages. The
majority of web pages are created using the HTML language. The HTML language is interpreted by
browser and shown as a document. HTML is a tag language of the document layout. It provides a
means to describe the structure of text-based information in a document by denoting certain text as
links, headings, paragraphs, lists, etc. Elements are the basic structure for HTML markup. Elements have
two basic properties: attributes and content. Each attribute and each element's content has certain
restrictions that must be followed for a HTML document to be considered valid. An element usually has
a start tag (e.g. <element-name>) and an end tag (e.g. </element-name>).

2003-2013 Stimulsoft

177

Stimulsoft Reports

20.4.1.1 Export Settings

The export parameters of the HTML export are described in the StiHtmlExportSettings class. The
description of all class properties are in the table below.
Name

Type

Description

Zoom

double

zoom coefficient; by default 1.0

ImageFormat

sets an image export format;

by default ImageFormat.Png

ExportMode

StiHtmlExportMode

sets the mode of the document

export using the div, span or
table elements; by default
StiHtmlExportMode.Table

ExportQuality

StiHtmlExportQuality

export quality of components

size;
by
default
StiHtmlExportQuality.High

Encoding

file encoding;
Encoding.UTF8

AddPageBreaks

bool

add page breaks; by default

false

BookmarksTreeWidth

int

bookmark column width, in

pixels; by default 150

ExportBookmarksMode

StiHtmlExportBookmarksMode

a mode the export a document

with bookmarks; by default
StiHtmlExportBookmarksMode.
All

UseStylesTable

bool

use the Styles table; if false

then the style table is empty
and all properties of each
component
will
described
directly in the style of this
component; by default true

default

20.4.1.2 Static Options

Except the StiHtmlExportSettings class parameters of export to HTML are set using the static
properties. All properties are described in the table below. To access to export properties it is
necessary to add the StiOptions.Export.Html... prefix. For example, StiOptions.Export.Html.
ConvertDigitsToArabic.

2003-2013 Stimulsoft

Exports

Name

Type

178

Description

ConvertDigitsToArabic

bool

convert ASCII digits to Arabic digits; by default false

ArabicDigitsType

enum

select Arabic digits type; by default Standard

AllowImageComparer

bool

use the image comparer, e.g. replace image

duplicates (see Common export settings); if false then
an image is exported "as is"; by default true

ForceWysiwygWordwrap

bool

Forcibly break text in rows as well as in the WYSIWYG

mode; by default - false

ReplaceSpecialCharacters

bool

change symbols '<', '>', '&', ' " ' on < > &
" by default true

20.4.2 MHT
MHTML (MIME HTML) is a web page archive format used to bind resources which are typically
represented by external links (such as images, Flash animations, Java applets, audio files) together with
HTML code into a single file. This file is a web archive and has the .mht extension. The content of a
file is written as an Email message using the MIME standard: in the beginning of a file the HTML file is
written. Then all resources in the base64 encoding with headers are written. Internet Explorer, Opera,
Microsoft Word can work with the MHTML format.

20.4.2.1 Export Settings

The export parameters of the MHT export are described in the StiMhtExportSettings class. The
description of all class properties are in the table below.
Name

Type

Description

Zoom

double

zoom coefficient; by default 1.0

ImageFormat

sets an image export format; by

default ImageFormat.Png

ExportMode

StiHtmlExportMode

sets the mode of the document export

using the div, span or table elements;
by default StiHtmlExportMode.Table

ExportQuality

StiHtmlExportQuality

export quality of components size; by

default StiHtmlExportQuality.High

Encoding

file encoding; by default Encoding.

UTF8

AddPageBreaks

bool

add page breaks; by default false

2003-2013 Stimulsoft

179

Stimulsoft Reports

Name

Type

Description

BookmarksTreeWidth

int

bookmark column width, in pixels; by

default 150

ExportBookmarksMode

StiHtmlExportBookmarksMode a mode the export a document with

bookmarks;
by
default
StiHtmlExportBookmarksMode.All

20.5 Text Formats

This chapter describes exports formats of text files. In other words the files which are used to create
text documents.

20.5.1 TXT
Text file (TXT) is a kind of computer file that is structured as a sequence of lines. A text file exists
within a computer file system. The end of a text file is often denoted by placing one or more special
characters, known as an end-of-file marker, after the last line in a text file.
Text files are commonly used for storage of information.

20.5.1.1 Export Settings

The export parameters of the TXT export are described in the StiTxtExportSettings class. The
description of all class properties are in the table below.
Name

Type

Description

Encoding

text file coding; by default Encoding.UTF8

DrawBorder

bool

draw border lines; if false, then borders are not

drawn; by default true

BorderType

StiTxtBorderType

a type of a border line; by default StiTxtBorderType.

UnicodeSingle

KillSpaceLines

bool

remove all empty rows of a text; by default true

KillSpaceGraphLines

bool

remove all rows of a text which contains only blank

spaces and symbols of the vertical border; by default
true

PutFeedPageCode

bool

put feed page code after each page; by default true

CutLongLines

bool

cut too long lines of a text which cannot be placed in

text boxes; by default true

2003-2013 Stimulsoft

Exports

Name

Type

180

Description

ZoomX

float

zoom coefficient by X axis; by default 1.0

ZoomY

float

zoom coefficient by Y axis; by default 1.0

20.5.1.2 Static Options

Static properties of export to TXT are shown on the table below. To access to export properties it is
necessary to add the StiOptions.Export.Txt... prefix. For example, StiOptions.Export.Txt.
ColumnWidths.
Name

Type

Description

ColumnWidths

string

forcibly set the text column width (the list through the
semicolon); if a row is empty then the column width is not
changed; by default empty string

UseFullTextBoxWidth

bool

use all text box width for a text; in this case if the text is laid
on a border, then the border is erased in this place; if false,
then when drawing a text, one blank space on the right is
always left for correct drawing borders; by default false

UseOldMode

bool

use the old mode of the text export; this property is left for
keeping compatibility with old versions; by default false

UseFullVerticalBorder

bool

draw vertical border outside a cell. So a border will never be

closed with a text; by default true

UseFullHorizontalBorder bool

draw horizontal border outside a cell. So a border will never

be closed with a text; by default true

CheckBoxTextForTrue

string

a text that shows the checkbox true status ; by default "+"

CheckBoxTextForFalse

string

a text that shows the check false status; by default "-"

20.5.2 RTF
Rich Text Format (RTF) is a free document file format developed by Microsoft for cross-platform
document interchange. The first version of the RTF standard appeared in 1987. Since that time format
specification was changed and added. RTF-documents are supported by many text editors.

20.5.2.1 Export Settings

The export parameters of the RTF export are described in the StiRtfExportSettings class. The
description of all class properties are in the table below.

2003-2013 Stimulsoft

181

Stimulsoft Reports

Name

Type

Description

ImageQuality

float

image quality; may have values from 0.0 (the lowest

quality) to 1.0 (the highest quality); by default 0.75

ImageResolution

float

image quality; may have values from 0.0 (the lowest

quality) to 1.0 (the highest quality), by default 100

UsePageHeadersAndFooters

bool

process headers and footers of a page (see Table

mode); by default false

ExportMode

enum

select export mode (see Common knowledge); by

default StiRtfExportMode.Table

CodePage

int

this property is obsolete and is not used any

longer, remained for compatibility with earlier
versions

20.5.2.2 Static Options

Except the StiRtfExportSettings class parameters of export to RTF can be set using the static
properties. All properties are described in the table below. To access to export properties it is
necessary to add the StiOptions.Export.Rtf... prefix. For example, StiOptions.Export.Rtf.
UsePageRefField.
Name

Type

Description

UsePageRefField

bool

when exporting a header with page numbers (for

example, the "Anchors" report) the MS-Word "PAGEREF"
command should be used for page numbers. Page
numbers in the table of contents will be dynamically
changed; if false, then numbers of pages will be static; by
default true

ConvertDigitsToArabic

bool

convert ASCII digits into Arabic digits; by default false

ArabicDigitsType

enum

select type of Arabic digits; by default Standard

DivideSegmentPages

bool

divide segmented pages into separate pages; if false then

are exported "as is" without dividing; by default true

LineHeightExactly

bool

export rows heights of a table "exactly"; if false then the

height is exported as "at least"; by default true

RemoveEmptySpaceAtBotto
m

bool

remove empty space on the bottom of a page; by default

true

LineSpacing

double

coefficient of correction of a row height in multilined text

fields; by default 0.965

RightMarginCorrection

int

correction of the right margin of a cell; by default 0

2003-2013 Stimulsoft

Exports

Name

Type

182

Description

SpaceBetweenCharacters

int

sets space between characters of a font in twips; negative

value corresponds to condensation; by default -2

UseCanBreakProperty

bool

use the CanBreak property when exporting rows of a

table; by default true

DivideBigCells

bool

divide big cells into smaller ones for easier editing and
scrolling; by default true

20.5.3 Word 2007/2010

Microsoft Word is a text processing software produces by Microsoft. It is a component of the
Microsoft Office system. The first version was released for IBM PC's running DOS in 1983. Later there
was a release for Apple Macintosh (1984), SCO UNIX, and Microsoft Windows (1989). Microsoft Word
is the most popular text processors. Starting with first versions MS Word could write files in binary
code with the .doc extension. The Word specification was secret and only in 2008 was published. The
latest version of Word 2007/2010 "uses by default" the XML based format: Microsoft Office Open
XML. For a new format the .docx file extension is used. This format is a zip-archive that contains a
text as XML, graphics, and other data. When exporting, a report is converted into one table. Such a
document is easy to edit.

20.5.3.1 Export Settings

The export parameters of the Word 2007 export are described in the StiWord2007ExportSettings
class. The description of all class properties are in the table below.
Name

Type

Description

ImageQuality

float

image quality; may have values from 0.0 (the lowest

quality) to 1.0 (the highest quality); by default 0.75

ImageResolution

float

image quality; may have values from 0.0 (the lowest

quality) to 1.0 (the highest quality), by default 100

UsePageHeadersAndFooters

bool

process headers and footers of a page; by default false

20.5.3.2 Static Options

Static properties of export to Word 2007. To access to export properties it is necessary to add the
StiOptions.Export.Word2007...
prefix.
For
example,
StiOptions.Export.Word2007.
DivideSegmentPages.

2003-2013 Stimulsoft

183

Stimulsoft Reports

Name

Type

Description

DivideSegmentPages

bool

divide segmented pages into separate pages; if

false then are exported "as is" without dividing; by
default true

AllowImageComparer

bool

use the image comparer, e.g. replace image

duplicates (see Common export settings); if false
then an image is exported "as is"; by default true

LineHeightExactly

bool

export the rows height of a table "exactly"; if false

then the height is exported as "at least"; by default
true

RemoveEmptySpaceAtBottom

bool

remove empty space on the bottom of a page; by

default true

RightMarginCorrection

int

correction of the right margin of a cell; by default 0

SpaceBetweenCharacters

int

sets the space between characters of a font (in

twips); negative value corresponds to condensed;
by default -2

20.5.4 ODT
Open Document Text (ODT) is the open document for storing documents of the OpenOffice Writer,
which is included into the OpenOffice.org package.
OpenOffice.org is the open package of office applications created as alternative to Microsoft Office.
OpenOffice.org was one of the first what supported the new open OpenDocument. Works on Microsoft
Windows and UNIX systems: GNU/Linux, Mac OS X, FreeBSD, Solaris, Irix.
OpenDocument Format (ODF) is the open file format for storing office documents, including text
documents, spreadsheets, images, data bases, presentations. This format is based on the XML format.

OpenOffice Writer is the text processor and visual HTML editor, included into the OpenOffice. It is open
software (LGPL license). Writer is similar to Microsoft Word and has approximately the same
functionality. Writer allows saving documents in different formats including Microsoft Word, RTF,
XHTML, and OASIS Open Document Format. Starting with the OpenOffice version 2.0, the
OpenDocument Format is the default format for saving documents. File have the .odt extension.
When exporting the report is converted into a single table. The document is easily editable but some
objects can be changed.

20.5.4.1 Export Settings

The export parameters of the ODT export are described in the StiOdtExportSettings class. The
2003-2013 Stimulsoft

Exports

184

description of all class properties are in the table below.

Name

Type

Description

ImageQuality

float

image quality; may have values from 0.0 (the lowest quality) to1.0
(the highest quality); by default 0.75

ImageResolution

float

image resolution, dot per inch; may have any value, by default 100

20.5.4.2 Static Options

Static properties of export to ODT. To access to export properties it is necessary to add the
StiOptions.Export.Odt... prefix. For example, StiOptions.Export.Odt.DivideSegmentPages.
Name

Type

Description

DivideSegmentPages

bool

divide segmented pages into separate pages; if false

then are exported "as is" without dividing; by default
true

AllowImageComparer

bool

use the image comparer, e.g. replace image duplicates

(see Common export settings); if false then an image is
exported "as is"; by default true

RemoveEmptySpaceAtBottom

bool

remove empty space on the bottom of a page; by

default true

20.6 Spreadsheets
This group of exports create spreadsheets. They are exports to both different formats of Microsoft
Excel and to OpenOffice Calc.

20.6.1 Excel
Microsoft Excel is a spreadsheet application written and distributed by Microsoft for Microsoft
Windows. It allows using calculation, graphing tools, pivot tables and a macro programming language
called VBA. So, it is the most popular table processor available for these platforms since version 5 in
1993.
Microsoft Excel up until Excel 2007 version used a proprietary binary file format called Binary
Interchange File Format (BIFF) and .xls file extension. Specification was closed but since 2008 it was
published. Besides, most of Microsoft Excel can read CSV, DBF, SYLK, DIF, and other formats.

2003-2013 Stimulsoft

185

Stimulsoft Reports

20.6.1.1 Export Settings

The export parameters of the XLS export are described in the StiExcelExportSettings class. The
description of all class properties are in the table below.
Name

Type

Description

ImageQuality

float

image quality; may have values from 0.0 (the lowest

quality) to1.0 (the highest quality); by default 0.75

ImageResolution

float

image resolution, dot per inch; may have any value, by

default 100

UseOnePageHeaderAndFooter bool

remove from a report all page headers (except the first

one) and all page footers (except the last one); by default
false

ExportDataOnly

bool

export data only, e.g. all components which are placed

on data bands; by default false

ExportPageBreaks

bool

export page breaks; by default false

ExportObjectFormatting

bool

export object formatting; by default true

ExportEachPageToSheet

bool

export each page of a report as a sheet; by default false

The ExportObjectFormatting property works only if the ExportDataOnly is set to true.

20.6.1.2 Static Options

Static properties of export to Excel. To access to export properties it is necessary to add the
StiOptions.Export.Excel... prefix. For example, StiOptions.Export.Excel.AllowExportDateTime.
Name

Type

Description

AllowExportDateTime

bool

export date and time; if false then date and time are
exported as text strings; by default false

ColumnsRightToLeft

bool

set the order of columns from right to left; by default

false

MaximumSheetHeight

int

maximal number of rows on a sheet; remaining rows are

transferred on the next sheet; by default 65534

RemoveEmptySpaceAtBottom

bool

remove empty space on the bottom of a page; by

default true

ShowGridLines

bool

show grid lines; by default true

2003-2013 Stimulsoft

Exports

186

20.6.2 Excel 2007/2010

For storing documents as the basic Microsoft Excel format, right up to the Excel 2007 version, used its
own binary format of files (BIFF) and the file extension was .xls. In Excel 2007/2010, the basic format
is the Microsoft Office Open XML format and stores document in files with the .xlsx extension. The
Excel 2007 is compatible with binary formats such as CSV, DBF, SYLK, DIF, and others.

20.6.2.1 Export Settings

The export parameters of the Excel 2007 export are described in the StiExcel2007ExportSettings
class. The description of all class properties are in the table below.
Name

Type

Description

ImageQuality

float

image quality; may have values from 0.0 (the

lowest quality) to1.0 (the highest quality); by
default 0.75

ImageResolution

float

image resolution, dot per inch; may have any

value, by default 100

UseOnePageHeaderAndFooter

bool

remove from a report all page headers (except

the first one) and all page footers (except the last
one); by default false

ExportDataOnly

bool

export data only, e.g. all components which are

placed on data bands; by default false

ExportPageBreaks

bool

export page breaks; by default false

ExportObjectFormatting

bool

export object formatting; by default true

ExportEachPageToSheet

bool

export each page of a report as a sheet; by

default false

The ExportObjectFormatting property works only if the ExportDataOnly is true.

20.6.2.2 Static Options

Static properties of export to Excel 2007.

Name
AllowImageComparer

2003-2013 Stimulsoft

Type
bool

Description
use the image comparer, e.g. replace image
duplicates (see Common export settings); if false
then an image is exported "as is"; by default true

187

Stimulsoft Reports

Name

Type

Description

ColumnsRightToLeft

bool

set the order of columns from right to left; by

default false

MaximumSheetHeight

int

maximal number of rows on a sheet; odd rows are

moved to the next sheet; by default 1048574

RemoveEmptySpaceAtBottom

bool

remove empty space on the bottom of a page; by

default true

20.6.3 ODS
Open Document Spreadsheet (ODS) is the opened format to store OpenOffice Calc spreadsheet
documents, that is included into the OpenOffice.org package.
OpenOffice.org is a free package of office applications developed as alternative to Microsoft Office.
The OpenDocument is one of the first what started to support the opened format. it works on
Microsoft Windows and UNIX-like systems: GNU/Linux, Mac OS X, FreeBSD, Solaris, Irix.
OpenDocument Format (ODF) an open document file format for storing and exchanging editable
documents including text documents (such as notes, reports, and books), spreadsheets, drawings,
databases, presentations. The format is based on the XML-format. The standard was jointly developed
by public and various organizations and is available to all and can be used without restrictions.
OpenOffice Calc is the table processor that is included into the OpenOffice and is a free software (LGPL
license). Calc is similar to the Microsoft Excel spreadsheet and functionality of these processors is
approximately equal. Calc allows you to saving documents to various formats, including Microsoft
Excel, CSV, HTML, SXC, DBF, DIF, UOF, SLK, SDC. Starting with version OpenOffice 2.0, for document
storage format by default OpenDocument Format, files are saved with the extension . Ods. Starting
with the OpenOffice version 2.0 for storing documents, by default, the OpenDocument Format is used.
Files are stored with the .ods extension.

20.6.3.1 Export Settings

The export parameters of the ODS export are described in the StiOdsExportSettings class. The
description of all class properties are in the table below.
Name

Type

Description

ImageQuality

float

image quality; may have values from 0.0 (the lowest quality)
to1.0 (the highest quality); by default 0.75

ImageResolution

float

image resolution, dot per inch; may have any value, by

default 100

2003-2013 Stimulsoft

Exports

188

20.6.3.2 Static Options

Static properties of export to ODS. To access to export properties it is necessary to add the
StiOptions.Export.Ods... prefix. For example, StiOptions.Export.Ods.AllowImageComparer.
Name

Type

Description

AllowImageComparer

bool

use the image comparer, e.g. replace image

duplicates (see Common export settings); if false
then an image is exported "as is"; by default true

DivideSegmentPages

bool

divide segmented pages into separate pages; if

false then are exported "as is" without dividing; by
default true

RemoveEmptySpaceAtBottom

bool

remove empty space on the bottom of a page; by

default true

20.7 Data
This is a group of file formats which are used to store table data.

20.7.1 CSV
CSV (Comma Separated Values) is a text format that is used to represent table data. Each string of the
file is one row of the table. The values of each column are separated by the delimiter that depends on
regional settings. The values that contain reserved characters (such as a comma or a new string) are
framed with the double quotes ( ") symbol; if double quotes are found in the value they are
represented as two double quotes in the file.
Notice: Only those data (components) can be exported to the CSV format which are placed on data
bands. If the SkipColumnHeaders property is set to false then, additionally, column headers are
exported as the first row.

20.7.1.1 Export Settings

The export parameters of the CSV export are described in the StiCsvExportSettings class. The
description of all class properties are in the table below.
Name
Separator

2003-2013 Stimulsoft

Type
string

Description
sets the symbol-separator of a list that is used when exporting;
by default CurrentCulture.TextInfo.ListSeparator

189

Stimulsoft Reports

Encoding

text file coding; by default Encoding.UTF8

SkipColumnHeaders

bool

skip headers of columns; by default false

20.7.1.2 Static Options

Static properties of export to CSV. To access to export properties it is necessary to add the
StiOptions.Export.Csv... prefix. For example, StiOptions.Export.Csv.ForcedSeparator.
Name
ForcedSeparator

Type
string

Description
sets the separator forcibly which are used in export; if
the empty string is set then the symbol from export
settings in used; by default - empty string

20.7.2 DBF
The DBF (DataBase File) is the format to store data and it is used as the standard way to store and
pass information. The DBF file consist of a header section for describing the structure of the data in the
file. There are several variations on the .dbf file structure.
Notice: Only data can be exported to the DBF format, in other words only the components, which
are placed on data bands.

20.7.2.1 Controlling Exports

The following elements can be specified in the Tag field to control export:
DataType [ : FieldLength [ : DecimalPartLength ] ]
ExportType : "FieldName"
Column: "FieldName" "DataString"
Several elements should be separated with the semicolon. The DataType" element should be only one
and should be placed first, other elements if necessary.
Values of the "DataType" element are shown in the table below. If the data type is not set, then the
string data type is taken by default. The "FieldLength" element sets fixed width of a data field. If the
field width is not set, then the width is taken from the table. For the string type the default width is the
longest string. The "DecimalPartLength" element sets the number of characters after comma. If it is not
set, then the default number is taken.

Data type
int

DBF data type

(default size)
Numeric (15 : 0)

Description
Numeric

2003-2013 Stimulsoft

Exports

long

Numeric (25 : 0)

Numeric

float

Numeric (15 : 5)

Decimal

double

Numeric (20 : 10)

Decimal

string

Character (auto)

Text

date

Date (8)

Date

190

Sample of using elements are shown in the table below.

Type

Description

string : 25

set the column width (25 characters) and cuts all long strings

float

converts decimal digit with the length 15 characters, 5 characters

after comma

float :10

converts decimal digit with the length 10 characters, 5 characters

after comma

float :10 : 2

converts decimal digit with the length 10 characters, 2 characters

after comma

int :10 : 2

converts integer digit with the length 10 characters; the second

parameter is ignored

Notice: If the integer part of a digit is long and cannot be placed into the specified field, then it is
cut, so data are lost. For example, if the write -12345,678 in the float:8:3 field, then the 2345,678
will be output.
The "ExportType" element indicates for which export the field name is set. The values can be used:
dbf, csv, xml, default. The "FieldName" element indicates the field name in the file (for the DBF
the is automatically cut up to 10 characters). The own name can be specified to each type of export. If
the name for each export is not specified then the name for the default type is taken. For example:
DBF : "Describe" ; XML : "Description" ; default: "Default name"

The "Column" element indicates that the additional field is added to the exported data. The
"FieldName" element indicates the name of a new field. The "DataRow" element indicates the content of
a new field and can be expression. For example
Column: "SortField" "{Products.Categories.CategoryName}"

20.7.2.2 Export Settings

The export parameters of the DBF export are described in the StiDbfExportSettings class. The
2003-2013 Stimulsoft

191

Stimulsoft Reports

description of all class properties are in the table below.

Name

Type

CodePage

Description

StiDbfCodePages

a code page of a
StiDbfCodePages.Default

file;

default

20.7.3 XML
XML (eXtensible Markup Language) is a text format that is used to store structured data (in exchange
for existed files of data bases), for exchange of information between programs and also to create on
its base the special markup languages (for example, XHTML), sometimes called dictionaries. XML is the
hierarchical structure that is used to store any data. Visually this structure can be represented as the
tree. XML supports Unicode and other encoding.
Notice: Only those data (components) are exported to the XML format which are placed on data
bands.

20.7.3.1 Controlling Exports

The following elements can be specified in the Tag field to control export to XML:
DataType
ExportType : "FieldName"
Column: "FieldName" "DataRow"
Several elements should be separated with the semicolon. The DataType" element should be only one
and should be placed first, other elements if necessary.
Values of the "DataType" element are shown in the table below. If the data type is not set, then the
string data type is taken by default.
Data type

Description

int

Numeric

long

Numeric

float

Decimal

double

Decimal

string

Text

date

Date

The "ExportType" element indicates for which export the field name is set. The values can be used:
dbf, csv, xml, default. The "FieldName" element indicates the field name in the file. The own
name can be specified to each type of export. If the name for each export is not specified then the

2003-2013 Stimulsoft

Exports

192

name for the default type is taken. For example:

DBF : "Describe" ; XML : "Description" ; default: "Default name"

The "Column" element indicates that additional field is added to the exported data. The "FieldName"
element indicates the name of a new field. The "DataRow" element indicates the content of a new field
and can be expression. For example:
Column: "SortField" "{Products.Categories.CategoryName}"

20.7.4 DIF
DIF (Data Interchange Format) is a text format that is used to exchange sheets between spreadsheets
processors (Microsoft Excel, OpenOffice.org Calc, Gnumeric, StarCalc, Lotus 1-2-3, FileMaker, dBase,
Framework, Multiplan, etc). The only limitation of this format is that the DIF format may contain only one
sheet in one book.

20.7.4.1 Export Settings

The export parameters of the DIF export are described in the StiDifExportSettings class. The
description of all class properties are in the table below.
Name

Type

Description

ExportDataOnly

bool

export data only. e.g. only components placed on

data bands; by default false

Encoding

file encoding; by default Encoding.ASCII

UseDefaultSystemEncoding

bool

use the default system encoding; if false then use

encoding that is set by the Encoding property; by
default true

20.7.5 SYLK
SYLK (Symbolic Link) format- this text format is used to exchange data between applications,
specifically spreadsheets. Files of SYLK have .slk extension. Microsoft does not publish a SYLK
specification, therefore work with this format in different applications can be different.
Notice: A SYLK file can be written in Unicode and read by some applications but anyway many
applications which do support Unicode writes SYLK files into ANSI but not Unicode. Therefore, symbols
which do not have representation in the system code page will be written as ('?') symbols.

2003-2013 Stimulsoft

193

Stimulsoft Reports

20.7.5.1 Export Settings

The export parameters of the SYLK export are described in the StiSylkExportSettings class. The
description of all class properties are in the table below.
Name

Type

Description

ExportDataOnly

bool

export data only. e.g. only components placed on

data bands; by default false

Encoding

file encoding; by default Encoding.ASCII

UseDefaultSystemEncoding

bool

use the default system encoding; if false then use

encoding that is set by the Encoding property; by
default true

Report Inheritance
There are two ways of report inheritance:
Creation of the basic class of a report;
Creation of the master-report.
In both ways you should create a basic report in the designer that includes all necessary elements. You
may add the following components to the basic reports:
Pages;
Components;
Data sources;
Variables;
Connections.

21.1 Basic Approaches

After the report has been created you may either save the report as a special basic class (for this you
should use the Save as command) or save the report as a regular report and then use it as a master
report. In the first case, you will get the C# or VB.NET class, and will be able to create new reports. For
example:
Reports.Report master = new Reports.Report();
master.RegData(dataSet);
master.Design();

In order to use the basic report when creating a new report in the designer, you need to add the
following string of a code:

2003-2013 Stimulsoft

Report Inheritance

194

StiReport.ReportType = typeof(Reports.Report);

Then all new reports will be automatically inherited from the basic class. In the second way you need to
use the following code:
StiReport masterReport = new StiReport();
masterReport.Load("d:\\master-detail.mrt");
StiReport report = new StiReport();
report.RegData(dataSet);
report.MasterReport = masterReport.SaveToString();
report.Design();

Scripts
Stimulsoft Reports supports a choice of languages for report generation.

22.1 Programming Language of Report

The report generator uses a single specified programming language to generate the report code and
handle report events. If the current programming language of a report does not suit your
requirements you can change it. The options are currently C# or VB.NET.
Changing The Language Of The Current Report
To do this select File | Report Setup. A new dialog will be displayed
In the Language group select a new programming language and press Ok. The current programming
language will then be changed.
Important: The underlying report code will have to be regenerated for the entire report, and any
changes which have been made within the report code will be lost.
Changing The Default Language
It is not convenient to change the programming language each time a report is rendered, so Stimulsoft
Reports allows you to set the default programming language used by all new reports.
To do this you should use the Services Configurator utility. All programming languages in Stimulsoft
Reports are located under the Languages node. The language which is shown first in the list is the

2003-2013 Stimulsoft

195

Stimulsoft Reports

default programming language. For example, on the picture below the C# programming language is
the default programming language. To make VB.Net the default programming language simply drag
the StiCSharpLanguage service down one position with the mouse or use the up and down buttons to
re-order the languages.

22.2 Report Code

When you create a new report its source code, often called the report script, is generated
automatically using either C# or VB.NET programming language depending on the currently selected
default. You can use only one of these programming languages at a time
In the report code the structure and initialization of the report class, which itself inherits from the
StiReport class, are described. When adding new pages, components or changing any parameters of a
report, those changes are automatically recorded within the class. The report class therefore contains a
description of all components, data, events, report properties, and data source structures for the
report. Any events specified by the user are also added to the report code.
For the ultimate in power and flexibility Stimulsoft Reports allows direct editing of the report code - if
you want something not provided by the available properties and features of the designer you can
actually code your own features within the report. When writing events or another code in the report,
you use the standard syntax of the selected .Net Framework programming language i.e. if the language
is set to C# you write code using C# syntax.
2003-2013 Stimulsoft

Scripts

196

Note: The report code is generated in C# or VB.Net programming language. All events and any
another code in this report must be written in the currently selected language.
When rendering reports, compilation of the report class occurs first. After that the compiled report is
executed.
Note: The report code is compiled using the .NET Framework compiler.
Reviewing and Editing the Report Code
To see the report code click the Code tab in the designer. The code will then be displayed:

To edit the code, simply start typing in the appropriate place.

Important: Do not change preprocessor directives or automatically updated code.
Whilst Stimulsoft Reports allows you to directly edit the report code, it is important to remember that
it is impossible to make changes in the parts of the report code which are automatically updated - such
changes will be lost when the next update takes place. The automatically updated report code is
enclosed in Region preprocessor directives:
At the beginning of the automatically updated code
#region StiReport Designer generated code - do not modify

2003-2013 Stimulsoft

197

Stimulsoft Reports

Automatically updated code goes here

the end of the automatically updated code
#endregion StiReport Designer generated code - do not modify

Any code that you write within the report must be written outside these Regions.

Right To Left
By default, components are output from left to right. The Right to Left property allows changing the
mode of showing report items.

23.1 WinForms Report Viewer

There is a capability to change the mode of showing viewer items and order of showing report pages
in WinForms. By default, showing of all elements of the viewer and the display order of pages of the
report is left to right. How the viewer will look like can depend on the static RightToLeft property of
the viewer. If the RightToLeft property is set to No, then the viewer items and pages of the report in
the viewer window are shown from left to right. Code below show how to set the left to right mode of
showing viewer items and report pages:
StiOptions.Viewer.RightToLeft = StiRightToLeftType.No;

If the RightToLeft property is set to Yes, then viewer items and report pages in a viewer window are
displayed from right to left. The code for setting the right to left mode is shown below:
StiOptions.Viewer.RightToLeft = StiRightToLeftType.No;

23.2 Icons
With the help of icons information about the components, settings and tools applied to these
components in the reports is displayed. These icons are filtering, conditions and events of the inherited
report, dynamic collapsing, dynamic sorting, order, quick information. By default, these icons are
displayed in the left to right order in a component, but if necessary, they can be displayed in the right
to left order. It is possible using the properties: ConditionsRightToLeft, EventsRightToLeft,
InheritedRightToLeft,
InteractionCollapsingRightToLeft,
InteractionSortRightToLeft,
OrderAndQuickInfoRightToLeft, FiltersRightToLeft, QuickButtonsRightToLeft. They belong to the
StiOptions.Viewer.Pins class. Consider these features in more detail:

2003-2013 Stimulsoft

Right To Left

198

The mode of displaying the Conditions icon depends on the value of the ConditionsRightToLeft
property. For example, if to place a Condition in the DataBand, then the Conditions icon will be
displayed by default in the lower left corner of this DataBand, because the ConditionsRightToLeft
property is set to false. The picture below shows an example of a report template with the Conditions
icon in the left to right mode:

Set the ConditionsRightToLeft property to true to change the position of the icon:
StiOptions.Viewer.Pins.ConditionsRightToLeft = true;

And then the icon will be displayed in the "right to left" mode, i.e. in the lower right corner of the
DataBand. The picture below shows an example of a report template with the Conditions icon in the
right to left mode:

Change the value of the EventsRightToLeft property to change the location of the Events icon. For
example, if to place an Event in the text component, then the Events bookmark will be displayed by
default in the upper left corner of the text component, because the EventsRightToLeft property is set
to false. The picture below shows an example of a report template with the Events icon in the left to
right mode:

Set the EventsRightToLeft property to true to change the location of the Events icon.

2003-2013 Stimulsoft

199

Stimulsoft Reports

StiOptions.Viewer.Pins.EventsRightToLeft = true;

The picture below shows an example of a report template with the Events icon in the right to left
mode:

The InheritedRightToLeft property is used to change the location of the Inherited icon. By default,
this property is set to false, i.e. the icon appears in the left to right mode. The picture below shows an
example of a report template with the Inherited icon in the left to right mode:

If the InheritedRightToLeft property is set to true

StiOptions.Viewer.Pins.InheritedRightToLeft = true;

the Inherited icon will appear in the right to left mode (see the picture below):

The InteractionCollapsingRightToLeft property is used to change the location of the Collapsing

icon. By default, this property is set to false, i.e. the icon appears in the left to right mode. The picture
below shows an example of a report template with the Collapsing icon in the left to right mode:

2003-2013 Stimulsoft

Right To Left

200

If the InteractionCollapsingRightToLeft property is set to true

StiOptions.Viewer.Pins.InteractionCollapsingRightToLeft = true;

Collapsing icons will appear in the right to left mode (see the picture below):

The InteractionSortRightToLeft property is used to change the location of the InteractionSort

icon. By default, this property is set to false, i.e. the icon appears in the left to right mode. The picture
below shows an example of a report template with the InteractionSort icon in the left to right mode:

If the InteractionSortRightToLeft property is set to true

StiOptions.Viewer.Pins.InteractionSortRightToLeft = true;

the InteractionSort icon will appear in the right to left mode (see the picture below):

2003-2013 Stimulsoft

201

Stimulsoft Reports

The OrderAndQuickInfoRightToLeft property is used to change the location of the Show Order
icon. By default, this property is set to false, i.e. the icon appears in the left to right mode. The picture
below shows an example of a report template with the Show Order icon in the left to right mode:

If the OrderAndQuickInfoRightToLeft property is set to true:

StiOptions.Viewer.Pins.InteractionSortRightToLeft = true;

the Show Order icon will appear in the right to left mode (see the picture below):

The FiltersRightToLeft property is used to change the location of the Filters icon. By default, this
property is set to false, i.e. the icon appears in the left to right mode. The picture below shows an
example of a report template with the Filters icon in the left to right mode:

If the FiltersRightToLeft property is set to true:

2003-2013 Stimulsoft

Right To Left

202

StiOptions.Viewer.Pins.FiltersRightToLeft = true;

the Filters icon will appear in the right to left mode (see the picture below):

The QuickButtonsRightToLeft property is used to change the location of the QuickButtons icon. By
default, this property is set to false, i.e. the icon appears in the left to right mode. The picture below
shows an example of a report template with the Filters icon in the left to right mode:

If the QuickButtonsRightToLeft property is set to true:

StiOptions.Viewer.Pins.QuickButtonsRightToLeft = true;

the QuickButtons icon will appear in the right to left mode (see the picture below):

23.3 WPF Reports Designer and Viewer

In the designer and WPF report viewer it is possible to set the mode of showing controls in the right to
left direction. By default, all controls are displayed in the left to right order. It is possible to change this.
The FlowDirection property is used for this. If the property is set to LeftToRight, then controls are
shown from left to right (see the code below).
FlowDirection="LeftToRight"

The picture below shows the left to right order of showing controls in the designer and viewer. If the
FlowDirection property is set to RightToLeft, then controls are shown in the right to left order. See
the code below how to achieve this result.

2003-2013 Stimulsoft

203

Stimulsoft Reports

FlowDirection="RightToLeft"

The picture below shows the right to left order of showing controls in the designer and viewer.

As can be seen from the picture above, the order of showing report pages in the viewer also depends
on the value of the FlowDirection property.
2003-2013 Stimulsoft

Right To Left

204

Deployment

24.1 Assemblies in Reports.Net

Stimulsoft Reports.Net is delivered with the following assemblies:
Assemblies

Description

Stimulsoft.Base.dll

The baseline assembly of the report generator.

Stimulsoft.Editor.dll

The Text editor used in the report designer.

Stimulsoft.Controls.dll

Controls used in the report generator.

Stimulsoft.Controls.Win.
dll

Controls used in the report generator.

Stimulsoft.Report.dll

This baseline assembly contains the base functionality of the report

generator.

Stimulsoft.Report.Chart.dll This baseline assembly contains the core of the chart component.
Stimulsoft.Design.dll

This assembly contains Visual Studio design-time part of the StiReport

class and StiDesignerControl class.

Stimulsoft.Report.Win.dll

This assembly contains WinForms Viewer.

Stimulsoft.Report.Design.
dll

This assembly contains WinForms Designer.

Stimulsoft.Report.Check.
dll

This assembly contains core of Report Checker tool.

Stimulsoft.Report.Helper.
dll

This assembly contains additional information about localization of

the report engine.

Stimulsoft.Database.dll

This dll file is used for creating and editing a connections string. Also
this dll contains QueryBuilder.

Stimulsoft.Report.Web.dll

This assembly helps showing reports in ASP.NET and contains Web

Viewer.
Demo Applications:

Demo.exe

This application demonstrates the basic capabilities of Stimulsoft

Reports.Net.

Tools:

2003-2013 Stimulsoft

205

Stimulsoft Reports

Configurator.exe

This application is used for editing the Stimulsoft Reports.Net

configuration.

Installer.exe

This application helps to install Stimulsoft Reports.Net into GAC. Also

it helps in using NGEN utility.

Browser.exe

This application is used for reports browsing.

Designer.exe

Stimulsoft Reports.Net report designer.

StyleDesigner.exe

Application that helps to design reports styles.

ReportChecker.exe

The utility is used for checking reports on issues.

Viewer.exe

Stimulsoft Reports.Net report viewer.

Import.CrystalReports.exe

This application is used for converting the CrystalReports templates to

the Stimulsoft Reports.Net templates.

Import.ActiveReports.exe

This application is used for converting the ActiveReports templates to

the Stimulsoft Reports.Net templates.

Import.FastReports.exe

This application is used for converting the FastReport.Net templates

to the Stimulsoft Reports.Net templates.

Import.Rdl.exe

This application is used for converting the RDL (Report Definition

Language) templates to the Stimulsoft Reports.Net templates.

Import.
ReportSharpShooter.exe

This application is used for converting the Report Sharp-Shooter

templates to the Stimulsoft Reports.Net templates.

Import.Rtf.exe

This application is used for converting the RTF (Rich Text Format) files
to the Stimulsoft Reports.Net templates.

Import.XtraReports.exe

This application is used for converting the XtraReports templates to

the Stimulsoft Reports.Net templates.

24.2 Assemblies in Reports.Wpf

Stimulsoft Reports.Wpf is delivered with the following assemblies:
Assemblies

Description

Stimulsoft.Base.dll

The baseline assembly of the report generator.

Stimulsoft.Editor.dll

The Text editor used in the report designer.

Stimulsoft.Controls.dll

Controls used in the report generator.

Stimulsoft.Controls.Wpf.
dll

This assembly contains additional WPF controls.

Stimulsoft.Report.Wpf.dll

This assembly contains the WPF Viewer.

2003-2013 Stimulsoft

Deployment

206

Stimulsoft.Report.Wpf.
Design.dll

This assembly contains Visual Studio design-time part for the WPF
viewer and WPF designer.

Stimulsoft.Report.Xbap.dll

This assembly contains the XBAP Viewer.

Stimulsoft.Report.Xbap.
Design.dll

This assembly contains Visual Studio design-time part for the XBAP
viewer.

Stimulsoft.Report.
WpfDesign.dll

This assembly contains WPF Designer.

Stimulsoft.Report.Check.
dll

This assembly contains core of Report Checker tool.

Stimulsoft.Report.Helper.
dll

This assembly contains additional information about localization of

the report engine.

Stimulsoft.Database.dll

This dll file is used for creating and editing a connections string. Also
this dll contains QueryBuilder.
WPF theme assemblies:

Stimulsoft.Report.Wpf.
BlackTheme.dll

This assembly contains the Black theme for the WPF report viewer and
WPF report designer.

Stimulsoft.Report.Wpf.
Office2003BlueTheme.dll

This assembly contains the Office 2003 Blue theme for the WPF report
viewer and WPF report designer.

Stimulsoft.Report.Wpf.
This assembly contains the Office 2003 Olive Green theme for the WPF
Office2003OliveGreenThem report viewer and WPF report designer.
e.dll
Stimulsoft.Report.Wpf.
Office2003SilverTheme.dll

This assembly contains Office 2003 Silver theme for the WPF report
viewer and WPF report designer.

Stimulsoft.Report.Wpf.
Office2007BlackTheme.dll

This assembly contains Office 2007 Black theme for the WPF report
viewer and WPF report designer.

Stimulsoft.Report.Wpf.
Office2007BlueTheme.dll

This assembly contains Office 2007 Blue theme for the WPF report
viewer and WPF report designer.

Stimulsoft.Report.Wpf.
Office2007SilverTheme.dll

This assembly contains Office 2007 Silver theme for the WPF report
viewer and WPF report designer.

Stimulsoft.Report.Wpf.
Office2010BlueTheme.dll

This assembly contains Office 2010 Blue theme for the WPF report
viewer and WPF report designer.
Demo Applications:

Demo.exe

This application shows the basic features of Stimulsoft Reports.Wpf

Tools:
Installer.exe

2003-2013 Stimulsoft

This application helps to install Stimulsoft Reports.Net into GAC. Also

207

Stimulsoft Reports

it helps in using NGEN utility.

Designer.exe

Stimulsoft Reports.Wpf report designer.

StyleDesigner.exe

Application that helps to design reports styles.

ReportChecker.exe

The utility is used for checking reports on issues.

Import.CrystalReports.exe

This application is used for converting the CrystalReports templates to

the Stimulsoft Reports.Net templates.

Import.ActiveReports.exe

This application is used for converting the ActiveReports templates to

the Stimulsoft Reports.Net templates.

Import.FastReports.exe

This application is used for converting the FastReport.Net templates

to the Stimulsoft Reports.Net templates.

Import.Rdl.exe

This application is used for converting the RDL (Report Definition

Language) templates to the Stimulsoft Reports.Net templates.

Import.
ReportSharpShooter.exe

This application is used for converting the Report Sharp-Shooter

templates to the Stimulsoft Reports.Net templates.

Import.Rtf.exe

This application is used for converting the RTF (Rich Text Format) files
to the Stimulsoft Reports.Net templates.

Import.XtraReports.exe

This application is used for converting the XtraReports templates to

the Stimulsoft Reports.Net templates.

24.3 Assemblies in Reports.Web

Stimulsoft Reports.Web is delivered with the following assemblies:
Assemblies

Description
The baseline assembly of the report generator.

Stimulsoft.Base.dll
Stimulsoft.Editor.dll

The Text editor used in the report designer.

Stimulsoft.Controls.dll

Controls used in the report generator.

Stimulsoft.Controls.Win.dll

Controls used in the report generator.

Stimulsoft.Report.dll

This baseline assembly contains the base functionality of the report

generator.

Stimulsoft.Report.Check.dll

This assembly contains a core of the Report Checker tool.

Stimulsoft.Report.Chart.dll

This baseline assembly contains a core of the chart component.

Stimulsoft.Report.Helper.dll This assembly contains additional information about localization of

report engine.

2003-2013 Stimulsoft

Deployment

208

Stimulsoft.Report.Design.
dll

This assembly contains WinForms Designer.

Stimulsoft.Report.Design.
WebViewer.dll

This assembly contains WebViewer.Fx for using in WinForms report

designer for showing a report with help of the Web preview tab.

Stimulsoft.Database.dll

This dll is used for creating and editing connections string. Also this
dll contains QueryBuilder.

Stimulsoft.Report.Web.dll

This assembly helps to show reports in ASP.NET and contains Web

Viewer.

Stimulsoft.Report.WebFx.
dll

This assembly helps to show reports in ASP.NET with help of Adobe

Flash and contains WebViewer.Fx.

Stimulsoft.Report.
WebDesign.dll

This assembly contains Web Designer.

Demo application:
Demo.Web.exe

This application demonstrates the potential of Stimulsoft Reports.

Web.
Tools:

Import.CrystalReports.exe

This application is used to convert the CrystalReports templates to

the Stimulsoft Reports templates.

Installer.exe

This application helps to install Stimulsoft Reports into GAC. Also it

helps in using NGEN utility.

Designer.exe

Stimulsoft Reports report designer.

ReportChecker.exe

The utility for checking reports on issues.

StyleDesigner.exe

This application helps to design report styles.

Import.ActiveReports.exe

This application is used for converting the ActiveReports templates

to the Stimulsoft Reports.Net templates.

Import.FastReports.exe

This application is used for converting the FastReport.Net templates

to the Stimulsoft Reports.Net templates.

Import.Rdl.exe

This application is used for converting the RDL (Report Definition

Language) templates to the Stimulsoft Reports.Net templates.

Import.ReportSharpShooter. This application is used for converting the Report Sharp-Shooter

exe
templates to the Stimulsoft Reports.Net templates.
Import.Rtf.exe

This application is used for converting the RTF (Rich Text Format)
files to the Stimulsoft Reports.Net templates.

Import.XtraReports.exe

This application is used for converting the XtraReports templates to

the Stimulsoft Reports.Net templates.

2003-2013 Stimulsoft

209

24.4

Stimulsoft Reports

Assemblies in Reports Designer.Web

Stimulsoft Reports Designer.Web is delivered with the following assemblies:
Assemblies
Stimulsoft.Report.
WebDesign.dll

Description
Assembly that contains the Web Designer.

24.5 Assemblies in Reports.Silverlight

Assemblies

Description
The baseline assembly of the report generator.

Stimulsoft.Base.dll
Stimulsoft.Editor.dll

The Text editor used in the report designer.

Stimulsoft.Controls.dll

Controls used in the report generator.

Stimulsoft.Controls.Win.dll

Controls used in the report generator.

Stimulsoft.Report.dll

This baseline assembly contains the base functionality of the report

generator.

Stimulsoft.Report.Check.dll

This assembly contains a core of the Report Checker tool.

Stimulsoft.Report.Chart.dll

This baseline assembly contains a core of the chart component.

Stimulsoft.Report.Helper.dll This assembly contains additional information about localization of

report engine.
Stimulsoft.Report.Design.
dll

This assembly contains WinForms Designer.

Stimulsoft.Report.Design.
SLViewer.dll

This assembly contains Silverlight Viewer for using in WinForms

report designer for showing reports with help of the Silverlight preview
tab.

Stimulsoft.Database.dll

This dll is used for creating and editing connections string. Also this
dll contains QueryBuilder.
Silverlight Assemblies:

Stimulsoft.Base.SL.dll

This is a baseline assembly of the report generator. Its Silverlight

based assembly.

Stimulsoft.Compression.SL.
dll

The assembly provides compression methods for using in the report

generator. It is a Silverlight based assembly.

Stimulsoft.Controls.SL.dll

Controls which are used in the report generator. It is a Silverlight

2003-2013 Stimulsoft

Deployment

210

based assembly.
Stimulsoft.Report.SL.dll

This baseline assembly contains the base functionality of the report

generator. It is a Silverlight based assembly.

Stimulsoft.Report.Check.SL.
dll

This assembly contains core of the Report Checker tool for

Silverlight.

Stimulsoft.Report.Helper.
SL.dll

This assembly contains additional information about localization of

the report engine for Silverlight.

Stimulsoft.Report.SLDesign. This assembly contains Silverlight Reports Designer. It is a Silverlight

dll
based assembly.
Stimulsoft.Report.Design.
SLViewer.dll

This assembly contains Silverlight Viewer for using in the WinForms

report designer for showing report with help of Silverlight preview
tab.

Stimulsoft.Report.Viewer.
SL.dll

This assembly contains Silverlight Reports Viewer. It is a Silverlight

based assembly.

Stimulsoft.Report.WebSL.
dll

This assembly contains Silverlight Reports Viewer (Client/Server

version) ASP.NET based control.

Stimulsoft.Report.
WebDesignSL.dll

This assembly contains Silverlight Reports Designer (Client/Server

version) ASP.NET based control.
Demo application:

Demo.SL

This application demonstrates the basic capabilities of Stimulsoft

Reports.Silverlight. It is a Silverlight based application.

Demo.Web.SL

This application demonstrates the basic capabilities of Stimulsoft

Reports.Silverlight. It is a Client-Server based application.
Tools:

Designer.SL

Stimulsoft Reports.Silverlight reports designer.

Viewer.SL

Stimulsoft Reports.Silverlight reports viewer.

OptionsHelper.exe

This application is used for creating Options.xml file for Designer.exe

application.

Import.CrystalReports.exe

This application is used to convert the CrystalReports templates to

the Stimulsoft Reports templates.

Installer.exe

This application helps to install Stimulsoft Reports into GAC. Also it

helps in using NGEN utility.

Designer.exe

Stimulsoft Reports report designer.

ReportChecker.exe

The utility for checking reports on issues.

StyleDesigner.exe

This application helps to design report styles.

2003-2013 Stimulsoft

211

Stimulsoft Reports

Import.ActiveReports.exe

This application is used for converting the ActiveReports templates

to the Stimulsoft Reports.Net templates.

Import.FastReports.exe

This application is used for converting the FastReport.Net templates

to the Stimulsoft Reports.Net templates.

Import.Rdl.exe

This application is used for converting the RDL (Report Definition

Language) templates to the Stimulsoft Reports.Net templates.

Import.ReportSharpShooter. This application is used for converting the Report Sharp-Shooter

exe
templates to the Stimulsoft Reports.Net templates.
Import.Rtf.exe

This application is used for converting the RTF (Rich Text Format)
files to the Stimulsoft Reports.Net templates.

Import.XtraReports.exe

This application is used for converting the XtraReports templates to

the Stimulsoft Reports.Net templates.

24.6 Assemblies in Reports Designer.Silverlight

Stimulsoft Reports Designer.Silverlight is delivered with the following assemblies:
Assemblies
Stimulsoft.Report.
WebDesignSL.dll

Description
Assembly which contains Silverlight Reports Designer (Client/Server
version) Asp.Net based control.

24.7 Assemblies in Reports.Ultimate

Assemblies

Description

Stimulsoft.Base.dll

The baseline assembly of the report generator.

Stimulsoft.Editor.dll

The Text editor used in the report designer.

Stimulsoft.Controls.dll

Controls used in the report generator.

Stimulsoft.Controls.Win.
dll

Controls used in the report generator.

Stimulsoft.Report.dll

This baseline assembly contains the base functionality of the report

generator.

Stimulsoft.Report.Chart.dll This baseline assembly contains the core of the chart component.
Stimulsoft.Design.dll

This assembly contains Visual Studio design-time part of the StiReport

class and StiDesignerControl class.

Stimulsoft.Report.Win.dll

This assembly contains WinForms Viewer.

2003-2013 Stimulsoft

Deployment

212

Stimulsoft.Report.Design.
dll

This assembly contains WinForms Designer.

Stimulsoft.Report.Check.
dll

This assembly contains core of Report Checker tool.

Stimulsoft.Report.Helper.
dll

This assembly contains additional information about localization of

the report engine.

Stimulsoft.Database.dll

This dll file is used for creating and editing a connections string. Also
this dll contains QueryBuilder.

Stimulsoft.Report.Web.dll

This assembly helps showing reports in ASP.NET and contains Web

Viewer.

Stimulsoft.Report.
WebDesign.dll

This assembly contains Web Designer.

Stimulsoft.Report.WebFx.
dll

This assembly helps to show reports in ASP.NET with help of Adobe

Flash and contains WebViewer.Fx.

Stimulsoft.Database.Wpf.
dll

This dll is used for creating and editing a connections string. Also this
dll contains QueryBuilder.

Stimulsoft.Report.Design.
SLViewer.dll

The assembly contains Silverlight Viewer for using in WinForms report

designer for showing report with help of Silverlight preview tab.

Stimulsoft.Database.Wpf.
dll

This is a WPF version of Stimulsoft.Database.dll. This dll is used for

creating and editing connections string. Also this dll contains
QueryBuilder.

Stimulsoft.Controls.Wpf.
dll

This assembly contains additional WPF controls.

Stimulsoft.Report.Wpf.dll

This assembly contains the WPF Viewer.

Stimulsoft.Report.Wpf.
Design.dll

This assembly contains Visual Studio design-time part for the WPF
viewer and WPF designer.

Stimulsoft.Report.Xbap.dll

This assembly contains the XBAP Viewer.

Stimulsoft.Report.Xbap.
Design.dll

This assembly contains Visual Studio design-time part for the XBAP
viewer.

Stimulsoft.Report.
WpfDesign.dll

This assembly contains WPF Designer.

WPF theme assemblies:

Stimulsoft.Report.Wpf.
BlackTheme.dll

This assembly contains Black theme for the WPF report viewer and
WPF report designer.

Stimulsoft.Report.Wpf.
Office2003BlueTheme.dll

This assembly contains Office 2003 Blue theme for the WPF report
viewer and WPF report designer.

Stimulsoft.Report.Wpf.

This assembly contains Office 2003 Olive Green theme for the WPF

2003-2013 Stimulsoft

213

Stimulsoft Reports

Office2003OliveGreenThem report viewer and WPF report designer.

e.dll
Stimulsoft.Report.Wpf.
Office2003SilverTheme.dll

This assembly contains Office 2003 Silver theme for the WPF report
viewer and WPF report designer.

Stimulsoft.Report.Wpf.
Office2007BlackTheme.dll

This assembly contains Office 2007 Black theme for the WPF report
viewer and WPF report designer.

Stimulsoft.Report.Wpf.
Office2007BlueTheme.dll

This assembly contains Office 2007 Blue theme for the WPF report
viewer and WPF report designer.

Stimulsoft.Report.Wpf.
Office2007SilverTheme.dll

This assembly contains Office 2007 Silver theme for the WPF report
viewer and WPF report designer.

Stimulsoft.Report.Wpf.
Office2010BlueTheme.dll

This assembly contains Office 2010 Blue theme for the WPF report
viewer and WPF report designer.
Silverlight Assemblies:

Stimulsoft.Base.SL.dll

The baseline assembly of the report generator. It is a Silverlight based

assembly.

Stimulsoft.Compression.
SL.dll

This assembly provides compression methods for using in the report

generator. It is a Silverlight based assembly.

Stimulsoft.Controls.SL.dll

Controls used in the report generator. It is a Silverlight based

assembly.

Stimulsoft.Report.SL.dll

The baseline assembly contains the basic functionality of the report

generator. It is a Silverlight based assembly.

Stimulsoft.Report.Check.
SL.dll

This assembly contains core of the Report Checker tool for Silverlight.

Stimulsoft.Report.Helper.
SL.dll

This assembly contains additional information about localization of

the report engine for Silverlight.

Stimulsoft.Report.
SLDesign.dll

This assembly contains Silverlight Reports Designer. It is a Silverlight

based assembly.

Stimulsoft.Report.Viewer.
SL.dll

This assembly contains Silverlight Reports Viewer. It is a Silverlight

based assembly.

Stimulsoft.Report.WebSL.
dll

This assembly contains Silverlight Reports Viewer (Client/Server

version) ASP.NET based control.

Stimulsoft.Report.
WebDesignSL.dll

This assembly contains Silverlight Reports Designer (Client/Server

version) ASP.NET based control.
Demo Applications:

Demo.exe

This application demonstrates the basic capabilities of Stimulsoft

Reports.Net.

2003-2013 Stimulsoft

Deployment

214

Demo.Web.exe

This application demonstrates the potential of Stimulsoft Reports.

Ultimate in Web.

Demo.Wpf.exe

This application demonstrates the potential of Stimulsoft Reports.

Ultimate in WPF.

Demo.SL

This application demonstrates the potential of Stimulsoft Reports.

Ultimate in Silverlight. It uses Native mode.

Demo.Web.SL

This application demonstrates the potential of Stimulsoft Reports.

Ultimate in Silverlight. It uses Client-Server mode.

Tools:
Configurator.exe

This application is used for editing the Stimulsoft Reports.Net

configuration.

Installer.exe

This application helps to install Stimulsoft Reports.Net into GAC. Also

it helps in using NGEN utility.

Browser.exe

This application is used for reports browsing.

Designer.exe

Stimulsoft Reports.Net report designer.

StyleDesigner.exe

Application that helps to design reports styles.

ReportChecker.exe

The utility is used for checking reports on issues.

Viewer.exe

Stimulsoft Reports.Net report viewer.

Import.CrystalReports.exe

This application is used for converting the CrystalReports templates to

the Stimulsoft Reports.Net templates.

Import.ActiveReports.exe

This application is used for converting the ActiveReports templates to

the Stimulsoft Reports.Net templates.

Import.FastReports.exe

This application is used for converting the FastReport.Net templates

to the Stimulsoft Reports.Net templates.

Import.Rdl.exe

This application is used for converting the RDL (Report Definition

Language) templates to the Stimulsoft Reports.Net templates.

Import.
ReportSharpShooter.exe

This application is used for converting the Report Sharp-Shooter

templates to the Stimulsoft Reports.Net templates.

Import.Rtf.exe

This application is used for converting the RTF (Rich Text Format) files
to the Stimulsoft Reports.Net templates.

Import.XtraReports.exe

This application is used for converting the XtraReports templates to

the Stimulsoft Reports.Net templates.

OptionsHelper.exe

This application is used for creating Options.xml file for Designer.exe

application.

Designer.Wpf.exe

Stimulsoft Reports designer which uses WPF technology.

2003-2013 Stimulsoft

215

Stimulsoft Reports

StyleDesigner.Wpf.exe

This application helps to design reports styles. It uses WPF

technology.

ReportChecker.Wpf.exe

The utility used for checking reports on issues. It uses WPF

technology.

Designer.SL

Stimulsoft Reports designer which uses Silverlight technology.

Viewer.exe

Stimulsoft Reports report viewer.

Viewer.Wpf.exe

Stimulsoft Reports report viewer. It uses WPF technology.

Viewer.SL

Stimulsoft Reports report viewer. It uses Silverlight technology.

24.8 Assemblies in Reports.Fx for Flex

Stimulsoft Reports.Fx for Flex is delivered with the following assemblies:
Assemblies

Description

Stimulsoft_ViewerFx.swc

This library contains the report engine and report viewer.

Stimulsoft_DesignerFx.swc

This library contains the report designer.

DesignerFx for Flex.exe

Stimulsoft Reports.Fx standalone report designer.

DemoFx for Flex.exe

The Adobe AIR application which demonstrates main features of

Stimulsoft Reports.Fx.

24.9 Assemblies in Reports.Fx for PHP

Stimulsoft Reports.Fx for PHP is delivered with the following assemblies:
Assemblies

Description

DesignerFx for PHP.exe

Stimulsoft Reports.Fx standalone report designer.

DemoFx for PHP.exe

An Adobe AIR application which demonstrates basic features of

Stimulsoft Reports.Fx.

localization (folder)

This folder contains all localization files. The list of localization files
is indicated automatically when loading the designer or viewer.

config.xml

A configuration file which contains all available options.

swfobject.js
playerProductInstall.swf

These files are used for loading the Flash content and Flash player
updates.

designer.html
viewer.html

Stimulsoft Reports.Fx web based report designer and report viewer

files.

2003-2013 Stimulsoft

Deployment

216

DesignerFx_PHP.swf
ViewerFx_PHP.swf
index.php
handler.php
localization.php
database_xml
database_mssql.php
database_mysql.php
database_odbc.php
database_oracle.php
database_pg.php

24.10 Assemblies in Reports.Fx for Java

Stimulsoft Reports.Fx for Java is delivered with the following assemblies:
Assemblies

Description

stimulsoft.reports.fx-core2011.1.1000.jar

This library contains the main part of the product.

stimulsoft.reports.fxdesigner-2011.1.1000.jar

This library contains the report designer.

stimulsoft.reports.fx-viewer- This library contains the report viewer.

2011.1.1000.jar
stimulsoft.reports.fx-web2011.1.1000.jar

This library is used for the report viewer and report designer in a
web application.

stimulsoft.reports.fx-swt2011.1.1000.jar

This library for using the report viewer and report designer in an
swt application.

DesignerFx for Java.exe

Stimulsoft Reports.Fx standalone report designer.

DemoFx for Java.exe

An Adobe AIR application which demonstrates basic features of

Stimulsoft Reports.Fx.

24.11 Working With Assemblies

There is no possibility of creating a method that compiles into memory and returns the assembly. This
is because of the restrictions of .NET Framework. If, in the application, the .NET assembly is loaded,
then the assembly is locked until the application closes even if the assembly is loaded from a stream. In
this case, the assembly is stored in the temp directory of the windows, and then loaded into memory.
Loading the report assemblies (like any other .NET assembly) is a file on disk in a particular place and
memory for this, blocked by the assembly.

2003-2013 Stimulsoft

217

Stimulsoft Reports

There are some ways to solve the issue:

Use the reports in the application as C# classes (keeping them as classes in the report designer). In
this case, the report is compiled with your application, and, therefore, it does not need compilation and
loading assemblies. When updating, it is inconvenient to administer reports.
Use reports as a compiled assembly, i.e. save reports as assemblies of the report designer. In this
case,when updating reports, it is also too inconvenient to administer them.
Do not use reports compilation. But use the interpretation of the expressions in the report.
Interpreter mode can be enabled by means of the CalculationMode report property. However, one
should consider that the expressions interpreter works slower than compiled expression. The
interpreter cannot interpret all expressions of C# and VB.NET. Also, do not use events in the report
components.
Compilation and report rendering in another application domain. In this case, after rendering the
report its assembly can be unloaded along with the entire application domain from memory. The
locked assembly file can be removed after unload. To create a report, you can use the
CreateReportInNewAppDomain() method of the StiReport class, for its upload use the
UnloadReportAppDomain() method. However, in this case, the RegData method and
RegBusinessObject work very slowly (as data marshaling in another domain is used). It is better
request data from the report. Creating and deleting the application domain takes some time.
One of the most effective ways is a report compilation when first calling the report. And with each
next calling - report loading from the previously compiled assembly. In this case, the report is stored in
memory only once, the assembly on disk only once. Before running the application the folder where
reports are stored can be removed (before using report) as all reports will be recreated (when
accessed). Here is the code that uses this method. New rendered report is created if it does not, or if
the report has been modified, and if the version of the .NET Framework, which has been collected for
the assembly, and the version under which the application is running is not the same. With this method,
only the first run is slow.
Code Sample:
StiReport report = new StiReport();
report.Load(file);
string folder = Environment.GetFolderPath(Environment.SpecialFolder.
LocalApplicationData);
folder = Path.Combine(folder, "Stimulsoft\\CompiledReports");
folder = Path.Combine(folder, System.Runtime.InteropServices.
RuntimeEnvironment.GetSystemVersion().ToString());
string compiledReportFile = Path.Combine(folder, report.
GetReportAssemblyCacheName());
if (File.Exists(compiledReportFile))
report = StiReport.GetReportFromAssembly(compiledReportFile, true);
else
{

2003-2013 Stimulsoft

Deployment

218

if (!Directory.Exists(folder)) Directory.CreateDirectory(folder);
report.Compile(compiledReportFile);
}
report.Render(false);

Precompilation of reports updating them. This method is a variation of the previous one. After
updating reports in the application, or if they are not present, or if necessary, start the compilation
process of all reports, which are used in the application. Before compiling the old version assemblies is
removed. Sometimes the process of compiling the report for a given process may take some time.

24.12 Redistributable files in Reports.Net

The following assemblies and files of Stimulsoft Reports.Net can be delivered with the final
application:
Stimulsoft.Base.dll
Stimulsoft.Controls.dll
Stimulsoft.Controls.Win.dll
Stimulsoft.Database.dll
Stimulsoft.Editor.dll
Stimulsoft.Report.dll
Stimulsoft.Report.Win.dll
Stimulsoft.Report.Design.dll
Stimulsoft.Report.Web.dll
Localization files

24.13 Redistributable files in Reports.Wpf

The following assemblies and files of Stimulsoft Reports.Wpf can be delivered with the final application:
Stimulsoft.Base.dll
Stimulsoft.Database.Wpf.dll
Stimulsoft.Report.dll
Stimulsoft.Report.Check.dll
Stimulsoft.Report.Wpf.dll
Stimulsoft.Report.Wpf.BlackTheme.dll
Stimulsoft.Report.Wpf.Office2003BlueTheme.dll
Stimulsoft.Report.Wpf.Office2003OliveGreenTheme.dll
Stimulsoft.Report.Wpf.Office2003SilverTheme.dll
Stimulsoft.Report.Wpf.Office2007BlackTheme.dll
Stimulsoft.Report.Wpf.Office2007BlueTheme.dll
Stimulsoft.Report.Wpf.Office2007SilverTheme.dll
Stimulsoft.Report.Wpf.Office2010BlueTheme.dll
Stimulsoft.Report.WpfDesign.dll
Stimulsoft.Report.Helper.dll
2003-2013 Stimulsoft

219

Stimulsoft Reports

Localization files

24.14 Redistributable files in Reports.Web

The following assemblies and files of Stimulsoft Reports.Web can be delivered with the final
application:
Stimulsoft.Base.dll
Stimulsoft.Report.dll
Stimulsoft.Report.Web.dll
Stimulsoft.Report.WebDesign.dll
Stimulsoft.Report.WebFx.dll
Localization files
Important: The Stimulsoft.Report.Design assembly cannot be distributed. The licensing per number
of developers is required.

24.15 Redistributable files in Report Designer.Web

The following assemblies and files of Stimulsoft Reports Designer.Web can be delivered with the final
application:
Stimulsoft.Report.WebDesign.dll

24.16 Redistributable files in Reports.Silverlight

The following assemblies and files of Stimulsoft Reports.Silverlight can be delivered with the final
application:
Stimulsoft.Base.SL.dll
Stimulsoft.Compression.SL.dll
Stimulsoft.Controls.SL.dll
Stimulsoft.Report.SL.dll
Stimulsoft.Report.SLDesign.dll
Stimulsoft.Report.Viewer.SL.dll
Stimulsoft.Report.WebSL.dll
Stimulsoft.Report.WebDesignSL.dll
Localization files

24.17 Redistributable files in Reports Designer.Silverlight

The following assemblies and files of Stimulsoft Reports Designer.Silverlight can be delivered with the

2003-2013 Stimulsoft

Deployment

220

final application:
Stimulsoft.Report.WebDesignSL.dll

24.18 Redistributable files in Reports.Ultimate

The following assemblies and files of Stimulsoft Reports.Ultimate can be delivered with the final
application:
Stimulsoft.Controls.dll
Stimulsoft.Controls.Win.dll
Stimulsoft.Base.dll
Stimulsoft.Database.dll
Stimulsoft.Database.Wpf.dll
Stimulsoft.Editor.dll
Stimulsoft.Report.dll
Stimulsoft.Report.Check.dll
Stimulsoft.Report.Win.dll
Stimulsoft.Report.Web.dll
Stimulsoft.Report.WebFx.dll
Stimulsoft.Report.Wpf.dll
Stimulsoft.Report.Wpf.BlackTheme.dll
Stimulsoft.Report.Wpf.Office2003BlueTheme.dll
Stimulsoft.Report.Wpf.Office2003OliveGreenTheme.dll
Stimulsoft.Report.Wpf.Office2003SilverTheme.dll
Stimulsoft.Report.Wpf.Office2007BlackTheme.dll
Stimulsoft.Report.Wpf.Office2007BlueTheme.dll
Stimulsoft.Report.Wpf.Office2007SilverTheme.dll
Stimulsoft.Report.Wpf.Office2010BlueTheme.dll
Stimulsoft.Report.Design.dll
Stimulsoft.Report.DesignHelper.dll
Stimulsoft.Report.WebDesign.dll
Stimulsoft.Report.WpfDesign.dll
Stimulsoft.Base.SL.dll
Stimulsoft.Compression.SL.dll
Stimulsoft.Controls.SL.dll
Stimulsoft.Report.SL.dll
Stimulsoft.Report.SLDesign.dll
Stimulsoft.Report.Viewer.SL.dll
Stimulsoft.Report.WebSL.dll
Stimulsoft.Report.WebDesignSL.dll
Localization files

24.19 Redistributable files in Reports.Fx for Flex

The following assemblies and files of Stimulsoft Reports.Fx for Flex can be delivered with the final

2003-2013 Stimulsoft

221

Stimulsoft Reports

application:
Stimulsoft_ViewerFx.swc
Stimulsoft_DesignerFx.swc
Localization files

24.20 Redistributable files in Reports.Fx for PHP

The following assemblies and files of Stimulsoft Reports.Fx for PHP can be delivered with the final
application:
Server-side files
Client-side files
Localization files

24.21 Redistributable files in Reports.Fx for Java

The following assemblies and files of Stimulsoft Reports.Fx for Java can be delivered with the final
application:
All *.jar files.

24.22 Deployment in Windows

For distribution Stimulsoft Reports assemblies together with the application it is enough to copy them
to the folder where the application file is saved. Registration to GAC is not required. Registration of
COM objects is not required. Registration in registry is not required. Using the NGEN utility is not
required.

24.23 Deployment in Web

For distribution Stimulsoft Reports.Web together with a web application it is enough to copy them to
the bin folder of an application. Registration to GAC is not required. Registration of COM objects is not
required. Registration in registry is not required. Using the NGEN utility is not required.

24.24 Deployment in Designer.Web

2003-2013 Stimulsoft

Deployment

222

24.25 Deployment in Wpf

24.26 Deployment in Silverlight

24.27 Deployment in Designer.Silverlight

24.28 Deployment in PHP

24.29 Deployment in Flex

24.30 Deployment Reports as Files

The most frequently used way of reports deployment is deployment reports as files. Stimulsoft Reports

2003-2013 Stimulsoft

223

Stimulsoft Reports

supports two type of files: unpacked report (the .mrt file extension) and packed reports (the .mrz file
extension). Packed reports have small file size but it takes much time for saving and loading them. For
loading the previously saved report the following code is required:
C#:
StiReport report = new StiReport();
report.Load("report.mrt");

VB.NET:
Dim Report As StiReport = New StiReport()
Report.Load("report.mrt")

:
C#:
StiReport report = new StiReport();
report.Save("report.mrt");

VB.NET:
Dim Report As StiReport = New StiReport()
Report.Save("report.mrt")

24.31 Reports as Source Code

For automatic generation a report code the standard .NET Framework languages are used. When
using C#, it is possible to write the same code as in Visual Studio.NET. The same can be said about
VB.NET, where a report code can be saved and in the Visual Studio.NET project. Use the File | Save
Report As menu for saving a report code

2003-2013 Stimulsoft

Deployment

224

Notice: The report code is completely compatible with C# and VB languages. Therefore, the report
code can be saved and used in the Visual Studio.NET project.

2003-2013 Stimulsoft

225

Stimulsoft Reports

24.32 Reports as Assemblies

Stimulsoft Reports reports generation has the unique ability to compile reports to the .Net Framework
assembly. Use the File | Save Report As menu for saving a report to the assembly.

2003-2013 Stimulsoft

Deployment

226

For loading a report from the assembly the following code is used:
C#:
StiReport report = StiReport.GetReportFromAssembly("report.dll");

VB.NET:
Dim Report As StiReport = StiReport.GetReportFromAssembly("report.dll")

Reports, which are loaded from assembly, do not require compilation. It is impossible to edit such
reports in the reports designer.

24.33 Standalone Reports

It is required to use the program code to compile standalone reports. It is impossible to create
standalone reports using the designer. The following code will create the standalone report:

2003-2013 Stimulsoft

227

Stimulsoft Reports

C#:
StiReport report = new StiReport();
report.Load("report.mrt");
report.CompileStandaloneReport("report.exe", StiStandaloneReportType.
Show);

VB.NET:
Dim Report As New StiReport()
Report.Load("report.mrt")
Report.CompileStandaloneReport("report.exe", StiStandaloneReportType.
Show)

It is important to remember that for working with standalone reports the Stimulsoft Reports libraries
are required. Besides, the report should get all data itself.

2003-2013 Stimulsoft

SQL Server 2022 Administration Inside Out 1St Edition Randolph West All Chapter
No ratings yet
SQL Server 2022 Administration Inside Out 1St Edition Randolph West All Chapter
67 pages
CLR Via C#, Fourth Edition
0% (1)
CLR Via C#, Fourth Edition
1 page
BOW310 LearnerGuide GA
100% (1)
BOW310 LearnerGuide GA
372 pages
Best Practices in Cognos Report Studio
No ratings yet
Best Practices in Cognos Report Studio
4 pages
Enterprise 7.4 Release Guide
No ratings yet
Enterprise 7.4 Release Guide
42 pages
Performance Tuning Cognos
No ratings yet
Performance Tuning Cognos
12 pages
Blazor For ASP NET Web Forms Developers
No ratings yet
Blazor For ASP NET Web Forms Developers
99 pages
Core Web API With Oracle Database and Dapper
No ratings yet
Core Web API With Oracle Database and Dapper
12 pages
Code Review
No ratings yet
Code Review
13 pages
Valid Cert Exams 22-05-14
No ratings yet
Valid Cert Exams 22-05-14
6 pages
Qualys Was API User Guide
No ratings yet
Qualys Was API User Guide
376 pages
Web Services Provider Guide
No ratings yet
Web Services Provider Guide
158 pages
Report Builder
No ratings yet
Report Builder
95 pages
DNCMag Issue45 PDF
No ratings yet
DNCMag Issue45 PDF
95 pages
Power-BI-for-Beginners
No ratings yet
Power-BI-for-Beginners
120 pages
Power BI Updates August 2023 1693108402
No ratings yet
Power BI Updates August 2023 1693108402
26 pages
Provera JMBG-a
No ratings yet
Provera JMBG-a
15 pages
BOW310 Web Intelligence Report
No ratings yet
BOW310 Web Intelligence Report
4 pages
Traveling Blazor Webassembly: With Simple Food Recipe Page
No ratings yet
Traveling Blazor Webassembly: With Simple Food Recipe Page
24 pages
Struts Ejb Tutorial
100% (3)
Struts Ejb Tutorial
65 pages
Unit 1: Course Introduction: Week 1: Core Planning Capabilities
No ratings yet
Unit 1: Course Introduction: Week 1: Core Planning Capabilities
7 pages
Common Tables For Financial Systems PeopleSoft
No ratings yet
Common Tables For Financial Systems PeopleSoft
10 pages
SAP Business Objects 4.1 Course Content:: SAP BO 4.1 Videos-2014 + 800 MB Material 32 Hours
No ratings yet
SAP Business Objects 4.1 Course Content:: SAP BO 4.1 Videos-2014 + 800 MB Material 32 Hours
4 pages
ASP Net MVC 3tier
No ratings yet
ASP Net MVC 3tier
12 pages
DNCMag Issue38
No ratings yet
DNCMag Issue38
123 pages
SAP BO Admin Questions
No ratings yet
SAP BO Admin Questions
4 pages
SPARK UI Toolkit Release Notes 4.5.4
No ratings yet
SPARK UI Toolkit Release Notes 4.5.4
22 pages
Learn SAP UI5 Nuno Correia PDF
No ratings yet
Learn SAP UI5 Nuno Correia PDF
136 pages
SAP HANA Database SQL Command Network Protocol en
No ratings yet
SAP HANA Database SQL Command Network Protocol en
53 pages
WPF Tutorial
No ratings yet
WPF Tutorial
5 pages
PASS SQLSaturday PowerApps Flow
No ratings yet
PASS SQLSaturday PowerApps Flow
57 pages
Essbase Optimization Techniques by Amit Sharma
No ratings yet
Essbase Optimization Techniques by Amit Sharma
17 pages
Power BI Building Blocks
No ratings yet
Power BI Building Blocks
16 pages
BW UPGRADe PDF
No ratings yet
BW UPGRADe PDF
23 pages
Asif Dotnet
No ratings yet
Asif Dotnet
1 page
503 C# Programming
No ratings yet
503 C# Programming
196 pages
ABAP Coding For BW Transformation...
No ratings yet
ABAP Coding For BW Transformation...
9 pages
Power Platform Licensing Guide - November 2021 - FINAL PUB v2
No ratings yet
Power Platform Licensing Guide - November 2021 - FINAL PUB v2
32 pages
Bizagi's Guide
No ratings yet
Bizagi's Guide
263 pages
SQL Server Questions
No ratings yet
SQL Server Questions
10 pages
T-SQL Coding Standards
No ratings yet
T-SQL Coding Standards
4 pages
Jesús David Guzmán Gallegos Tesselar
No ratings yet
Jesús David Guzmán Gallegos Tesselar
16 pages
Total Experience: 6 Year(s) 0 Month(s) Annual Salary: Rs 7.0 Lac(s)
No ratings yet
Total Experience: 6 Year(s) 0 Month(s) Annual Salary: Rs 7.0 Lac(s)
7 pages
Career Objective: SAP Business Objects Consultant Having 8years of Experience in Business Objects and Involved in Design
No ratings yet
Career Objective: SAP Business Objects Consultant Having 8years of Experience in Business Objects and Involved in Design
5 pages
SAP BO Designer Int Ques PDF
No ratings yet
SAP BO Designer Int Ques PDF
21 pages
Technical Publications: Product Name(s)
No ratings yet
Technical Publications: Product Name(s)
6 pages
PowerAutomate Vs UiPath
No ratings yet
PowerAutomate Vs UiPath
8 pages
ASP Road Map
No ratings yet
ASP Road Map
19 pages
Dynamics NAV Inventory Cost Restoration Whitepaper
No ratings yet
Dynamics NAV Inventory Cost Restoration Whitepaper
9 pages
Sap Bo Universe Designer Guide
No ratings yet
Sap Bo Universe Designer Guide
76 pages
Hands-On Microservices with JavaScript: Build scalable web applications with JavaScript, Node.js, and Docker
From Everand
Hands-On Microservices with JavaScript: Build scalable web applications with JavaScript, Node.js, and Docker
Tural Suleymani
No ratings yet
Instant Razor View Engine How-to
From Everand
Instant Razor View Engine How-to
Abhimanyu Kumar Vatsa
No ratings yet
IBM DB2 9.7 Advanced Application Developer Cookbook
From Everand
IBM DB2 9.7 Advanced Application Developer Cookbook
Mohankumar Saraswatipura
No ratings yet
Mlmebook
No ratings yet
Mlmebook
332 pages
Stimulsoft Reports and Dashboards User Manual - en
No ratings yet
Stimulsoft Reports and Dashboards User Manual - en
1,259 pages
Nav2013 Enus Rep Toc
No ratings yet
Nav2013 Enus Rep Toc
6 pages
Viral Ipod Video
From Everand
Viral Ipod Video
MUHAMMAD NUR WAHID ANUAR
No ratings yet
Active Reports For .NET User Guide
No ratings yet
Active Reports For .NET User Guide
281 pages
Readme
No ratings yet
Readme
2 pages
Business Scorecard Builder Custom Report WP
No ratings yet
Business Scorecard Builder Custom Report WP
12 pages
Handling Touch Input in Windows 8 Applications
No ratings yet
Handling Touch Input in Windows 8 Applications
9 pages
HDSE-I Exams Important Points
33% (3)
HDSE-I Exams Important Points
15 pages
DDF300 - Accessing GPIO, I2C, and UART Devices
No ratings yet
DDF300 - Accessing GPIO, I2C, and UART Devices
52 pages
Windows API For Red Team #101: Author
No ratings yet
Windows API For Red Team #101: Author
24 pages
(Ebook) Beginning Windows 8 Application Development by István Novák, Zoltan Arvai, György Balássy, David Fulop ISBN 9781118012680, 1118012682 - Get instant access to the full ebook with detailed content
100% (1)
(Ebook) Beginning Windows 8 Application Development by István Novák, Zoltan Arvai, György Balássy, David Fulop ISBN 9781118012680, 1118012682 - Get instant access to the full ebook with detailed content
48 pages
Blackhat USA 2012 - The Line 8 Subway - Exploitation of Windows 8 Metro Style App (Slides)
No ratings yet
Blackhat USA 2012 - The Line 8 Subway - Exploitation of Windows 8 Metro Style App (Slides)
76 pages
Modern CPP and Windows Store Apps PDF
100% (1)
Modern CPP and Windows Store Apps PDF
411 pages
Syncfusion vs. Major Competitors
No ratings yet
Syncfusion vs. Major Competitors
37 pages
AN - 271 D2xx WinRT Guide
No ratings yet
AN - 271 D2xx WinRT Guide
26 pages
Chapter 6 From Building Windows 8 Applications With C# and XAML by Jeremy Likness
No ratings yet
Chapter 6 From Building Windows 8 Applications With C# and XAML by Jeremy Likness
53 pages
CMake Lists
No ratings yet
CMake Lists
33 pages
Unit-V Windows Mobile App Development
No ratings yet
Unit-V Windows Mobile App Development
138 pages
Windows 10 System Programming Part 2 Pavel Yosifovich - The ebook in PDF format is ready for immediate access
100% (1)
Windows 10 System Programming Part 2 Pavel Yosifovich - The ebook in PDF format is ready for immediate access
62 pages
Async and Await PDF
No ratings yet
Async and Await PDF
5 pages
Project Work 1
No ratings yet
Project Work 1
7 pages
10.84 MC Works64 Resolved Issues
No ratings yet
10.84 MC Works64 Resolved Issues
18 pages
SQLite Download Page
No ratings yet
SQLite Download Page
2 pages
London RADStudio1031 MarcoCantu
No ratings yet
London RADStudio1031 MarcoCantu
129 pages
Metro Style Application: A Seminar Report ON
No ratings yet
Metro Style Application: A Seminar Report ON
31 pages
DirectX 11 1 Game Programming 1st Edition Pooya Eimandar - Get instant access to the full ebook with detailed content
No ratings yet
DirectX 11 1 Game Programming 1st Edition Pooya Eimandar - Get instant access to the full ebook with detailed content
69 pages
WindowsStoreApps Succinctly
No ratings yet
WindowsStoreApps Succinctly
187 pages
Windows 10 - UWP Development
50% (2)
Windows 10 - UWP Development
5,191 pages
Windows Store Apps Succinctly John Garland pdf download
100% (1)
Windows Store Apps Succinctly John Garland pdf download
45 pages
Smart Pointers: C++ Training
No ratings yet
Smart Pointers: C++ Training
9 pages
Matriz de Características Del Producto Rad Studio 11.1
No ratings yet
Matriz de Características Del Producto Rad Studio 11.1
27 pages
Creating Mobile Apps With Xamarin - Forms
No ratings yet
Creating Mobile Apps With Xamarin - Forms
117 pages
D1T2 - The Inner Workings of The Windows Runtime - James Forshaw
No ratings yet
D1T2 - The Inner Workings of The Windows Runtime - James Forshaw
60 pages
C#Web Basics SQL
No ratings yet
C#Web Basics SQL
113 pages