←Select platform

Lock Method

Summary

Locks this AnnObject with the specified password.

Syntax

C++

public virtual void Lock( 
   string password 
)

  
Public Overridable Sub Lock( _ 
   ByVal password As String _ 
)

public: 
virtual void Lock(  
   String^ password 
)

Parameters

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

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 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. (Deprecated)

Example

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

using Leadtools; 
using Leadtools.Annotations; 
using Leadtools.Codecs; 
using Leadtools.WinForms; 
using Leadtools.Drawing; 
 
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); 
   } 
}

Imports Leadtools 
Imports Leadtools.Annotations 
Imports Leadtools.Codecs 
Imports Leadtools.WinForms 
Imports Leadtools.Drawing 
 
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

Requirements

Target Platforms

Reference

AnnObject Class

AnnObject Members

Help Version 19.0.2017.10.27

Leadtools.Annotations Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations Namespace

Assemblies