Welcome to 5.0 Automation Library. Using this library you can automate the features for Excel.

Transcription

1 Introduction Welcome to 5.0 Automation Library. Using this library you can automate the features for Excel. Please Note: While Palisade Corporation will make every effort to maintain compatibility with the information presented here, we can not guarantee that we will do so in future releases

2 Project Overview 5.0 for Excel Object Library Object Model Classes Class Module Risk RiskApplicationSettings RiskFitDefinition RiskFitDefinitionCollection RiskFitInput RiskFitResult RiskFitResultCollection RiskLibraryServer RiskOL RiskProductInformation RiskSimResultCollection RiskSimulatedResult RiskSimulation RiskSimulationSettings The application object. Contains a collection of properties that control general application settings. The definition of a fit which exists in a currently open Excel workbook. A collection of all RiskFitDefinitions associated with all open Excel workbooks. Contains summary information about the input data of a fit. The results of a single distribution fitting operation. A collection of RISKFitResult objects, produced by performing a distribution fitting operation. Provides an object for the control of Library. Contains utility enumeration, structures, and constant values. Contains information about the currently running copy of application, including licensing and registration information. An object which allows access to the results of the most recently simulation. Contains simulation results for input or output. An object simulations can be setup, started, and results analyzed. An object where simulation settings are maintained. Public Enumerations

3 Enumeration RiskAutomaticResultsDisplay RiskCellFormattingStyle RiskCollectDistributionSamples RiskDistributionDisplayFormat RiskEdition RiskFitChiSqBinArrangement RiskFitDataType RiskFitFilterType RiskFitLimitType RiskFitMethod RiskFitStatistic RiskInterfaceMode RiskLanguageID RiskLibraryAvailability RiskProductType RiskRandomNumberGenerator RiskRegressionCoefficientFormat RiskReportPlacement RiskReportSelection RiskResultsStorageLocation RiskSamplingType RiskScalingFactor RiskSimulationCompletionStatus RiskStandardRecalcBehavior RiskStaticValueType RiskSummaryGraphCenterlineStatistic RiskSummaryGraphRange RiskSwapPreviewChanges RiskTornadoDisplayFormat RiskWindowListDisplay RiskWindowSize An enumeration of the possible automatic results (if any) that can be automatically displayed when simulation is run. An enumeration of different can automatically format spreadsheet cells inputs or outputs. An enumerated list of possible ways distribution samples can be collected. An enumeration of distribution graph display formats. An enumerated list product editions. An enumeration of bin arrangments that can be used for the chi-squared goodness-of-fit test. An enumeration of the possible types of input data for a fitting operation. An enumeration of the possible fit filters that can be applied. An enumeration of possible limits (or boundary conditions) that can be applied to an extremum of a distribution. An enumeration which specified possible methods of fitting distribution to data. An enumeration of fitting statistics. An enumerated list of possible operational states of application. An enumerated list of the possible can be using. An enumeration of the possible states of availability of Library. An enumeration product types. An enumerated list of random number generators available for use An enumeration of possible regression coefficient formats. An enumeration of possible destination workbooks for a report. An enumeration of Excel reports. An enumeration of possible choices where and can stored simulation results. An enumeration of sampling types that can be used during a simulation. An enumerated list of named scaling factors. An enumerated list of possible results from a simulation. An enumerated list of distribution functions will return values when a simulation is not in progress. An enumeration of possible static values to be used when an RiskStaticValue is not specified for a function. An enumerated list of different summary graph center line statistics. An enumerated list of possible summary graph ranges. An enumeration of possible ways the change preview dialog will be displayed when user swaps in functions. An enumeration of tornado graph display formats. An enumeration of values controling how Windows List will be displayed. An enumeration of default window sizes.

4 Public UDTs UDT RiskChiSqBinInformation RiskPredefinedFit RiskScenarioData RiskSensitivityData

5 Getting Started To you must first make a reference to 5.0 Object Library. From within the VBA Editor window, make sure your VBA project is active, and then select the Tools / References menu item. In the References dialog, choose the item labeled 5.0 for Excel Object Library". (Please note: In previous versions you made reference directly to Add-in file, called either Risk.xla or AtRiskXL. You should not make reference to this file in order to 5.0). Once you make this reference you will have access to the object model via the root "Risk" object. For example, you can run simulation of 150 iterations and display the mean of the output named "Profit" with the following code: Public Sub RunMySimulation Risk.Simulation.Settings.NumIterations = 150 Risk.Simulation.Start MsgBox Risk.Simulation.Results.GetSimulatedOuput("Profit").Mean See the RiskMacro.xls example for a more complicated example.

6 Risk Object The application object. For a list of all members defined in this module, see Risk members. Object Model This object is available globally (in VBA) once you have made reference to Developer's Kit Library. Risk Members

7 Risk Object Members Public Methods GenerateExcelReports Creates one or reports in Excel. Help context help Sample Returns a sample from distribution. UnloadAddin Asynchronously shuts WriteWorkbookInformation information to the specified Excel workbook. Public Properties Addin Returns an Excel Workbook object for add-in (.xla) file. ApplicationSettings DisplayAlerts Returns a RISKApplicationSettings object, which contains all the user application settings. Controls will display messages during execution. ExcelApplication Returns the Excel Application object is working within. Fits Returns a collection of fits currently defined in application. InterfaceMode Library ProductInformation Simulation Returns the current "interface" mode This property can be used to determine the state of operation of the product. Returns a RiskLibraryServer Object which allows you to interact with Library. Returns a RiskProductInformation Object which contains information about the current running copy Returns a RiskSimulation object, from which you can change simulation settings, start simualation, and get the results of a simulation. Events ApplicationSettingsChanged UserInterfaceModeChanged Raised when any settings in the RiskApplicationSettings object have been changed by the user. Raised interface mode is changing. Risk Overview

8 GenerateExcelReports Method Creates one or reports in Excel. Syntax Public Function GenerateExcelReports( _ ByVal p_whichreports As RiskReportSelection _ ) As Workbook Parameters p_whichreports Value RiskSimulationReportQuick RiskSimulationReportInputResultsSummary RiskSimulationReportOutputResultsSummary RiskSimulationReportDetailedStatistics RiskSimulationReportData RiskSimulationReportSensitivity RiskSimulationReportScenarios RiskSimulationReportTemplateSheets RiskModelReportInputs RiskModelReportOutputs RiskModelReportCorrelations A "Quick" Report, one page per output, with a summary of the most important information for each output. A summary report of all the simulated inputs. This matches the information in the Input tab of Results Summary window. A summary report of all the simulated outputs. This matches the information in the Output tab of Results Summary window. A set of detailed statistical results for all inputs and outputs. This matches the information in Detailed Statistics window. The complete set of simulation data for all inputs and outputs. This matches the information in Data window. The sensitivity results for all outputs. This matches the information in Sensitivities window. The scenarios report for all outputs. This matches the information in Scenarios window. A static copy of all open template sheet. Template sheets must start with the prefix "RiskTemplate_". A report summarizing all the currently defined inputs. This matches the information in the Inputs tab of Model window. A report summarizing all the currently defined outputs. This matches the information in the Outputs tab of Model window. A report summarizing all the currently defined correlations. This matches the information in the Correlations tab of Model window. Return Type Excel Workbook Object - the workbook where the reports were created. You can add the various report constants together to generate multiple reports at the same time. The user's current report selection can be gotten from Risk.SimulationSettings.ReportsToGenerate property.

9 The placement of the reports is controled by several report settings in the Risk.ApplicationSettings object. [[New ] (Visual Basic)] 'Run a simulation and then generate the input and output result summary reports Public Sub GenerateResultSummaryReports() Risk.Simulation.Start Risk.GenerateExcelReports RiskSimulationReportInputResultsSummary + RiskSimulationReportOutputResultsSumm Risk Object ReportGraphFormat Property ReportOverwriteExisting Property ReportPlacement Property ReportReuseNewWorkbook Property ReportSelected Property ReportsToGenerate Property AutomaticallyGenerateReports Property RiskReportSelection Enumeration

10 Help Method context help Syntax Public Sub Help( _ ) Optional ByVal p_contextid As Long _ Parameters p_contextid The context identifier for the help file page that should be displayed. If left blank, the file will display the first page. Risk Object

11 Sample Method Returns a sample from distribution. Syntax Public Function Sample( _ ByVal p_expression As String, _ Optional ByVal p_contextworksheet As Worksheet = Nothing _ ) As Variant Parameters p_expression distribution function. The must be specified in US/English format and have function syntax. It may have references to spreadsheet cells (in A1 format only) but those references will be resolved with respect to the ContextWorksheet argument. p_contextworksheet An optional worksheet parameter which is used to resolve any spreadsheet references in the specified expression. If omitted, the active worksheet is implied. Return Type Variant - Most often this will be a numeric value. However, illegal distribution definition will return error variants in the standard Excel manner. For example, Excel's #VALUE! error is represented by an Error Variant of type [[New ] (Visual Basic)] 'Samples ten independent Normal(0,1) distributions, adds up the result, and displays it. Public Sub SampleNormals() Dim result As Variant Dim i As Integer For i = 1 To 10 result = result + Risk.Sample("RiskNormal(0,1)") Next i MsgBox "The result is " & result Risk Object

12 UnloadAddin Method Asynchronously shuts Syntax Public Sub UnloadAddin() The shutdown is asynchronous. That is, it will not occur immediately when you make this call, but rather will start the shut-down process after your code has finished executing and control has returned to Excel. [[New ] (Visual Basic)] Public Sub ShutDownAtRisk Risk.UnloadAddIn Risk Object

13 WriteWorkbookInformation Method information to the specified Excel workbook. Syntax Public Sub WriteWorkbookInformation( _ ) ByVal p_workbook As Workbook _ Parameters p_workbook The workbook to information should be written. When the user saves an Excel workbook open, it automatically information into it. This information includes the simulation settings, fit definitions, and simulation results if appropriate. However, if you save a workbook via code using the Workbook.Save or Workbook.SaveAs methods, this information is not automatically written into the workbook and you must use this method to add it. Calling this method may display dialog, asking you for how you want to save your results. If you set the Risk.DisplayAlerts property to FALSE, this dialog will be suppressed and the default saving options will be chosen. If you only want to write simulation settings to a workbook, you can call instead the Risk.Simulation.Settings.SaveToWorkbook method. [[New ] (Visual Basic)] 'Saves the active Excel Workbook with the information embedded in it. Save dialog has been suppress during this process. Public Function SaveWorkbookWithAtRiskInformation() Risk.DisplayAlerts = False Risk.WriteWorkbookInformation ActiveWorkbook Risk.DisplayAlerts = True ActiveWorkbook.Save End Function Risk Object DisplayAlerts Property LoadFromWorkbook Method SaveToWorkbook Method

14 Addin Property Returns an Excel Workbook object for add-in (.xla) file. Read-only property Public Property Addin() As Workbook [[New ] (Visual Basic)] 'Displays the full path and filename of add-in file. Public Sub Dim addinwb As Workbook Set addinwb = Risk.Addin MsgBox addinwb.fullname Risk Object

15 ApplicationSettings Property Returns a RISKApplicationSettings object, which contains all the user application settings. Read-only property Public Property ApplicationSettings() As RiskApplicationSettings Risk Object RiskApplicationSettings Object

16 DisplayAlerts Property Controls will display messages during execution. Read-write property Public Property DisplayAlerts() As Boolean Macro developers may want to turn this message off to suppress the display messages. For example, a confirmation message displayed will pause the execution of a macro until the user clicks a button. This is very similar to the property of Excel with the same name. You should be sure to turn this property back to TRUE when your macro has finished. [[New ] (Visual Basic)] 'Perform a fit without displaying the fit status window Public Sub FitWithNoMessages() Dim fitresults As RiskFitResultCollection Dim fittedfunction As String Risk.DisplayAlerts = False Set fitresults = Risk.Fits(1).PerformFit fittedfunction = fitresults("normal").distributionfunction Risk.DisplayAlerts = True MsgBox fittedfunction Risk Object

17 ExcelApplication Property Returns the Excel Application object is working within. Read-only property Public Property ExcelApplication() As Application [[New ] (Visual Basic)] 'Displays the version of Excel is being used with Public Sub DisplayExcelVersion MsgBox Risk.ExcelApplication.Version Risk Object

18 Fits Property Returns a collection of fits currently defined in application. Read-only property Public Property Fits() As RiskFitDefinitionCollection Risk Object RiskFitDefinitionCollection Object

19 InterfaceMode Property Returns the current "interface" mode This property can be used to determine the state of operation of the product. Read-only property Public Property InterfaceMode() As RiskInterfaceMode actions can only be performed in a particular mode. For example, you can not perform a fit is the middle of running a simulation. You can use this property to check and respond appropriately to this type of situation. [[New ] (Visual Basic)] 'Check if we are in "Standard Mode" before doing something Public Sub DoSomethingOnlyIfInStandardMode() If Risk.InterfaceMode <> RiskStandardOperation Then MsgBox "This action can not be performed at this time." Exit Sub End If 'Proceed with the rest of the macro here... Risk Object

20 Library Property Returns a RiskLibraryServer Object which allows you to interact with Library. Read-only property Public Property Library() As RiskLibraryServer Risk Object RiskLibraryServer Object

21 ProductInformation Property Returns a RiskProductInformation Object which contains information about the current running copy Read-only property Public Property ProductInformation() As RiskProductInformation Risk Object RiskProductInformation Object

22 Simulation Property Returns a RiskSimulation object, from which you can change simulation settings, start simualation, and get the results of a simulation. Read-only property Public Property Simulation() As RiskSimulation Risk Object RiskSimulation Object

23 ApplicationSettingsChanged Event Raised when any settings in the RiskApplicationSettings object have been changed by the user. Syntax Public Event ApplicationSettingsChanged() Risk Object RiskApplicationSettings Object

24 UserInterfaceModeChanged Event Raised interface mode is changing. Syntax Public Event UserInterfaceModeChanged( _ ByVal oldmode As RiskInterfaceMode, _ ByVal newmode As RiskInterfaceMode _ ) Parameters oldmode Value RiskDisabledInterface RiskStandardOperation RiskDefiningDistributions RiskSimulating RiskBrowsingResults RiskApplicationInitializing RiskApplicationTerminating RiskFunctionsRemoved For internal use only. The normal operational mode The Define Distribution window is being displayed. A simulation is in progress. The Browse Results window is being displayed. application is in the processing of starting. application is in the processing of shutting is in "swapped out" mode, where functions have been removed. The old interface mode being switched out of. newmode Value RiskDisabledInterface RiskStandardOperation RiskDefiningDistributions RiskSimulating RiskBrowsingResults RiskApplicationInitializing RiskApplicationTerminating RiskFunctionsRemoved For internal use only. The normal operational mode The Define Distribution window is being displayed. A simulation is in progress. The Browse Results window is being displayed. application is in the processing of starting. application is in the processing of shutting is in "swapped out" mode, where functions have been removed. The new interface mode being switched into. Risk Object InterfaceMode Property

25

26 RiskApplicationSettings Object Contains a collection of properties that control general application settings. For a list of all members defined in this module, see RiskApplicationSettings members. These correspond to the program's Application Settings dialog. RiskApplicationSettings Members

27 RiskApplicationSettings Object Members Public Methods ApplyNow Applies current Application Settings to open windows, graphs, and workbooks. ResetToFactoryDefaults Resets Application Settings to their default state. Public Properties CellFormattingInputColor CellFormattingOutputColor CellFormattingStyle CumulativeDescendingPercentiles GraphBoxPlotCenterline Controls the (RGB) color to be used automatically formats cells input distributions. Controls the (RGB) color to be used automatically formats cells output functions. Controls will automatically format spreadsheet cells input or output functions. Sets will display percentiles in cumulative descending format. Controls the centerline statistic used for box-plots. GraphBoxPlotColor Controls the color used for box-plot graphs. GraphBoxPlotFormattingIsAutomatic Controls whether box-plots are formatted automatically. GraphBoxPlotInnerRange Controls the bounds of the box in a box-plot. GraphBoxPlotOuterRange Controls the bounds of the whiskers in a box-plot. GraphBoxPlotShowCenterlineLabels GraphInputColor GraphLeftDelimiter GraphLegendTableDefinition Controls whether the centerline value are displayed on a box-plot. Controls the default (RGB) color applied to the curves representing inputs in graph. Controls the default value for a distribution graph's left delimiter percentile. Controls what items appear by default on a graph's legend. GraphMarkerDefinition GraphNumberFormatQuantitiesWithUnits GraphNumberFormattingIsAutomatic GraphNumberFormatUnitlessQuantities GraphNumDelimitedCurves GraphNumHistogramBins Controls what items appear by default as marked items on a graph. Controls the number formatting used for graph statistics that have scaled units. Controls whether the number formatting used in graph statistics is automatically determined. Controls the number formatting used for unitless graph statistics. Controls the maximum number of curves in a graph that will display delimited percentile information. Specifies the number of histogram bins to be used in the display of graphs.

28 GraphOutputColor GraphOutputScalingFactor Controls the default (RGB) color applied to the curves representing outputs in graph. Specifies a default scaling factor for a output distribution graph. GraphOutputScalingIsAutomatic GraphOutputScalingMaximum GraphOutputScalingMinimum GraphPreferredDistributionFormat GraphPreferredTornadoFormat Indicates whether the default x-axis scaling of output distributions graphs is automatically determined. Specifies a default maximum value for a output distribution graph. Specifies a default minimum value for a output distribution graph. Controls the preferred distribution display format for distribution graphs. Controls the preferred display format for tornado graphs. GraphRightDelimiter GraphSummaryTrendCenterline Controls the default value for a distribution graph's left delimiter percentile. Controls the centerline statistic used for summery trend graphs. GraphSummaryTrendCenterlineColor Controsl the control of the centerline for summary trend graphs. GraphSummaryTrendFormattingIsAutomatic GraphSummaryTrendInnerColor Controls whether summary trend graphs are formatted automatically. Controls the color of a summary trend graph's inner band. GraphSummaryTrendInnerRange GraphSummaryTrendOuterColor Controls the bounds of the inner band of a summary trend graph. Controls the color of a summary trend graph's outer band. GraphSummaryTrendOuterRange GraphTitle GraphTitleMainText InsertStaticValues LibraryEnabled ModelWindowColumns PolicyFileInUse Controls the bounds of the outer band of a summary trend graph. Specifies a default graph description to use, overriding the automatic title generated Specifies a default graph title to use, overriding the automatic title generated Controls by default, will put RiskStatic() property functions into input distributions. Controls whether Library facility is enabled be default is started. Controls the columns that will be displayed by default in Model Window. Indicates whether user has a policy file installed. ReportOverwriteExisting ReportPlacement ReportReuseNewWorkbook Controls whether newly generated reports in a workbook will replace already existing reports in that same workbook. Controls Excel reports will be placed, either in a new workbook or the active workbook. Controls whether only a single new Excel workbook will be created to hold reports.

29 ResultWindowColumns SaveLocation Controls the columns that will be displayed by default in Results Window. Controls stores simulation results. ShowWelcomeScreenAtStartup SimSettingsAutomaticResultsDisplay SimSettingsCollectDistributionSamples SimSettingsConvergenceTestingEnabled SimSettingsLiveUpdate Controls whether "Welcome / What's New" windows is automatically displayed each time the application starts. Sets the default AutomaticResultsDisplay simulation settings for new models. Sets the default CollectDistributionSamples simulation settings for new models. Sets the default ConvergenceTestingEnabled simulation settings for new models. Sets the default LiveUpdate simulation settings for new models. SimSettingsMinimizeExcel SimSettingsNumIterations SimSettingsPauseOnOutputErrors SimSettingsSamplingType SimSettingsShowExcelRecalculations SimSettingsSmartSensitivityAnalysisEnabled Sets the default MinimizeExcel simulation settings for new models. Sets the default NumIterations simulation settings for new models. Sets the default PauseOnOutputErrors simulation settings for new models. Sets the default SamplingType simulation settings for new models. Sets the default ShowExcelRecalculations simulation settings for new models. Controls whether smart sensitivity analysis will is enabled. SimSettingsStdRecalcBehavior SimSettingsStdRecalcWithoutRiskStatic SimSettingsStdRecalcWithoutRiskStaticPercentile SwapPreviewChanges Sets the default StdRecalcBehavior simulation settings for new models. Sets the default StdRecalcWithoutRiskStatic simulation settings for new models. Sets the default StdRecalcWithoutRiskStaticPercentile simulation settings for new models. Controls what items are previewed when swapping in formulas. SwapWithoutRiskStatic SwapWithoutRiskStaticPercentile WindowDefaultSize Controls what statistic is substituted when the user swaps functions that do not contain RiskStatic() property functions. Controls what percentile is substituted when the user swaps functions that do not contain RiskStatic() property functions. Controls the default size of windows. WindowListDisplay Controls under what circumstances Windows List will be displayed. RiskApplicationSettings Overview

30

31 ApplyNow Method Applies current Application Settings to open windows, graphs, and workbooks. Syntax Public Sub ApplyNow() Many application settings only affect object (graphs, workbooks, windows, etc.) when they are first created. This property applies the settings to already existing open objects. [[New ] (Visual Basic)] 'Change how percentiles are displayed by default and apply the change to all open windows. Public Sub ChangePercentileDisplay() Risk.ApplicationSettings.CumulativeDescendingPercentiles = True Risk.ApplicationSettings.ApplyNow RiskApplicationSettings Object

32 ResetToFactoryDefaults Method Resets Application Settings to their default state. Syntax Public Sub ResetToFactoryDefaults() This will reset all of application settings to their internal "factory" defaults. If a policy file is in use, this call will override the settings stored in the policy file. RiskApplicationSettings Object PolicyFileInUse Property

33 CellFormattingInputColor Property Controls the (RGB) color to be used automatically formats cells input distributions. Read-write property Public Property CellFormattingInputColor() As Long This is an RGB color. You can use either build in VB color constants (e.g. vbred, vbblue, etc.) or the RGB function to specify these colors. This property will only have effect if the CellFormattingStyle property is not set to RiskCellFormattingNone. Changes to this setting will not take effect until you call the ApplyNow method. [[New ] (Visual Basic)] up to automatically color input cells green and output cells blue. Public Sub SetCellFormatting() With Risk.ApplicationSettings.CellFormattingStyle = RiskCellFormattingBackgroundColor.CellFormattingInputColor = vbgreen.cellformattingoutputcolor = vbblue.applynow End With RiskApplicationSettings Object CellFormattingStyle Property CellFormattingOutputColor Property ApplyNow Method

34 CellFormattingOutputColor Property Controls the (RGB) color to be used automatically formats cells output functions. Read-write property Public Property CellFormattingOutputColor() As Long This is an RGB color. You can use either build in VB color constants (e.g. vbred, vbblue, etc.) or the RGB function to specify these colors. This property will only have effect if the CellFormattingStyle property is not set to RiskCellFormattingNone. Changes to this setting will not take effect until you call the ApplyNow method. [[New ] (Visual Basic)] up to automatically color input cells green and output cells blue. Public Sub SetCellFormatting() With Risk.ApplicationSettings.CellFormattingStyle = RiskCellFormattingBackgroundColor.CellFormattingInputColor = vbgreen.cellformattingoutputcolor = vbblue.applynow End With RiskApplicationSettings Object CellFormattingStyle Property CellFormattingInputColor Property ApplyNow Method

35 CellFormattingStyle Property Controls will automatically format spreadsheet cells input or output functions. Read-write property Public Property CellFormattingStyle() As RiskCellFormattingStyle The CellFormattingInputColor and CellFormattingOutputColor control the colors used in the cell formatting. Changes to this setting will not take effect until you call the ApplyNow method. [[New ] (Visual Basic)] up to automatically color input cells green and output cells blue. Public Sub SetCellFormatting() With Risk.ApplicationSettings.CellFormattingStyle = RiskCellFormattingBackgroundColor.CellFormattingInputColor = vbgreen.cellformattingoutputcolor = vbblue.applynow End With RiskApplicationSettings Object CellFormattingInputColor Property CellFormattingOutputColor Property ApplyNow Method RiskCellFormattingStyle Enumeration

36 CumulativeDescendingPercentiles Property Sets will display percentiles in cumulative descending format. Read-write property Public Property CumulativeDescendingPercentiles() As Boolean This property only affects the display of percentiles in interface. All methods and properties will continue to return cumulative ascending percentiles. This settings will affect all new windows created After changing this setting, you can apply it to already open windows using the ApplyNow method. [[New ] (Visual Basic)] 'Change how percentiles are displayed by default and apply the change to all open windows. Public Sub ChangePercentileDisplay() Risk.ApplicationSettings.CumulativeDescendingPercentiles = True Risk.ApplicationSettings.ApplyNow RiskApplicationSettings Object ApplyNow Method

37 GraphBoxPlotCenterline Property Controls the centerline statistic used for box-plots. Read-write property Public Property GraphBoxPlotCenterline() As RiskSummaryGraphCenterlineStatistic This property only has effect if the GraphBoxPlotFormattingIsAutomatic Property is False. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. [Visual Basic] 'Change Default Box Plot Options: Public Sub ChangeDefaultBoxPlotOptions() With Risk.ApplicationSettings.GraphBoxPlotFormattingIsAutomatic = False.GraphBoxPlotCenterline = RiskSummaryGraphCenterlineStatisticMedian.GraphBoxPlotInnerRange = RiskSummaryGraphRangeP25P75.GraphBoxPlotOuterRange = RiskSummaryGraphRangeP10P90.GraphBoxPlotShowCenterlineLabels = True.GraphBoxPlotColor = vbgreen End With RiskApplicationSettings Object GraphBoxPlotColor Property GraphBoxPlotFormattingIsAutomatic Property GraphBoxPlotInnerRange Property GraphBoxPlotOuterRange Property GraphBoxPlotShowCenterlineLabels Property

38 GraphBoxPlotColor Property Controls the color used for box-plot graphs. Read-write property Public Property GraphBoxPlotColor() As Long This is an RGB color. You can use either build in VB color constants (e.g. vbred, vbblue, etc.) or the RGB function to specify these colors. This property only has effect if the GraphBoxPlotFormattingIsAutomatic Property is False. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. [Visual Basic] 'Change Default Box Plot Options: Public Sub ChangeDefaultBoxPlotOptions() With Risk.ApplicationSettings.GraphBoxPlotFormattingIsAutomatic = False.GraphBoxPlotCenterline = RiskSummaryGraphCenterlineStatisticMedian.GraphBoxPlotInnerRange = RiskSummaryGraphRangeP25P75.GraphBoxPlotOuterRange = RiskSummaryGraphRangeP10P90.GraphBoxPlotShowCenterlineLabels = True.GraphBoxPlotColor = vbgreen End With RiskApplicationSettings Object GraphBoxPlotCenterline Property GraphBoxPlotFormattingIsAutomatic Property GraphBoxPlotInnerRange Property GraphBoxPlotOuterRange Property GraphBoxPlotShowCenterlineLabels Property

39 GraphBoxPlotFormattingIsAutomatic Property Controls whether box-plots are formatted automatically. Read-write property Public Property GraphBoxPlotFormattingIsAutomatic() As Boolean If this property is FALSE, the other GraphBoxPlot properties are use to determine the formatting of new box-plots. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. [Visual Basic] 'Change Default Box Plot Options: Public Sub ChangeDefaultBoxPlotOptions() With Risk.ApplicationSettings.GraphBoxPlotFormattingIsAutomatic = False.GraphBoxPlotCenterline = RiskSummaryGraphCenterlineStatisticMedian.GraphBoxPlotInnerRange = RiskSummaryGraphRangeP25P75.GraphBoxPlotOuterRange = RiskSummaryGraphRangeP10P90.GraphBoxPlotShowCenterlineLabels = True.GraphBoxPlotColor = vbgreen End With RiskApplicationSettings Object GraphBoxPlotCenterline Property GraphBoxPlotColor Property GraphBoxPlotInnerRange Property GraphBoxPlotOuterRange Property GraphBoxPlotShowCenterlineLabels Property

40 GraphBoxPlotInnerRange Property Controls the bounds of the box in a box-plot. Read-write property Public Property GraphBoxPlotInnerRange() As RiskSummaryGraphRange This property only has effect if the GraphBoxPlotFormattingIsAutomatic Property is False. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. [Visual Basic] 'Change Default Box Plot Options: Public Sub ChangeDefaultBoxPlotOptions() With Risk.ApplicationSettings.GraphBoxPlotFormattingIsAutomatic = False.GraphBoxPlotCenterline = RiskSummaryGraphCenterlineStatisticMedian.GraphBoxPlotInnerRange = RiskSummaryGraphRangeP25P75.GraphBoxPlotOuterRange = RiskSummaryGraphRangeP10P90.GraphBoxPlotShowCenterlineLabels = True.GraphBoxPlotColor = vbgreen End With RiskApplicationSettings Object GraphBoxPlotCenterline Property GraphBoxPlotColor Property GraphBoxPlotFormattingIsAutomatic Property GraphBoxPlotOuterRange Property GraphBoxPlotOuterRange Property

41 GraphBoxPlotOuterRange Property Controls the bounds of the whiskers in a box-plot. Read-write property Public Property GraphBoxPlotOuterRange() As RiskSummaryGraphRange This property only has effect if the GraphBoxPlotFormattingIsAutomatic Property is False. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. [Visual Basic] 'Change Default Box Plot Options: Public Sub ChangeDefaultBoxPlotOptions() With Risk.ApplicationSettings.GraphBoxPlotFormattingIsAutomatic = False.GraphBoxPlotCenterline = RiskSummaryGraphCenterlineStatisticMedian.GraphBoxPlotInnerRange = RiskSummaryGraphRangeP25P75.GraphBoxPlotOuterRange = RiskSummaryGraphRangeP10P90.GraphBoxPlotShowCenterlineLabels = True.GraphBoxPlotColor = vbgreen End With RiskApplicationSettings Object GraphBoxPlotCenterline Property GraphBoxPlotColor Property GraphBoxPlotFormattingIsAutomatic Property GraphBoxPlotInnerRange Property GraphBoxPlotShowCenterlineLabels Property

42 GraphBoxPlotShowCenterlineLabels Property Controls whether the centerline value are displayed on a box-plot. Read-write property Public Property GraphBoxPlotShowCenterlineLabels() As Boolean This property only has effect if the GraphBoxPlotFormattingIsAutomatic Property is False. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. [Visual Basic] 'Change Default Box Plot Options: Public Sub ChangeDefaultBoxPlotOptions() With Risk.ApplicationSettings.GraphBoxPlotFormattingIsAutomatic = False.GraphBoxPlotCenterline = RiskSummaryGraphCenterlineStatisticMedian.GraphBoxPlotInnerRange = RiskSummaryGraphRangeP25P75.GraphBoxPlotOuterRange = RiskSummaryGraphRangeP10P90.GraphBoxPlotShowCenterlineLabels = True.GraphBoxPlotColor = vbgreen End With RiskApplicationSettings Object GraphBoxPlotCenterline Property GraphBoxPlotColor Property GraphBoxPlotFormattingIsAutomatic Property GraphBoxPlotInnerRange Property GraphBoxPlotOuterRange Property

43 GraphInputColor Property Controls the default (RGB) color applied to the curves representing inputs in graph. Read-write property Public Property GraphInputColor() As Long This property does not apply to graph types. This is an RGB color. You can use either build in VB color constants (e.g. vbred, vbblue, etc.) or the RGB function to specify these colors. Changes to this setting will affect new graphs created in interface. Calling the ApplyNow method will apply this color to all graph windows. [[New ] (Visual Basic)] to automatically make graphs on outputs green and graphs of inputs yellow Public Sub SetGraphColors() With Risk.ApplicationSettings.GraphOutputColor = vbgreen.graphinputcolor = vbyellow End With RiskApplicationSettings Object GraphOutputColor Property ApplyNow Method

44 GraphLeftDelimiter Property Controls the default value for a distribution graph's left delimiter percentile. Read-write property Public Property GraphLeftDelimiter() As Double This property only applies to distribution graphs. This is a percentile value which must be between 0 and 1. Changes to this setting will affect new graphs created in interface. Calling the ApplyNow method will apply the change to all graph windows. [[New ] (Visual Basic)] 'Set the default graph delimiter to be at 2.5% and 97.5% and show delimited values for up to 3 curves. Public Sub SetGraphDelimiterDefaults() With Risk.ApplicationSettings.GraphLeftDelimiter = GraphRightDelimiter = GraphNumDelimitedCurves = 3 End With RiskApplicationSettings Object GraphRightDelimiter Property GraphNumDelimitedCurves Property ApplyNow Method

45 GraphLegendTableDefinition Property Controls what items appear by default on a graph's legend. Read-write property Public Property GraphLegendTableDefinition() As String This property does not apply to graph types. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. Set this property to the string "{Default}" to use the default settings of the application. The detailed format of this string has not yet been made public for automation control. RiskApplicationSettings Object GraphMarkerDefinition Property ApplyNow Method

46 GraphMarkerDefinition Property Controls what items appear by default as marked items on a graph. Read-write property Public Property GraphMarkerDefinition() As String This property does not apply to graph types. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. Set this property to the string "{Default}" to use the default settings of the application. The detailed format of this string has not yet been made public for automation control. RiskApplicationSettings Object GraphLegendTableDefinition Property ApplyNow Method

47 GraphNumberFormatQuantitiesWithUnits Property Controls the number formatting used for graph statistics that have scaled units. Read-write property Public Property GraphNumberFormatQuantitiesWithUnits() As String This property does not apply to graph types. This property only has effect when the GraphNumberFormattingIsAutomatic property is False. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. This property is applied to statistics with units (such as mean, standard deviation, etc.) Use the GraphNumberFormatUnitlessQuantities property to specify the number formatting used for statistics that do not have units (such as skewness, kurtosis, etc.) This format of this property string may be set to: A blank string - indicating the "General" number format. A two character string in the format "C#" where # is a number between 0 and 9. This is a currency format with the specified number of digits trailing the decimal. A two character string in the format "F#" where # is a number between 0 and 9. This is a fixed format with the specified number of digits trailing the decimal. RiskApplicationSettings Object GraphNumberFormattingIsAutomatic Property GraphNumberFormatUnitlessQuantities Property ApplyNow Method

48 GraphNumberFormattingIsAutomatic Property Controls whether the number formatting used in graph statistics is automatically determined. Read-write property Public Property GraphNumberFormattingIsAutomatic() As Boolean This property does not apply to graph types. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. When this property is False, the GraphNumberFomatQuantitiesWithUnits and GraphNumberFormatUnitlessQuantities property specify the number formatting to use. RiskApplicationSettings Object GraphNumberFormatQuantitiesWithUnits Property GraphNumberFormatUnitlessQuantities Property ApplyNow Method

49 GraphNumberFormatUnitlessQuantities Property Controls the number formatting used for unitless graph statistics. Read-write property Public Property GraphNumberFormatUnitlessQuantities() As String This property does not apply to graph types. This property only has effect when the GraphNumberFormattingIsAutomatic property is False. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. This property is applied to 'unitless' statistics (such as skewness, kurtosis, etc.) Use the GraphNumberFormatQuantitiesWithUnits property to specify the number formatting used for statistics with units. This format of this property string may be set to: A blank string - indicating the "General" number format. A two character string in the format "F#" where # is a number between 0 and 9. This is a fixed format with the specified number of digits trailing the decimal. RiskApplicationSettings Object GraphNumberFormattingIsAutomatic Property GraphNumberFormatQuantitiesWithUnits Property ApplyNow Method

50 GraphNumDelimitedCurves Property Controls the maximum number of curves in a graph that will display delimited percentile information. Read-write property Public Property GraphNumDelimitedCurves() As Integer This property only applies to distribution graphs. Changes to this setting will affect new graphs created in interface. Calling the ApplyNow method will apply the change to all graph windows. [[New ] (Visual Basic)] 'Set the default graph delimiter to be at 2.5% and 97.5% and show delimited values for up to 3 curves. Public Sub SetGraphDelimiterDefaults() With Risk.ApplicationSettings.GraphLeftDelimiter = GraphRightDelimiter = GraphNumDelimitedCurves = 3 End With RiskApplicationSettings Object GraphLeftDelimiter Property GraphRightDelimiter Property ApplyNow Method

51 GraphNumHistogramBins Property Specifies the number of histogram bins to be used in the display of graphs. Read-write property Public Property GraphNumHistogramBins() As Integer This property does not apply to graph types. The special value RiskAutoNumHistogramBins can be used to automatically determine this value for you. Changes to this setting will affect new graphs created in interface. Calling the ApplyNow method will apply the change to all graph windows. RiskApplicationSettings Object RiskAutoNumHistogramBins Property ApplyNow Method

52 GraphOutputColor Property Controls the default (RGB) color applied to the curves representing outputs in graph. Read-write property Public Property GraphOutputColor() As Long This property does not apply to graph types. This is an RGB color. You can use either build in VB color constants (e.g. vbred, vbblue, etc.) or the RGB function to specify these colors. Changes to this setting will affect new graphs created in interface. Calling the ApplyNow method will apply this color to all graph windows. [[New ] (Visual Basic)] to automatically make graphs on outputs green and graphs of inputs yellow Public Sub SetGraphColors() With Risk.ApplicationSettings.GraphOutputColor = vbgreen.graphinputcolor = vbyellow End With RiskApplicationSettings Object GraphInputColor Property ApplyNow Method

53 GraphOutputScalingFactor Property Specifies a default scaling factor for a output distribution graph. Read-write property Public Property GraphOutputScalingFactor() As RiskScalingFactor This property on applies to distribution graphs of outputs. This property on has effect if the GraphOutputScalingIsAutomatic property is False. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. [[New ] (Visual Basic)] 'Change Default Graph Scaling Public Sub ChangeDefaultGraphScaling() With Risk.ApplicationSettings.GraphOutputScalingIsAutomatic = False.GraphOutputScalingMinimum = 1000.GraphOutputScalingMaximum = 5000.GraphOutputScalingFactor = RiskScaleByThousands End With RiskApplicationSettings Object GraphOutputScalingIsAutomatic Property GraphOutputScalingMinimum Property GraphOutputScalingMaximum Property ApplyNow Method

54 GraphOutputScalingIsAutomatic Property Indicates whether the default x-axis scaling of output distributions graphs is automatically determined. Read-write property Public Property GraphOutputScalingIsAutomatic() As Boolean This property on applies to distribution graphs of outputs. If this property is set to False, the GraphOutputScalingMinimum, GraphOutputScalingMaximum, and GraphOutputScalingFactor properties will control the default scaling applies to new distribution graphs. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. [[New ] (Visual Basic)] 'Change Default Graph Scaling Public Sub ChangeDefaultGraphScaling() With Risk.ApplicationSettings.GraphOutputScalingIsAutomatic = False.GraphOutputScalingMinimum = 1000.GraphOutputScalingMaximum = 5000.GraphOutputScalingFactor = RiskScaleByThousands End With RiskApplicationSettings Object GraphOutputScalingIsAutomatic Property GraphOutputScalingMinimum Property GraphOutputScalingMaximum Property ApplyNow Method

55 GraphOutputScalingMaximum Property Specifies a default maximum value for a output distribution graph. Read-write property Public Property GraphOutputScalingMaximum() As Double This property on applies to distribution graphs of outputs. This property on has effect if the GraphOutputScalingIsAutomatic property is False. The value specified in this property is NOT scaled by the value in the GraphOutputScalingFactor property. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. [[New ] (Visual Basic)] 'Change Default Graph Scaling Public Sub ChangeDefaultGraphScaling() With Risk.ApplicationSettings.GraphOutputScalingIsAutomatic = False.GraphOutputScalingMinimum = 1000.GraphOutputScalingMaximum = 5000.GraphOutputScalingFactor = RiskScaleByThousands End With RiskApplicationSettings Object GraphOutputScalingIsAutomatic Property GraphOutputScalingMinimum Property GraphOutputScalingFactor Property ApplyNow Method

56 GraphOutputScalingMinimum Property Specifies a default minimum value for a output distribution graph. Read-write property Public Property GraphOutputScalingMinimum() As Double This property on applies to distribution graphs of outputs. This property on has effect if the GraphOutputScalingIsAutomatic property is False. The value specified in this property is NOT scaled by the value in the GraphOutputScalingFactor property. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. [[New ] (Visual Basic)] 'Change Default Graph Scaling Public Sub ChangeDefaultGraphScaling() With Risk.ApplicationSettings.GraphOutputScalingIsAutomatic = False.GraphOutputScalingMinimum = 1000.GraphOutputScalingMaximum = 5000.GraphOutputScalingFactor = RiskScaleByThousands End With RiskApplicationSettings Object GraphOutputScalingIsAutomatic Property GraphOutputScalingMaximum Property GraphOutputScalingFactor Property ApplyNow Method

57 GraphPreferredDistributionFormat Property Controls the preferred distribution display format for distribution graphs. Read-write property Public Property GraphPreferredDistributionFormat() As RiskDistributionDisplayFormat This graph only applies to distribution graphs. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. RiskApplicationSettings Object GraphPreferredTornadoFormat Property ApplyNow Method RiskDistributionDisplayFormat Enumeration

58 GraphPreferredTornadoFormat Property Controls the preferred display format for tornado graphs. Read-write property Public Property GraphPreferredTornadoFormat() As RiskTornadoDisplayFormat This property only applies to tornado graphs. This property applies to new graphs when they are first created. To apply this property to existing graphs call the ApplyNow method. RiskApplicationSettings Object GraphPreferredDistributionFormat Property RiskTornadoDisplayFormat Enumeration