ITcSmTreeItem

Extended by: ITcSmTreeItem2

ITcSmTreeItem is the basic interface for every automation Tree Item. It provides access to the name, type, path, parent/child relationships, variables, XML serialization, and basic child operations.

Properties

Property

Type

get/set

Description

Child

ITcSmTreeItem**

get

Returns a direct child based on a 1-based index.

ChildCount

long*

get

Returns the number of direct children.

Comment

BSTR

get/set

Reads or sets the item's comment.

Disabled

DISABLED_STATE

get/set

Reads or sets the deactivation status.

ItemSubType

long

get/set

Reads or sets the SubType, provided that the specific item supports SubTypes.

ItemSubTypeName

BSTR*

get

Returns the readable SubType/type name.

ItemType

long*

get

Returns the numeric Tree Item type.

Name

BSTR

get/set

Reads or sets the display name of the item.

Parent

ITcSmTreeItem**

get

Returns the parent Tree Item.

PathName

BSTR*

get

Returns the hierarchical path name of the item.

Var

ITcSmTreeItem**

get

Returns a variable based on its direction and index.

VarCount

long*

get

Returns the number of variables in a given direction.

Methods

Method

Description

_NewEnum

Generates an enumeration over the direct child nodes.

ConsumeXml

Imports XML data into the current item or selected target items.

CreateChild

Creates a child with a name, SubType, and optional additional data.

DeleteChild

Deletes a direct child by its name.

ExportChild

Exports a child or the current item to an .xti file.

GetLastXmlError

Returns the most recently saved XML error context.

ImportChild

Imports a child item from an XML/XTI file.

LookupChild

Searches for a direct child by name or by a language-independent name.

ProduceXml

Serializes the item as TreeItem XML.