Locks the object(s) currently being edited (selected).

Syntax

Visual Basic (Declaration)
Public Overridable Sub Lock()

Visual Basic (Usage)	Copy Code
`Dim instance As AnnAutomation instance.Lock()`

C#
public virtual void Lock()

Managed Extensions for C++
public: virtual void Lock();

C++/CLI
public: virtual void Lock();

Example

Visual Basic Copy Code

Visual Basic	Copy Code
Public Sub AnnAutomation_Lock(ByVal automation As AnnAutomation) ' first add a new object to the automation Dim rectObj As AnnRectangleObject = New AnnRectangleObject() rectObj.Bounds = New AnnRectangle(100, 100, 100, 100, AnnUnit.Pixel) rectObj.Pen = New AnnPen(Color.Blue, New AnnLength(1, AnnUnit.Pixel)) rectObj.Brush = New AnnSolidBrush(Color.Yellow) automation.Container.Objects.Add(rectObj) automation.Viewer.Invalidate(rectObj.InvalidRectangle) ' make sure no objects are selected in the automation automation.SelectNone() ' see if we can lock or unlock the object (this should show a message informing you that no objects are currently selected (bring edited) LockUnlock(automation) ' select (edit) the object we have just added automation.StartEditing(rectObj, False) ' see if we can lock or unlock the object (should show the password dialog to lock the object) LockUnlock(automation) ' see if we can lock or unlock the object (should show the password dialog to unlock the object) LockUnlock(automation) End Sub Private Sub LockUnlock(ByVal automation As AnnAutomation) ' first, check if we can lock the object If automation.CanLock Then ' lock this object automation.Lock() ElseIf automation.CanUnlock Then ' unlock this object automation.Unlock() Else MessageBox.Show("Cannot lock or unlock because no object is currently being edited (selected)") End If End Sub

Public Sub AnnAutomation_Lock(ByVal automation As AnnAutomation)

   ' first add a new object to the automation

   Dim rectObj As AnnRectangleObject = New AnnRectangleObject()

   rectObj.Bounds = New AnnRectangle(100, 100, 100, 100, AnnUnit.Pixel)

   rectObj.Pen = New AnnPen(Color.Blue, New AnnLength(1, AnnUnit.Pixel))

   rectObj.Brush = New AnnSolidBrush(Color.Yellow)

   automation.Container.Objects.Add(rectObj)

   automation.Viewer.Invalidate(rectObj.InvalidRectangle)

   ' make sure no objects are selected in the automation

   automation.SelectNone()



   ' see if we can lock or unlock the object (this should show a message informing you that no objects are currently selected (bring edited)

   LockUnlock(automation)



   ' select (edit) the object we have just added

   automation.StartEditing(rectObj, False)



   ' see if we can lock or unlock the object (should show the password dialog to lock the object)

   LockUnlock(automation)



   ' see if we can lock or unlock the object (should show the password dialog to unlock the object)

   LockUnlock(automation)

End Sub



Private Sub LockUnlock(ByVal automation As AnnAutomation)

   ' first, check if we can lock the object

   If automation.CanLock Then

      ' lock this object

      automation.Lock()

   ElseIf automation.CanUnlock Then

      ' unlock this object

      automation.Unlock()

   Else

      MessageBox.Show("Cannot lock or unlock because no object is currently being edited (selected)")

   End If

End Sub

C# Copy Code

C#	Copy Code
public void AnnAutomation_Lock(AnnAutomation automation) { // first add a new object to the automation AnnRectangleObject rectObj = new AnnRectangleObject(); rectObj.Bounds = new AnnRectangle(100, 100, 100, 100, AnnUnit.Pixel); rectObj.Pen = new AnnPen(Color.Blue, new AnnLength(1, AnnUnit.Pixel)); rectObj.Brush = new AnnSolidBrush(Color.Yellow); automation.Container.Objects.Add(rectObj); automation.Viewer.Invalidate(rectObj.InvalidRectangle); // make sure no objects are selected in the automation automation.SelectNone(); // see if we can lock or unlock the object (this should show a message informing you that no objects are currently selected (bring edited) LockUnlock(automation); // select (edit) the object we have just added automation.StartEditing(rectObj, false); // see if we can lock or unlock the object (should show the password dialog to lock the object) LockUnlock(automation); // see if we can lock or unlock the object (should show the password dialog to unlock the object) LockUnlock(automation); } private void LockUnlock(AnnAutomation automation) { // first, check if we can lock the object if(automation.CanLock) { // lock this object automation.Lock(); } else if(automation.CanUnlock) { // unlock this object automation.Unlock(); } else MessageBox.Show("Cannot lock or unlock because no object is currently being edited (selected)"); }

public void AnnAutomation_Lock(AnnAutomation automation) 
{ 
   // first add a new object to the automation 
   AnnRectangleObject rectObj = new AnnRectangleObject(); 
   rectObj.Bounds = new AnnRectangle(100, 100, 100, 100, AnnUnit.Pixel); 
   rectObj.Pen = new AnnPen(Color.Blue, new AnnLength(1, AnnUnit.Pixel)); 
   rectObj.Brush = new AnnSolidBrush(Color.Yellow); 
   automation.Container.Objects.Add(rectObj); 
   automation.Viewer.Invalidate(rectObj.InvalidRectangle); 
   // make sure no objects are selected in the automation 
   automation.SelectNone(); 
 
   // see if we can lock or unlock the object (this should show a message informing you that no objects are currently selected (bring edited) 
   LockUnlock(automation); 
 
   // select (edit) the object we have just added 
   automation.StartEditing(rectObj, false); 
 
   // see if we can lock or unlock the object (should show the password dialog to lock the object) 
   LockUnlock(automation); 
 
   // see if we can lock or unlock the object (should show the password dialog to unlock the object) 
   LockUnlock(automation); 
} 
 
private void LockUnlock(AnnAutomation automation) 
{ 
   // first, check if we can lock the object 
   if(automation.CanLock) 
   { 
      // lock this object 
      automation.Lock(); 
   } 
   else if(automation.CanUnlock) 
   { 
      // unlock this object 
      automation.Unlock(); 
   } 
   else 
      MessageBox.Show("Cannot lock or unlock because no object is currently being edited (selected)"); 
}

Remarks

Use the CanLock property to determine whether you can currently call this method.

This method opens the PasswordDialogType form and uses the value entered in this dialog as the password to Lock.

If the PasswordDialogType value is null (Nothing in Visual Basic), this method will not do anything.

For more information, refer to Implementing Annotation Security..

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Leadtools.Annotations	Requires Document/Medical product license \| Send comments on this topic. \| Back to Introduction - All Topics \| Help Version 15.10.31
Lock Method
See Also Example

Syntax

Example

Remarks

Requirements

See Also

Reference