ActiveReports 16 .NET Edition
ActiveReports 16 User Guide / Welcome to ActiveReports 16 / ActiveReports Configuration File
In This Topic
    ActiveReports Configuration File
    In This Topic

    The default location of the ActiveReports configuration file (GrapeCity.ActiveReports.config) is the installer location: C:\Program Files (x86)\GrapeCity\ActiveReports 16. Otherwise, the file may be placed beside the application or the plugin assembly. See the Custom Tile Provider sample description as an example.

    You can specify control various settings in the configuration file, such as:

    Control Launching the Data Source Wizard

    Set the value for the LaunchDataSourceWizard key to 'false' to disable the default behavior of the wizard, which is to open the Report Data Source dialog on creating a new report.

    Paste into the GrapeCity.ActiveReports.config file
    Copy Code
    <Configuration>
      <appSettings>
        <add key="LaunchDataSourceWizard" value="false"/>
      </appSettings>
    </Configuration>
    

    Control Print Dialog Settings

    Set PrintDialogStyle key to the values shown below to change the default print dialog for the ActiveReports Designer.

    Paste into the GrapeCity.ActiveReports.config file
    Copy Code
    <Configuration>
      <appSettings>             
                         
              <!-- For OS native print dialog -->
                    <add key="PrintDialogStyle" value="Standard"/>
                   
              <!-- For OS native print dialog shown in Windows XP style
                    <add key="PrintDialogStyle" value="XpStyle"/>
    
                   For Print dialog with advanced printing settings, used by default 
                    <add key="PrintDialogStyle" value="Advanced"/> --> 
      </appSettings>
    </Configuration>
    

    Enable Classic Charts

    Set EnableChartClassic key to the value  to 'true' to enable the classic chart in the ActiveReports Designer.

    Paste into the GrapeCity.ActiveReports.config file
    Copy Code
    <Configuration>
      <appSettings>
        <add key="EnableChartClassic" value="true"/>
      </appSettings>
    </Configuration>
    

    See the Classic Chart topic.

    Disable New Charts in Page/RDL Reports

    Set EnableChart key to the value  to 'false' to disable the classic chart in the ActiveReports Designer.

    Paste into the GrapeCity.ActiveReports.config file
    Copy Code
    <Configuration>
      <appSettings>
        <add key="EnableChart" value="false"/>
      </appSettings>
    </Configuration>
    

    See the Chart topic.

    Custom Report Items

    Page and RDL reports allow extending the functionality of existing controls in the ActiveReports Designer. The config file should be something as follows.

    Paste into the GrapeCity.ActiveReports.config file
    Copy Code
    <?xml version="1.0" encoding="utf-8" ?>
    <Configuration>
        <Extensions>
            <ReportItems>
                <ReportItem Name="RadarChart" Type="GrapeCity.ActiveReports.Samples.Radar.RadarChart, RadarChart" />
            </ReportItems>
            <ReportItemDesigner>
                <ReportItem Name="RadarChart" Type="GrapeCity.ActiveReports.Samples.Radar.RadarDesigner, RadarDesigner" BitmapResource="GrapeCity.ActiveReports.Samples.Radar.RadarIcon.png" />
            </ReportItemDesigner>
        </Extensions>
    </Configuration>
    

    See the Custom Chart sample.

    Specify Custom Fonts

    In the GrapeCity.ActiveReports.config file, you can also specify custom fonts to be used in Page, RDL, and Section reports (in the CrossPlatform compatibility mode) as in the following example.

    Note: Custom font settings have higher priority over default font settings.
    Paste into the GrapeCity.ActiveReports.config file
    Copy Code
    <Configuration>
         <Extensions>
               <FontFactory>
                    <AddFolder Path="%WINDIR%/Fonts" Recurse="true" />
                    <AddFolder Path="%USERPROFILE%/AppData/Local/Microsoft/Windows/Fonts" Recurse="true" />
                    <Substitute Font="Arabic Transparent" To="Arial" />
                    <Substitute Font="Coutier" To="Coutier New" />
                    <Substitute Font="Helv" To="Arial" />
                    <Substitute Font="Helvetica" To="Arial" />
                    <Substitute Font="MS Sans Serif" To="Microsoft Sans Serif" />
                    <Substitute Font="MS Serif" To="Times New Roman" />
                    <Substitute Font="Times" To="Times New Roman" />
                    <Substitute Font="Tms Rmn" To="Times New Roman" />
                    <SetFallbackFont Font="Microsoft Sans Serif" />
                    <SetFallbackFont Font="MS UI Gothic" />
                    <SetFallbackFont Font="Arial" />
                    <AddFontLink Font="Lucida Sans Unicode" List="MS UI Gothic,PMingLiU,SimSun,Gulim,Yu Gothic UI,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic" />
                    <AddFontLink Font="Microsoft Sans Serif" List="MS UI Gothic,Yu Gothic UI,PMingLiU,SimSun,Gulim,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic" />
                    <AddFontLink Font="Tahoma" List="MS UI Gothic,PMingLiU,SimSun,Gulim,Yu Gothic UI,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic" />
                    <AddFontLink Font="Segoe UI" List="Tahoma,Meiryo UI,MS UI Gothic,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic,PMingLiU,SimSun,Gulim,Yu Gothic UI" />
                    <AddFontLink Font="Ebrima" List="Segoe UI,Meiryo UI,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic,Yu Gothic UI" />
                    <AddFontLink Font="Gadugi" List="Segoe UI,Meiryo UI,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic,Yu Gothic UI" />
                    <AddFontLink Font="Khmer UI" List="Segoe UI,Meiryo UI,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic,Yu Gothic UI" />
                    <AddFontLink Font="Lao UI" List="Segoe UI,Meiryo UI,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic,Yu Gothic UI" />
                    <AddFontLink Font="Leelawadee" List="Segoe UI,Meiryo UI,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic,Yu Gothic UI" />
                    <AddFontLink Font="Leelawadee UI" List="Segoe UI,Meiryo UI,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic,Yu Gothic UI" />
                    <AddFontLink Font="Nirmala UI" List="Segoe UI,Meiryo UI,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic,Yu Gothic UI" />
                    <AddFontLink Font="MingLiU" List="Microsoft Sans Serif,SimSun,MS Mincho,BatangChe,Microsoft JhengHei UI,Microsoft YaHei UI,Yu Gothic UI,Malgun Gothic" />
                    <AddFontLink Font="PMingLiU" List="Microsoft Sans Serif,SimSun,MS PMincho,Batang,Microsoft JhengHei UI,Microsoft YaHei UI,Yu Gothic UI,Malgun Gothic" />
                    <AddFontLink Font="Microsoft JhengHei" List="Segoe UI,MingLiU,Microsoft YaHei,Meiryo,Malgun Gothic,Yu Gothic UI" />
                    <AddFontLink Font="Microsoft JhengHei UI" List="Segoe UI,MingLiU,Microsoft YaHei UI,Meiryo UI,Malgun Gothic,Yu Gothic UI" />
                    <AddFontLink Font="SimSun" List="Microsoft Sans Serif,PMingLiU,MS PMincho,Batang,Microsoft YaHei UI,Microsoft JhengHei UI,Yu Gothic UI,Malgun Gothic" />
                    <AddFontLink Font="NSimSun" List="PMingLiU,MS Mincho,BatangChe,Microsoft YaHei UI,Microsoft JhengHei UI,Yu Gothic UI,Malgun Gothic" />
                    <AddFontLink Font="Microsoft YaHei" List="Segoe UI,Segoe UI,SimSun,Microsoft JhengHei,Meiryo,Malgun Gothic,Yu Gothic UI" />
                    <AddFontLink Font="Microsoft YaHei UI" List="Segoe UI,SimSun,Microsoft Jhenghei UI,Meiryo UI,Malgun Gothic,Yu Gothic UI" />
                    <AddFontLink Font="Yu Gothic UI" List="Segoe UI,Microsoft JhengHei,Microsoft YaHei,Malgun Gothic" />
                    <AddFontLink Font="Meiryo" List="Segoe UI,Yu Gothic UI,MS UI Gothic,Microsoft Jhenghei,Microsoft YaHei,Malgun Gothic" />
                    <AddFontLink Font="Meiryo UI" List="Segoe UI,Yu Gothic UI,MS UI Gothic,Microsoft Jhenghei UI,Microsoft YaHei UI,Malgun Gothic" />
                    <AddFontLink Font="MS Gothic" List="MingLiU,SimSun,GulimChe,Yu Gothic UI,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic" />
                    <AddFontLink Font="MS PGothic" List="PMingLiU,SimSun,Gulim,Yu Gothic UI,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic" />
                    <AddFontLink Font="MS UI Gothic" List="Microsoft Sans Serif,PMingLiU,SimSun,Gulim,Yu Gothic UI,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic" />
                    <AddFontLink Font="MS Mincho" List="MingLiU,SimSun,Batang,Yu Gothic UI,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic" />
                    <AddFontLink Font="MS PMincho" List="PMingLiU,SimSun,Batang,Yu Gothic UI,Microsoft JhengHei UI,Microsoft YaHei UI,Malgun Gothic" />
                    <AddFontLink Font="Batang" List="MS PMincho,PMingLiU,SimSun,Malgun Gothic,Yu Gothic UI,Microsoft JhengHei UI,Microsoft YaHei UI" />
                    <AddFontLink Font="BatangChe" List="MS Mincho,MingLiU,SimSun,Malgun Gothic,Yu Gothic UI,Microsoft JhengHei UI,Microsoft YaHei UI" />
                    <AddFontLink Font="Dotum" List="MS UI Gothic,PMingLiU,SimSun,Malgun Gothic,Yu Gothic UI,Microsoft JhengHei UI,Microsoft YaHei UI" />
                    <AddFontLink Font="DotumChe" List="MS Gothic,MingLiU,SimSun,Malgun Gothic,Yu Gothic UI,Microsoft JhengHei UI,Microsoft YaHei UI" />
                    <AddFontLink Font="Gulim" List="Microsoft Sans Serif,MS UI Gothic,PMingLiU,SimSun,Malgun Gothic,Yu Gothic UI,Microsoft JhengHei UI,Microsoft YaHei UI" />
                    <AddFontLink Font="GulimChe" List="MS Gothic,MingLiU,SimSun,Malgun Gothic,Yu Gothic UI,Microsoft JhengHei UI,Microsoft YaHei UI" />
                    <AddFontLink Font="Gungsuh" List="MS PMincho,PMingLiU,SimSun,Malgun Gothic,Yu Gothic UI,Microsoft JhengHei UI,Microsoft YaHei UI" />
                    <AddFontLink Font="GungsuhChe" List="MS Mincho,MingLiU,SimSun,Malgun Gothic,Yu Gothic UI,Microsoft JhengHei UI,Microsoft YaHei UI" />
                    <AddFontLink Font="Malgun Gothic" List="Segoe UI,Gulim,Meiryo UI,Microsoft Jhenghei UI,Microsoft YaHei UI,Yu Gothic UI" />
                    <DefaultEudcFont File="EUDC.tte" />
                    <AddEudcFont Font="MS UI Gothic" File="myEUDC1.tte" />
                    <AddEudcFont Font="Meiryo" File="myEUDC2.tte" />
                  </FontFactory>
         </Extensions>
    </Configuration>
    

    See Custom Font Settings topic for more information.

    Custom Font Configuration Settings

    Element Description
    AddFolder Adds all TrueType fonts from a specific folder. Specifies the Path attribute for the absolute filesystem path with possible environment variables. Sets Recurse to True for the factory to read folders recursively.
    Substitute Adds a font substitution entry. See https://docs.microsoft.com/en-us/globalization/input/font-technology and HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\FontSubstitutes registry key.
    SetFallbackFont

    Specifies the font to be used if no font is installed or no substitution rule is specified. See https://docs.microsoft.com/en-us/globalization/input/font-technology.

    AddFontLink  The List attribute specifies a comma-separated list of fonts that will be used in case of missing glyphs, specified in the Font attribute. See https://docs.microsoft.com/en-us/globalization/input/font-technology and HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\FontLink\SystemLink registy key. 
    DefaultEudcFont

    A default unique EUDC font for all fonts. It is an absolute path or a relative to the first one, found in the AddFolder setting. The same role as the "SystemDefaultEudcFont" entry in the registry - see https://docs.microsoft.com/en-us/windows/win32/intl/eudc.

    AddEudcFont Associates the EUDC file and the font name. See https://docs.microsoft.com/en-us/windows/win32/intl/eudc.

    Map Report Item and Map Tile Providers

    The Map report item allows configuring built-in tile providers and extensions with custom report items. External providers in general have limited support to the resources. They require something like an external key to access without limits. ActiveReports allows configuring the following keys:

     See the example below.

    GrapeCity.ActiveReports.config file
    Copy Code
    <?xml version="1.0" encoding="utf-8" ?>
    <Configuration>
        <Extensions>
            <MapTileProviders>
                <MapTileProvider Name="MapQuest" DisplayName="MapQuest Tiles">
                    <Settings>
                        <add key="ApiKey" value="Fmjtd%7Cluur21ua2l%2C2x%3Do5-90t5h6" />
                        <add key="Timeout" value="5000" />
                    </Settings>
                </MapTileProvider>
                <MapTileProvider Name="Google" DisplayName="Google Tiles">
                    <Settings>
                        <add key="ApiKey" value="AIzaSyBdJ88HN7LTGkHHK5whfaVv8a5ozlx2E_k" />
                        <add key="Timeout" value="5000" />
                    </Settings>
                </MapTileProvider>
                <MapTileProvider Name="Bing" DisplayName="Bing Tiles" >
                    <Settings>
                        <add key="ApiKey" value="Al3SxHf0LOva-5GI5fOajO0LCuKjYKLarjWQFcdGiKfaJNRrE6SBbH9o3-HJDOX7" />
                        <add key="Timeout" value="5000" />
                    </Settings>
                </MapTileProvider>
            </MapTileProviders>
        </Extensions>
    </Configuration>
    

    Custom Map Tile Providers

    You can implement your own tile provider and register it in ActiveReports.

    GrapeCity.ActiveReports.config file
    Copy Code
    <?xml version="1.0" encoding="utf-8" ?>
    <Configuration>
        <Extensions>
            <MapTileProviders>
                <MapTileProvider Name="MapQuest-Sample" DisplayName="MapQuest-Sample" Type="GrapeCity.ActiveReports.Samples.CustomTileProviders.MapQuestTileProvider, CustomTileProviders, Version=1.0.0.0">
                    <Settings>
                        <add key="ApiKey" value="Fmjtd%7Cluur21ua2l%2C2x%3Do5-90t5h6" />
                        <add key="Timeout" value="3000" />
                    </Settings>
                </MapTileProvider>
            </MapTileProviders>
        </Extensions>
    </Configuration>
    

    See the Custom Tile Provider sample.

    Custom Data Providers

     You can configure custom data providers by adding just a few lines in the configuration file as shown:

    GrapeCity.ActiveReports.config file
    Copy Code
    <?xml version="1.0" encoding="utf-8" ?>
    <Configuration>
        <Extensions>
            <Data>
                <Extension Name="SQLITE" Type="System.Data.SQLite.SQLiteFactory, System.Data.SQLite"
                           DisplayName="Sqlite Provider" />
            </Data>
        </Extensions>
    </Configuration>
    

    If you require custom UI, use CommandTextEditorType key as shown. 

    GrapeCity.ActiveReports.config file
    Copy Code
    <?xml version="1.0" encoding="utf-8" ?>
    <Configuration>
        <Extensions>
            <Data>
                <Extension Name="CustomCSV"
                 DisplayName="CSV Data Provider"
                 Type="GrapeCity.ActiveReports.Samples.CustomDataProvider.CSVDataProvider.CsvDataProviderFactory,CustomDataProvider, version=0.0.0.0, Culture=neutral"
                 CommandTextEditorType="GrapeCity.ActiveReports.Samples.CustomDataProviderUI.QueryEditor,CustomDataProviderUI, Version=1.0.0.0, Culture=neutral"
                />
            </Data>
        </Extensions>
    </Configuration>
    

    See the Custom Data Provider sample.

    Prevent Report Crashing


    You can disable the report validation in WinViewer and End User Designer, which is performed to prevent report crashing. By default, the report validation is enabled.

     

    GrapeCity.ActiveReports.config file
    Copy Code
    <add key="SkipReportValidation" value="true"/>
    

     

    To disable the report validation in WebViewer, the configuration file has to be specified in the settings in UseReporting method.

    GrapeCity.ActiveReports.config file
    Copy Code
    app.UseReporting(settings =>
    {
    //...
    settings.UseConfig("C:\\Program Files (x86)\\GrapeCity\\ActiveReports 16\\GrapeCity.ActiveReports.config");
    });
    
    See Also