OverviewExamples
|
DlgSelectPackages.SetCategoryProperties ( |
Sets the properties of a package category within the select package control on the current screen.
Note: This action
will not cause the select packages tree to redraw unless you call the
DlgSelectPackages.UpdateDisplay
action.
This action will only work if called from a screen's events and if the
named control is on the current screen. This action is normally used on
the Select Packages
screen.
Tip: You can also get and set the properties of packages using SetupData.GetPackageProperties and SetupData.SetPackageProperties and get a list of the packages using SetupData.GetPackageList.
(number) The numeric ID of the select packages control whose category properties you want to set.
(number) The numeric ID of the package category whose properties you want to set.
(table) A table containing the control properties you want to set, indexed by the following categories:
|
KEY |
TYPE |
DESCRIPTION |
|
Text |
string |
The text you want to display in the category. This value can be assigned to tb.Text. |
|
Description |
string |
The description text you want to display for the category. This value can be assigned to tb.Description. |
|
Enabled |
boolean |
Whether to enable the category. Setting tb.Enabled to true enables the category and setting tb.Enabled to false disables the category. |
|
Expanded |
boolean |
Whether to expand the category in the tree view. Setting tb.Expanded to true expands the category and setting tb.Expanded to false collapses the category tree. |
|
State |
number |
The state to set the category to. The following states are available (constant followed by its value): CB_UNCHECKED = 1 (deselect the category) CB_CHECKED = 2 (select the category) This value can be assigned using the format tb.State = CB_CHECKED or {State=CB_CHECKED} |
Nothing. If the current screen does not contain the control, this action will fail. You can use Application.GetLastError to determine whether this action failed, and why.
See also: Related Actions