Stimulsoft Reports.PHP (Flash version) - Configuration

The config.xml file is used to configure the DesignerFx and ViewerFx. This file is automatically called by the designer or viewer immediately after loading.


The Appearance section defines the appearance of the components:

DateFormat Specifies the date and time format for dialog boxes, as well as for variables of the corresponding type in the parameters panel. By default, the date and time format set on the client side is used. ShowFormsHelp Enables displaying a link to online documentation in the titles of the dialog forms of the designer. By default, the property is set to true. ShowFormsHints Enables displaying tooltips when hovering over the interface elements in the dialog boxes of the designer. By default, the property is set to true. ShowTooltips Enables displaying tooltips for the designer controls when the mouse hovers over. By default, the property is set to true. ShowTooltipsHelp Enables displaying links to online documentation in tooltips for the designer controls. By default, the property is set to true.

The Connection section defines the connection settings:

ClientRepeatCount Sets the number of times to retry the request to the server when an error occurs in the response. By default, the property is set to 1. ClientRequestTimeout Sets the time to wait for a response from the server in seconds, after which an error will be generated. The default value is 20 seconds. For big reports, it is recommended to increase this value. EnableDataLogger Sets the logging mode for all client side requests and server responses to a special repository. When you enable the property, the new Save Log File item will be added to the menu. It allows you to save the query and response logs to a text file. By default, the property is set to false. EnableUrlGuid Adds to the URL a random Guid, which prevents the caching report files and data. By default, the property is set to false. ShowCancelButton Enables displaying the Cancel button in the load data from the server window. By default, the property is set to false.

The Designer section defines the DesignerFx component settings:

AlwaysUpdateReportFileName Always update the report file name in the save event function. By default, the property is set to false. AutoSaveInterval Specifies the time interval (in minutes) through which the designer automatically calls the action to save the report. The default value is set to 0 minutes (auto-saving is disabled). DefaultPaperSize Sets the default paper size for new page. By default, the property is set to Custom value (none of the standard paper size is not specified). DefaultReportUnit Sets the default report unit for all components. By default, the property is set to Centimeters. DontAskSaveReport Disables the save report file name dialog. By default, the property is set to false. ExitUrl Specifies the URL address when clicking the Exit button in the main menu of the designer. RunWizardAfterLoad Enables displaying the window of the render report wizard when the designer runs. By default, the property is set to false. Title Specifies the title of the web browser window on the page on what the designer is placed. By default, the property has an empty value and, in this case, as the title of the browser window will be the name or alias of the report.

The Designer / Appearance section defines the appearance settings:

GridSizeCentimetres Specifies the grid size for the Centimetres units. By default, the property is set to 0.2. GridSizeHundredthsOfInch Specifies the grid size for the Hundredths of Inch units. By default, the property is set to 10. GridSizeInch Specifies the grid size for the Inch units. By default, the property is set to 0.1. GridSizeMillimeters Specifies the grid size for the Millimeters units. By default, the property is set to 2. SetReportModifiedWhenOpening Specifies the report, opened when the designer runs, as already changed. By default, the property is set to false. ShowMoreDetailsButton Enables displaying the More Details button in the error message. By default, the property is set to true. ShowSaveFileDialog Enables displaying the dialog to insert a report name when it is saved. The name of the report will be transferred in the parameters of the report designer. By default, the property is set to false.

The Designer / Database section defines the databases settings:

AdapterFirebird Enables the Firebird database adapter for the designer. By default, the property is set to true. AdapterMongoDB Enables the MongoDB database adapter for the designer. By default, the property is set to false. Currently not supported. AdapterMySql Enables the MySQL database adapter for the designer. By default, the property is set to true. AdapterOdbc Enables the Odbc database adapter for the designer. By default, the property is set to true. AdapterOracle Enables the Oracle database adapter for the designer. By default, the property is set to true. AdapterPostgreSQL Enables the PostgreSQL database adapter for the designer. By default, the property is set to true. AdapterSql Enables the MS SQL database adapter for the designer. By default, the property is set to true. AdapterXmlData Enables the XML database adapter for the designer. By default, the property is set to true. AdapterVirtual Enables the Virtual data sources for the designer. By default, the property is set to true.

The Designer / Dictionary section defines the dictionary settings:

AllowModifyConnections Allows editing connections in the data dictionary. By default, the property is set to true. AllowModifyDataSources Allows editing data sources in the data dictionary. By default, the property is set to true. AllowModifyDictionary Allows editing data dictionary. By default, the property is set to true. AllowModifyRelations Allows editing connections in the data dictionary. By default, the property is set to true. AllowModifyVariables Allows editing variables in the data dictionary. By default, the property is set to true. CachePreviewData Enables cache for data rows. By default, the property is set to true. ShowActionsMenu Enables showing the Actions menu in the data dictionary. By default, the property is set to true. ShowConnectionType Enables showing the type of connection in the data dictionary. By default, the property is set to true. ShowOnlyAliasForBusinessObject Enables showing the mode of showing aliases for business objects. By default, the property is set to false. ShowOnlyAliasForDatabase Enables showing the mode of showing aliases for connections. By default, the property is set to false. ShowOnlyAliasForDataColumn Enables showing the mode of showing aliases for columns. By default, the property is set to false. ShowOnlyAliasForDataRelation Enables showing the mode of showing aliases for relations. By default, the property is set to false. ShowOnlyAliasForDataSource Enables showing the mode of showing aliases for data sources. By default, the property is set to false. ShowOnlyAliasForVariable Enables showing the mode of showing aliases for variables. By default, the property is set to false. ShowTestConnectionButton Enables showing the Test button in the edit connection dialog. By default, the property is set to true.

The Designer / MainMenu section defines the file menu settings:

Caption Specifies the title of the main menu. By default, the standard title is used. ShowClose Enables showing the Close item of the main menu. By default, the property is set to true. ShowExitButton Enables showing the Exit item of the main menu. By default, the property is set to true. ShowNew Enables showing the New item of the main menu. By default, the property is set to true. ShowNewPage Enables showing the New Page item of the main menu. By default, the property is set to true. ShowNewReport Enables showing the New Report item of the main menu. By default, the property is set to true. ShowNewReportWithWizard Enables showing the New Report With Wizard item of the main menu. By default, the property is set to true. ShowOpenReport Enables showing the Open Report item of the main menu. By default, the property is set to true. ShowSaveAs Enables showing the Save Report As item of the main menu. By default, the property is set to true. ShowSaveReport Enables showing the Save Report item of the main menu. By default, the property is set to true.

The Designer / Toolbar section defines the settings of panels:

ShowAboutButton Enables showing the About item of the main menu. By default, the property is set to true. ShowDictionaryTab Enables showing data dictionary. By default, the property is set to true. ShowPreviewReportTab Enables showing the report preview window. By default, the property is set to true. ShowSelectLanguage Enables a list of available localizations. By default, the property is set to true. Zoom Sets the zoom for displaying report pages. The default setting is Default value - latest zoom mode will be applied. The values are from 20 to 500 percent. Also it may have the following values: Default, OnePage, PageWidth, PageHeight.

The Localizations section defines the interface localization:

Localization Interface localization that will be loaded and applied by default. The value is the localization file name without extansion. For example, <Localization>en</Localization>. The localization XML files should be located in the localization folder on the server side. If the Default value is specified to the localization, the previously selected localization will be applied.

The Theme section defines the interface theme:

Theme Specifies the theme of the components layout. The default value is Office2013. Also it may have the following values: Office2013, Blue, Silver, Black. The Silver and Black values are intended only for the ViewerFx component.

The Print section defines the print settings of the report:

AllowDefaultPrint Enables the Default report printing mode in the print report dialog box of the report viewer. By default, the property is set to true. AllowPrintToHtml Enables the Print as HTML report printing mode in the print report dialog box of the report viewer. By default, the property is set to true. AutoPageOrientation Enables automatic page rotation of the report if the report page orientation does not match the page orientation settings of the printer. By default, the property is set to true. AutoPageScale Enables automatic scaling of the report page to fit the paper size. By default, the property is set to true. PrintAsBitmap Enables report printing by means of a graphical snapshot of the report page. By default, the property is set to true. ShowPrintDialog Enables displaying the report printing dialog box. If the print dialog is disabled, then, clicking the button, will immediately display the system print dialog, the report will be printed in the Default mode. By default, the property is set to true.

The Viewer section defines the ViewerFx component settings:

DefaultEmail Sets the default recipient email, i.e. the address to which the email with the attached report will be sent. ExitUrl Specifies the URL address when clicking the Exit button in the main toolbar of the viewer. Title Specifies the title of the web browser window on the page on what the viewer is placed. By default, the property has an empty value and, in this case, as the title of the browser window will be the name or alias of the report.

The Viewer / Appearance section defines the appearance settings:

AllowDrawSegmentMode Enables drawing the blue lines of the segmented report pages. By default, the property is set to true. AutoHideScrollbars Enables automatic hiding of report scrollbars, if they are not required. By default, the property is set to false. CurrentPageBorderColor Sets the border color of the selected (current) report page. By default, the property is set to Gold (or Blue for the Office2013 theme). OpenLinksTarget ESets the target window for opening the links contained in the report. By default, the property is set to _blank (new window). ShowEmailDialog Enables displaying settings for sending the report via email. If the dialog box is disabled, the email will be sent with the settings set on the server side. By default the property is set to true. ShowEmailExportDialog Enables displaying export options dialog box when sending email. If the property is set to false, the export will be done with the default settings. By default the property is set to true. VariablesPanelColumns Sets the number of columns to display report parameters. By default, there are 2 columns. VariablesPanelEditorWidth Sets the width of editable fields in the parameters panel. The default width is 200 pixels.

The Viewer / Exports section defines the export settings, and also allows hide unnecessary export formats from the save menu:

Destination Sets the destination for exported report stream. The property may have the following values: Local - save file to local computer, Remote - send file to remote server, LocalAndRemote - save file to local computer, then send file to remote server. By default, the property is set to Local. ShowExportDialog Enables showing export options dialog box. If the property is false, the export will be done with the default settings. By default the property is set to true. ShowExportToCsv Enables the export menu item CSV File. By default, the property is set to true. ShowExportToDocument Enables the export menu item Document File. By default, the property is set to true. ShowExportToExcel Enables the export menu item Microsoft Excel File. By default, the property is set to true. ShowExportToExcel2007 Enables the export menu item Microsoft Word 2007/2010 File. By default, the property is set to true. ShowExportToHtml Enables the export menu item HMTL File. By default, the property is set to true. ShowExportToHtml5 Enables the export menu item HMTL5 File. By default, the property is set to true. ShowExportToPdf Enables the export menu item Adobe PDF File. By default, the property is set to true. ShowExportToRtf Enables the export menu item Rich Text File. By default, the property is set to true. ShowExportToText Enables the export menu item Text File. By default, the property is set to true. ShowExportToWord2007 Enables the export menu item Microsoft Word 2007/2010 File. By default, the property is set to true.

The Viewer / Toolbar section defines the settings of the panels:

ShowAboutButton Enables showing the button - About - on the toolbar of the viewer. By default, the property is set to true. ShowBookmarksButton Enables showing the button - Bookmarks - on the toolbar of the viewer. By default, the property is set to true. ShowDesignButton Enables showing the button - Design - on the toolbar of the viewer. By default, the property is set to false. ShowExitButton Enables showing the button - Exit - on the toolbar of the viewer. By default, the property is set to false. ShowFindButton Enables showing the button - Find - on the toolbar of the viewer. By default, the property is set to true. ShowFirstPageButton Enables showing the button - First Page -on the navigation panel of the viewer. By default, the property is set to true. ShowFullScreenButton Enables showing the button - Full Screen - on the toolbar of the viewer. By default, the property is set to true. ShowGoToPageButton Enables showing the button - Go To Page - on the navigation panel of the viewer. By default, the property is set to true. ShowLastPageButton Enables showing the button - Last Page - on the navigation panel of the viewer. By default, the property is set to true. ShowMainToolbar Enables showing the viewer main toolbar. By default, the property is set to true. ShowNavigateToolbar Enables the navigation panel for the report. By default, the property is set to true. ShowNextPageButton Enables showing the button - Next Page - on the navigation panel of the viewer. By default, the property is set to true. ShowOpenButton Enables showing the button - Open - on the toolbar of the viewer. By default, the property is set to false. ShowPageViewModeContinuousButton Enables showing the button - Continuous Page - on the report preview panel. By default, the property is set to true. ShowPageViewModeMultipleButton Enables showing the button - Multiple Page - on the report preview panel. By default, the property is set to true. ShowPageViewModeSingleButton Enables showing the button - Single Page - on the report preview panel. By default, the property is set to true. ShowParametersButton Enables showing the button - Parameters - on the toolbar of the viewer. By default, the property is set to true. ShowParametersPanel Enables showing the parameters panel of the viewer. By default, the property is set to true. ShowPreviousPageButton Enables showing the button - Previous Page - on the navigation panel of the viewer. By default, the property is set to true. ShowPrintButton Enables showing the button - Print - on the toolbar of the viewer. By default, the property is set to true. ShowSaveButton Enables showing the button - Save - on the toolbar of the viewer. By default, the property is set to true. ShowSendEMailButton Enables showing the button - Send Email - on the toolbar of the viewer. By default, the property is set to false. ShowThumbnailsButton Enables showing report page thumbnails in the special panel of the viewer. By default, the property is set to true. ShowViewModeToolbar Enables showing the report preview panel. By default, the property is set to true. ShowZoom Enables showing zoom buttons. By default, the property is set to true. Zoom Sets the zoom for displaying report pages. The default setting is Default value - latest zoom mode will be applied. The values are from 20 to 500 percent. Also it may have the following values: Default, OnePage, TwoPages, PageWidth.