restore Method

Summary

Restores the background behind the AnnRedactionObject using the specified data provider.

Syntax

JavaScript Syntax

AnnRedactionObject.prototype.restore = function(provider, container)

TypeScript Syntax

restore(provider: AnnDataProvider, container: AnnContainer): void;

Parameters

provider

AnnDataProvider instance that is used to set the image pixel data.

container

The reference AnnContainer.

Remarks

When this method is called, the background behind this AnnRedactionObject must be restored back onto the original image. It is up to AnnDataProvider implementation to perform this operation since this object has no concept of the original image.

If this AnnRedactionObject has not been realized, this method does nothing. You can determine if this AnnRedactionObject is realized using the CanRestore property.

This method uses AnnDataProvider as follows: the AnnDataProvider.SetImageData method is called to put the pixel data back in the image. This data was previously obtained and stored inside this object in ImageData when Realize was called.

Requirements

Target Platforms

Reference

AnnRedactionObject Class

AnnRedactionObject 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