Dashboard.ControlExists Function
Determines whether a given control exists on a given Dashboard.
[Dashboard.]ControlExists (Control)
Arguments
- Control
- Required. A string value containing the name of the control for which to search.
Return Value
The DashControlExists function returns the following values:
| If |
DashControlExists returns |
| Control is not the name of a control in Dashboard. |
false
...and "Control is not the name of a
control in Dashboard." is written to the console. |
| Control is the name of a control in Dashboard. |
true |
Remarks
The following examples use ControlExists to determine whether a specifit ListBox exists in a dashboard named "Dashboard":
// output whether lstProgram exists
Alert(ActiveDocument.Sections["Dashboard"].ControlExists("lstProgram"));
Requirements
ActiveDocument.loadObjectMethods() must be run after the dashboard
object is created and before this object method is used.
|