In This Topic ▼

append Method

Summary

Appends the changes between two versions of a container to the history.

Syntax

TypeScript

JavaScript

AnnHistory.prototype.append = function( 
   currentContainers, 
   updatedContainers 
)

append( 
   currentContainers: AnnContainer[], 
   updatedContainers: AnnContainer[] 
): void;

Parameters

currentContainers

The current (old) containers containing the original objects.

updatedContainers

The updated (new) containers with any changes.

Remarks

Append will compare the objects in the current and modified containers and add a new item in Items for each annotation object that has been changed.

This method works as follows:

If a container is removed (is in currentContainer but not in updatedContainer), then an entry for all the AnnObject children of this container is added to Items with AnnHistoryItemState equals to Deleted.
If a container is added (is in updatedContainer but not in currentContainer), then an entry for all the AnnObject children of this container is added to Items with AnnHistoryItemState equals to Added.
Any object that is in updatedContainer but not in its corresponding container in currentContainer is considered a new object and an entry of type Added is added to Items.
Any object that is in currentContainer but not in its corresponding container in updatedContainer is considered deleted and an entry of type Deleted is added to Items.
For all objects that are in both currentContainer and its corresponding updatedContainer, the AnnObject.ModifiedMetadataKey values are compared and if not equal, an entry of type 'Modified' is added to Items.

Therefore, when this method returns, Items will be updated to add a list of all the annotation objects that have been changed between the two container sets.

Requirements

Target Platforms

Reference

AnnHistory Class

AnnHistory Members

Leadtools.Annotations.Engine Namespace

Download our FREE evaluation

Help Version 22.0.2023.1.31

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies