1. Graphics Mill 5.5 for .NET
  2. Aurigma Graphics Mill 5.5 for .NET
  3. Class Library Reference
  4. Aurigma.GraphicsMill Namespace
  5. LockableObject Class
  6. LockableObject Methods
This documentation is for the old version. Go to the latest Graphics Mill docs

LockableObject.Lock Method

Locks the object.

Namespace: Aurigma.GraphicsMill
Assembly: Aurigma.GraphicsMill (in Aurigma.GraphicsMill.dll)

Syntax

Visual Basic 
Public Overridable Sub Lock
C# 
public virtual void Lock()

Implements

ILockable.Lock()

Remarks

After calling this method this object is not accessible from any other thread (until Unlock() is called). If you try to lock the object twice (e.g. with two consequent calls of this method), ObjectLockedExceptionwill be thrown. You can safely check Locked property to ensure if object is locked.

When you access the object which has been locked, the thread stops and waits until it become unlocked. Using property Timeout you can specify how much time to wait.

Note

All Graphics Mill for .NET method and properties already uses Lock()/Unlock() methods to provide thread safety. You need call these methods manually only if you manipulate the objects manually, or if you inherit your own class from ILockable interface.

See Also

Reference