Skip to main content
View as Markdown

ITimerManager interface

The ITimerManager interface manages the timing mechanisms efficiently in Altium Designer which registers timer objects and calls them when used. Normally a Timer object needs a window to run and responds to WM_Timer messages. This is for internal use.

public interface ITimerManager

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Properties​

PropertyTypeAccessDescription
HandlerEnabledboolget; setInternal Use only

HandlerEnabled​

Internal Use only

bool GetHandlerEnabled(uint argID);
void SetHandlerEnabled(uint argID, bool argEnabled);

Type: bool · Access: read/write · Index: argID (uint)

Methods​

MethodReturnsDescription
AddHandleruintInternal Use only
RemoveHandlervoidInternal Use only
SetGlobalEnabledvoidInternal Use only

AddHandler​

Internal Use only

uint AddHandler(ITimerHandler argHandler, uint argInterval, bool argEnabled);
uint AddHandler(object argHandler, uint argInterval, bool argEnabled);
ParameterTypePassing
argHandlerITimerHandlervalue
argIntervaluintvalue
argEnabledboolvalue

Returns: uint

The first overload is an extension method of ITimerManagerHelper (using DXP;) with typed parameters; the second is declared by the interface.

RemoveHandler​

Internal Use only

void RemoveHandler(uint argID);
ParameterTypePassing
argIDuintvalue

Returns: nothing (void)

SetGlobalEnabled​

Internal Use only

void SetGlobalEnabled(bool argEnabled);
ParameterTypePassing
argEnabledboolvalue

Returns: nothing (void)

Returned by​

IClient.GetTimerManager