Package com.stimulsoft.report.options

Class EngineOptions

java.lang.Object
com.stimulsoft.report.options.EngineOptions
Direct Known Subclasses:
StiOptions.Engine
public class EngineOptions extends Object

  • Field Details

    • allowScriptsToRun

      public static boolean allowScriptsToRun
      Allows the report engine to run scripts in a report in the interpretation mode.

    • allowHtmlTagsInChart

      public static boolean allowHtmlTagsInChart

    • defaultNumberFormatLocale

      public static Locale defaultNumberFormatLocale

    • defaultDateTimeFormatLocale

      public static Locale defaultDateTimeFormatLocale

    • negativeColor

      public static StiColor negativeColor
      A color which is used for coloring negative values in the text formatting.

    • optimizeDetailDataFiltering

      public static boolean optimizeDetailDataFiltering
      If true then remove double call of SetData method for detail bands. For backward compatibility with 2016.1.

    • removeBottomBorderOfSplitContainer

      public static boolean removeBottomBorderOfSplitContainer
      a value forcing removing bottom border for breaked container.

    • allowCacheForGetActualSize

      public static boolean allowCacheForGetActualSize
      A value which allow using cache for GetActualSize methods.

    • hideMessages

      public static boolean hideMessages

    • showBookmarkToDisabledBand

      public static boolean showBookmarkToDisabledBand

    • allowConvertingInFormatting

      public static boolean allowConvertingInFormatting
      a value which allows converting values to required types in the text formatting.

    • useNewHtmlEngine

      public static boolean useNewHtmlEngine

    • usePrintOnAllPagesPropertyOfHeadersInSubreports

      public static boolean usePrintOnAllPagesPropertyOfHeadersInSubreports
      a value which allow to use the PrintOnAllPages property of headers in subreports

    • allowBreakContainerOptimization

      public static boolean allowBreakContainerOptimization
      a value which allow BreakContainer optimization.

    • logLevel

      public static int logLevel
      Set log level to 10 to show all debug info

    • fixCyrillicRtf

      public static boolean fixCyrillicRtf

    • allExceptions

      public static boolean allExceptions
      Do not hide any exceptions in the report engine if this value is true.

  • Constructor Details

    • EngineOptions

      public EngineOptions()

  • Method Details

    • isFilterDataInDataSourceBeforeSorting

      public static boolean isFilterDataInDataSourceBeforeSorting()
      If true then filter data in DataSource before sorting. For backward compatibility with 2016.1.
      Returns:

    • setFilterDataInDataSourceBeforeSorting

      public static void setFilterDataInDataSourceBeforeSorting(boolean filterDataInDataSourceBeforeSorting)
      If true then filter data in DataSource before sorting. For backward compatibility with 2016.1.
      Parameters:
      filterDataInDataSourceBeforeSorting -

    • isPrintIfDetailEmptyNesting

      public static boolean isPrintIfDetailEmptyNesting()
      a value which allow extended check for PrintIfDetailEmpty property.
      Returns:
      the printIfDetailEmptyNesting

    • setPrintIfDetailEmptyNesting

      public static void setPrintIfDetailEmptyNesting(boolean printIfDetailEmptyNesting)
      a value which allow extended check for PrintIfDetailEmpty property.
      Parameters:
      printIfDetailEmptyNesting - the printIfDetailEmptyNesting to set

    • isRenderExternalSubReportsWithHelpOfUnlimitedHeightPages

      public static boolean isRenderExternalSubReportsWithHelpOfUnlimitedHeightPages()
      a value indicating whether it is necessary to render external subreports with help of unlimited height pages.
      Returns:
      the renderExternalSubReportsWithHelpOfUnlimitedHeightPages

    • setRenderExternalSubReportsWithHelpOfUnlimitedHeightPages

      public static void setRenderExternalSubReportsWithHelpOfUnlimitedHeightPages(boolean renderExternalSubReportsWithHelpOfUnlimitedHeightPages)
      a value indicating whether it is necessary to render external subreports with help of unlimited height pages.
      Parameters:
      renderExternalSubReportsWithHelpOfUnlimitedHeightPages - the renderExternalSubReportsWithHelpOfUnlimitedHeightPages to set

    • isAllowForceCanBreakForCrossTabPrintOnAllPages

      public static boolean isAllowForceCanBreakForCrossTabPrintOnAllPages()
      This value indicates that it is necessary to simulate interactivity for charts with text elements.
      Returns:
      the allowForceCanBreakForCrossTabPrintOnAllPages

    • setAllowForceCanBreakForCrossTabPrintOnAllPages

      public static void setAllowForceCanBreakForCrossTabPrintOnAllPages(boolean allowForceCanBreakForCrossTabPrintOnAllPages)
      This value indicates that it is necessary to simulate interactivity for charts with text elements.
      Parameters:
      allowForceCanBreakForCrossTabPrintOnAllPages - the allowForceCanBreakForCrossTabPrintOnAllPages to set

    • getBarcodeQRCodeDefaultByteModeEncoding

      public static StiQRCodeECIMode getBarcodeQRCodeDefaultByteModeEncoding()

    • setBarcodeQRCodeDefaultByteModeEncoding

      public static void setBarcodeQRCodeDefaultByteModeEncoding(StiQRCodeECIMode barcodeQRCodeDefaultByteModeEncoding)

    • isBarcodeQRCodeAllowUnicodeBOM

      public static boolean isBarcodeQRCodeAllowUnicodeBOM()
      A value which allow to use BOM for the Unicode encoding in the QR-Code.
      Returns:

    • setBarcodeQRCodeAllowUnicodeBOM

      public static void setBarcodeQRCodeAllowUnicodeBOM(boolean barcodeQRCodeAllowUnicodeBOM)
      A value which allow to use BOM for the Unicode encoding in the QR-Code.
      Parameters:
      barcodeQRCodeAllowUnicodeBOM -

    • getBarcodeDpiMultiplierFactor

      public static double getBarcodeDpiMultiplierFactor()
      a value of barcode dpi multiplier factor.
      Returns:
      the barcodeDpiMultiplierFactor

    • setBarcodeDpiMultiplierFactor

      public static void setBarcodeDpiMultiplierFactor(double barcodeDpiMultiplierFactor)
      a value of barcode dpi multiplier factor.
      Parameters:
      barcodeDpiMultiplierFactor - the barcodeDpiMultiplierFactor to set

    • isBarcodeImproveQualityHtmlExport

      public static boolean isBarcodeImproveQualityHtmlExport()
      a value which force improve barcode quality in HTML export
      Returns:
      the barcodeImproveQualityHtmlExport

    • setBarcodeImproveQualityHtmlExport

      public static void setBarcodeImproveQualityHtmlExport(boolean barcodeImproveQualityHtmlExport)
      a value which force improve barcode quality in HTML export
      Parameters:
      barcodeImproveQualityHtmlExport - the barcodeImproveQualityHtmlExport to set

    • isAllowSimplifyChartValues

      public static boolean isAllowSimplifyChartValues()
      A value indicates that the chart values will be simplified
      Returns:
      the allowSimplifyChartValues

    • setAllowSimplifyChartValues

      public static void setAllowSimplifyChartValues(boolean allowSimplifyChartValues)
      A value indicates that the chart values will be simplified
      Parameters:
      allowSimplifyChartValues - the allowSimplifyChartValues to set

    • isUseOldZipCodePaintMode

      public static boolean isUseOldZipCodePaintMode()
      A value which defines a previous realization of the Paint mode of the ZipCode component.
      Returns:
      the useOldZipCodePaintMode

    • setUseOldZipCodePaintMode

      public static void setUseOldZipCodePaintMode(boolean useOldZipCodePaintMode)
      A value which defines a previous realization of the Paint mode of the ZipCode component.
      Parameters:
      useOldZipCodePaintMode - the useOldZipCodePaintMode to set

    • getComponentsStabilizationValue

      public static double getComponentsStabilizationValue()
      Stabilize matrix cells position. Most used value is 0.1 or greater. Zero value (default) = no stabilization
      Returns:
      the cellsStabilizationValue

    • setComponentsStabilizationValue

      public static void setComponentsStabilizationValue(double cellsStabilizationValue)
      Stabilize matrix cells position. Most used value is 0.1 or greater. Zero value (default) = no stabilization
      Parameters:
      cellsStabilizationValue - the cellsStabilizationValue to set

    • setUseRoundForToCurrencyWordsFunctions

      public static void setUseRoundForToCurrencyWordsFunctions(boolean value)

    • getMeasureTrailingSpaces

      public static boolean getMeasureTrailingSpaces()

    • isDockPageFooterToBottom

      public static boolean isDockPageFooterToBottom()

    • getDefaultPaperSize

      public static StiPaperKind getDefaultPaperSize()

    • getHideExceptions

      public static boolean getHideExceptions()

    • setHideExceptions

      public static void setHideExceptions(boolean value)

    • getAdvancedRetrievalModeOfDatabaseInformation

      public static boolean getAdvancedRetrievalModeOfDatabaseInformation()
      Retrieve database information with DataAdapters (instead Connection.GetSchema)

    • setAdvancedRetrievalModeOfDatabaseInformation

      public static void setAdvancedRetrievalModeOfDatabaseInformation(boolean value)

    • getDefaultUnit

      public static Object getDefaultUnit()

    • setDefaultUnit

      public static void setDefaultUnit(Object value)

    • getAllowUseOriginalFontName

      public static boolean getAllowUseOriginalFontName()

    • setAllowUseOriginalFontName

      public static void setAllowUseOriginalFontName(boolean value)

    • getAllowInteractionInChartWithComponents

      public static boolean getAllowInteractionInChartWithComponents()

    • setAllowInteractionInChartWithComponents

      public static void setAllowInteractionInChartWithComponents(boolean value)

    • getAllowResetValuesAtComponent

      public static boolean getAllowResetValuesAtComponent()
      Allows reset values (TagValue, HyperlinkValue, BookmarkValue and ToolTipValue) to null before report rendering.

    • setAllowResetValuesAtComponent

      public static void setAllowResetValuesAtComponent(boolean value)

    • getPrintIfDetailEmptyDefaultValue

      public static boolean getPrintIfDetailEmptyDefaultValue()

    • setPrintIfDetailEmptyDefaultValue

      public static void setPrintIfDetailEmptyDefaultValue(boolean value)

    • getAllowSetCurrentDirectory

      public static boolean getAllowSetCurrentDirectory()

    • setAllowSetCurrentDirectory

      public static void setAllowSetCurrentDirectory(boolean value)

    • getDefaultValueOfAllowApplyStyleProperty

      public static boolean getDefaultValueOfAllowApplyStyleProperty()

    • setDefaultValueOfAllowApplyStyleProperty

      public static void setDefaultValueOfAllowApplyStyleProperty(boolean value)

    • getAllowProgressInThread

      public static boolean getAllowProgressInThread()

    • setAllowProgressInThread

      public static void setAllowProgressInThread(boolean value)

    • getApplyStylesInAutoSeries

      public static boolean getApplyStylesInAutoSeries()

    • setApplyStylesInAutoSeries

      public static void setApplyStylesInAutoSeries(boolean value)

    • getOldChartPercentMode

      public static boolean getOldChartPercentMode()

    • setOldChartPercentMode

      public static void setOldChartPercentMode(boolean value)

    • getDontSaveDataSourceBeforeChartRendering

      public static boolean getDontSaveDataSourceBeforeChartRendering()

    • setDontSaveDataSourceBeforeChartRendering

      public static void setDontSaveDataSourceBeforeChartRendering(boolean value)

    • getDontSaveConfig

      public static boolean getDontSaveConfig()
      Gets or sets value which indicates that config file "Stimulsoft.Report.config" is not saved from report engine.

    • setDontSaveConfig

      public static void setDontSaveConfig(boolean value)

    • getDontSaveSettings

      public static boolean getDontSaveSettings()
      Gets or sets value which indicates that config file "Stimulsoft.Report.settings" is not saved from report engine.

    • setDontSaveSettings

      public static void setDontSaveSettings(boolean value)

    • getDefaultEngineVersion

      public static StiEngineVersion getDefaultEngineVersion()
      Gets or sets the default report engine for new report.

    • setDefaultEngineVersion

      public static void setDefaultEngineVersion(StiEngineVersion value)

    • getUseAdvancedPrintOn

      public static boolean getUseAdvancedPrintOn()

    • setUseAdvancedPrintOn

      public static void setUseAdvancedPrintOn(boolean value)

    • getUseAdvancedPrintOnEngineV2

      public static boolean getUseAdvancedPrintOnEngineV2()

    • setUseAdvancedPrintOnEngineV2

      public static void setUseAdvancedPrintOnEngineV2(boolean value)

    • getForceGenerationLocalizedName

      public static boolean getForceGenerationLocalizedName()

    • setForceGenerationLocalizedName

      public static void setForceGenerationLocalizedName(boolean value)

    • getForceGenerationNonLocalizedName

      public static boolean getForceGenerationNonLocalizedName()

    • setForceGenerationNonLocalizedName

      public static void setForceGenerationNonLocalizedName(boolean value)

    • getRenderBarCodeAsBitmap

      public static boolean getRenderBarCodeAsBitmap()
      Gets or sets a value which controls of output barcodes as bitmaps in WebViewerFx.

    • setRenderBarCodeAsBitmap

      public static void setRenderBarCodeAsBitmap(boolean value)

    • getRenderChartAsBitmap

      public static boolean getRenderChartAsBitmap()
      Gets or sets a value which controls of output charts as bitmaps.

    • setRenderChartAsBitmap

      public static void setRenderChartAsBitmap(boolean value)

    • getRenderChartAsBitmapZoom

      public static float getRenderChartAsBitmapZoom()
      Gets or sets a scalling factor for rendering charts as bitmaps.

    • setRenderChartAsBitmapZoom

      public static void setRenderChartAsBitmapZoom(float value)

    • getShowReportRenderingMessages

      public static boolean getShowReportRenderingMessages()

    • setShowReportRenderingMessages

      public static void setShowReportRenderingMessages(boolean value)

    • getGeneratePartialReportClass

      public static boolean getGeneratePartialReportClass()

    • setGeneratePartialReportClass

      public static void setGeneratePartialReportClass(boolean value)

    • getSourceCodeEncoding

      public static String getSourceCodeEncoding()
      Gets or sets encoding which used for saving soure code.

    • setSourceCodeEncoding

      public static void setSourceCodeEncoding(String value)

    • getDefaultTextQualityMode

      public static StiTextQuality getDefaultTextQualityMode()

    • setDefaultTextQualityMode

      public static void setDefaultTextQualityMode(StiTextQuality value)

    • getPathToAssemblyKeyFile

      public static String getPathToAssemblyKeyFile()
      Gets or sets path to AssemblyKeyFile for signing all compiled reports.

    • setPathToAssemblyKeyFile

      public static void setPathToAssemblyKeyFile(String value)

    • getUseGdi32ForTextRendering

      public static boolean getUseGdi32ForTextRendering()
      Gets or sets a value which indicates whether Gdi32 is used for text rendering. For .NET 2.0 only.

    • setUseGdi32ForTextRendering

      public static void setUseGdi32ForTextRendering(boolean value)

    • getNotClearParentReport

      public static boolean getNotClearParentReport()

    • setNotClearParentReport

      public static void setNotClearParentReport(boolean value)

    • getAllowInvokeProcessChartEventForTemplateOfChart

      public static boolean getAllowInvokeProcessChartEventForTemplateOfChart()

    • setAllowInvokeProcessChartEventForTemplateOfChart

      public static void setAllowInvokeProcessChartEventForTemplateOfChart(boolean value)

    • getDockPageFooterToBottom

      public static boolean getDockPageFooterToBottom()

    • setDockPageFooterToBottom

      public static void setDockPageFooterToBottom(boolean value)

    • getUseOldWYSIWYGTextQuality

      public static boolean getUseOldWYSIWYGTextQuality()

    • setUseOldWYSIWYGTextQuality

      public static void setUseOldWYSIWYGTextQuality(boolean value)

    • getOldWYSIWYG

      public static boolean getOldWYSIWYG()
      Gets or sets a value which defines a previous realization of the WYSIWYG mode of the StiText component.

    • setOldWYSIWYG

      public static void setOldWYSIWYG(boolean value)

    • getDefaultNamespace

      public static String getDefaultNamespace()
      Gets or sets default namespace for the report.

    • setDefaultNamespace

      public static void setDefaultNamespace(String value)

    • getNamespaces

      public static String[] getNamespaces()
      Gets or sets namespaces which are to be added in to the report class being generated.

    • setNamespaces

      public static void setNamespaces(String[] value)

    • getIsDefaultNamespaces

      public static boolean getIsDefaultNamespaces()
      Returns true if Namespaces property has default value;

    • getReferencedAssemblies

      public static String[] getReferencedAssemblies()
      Gets or sets assemblies which are being attached to a new report.

    • setReferencedAssemblies

      public static void setReferencedAssemblies(String[] value)

    • getIsDefaultReferencedAssemblies

      public static boolean getIsDefaultReferencedAssemblies()
      Returns true if Namespaces property has default value;

    • getNamingRule

      public static StiNamingRule getNamingRule()
      Gets or sets a value which controls of naming of new components in the report.

    • setNamingRule

      public static void setNamingRule(StiNamingRule value)

    • getDefaultReportLanguage

      public static StiReportLanguageType getDefaultReportLanguage()
      Gets or sets the default programming language of the report.

    • setDefaultReportLanguage

      public static void setDefaultReportLanguage(StiReportLanguageType value)

    • getBaseReportType

      public static Class getBaseReportType()

    • setBaseReportType

      public static void setBaseReportType(Class value)

    • getFullTrust

      public static boolean getFullTrust()

    • setFullTrust

      public static void setFullTrust(boolean value)

    • getHideRenderingProgress

      public static boolean getHideRenderingProgress()

    • setHideRenderingProgress

      public static void setHideRenderingProgress(boolean value)

    • getEmulateData

      public static boolean getEmulateData()
      Gets or sets a value, which indicates that if data are absent then controls of the data emulation. This value is used for report rendering in the designer without data.

    • setEmulateData

      public static void setEmulateData(boolean value)

    • getForceRtfBreak

      public static boolean getForceRtfBreak()
      Gets or sets a value indicating whether it is necessary to insert breaks in Rtf export.

    • setForceRtfBreak

      public static void setForceRtfBreak(boolean value)

    • getIgnoreFirstPassForGroup

      public static boolean getIgnoreFirstPassForGroup()

    • setIgnoreFirstPassForGroup

      public static void setIgnoreFirstPassForGroup(boolean value)

    • getOldModeOfRenderingEventInEngineV2

      public static boolean getOldModeOfRenderingEventInEngineV2()

    • setOldModeOfRenderingEventInEngineV2

      public static void setOldModeOfRenderingEventInEngineV2(boolean value)

    • getDefaultRtfFont

      public static StiFont getDefaultRtfFont()

    • setDefaultRtfFont

      public static void setDefaultRtfFont(StiFont value)

    • getUseGarbageCollectorForImageCache

      public static boolean getUseGarbageCollectorForImageCache()

    • setUseGarbageCollectorForImageCache

      public static void setUseGarbageCollectorForImageCache(boolean value)

    • getConvertBmpDataToPng

      public static boolean getConvertBmpDataToPng()

    • setConvertBmpDataToPng

      public static void setConvertBmpDataToPng(boolean value)

    • getUsePercentageProgress

      public static boolean getUsePercentageProgress()

    • setUsePercentageProgress

      public static void setUsePercentageProgress(boolean value)

    • getUseTemplateForPagePrintEvents

      public static boolean getUseTemplateForPagePrintEvents()

    • setUseTemplateForPagePrintEvents

      public static void setUseTemplateForPagePrintEvents(boolean value)

    • getUseParentStylesOldMode

      public static boolean getUseParentStylesOldMode()

    • setUseParentStylesOldMode

      public static void setUseParentStylesOldMode(boolean value)

    • getThrowErrorIfFontIsNotInstalledInSystem

      public static boolean getThrowErrorIfFontIsNotInstalledInSystem()

    • setThrowErrorIfFontIsNotInstalledInSystem

      public static void setThrowErrorIfFontIsNotInstalledInSystem(boolean value)

    • getUseCollateOldMode

      public static boolean getUseCollateOldMode()

    • setUseCollateOldMode

      public static void setUseCollateOldMode(boolean value)

    • getForceNewPageInSubReports

      public static boolean getForceNewPageInSubReports()

    • setForceNewPageInSubReports

      public static void setForceNewPageInSubReports(boolean value)

    • getDpiAware

      public static boolean getDpiAware()

    • setDpiAware

      public static void setDpiAware(boolean value)

    • getAllowUseResetMethodInBusinessObject

      public static boolean getAllowUseResetMethodInBusinessObject()

    • setAllowUseResetMethodInBusinessObject

      public static void setAllowUseResetMethodInBusinessObject(boolean value)

    • getPrimitivesStyleNoneBackCompatibility

      public static boolean getPrimitivesStyleNoneBackCompatibility()
      Gets or sets a value which indicates whether use the back compatibility when Style property of primitives is set to None

    • setPrimitivesStyleNoneBackCompatibility

      public static void setPrimitivesStyleNoneBackCompatibility(boolean value)

    • getUseCheckSizeForContinuedContainers

      public static boolean getUseCheckSizeForContinuedContainers()
      Gets or sets a value which indicates whether use the CheckSize method for Continued containers

    • setUseCheckSizeForContinuedContainers

      public static void setUseCheckSizeForContinuedContainers(boolean value)

    • getCheckDockToContainerIfComponentDisabled

      public static boolean getCheckDockToContainerIfComponentDisabled()
      Gets or sets a value which indicates whether check DockToContainer if component is disabled

    • setCheckDockToContainerIfComponentDisabled

      public static void setCheckDockToContainerIfComponentDisabled(boolean value)

    • getForceNewPageForExtraColumns

      public static boolean getForceNewPageForExtraColumns()
      Gets or sets a value which indicates whether force the NewPage method for the extra columns

    • setForceNewPageForExtraColumns

      public static void setForceNewPageForExtraColumns(boolean value)

    • getUseRoundForToCurrencyWordsFunctions

      public static boolean getUseRoundForToCurrencyWordsFunctions()
      Gets or sets a value which indicates whether use Round() for the ToCurrencyWords functions