EditItem

Opens the property sheet to edit a specified item. Advanced edit options are available through the Flags parameter.

 

JavaScript

 

EditItem(    

       ID,

       Flags )

 

C#

 

void EditItem(      

       string ID,

       [EditItemFlags Flags = EditItemFlags.EDIT_ITEM_USE_PROPERTY])

 

C++

 

HRESULT EditItem(

       BSTR ID,

       EditItemFlags Flags) 

Parameters

ID

The ID of the item to edit.

Flags 

An enum that can use any of the following values:

·          EDIT_ITEM_USE_PROPERTY = 0
Opens the property sheet to edit the item.

·          EDIT_ITEM = 1
Sets the edit mode without opening the property sheet.

·          EDIT_ITEM_VERTICES = 2
Sets the edit mode to vertices mode without opening the property sheet.

Exceptions

HRESULT can return any of the values listed in the HRESULT Return Values list, as well as the following values:

TE_E_INFOTREE_PARENTNOTGROUP

The group ID entered does not represent a valid group in the Project Tree.

TE_E_INFOTREE_ITEMNOTGROUP

The item entered is not a group and therefore cannot be used as a group.

TE_E_INFOTREE_CANTUSEROOT

Cannot use Tree root for this operation

TE_E_INFOTREE_ITEMISGROUP

Item ID is a group so an object cannot be retrieved.