C++ Syntax

MKI_EditLinkBehind(

bool f_fDuplicate );

Moves the given entity inside the drawing's object list behind the given reference object (or to the end of the list) while maintaining its undo structure, i.e. it can be moved to its original position by the user.

Make sure that the entity you want to move and the reference entity (if any) are already part of the drawing's object list! If not, the internal lists may get corrupted and the system might reveal unexpected behavior.

This procedure may only be called inside a MKI_UndoInitProcess and MKI_UndoFinishProcess bracket.

Parameters

Entity

[MKI_ENTITY_PTR] Address of the entity to be moved in the list. Make sure that this address points to an entity located in the current drawing! If not, the system might reveal unexpected behavior.

RefEntity

[MKI_ENTITY_PTR] Address of a reference entity behind which the entity is to be moved. If RefEntity is nullptr, the entity will be moved to the end of the list.

Duplicate

[bool] Determines whether the entity itself shall be moved or a copy of it. This is equivalent to the "Duplicate" function in the serving application.

Return Value

New address of the moved entity. Due to the undo structure, the address of the entity will always change!

Moving an entity within the entity list will change the drawing order of the entity. When moving an entity to the beginning of the list, it will be drawn first, i.e. it will be overdrawn by any following entity. Moving an entity to the end of the list will make it the topmost entity.