Read-Write. Indicates whether an agent is able to run.

Defined in

Agent

Data type

boolean

Syntax

public boolean isEnabled()
   throws NotesException

public void setEnabled(boolean value)
   throws NotesException

Legal values

• true if the agent can be run
• false if the agent is disabled

This property is intended for use with scheduled agents, which can be enabled and disabled. This property always returns true for hidden agents and agents that are run from a menu.

You must call Save to make any change effective.

If the agent is open in the UI, a change is not immediately reflected. The agent must be closed and reopened.

Access privileges and agent signing depend on whether user or designer activation is in effect. See IsActivatable.

Language cross-reference

IsEnabled property in LotusScript NotesAgent class

@IsAgentEnabled function in formula language

AgentEnableDisable @command in formula language

Example
See Also

Accessing agents

Glossary