Leaf Class Properties

In this section, we discuss the Leaf class properties. The properties are discussed in alphabetical order.

Description

Use this property to return the tree leaf’s description as a string.

Note: This property is currently supported for what is known as a single detail leaf. Do not use this property with ranged or dynamic leaves.

This property is read-only.

Description

When using the Tree API to create a graphic representation of the tree (such as for HTML Tree Manager or other application pages) use this property to indicate the display level, that is, tell the user how many levels deep the leaf is. This is generally used for trees where levels aren't used and the LevelNumber property always returns 0. This property always returns a number.

This property is read-only.

Related Links

LevelNumber

Description

This property specifies whether the leaf has a dynamic range or a specified range. If you set this property to True, the leaf has a dynamic range. If this is a new leaf, and you do not set this property, the value is automatically set is False.

This property is read/write.

Description

This property returns True if the leaf has a next sibling, that is, it isn’t the last leaf listed under the parent node.

This property is read-only.

Description

This property returns True if the leaf has a previous sibling, that is, it isn’t the first leaf listed under the parent node.

This property is read-only.

Description

This property sets the which image is used to display the leaf. This property takes a string value for the image name of the leaf.

This property is read/write.

Description

This property returns True if the leaf has been edited or changed.

This property is read-only.

Example

If &MYLEAF.IsChanged Then 
   &MYTREE.Save(); 
End-If;

Description

This property returns True if the leaf has been cut from the displayed tree. This property is generally used with the HTML Tree Manager.

This property is read-only.

Description

This property returns True if the leaf has been deleted from the tree but the tree hasn’t been saved.

This property is read-only.

Description

This property returns True if the leaf has been inserted as a new leaf in the tree but the tree hasn’t been saved.

This property is read-only.

Description

This property returns a leaf object associated with the next sibling leaf. The next sibling of a leaf is the leaf appearing under the current leaf. If there is no next sibling and you try to assign it to a variable, you receive a runtime error.

This property is read-only.

Example

The following code traversed the leaves from top to bottom.

While &MYLEAF.HasNextSib 
   &MYLEAF = &MYLEAF.NextSib; 
   /* do some processing */ 
End-While;

Description

This property returns a node object associated with the parent node for the leaf.

This property is read-only.

Example

&PARENTNODE = &MYLEAF.Parent; 
/* do node processing with node object */

Description

This property returns a leaf object associated with the previous sibling leaf. The previous sibling of a leaf is the leaf appearing above the current leaf. If there is no previous sibling and you try to assign it to a variable, you receive a runtime error.

This property is read-only.

Example

The following code traverses the leaves from bottom to top.

While &MYLEAF.HasPrevSib 
   &MYLEAF = &MYLEAF.PrevSib; 
   /* do some processing */ 
End-While;

Description

This property returns the starting range, as a string, of the leaf.

This property is read/write.

Description

This property returns the ending range, as a string, of the leaf.

This property is read/write.

Description

This property returns the branch name of the tree as a string if the tree is branched. If not branched, this property returns a blank string.

This property is read-only.

Description

This property returns the effective date of the tree as a string if the tree is effective-dated. If not effective-dated, this property returns a blank string.

This property is read-only.

Description

This property returns the name of the tree as a string.

This property is read-only.

Description

This property returns the SetID of the tree as a string if the tree has a SetID. If the tree doesn’t have a SetID, this property returns a blank string.

This property is read-only.

Description

This property returns the UserKeyValue of the tree as a string if the tree has a UserKeyValue. If the tree doesn’t have a UserKeyValue, this property returns a blank string.

This property is read-only.