unlock Method

Summary

Unlocks this AnnObject with the specified password.

Syntax

JavaScript Syntax

AnnObject.prototype.unlock = function( 
   password 
)

TypeScript Syntax

unlock( 
   password: string 
): void;

Parameters

password

String containing the password used to unlock 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, the password will be stored inside the object and can be retrieved 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.

Example

For an example, refer to Lock.

Requirements

Target Platforms

Reference

AnnObject Class

AnnObject Members

Leadtools.Annotations.Core Namespace

Help Version 19.0.2017.10.27

Leadtools.Annotations.Core Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Core Namespace

Assemblies