CB Com Devkit.chm

This help file is a reference with lists and descriptions of methods and properties in OptQuest Developer Kit classes. It is located in the Docs folder beneath the main Crystal Ball installation folder (by default, C:\Program Files\Oracle\Crystal Ball\Docs). You can open and use CB Com Devkit.chm directly from that folder at any time.

When you first open CB Com Devkit.chm, three namespaces appear in the navigation pane (Figure 1, CB Com Devkit.chm with Three C# Namespaces). These namespaces are only used in C# code, not Visual Basic (VBA) code. However, if you are using VBA, they indicate which classes are used for OptQuest automation (.Optimization) and which are used for Predictor (.Predictor). When writing VBA code, you omit .Optimization or .Predictor as shown in the code examples included in this Developer's Guide.

Figure 1. CB Com Devkit.chm with Three C# Namespaces

CB COM DevKit.chm initial screen with .Optimization and .Predictor namespaces

The Index and Search tabs are helpful for locating information about a specific class. For example, if you click the Search tab, type Constraint, and then click List Topics, you can select one of the listed topics in the navigation pane to display it in the content pane. See Figure 2, CB Com Devkit.chm Opened to the Constraint Properties Topic for OptQuest, following, for an example of the Constraint Properties topic for OptQuest. You can also review lists and descriptions of methods, the classes themselves, and other important development information.

Figure 2. CB Com Devkit.chm Opened to the Constraint Properties Topic for OptQuest

The Constraint Properties topic contains two sections: Constraints, that enables you to view the associated properties, such as Public, Protected, Inherited, and so on, and the memberes with which they are associated. There is also a See Also, that lists relatecan d topics. pened to view detailed information about the properties for the selected constraint.

CB Com Devkit.chm is generated from actual OptQuest Developer Kit code and has a development language filter to help you with your code. The default is C#. You can change to Visual Basic or Visual Basic Usage (for code snippet examples). The topic in Figure 2, CB Com Devkit.chm Opened to the Constraint Properties Topic for OptQuest has two collapsible headings, Properties and See Also. Other topics, such as Decision Class, shown in Figure 3, CB Com Devkit.chm opened to the Decision Class topic., have an additional Syntax heading.

The Syntax tabs are linked to the Language Filter menu in the help window. In Figure 3, CB Com Devkit.chm opened to the Decision Class topic., the language filter is set to Visual Basic Usage. Since the Visual Basic Usage filter shows sample Visual Basic code, a code snippet appears on the tab.

Figure 3. CB Com Devkit.chm opened to the Decision Class topic.

This example shows the Decision Class tab, which displays the Syntax and Members.

If you click the Visual Basic tab, Visual Basic appears in the Language Filter menu and the Visual Basic tab is selected in the Syntax tab group.