Configuring Siebel Business Applications > Reference Materials for Configuring Siebel Business Applications > Properties of Object Types >
Properties of Objects You Use with a Menu or Toolbar
This topic describes some of the properties of objects that you use with a menu or toolbar. Properties of a Command
Table 85 describes some of the properties that Siebel CRM commonly uses with a command.
Table 85. Properties That Siebel CRM Commonly Uses with a Command
|
|
Business Service |
Specifies the business service that handles the method. The service is browser or server depending on the Target property. Note the following:
- If the Business Service property is empty, then Siebel CRM targets the browser or server infrastructure rather than a specific service.
- If the Business Service property is not empty, then the business service that is defined must handle CanInvokeMethod and InvokeMethod for the method that is defined in the Method property.
|
HTML Bitmap |
Specifies that the Command object uses a bitmap. |
HTML Popup Dimensions |
If the Show Popup property contains a check mark, then the HTML Popup Dimensions property specifies the dimensions of the pop-up window, in pixels. For example, you can specify a popup with a dimension of 640x480. Do include the x between the dimensions. Do not include spaces. |
Method |
Specifies the name of the method that Siebel CRM calls if the user clicks the menu item or clicks the toolbar icon. This is a required property. For more information, see About the Method, Business Service, and Target Properties of the Command Object. |
Method Argument |
Allows you to send an argument to the method defined in the Method property. For example, assume a command item opens a new window and navigates to a URL in that window. This command can use the Method Argument property to define the GotoURL method in the Method property and the URL to navigate to. |
Show Popup |
Note the following:
- If the Show Popup property contains a check mark, then Siebel CRM opens a new browser window before it calls the method.
- If the Show Popup property does not contain a check mark, then Siebel CRM does not open a new browser window before it calls the method.
|
Target |
Specifies the entity that handles the method that the command calls. The following options are available:
For more information, see About the Method, Business Service, and Target Properties of the Command Object. |
Tooltip Text |
The tooltip text that Siebel CRM displays if the user positions the cursor over a toolbar icon. For a predefined method, leave the Tooltip Text property empty. If the Tooltip Text property is empty, then the method dynamically supplies the text, and language localization takes place as a part of this process. If you define the method, then you must enter literal text. If you define literal text, then Siebel CRM does not use language localization for this tooltip text. For more information, see Localizing Siebel Business Applications. |
Properties of a Toolbar
Table 86 describes some of the properties that Siebel CRM commonly uses with a toolbar.
Table 86. Properties That Siebel CRM Commonly Uses with a Toolbar
|
|
Class |
Note the following:
- For an HTML toolbar, leave the Class property empty.
- For a Java toolbar, enter the name of the Java class that implements the toolbar.
|
Display Name |
Siebel CRM uses this property for the History button and to display or hide toolbars by name. |
Name |
Referenced by other object definitions and by the swe:toolbar tag in the name clause. |
Properties of a Menu Item
Table 87 describes some of the properties that Siebel CRM commonly uses with a menu item.
Table 87. Properties That Siebel CRM Commonly Uses with a Menu Item
|
|
Caption |
The text that Siebel CRM displays in the menu or menu item. |
Command |
Name of the Command object definition that provides the method and target for the menu item. |
Name |
Uniquely identifies the menu or menu item. |
Position |
Determines the order of menu items and the parent-child relationships. For example, a menu item with a Position of 150 is a parent to menu items with Position values of 150.10, 150.20, and so on. Note the following:
- If the parent menu item is active, then Siebel CRM displays the child menu items.
- If the parent menu item is not active, then Siebel CRM does not display the child menu items.
|
Properties of a Toolbar Item
Table 88 describes some of the properties that Siebel CRM commonly uses with a toolbar item.
Table 88. Properties That Siebel CRM Commonly Uses with a Toolbar Item
|
|
Command |
Name of the Command object definition that provides the bitmap, method, and target for the toolbar item. To configure Siebel CRM to insert a separator between icons, you can define one or more hyphens instead of the name of a Command object. |
HTML Type |
Identifies the type of control that Siebel CRM displays in the toolbar in the browser. You can specify one of the following types:
- ComboBox
- Button
- Edit
- Label
- Hyperlink
- MiniButton
- Timer
|
Name |
Name of the toolbar item. Siebel Tools uses this property for internal use only. The Name property must be unique in the toolbar. |
Position |
Determines the order of toolbar items and the parent-child relationships. For example, a Toolbar item with a Position of 150 is a parent to Toolbar items with Position values of 150.10, 150.20, and so on. Note the following:
- If the parent toolbar item is active, then Siebel CRM displays the child toolbar items.
- If the parent toolbar item is not active, then Siebel CRM does not display the child toolbar items.
|
Properties of an Applet Method Menu Item
Table 89 describes some of the properties that Siebel CRM commonly uses with an applet method menu item.
Table 89. Properties that Siebel CRM Commonly Uses with an Applet Method Menu Item
|
|
Command |
Name of the command that provides the bitmap, method, and target for the applet method menu item. Use Browser as the target of the Command object for a menu item that Siebel CRM displays on an applet menu. |
Menu Text |
The text that Siebel CRM displays in the menu item. |
Position |
The sequence of the menu item in the list of menu items. |
Suppress Menu Item |
If the Suppress Menu Item property contains a check mark, then Siebel CRM removes the class-level menu item of the defined name from the applet menu in the applet where this property is defined. |
Properties of a Class Method Menu Item
Table 90 describes some of the properties that Siebel CRM commonly uses with a class method menu item.
Table 90. Properties That Siebel CRM Commonly Uses with a Class Method Menu Item
|
|
Business Service |
Note the following:
- If defined, then this property identifies the business service that contains the method that Siebel CRM calls.
- If not defined, then Siebel CRM calls the method in the applet class on the browser or server, as defined in the Target property. If not handled, then Siebel CRM does a subsequent retargeting.
|
Menu Text |
The text that Siebel CRM displays in the menu item. |
Method |
The method that Siebel CRM calls if the user clicks the item. |
Position |
The sequence of the menu item in the list of menu items. |
Suppress Menu Item |
If the Suppress Menu Item property contains a check mark, then Siebel CRM removes the applet menu items of the defined name from the applet menu in all applets that it gets from this class and subclasses. |
Target |
Specifies the entity that handles the method that is defined in the Method property. The following options are available:
- Browser. Specifies that the method handler is a JavaScript service on the browser, or the JavaScript applet class on the browser, depending on if a service is defined or not defined in the Business Service property. The JavaScript applet class is the JavaScript business component class.
- Server. Specifies that the method handler is an object manager service on the Siebel Server or the applet and business component and their superclasses, depending on if a service is defined or not defined in the Business Service property.
|
|