LEADTOOLS Annotations (Leadtools.Annotations assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
Lock Method
See Also 
Leadtools.Annotations Namespace > AnnObject Class : Lock Method



password
String containing the password used to lock the annotation object.

The Lock Method is available in LEADTOOLS Document and Medical Imaging toolkits.

password
String containing the password used to lock the annotation object.
Locks this AnnObject with the specified password.

Syntax

Visual Basic (Declaration) 
Public Overridable Sub Lock( _
   ByVal password As String _
) 
Visual Basic (Usage)Copy Code
Dim instance As AnnObject
Dim password As String
 
instance.Lock(password)
C# 
public virtual void Lock( 
   string password
)
C++/CLI 
public:
virtual void Lock( 
   String^ password
) 

Parameters

password
String containing the password used to lock the annotation object.

Example

This method changes the 'lock' state of an object.

Visual BasicCopy Code
Public Sub AnnObject_Lock(ByVal obj As AnnObject, ByVal password As String)
   If obj.IsLocked Then
      MessageBox.Show("Object is locked. It will be unlocked.")
      If String.Compare(password, obj.Password, False) <> 0 Then
         MessageBox.Show("Invalid password!!")
      Else
         obj.Unlock(password)
      End If
   Else
      MessageBox.Show("Object was not locked. It will be locked now.")
      obj.Lock(password)
   End If
End Sub
C#Copy Code
public void AnnObject_Lock(AnnObject obj, string password)
{
   if(obj.IsLocked)
   {
      MessageBox.Show("Object is locked. It will be unlocked.");
      if(string.Compare(password, obj.Password, false) != 0)
         MessageBox.Show("Invalid password!!");
      else
         obj.Unlock(password);
   }
   else
   {
      MessageBox.Show("Object was not locked. It will be locked now.");
      obj.Lock(password);
   }
}

Remarks

Only unlocked objects can be locked. If an object is already locked, it will stay locked with its original password. You must pass the same password to AnnObject.Unlock to unlock this AnnObject.

If this method succeeds, password will be stored inside the object and can be retreived with the Password property.

An object must be unlocked in order to change that object in automated mode.

For more information, refer to Implementing Annotation Security.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

Leadtools.Annotations requires a Document or Medical toolkit license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features