TreeModify (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Controls, pages and windows

Tree functions

Prefix syntax

WLanguage procedure

TreeModify

Presentation

Example

Format of collapsed/expanded images

Type of collapsed/expanded images

See also

TreeModify (Function)

In french: ArbreModifie

Modifies an element (node or leaf) in a TreeView control.

Example of TreeView control:

Example

// Modify the caption of "Desserts" node in the "TREE_TVRecipe" TreeView control
Res = TreeModify(TREE_TVRecipe, "Recipes" + TAB + "Desserts", "Ice creams")

// Modify the root image in the "TREE_TVRecipe" TreeView control
Res = TreeModify(TREE_TVRecipe, "Recipes", Null, ...
"C:\MyImages\Img1.GIF", "C:\MyImages\Img2.GIF")

Syntax

<Result> = TreeModify(<TreeView control> , <Path of element to modify> , <New caption> [, <New collapsed image> [, <New expanded image> [, <New element identifier> [, <Tooltip text>]]]])

<Result>: Boolean

True if the element was modified in the TreeView control,
False otherwise.

<TreeView control>: Control name

Name of the TreeView control to be used.

<Path of element to modify>: Character string

Full path of element to modify. This parameter has the following format:

"<Root name>" + TAB + ["<Name of 1st node>" + TAB + ...
["<Name of 2nd node>" + TAB + [...]]]"<Leaf name>"

<New caption>: Character string

New caption for the specified element,
NULL constant to keep the existing caption.

<New collapsed image>: Optional character string or constant

New image associated with the specified element. This image is displayed when this element is collapsed (see the Remarks). This parameter corresponds to:
the name and full (or relative) path of image. A UNC path can be used.
the constant:
Null Stores the image of specified element
tvDefault
(Default value) Default image (closed folder):

<New expanded image>: Optional character string or constant

New image associated with the specified element. This image is displayed when this element is expanded (see the Remarks). This parameter corresponds to:
the name and full (or relative) path of image. A UNC path can be used.
the constant:
Null Stores the image of specified element
tvDefault
(Default value) Default image (opened folder):

<New element identifier>: Character string or integer (optional)

New identifier of element or the NULL constant to keep the identifier of specified element.
Caution: The TAB character cannot be used in the identifiers of elements.

<Tooltip text>: Optional character string

If this parameter is specified, its content will be displayed in a tooltip when the element is hovered by the mouse cursor. This parameter corresponds to an empty string by default. If no tooltip is associated with the element, the tooltip associated with the TreeView control will be automatically displayed.

Remarks

Format of collapsed/expanded images

The following image formats are supported in Windows:

Bitmap (*.BMP)
Graphics Interchange Format (*.gif)
Joint Picture Experts Group (*.jpg ; *.jpeg)
Kodak Photo CD (*.pcd)
PaintBrush (*.pcx)
Adobe Photoshop Format (*.psd)
TrueVision TARGA (*.tga)
Tagged Image File Format (*.tif ; *.tiff)
Remark: the "tiled tiff" option of tiff 6.0 standard is not supported. In this case, we advise you to save the image in tiff 5.0 standard.
Portable Network Graphics (*.png)
Windows MetaFiles (*.emf ; *.wmf)
Icons (*.ico ; *.icw)
Remarks:
- HQ display (High Quality) available.
- Management of sheets in transparent BMP format (32 bits).
Cursors (*.cur)
Portable Document Format (*.pdf)
Scalable Vector Graphics (*.svg)
WINDEV images (generated by the image editor, *.WDPIC).

The recognized image formats are as follows: GIF, JPEG, PNG or SVG (depending on the browsers).

Type of collapsed/expanded images

The images used can be:

image files,
items of a "Binary Memo" HFSQL data file containing an image.
drawings created by the functions for drawing in the list boxes and combo boxes.

The specified image is proportionally resized to 16 x 16 pixels: in most cases, the height of the image corresponds to the height of TreeView row.

Only the image files can be used. These files must be found in the "<ProjectName>_WEB" directory. These images are not transformed when the page is saved. There is no need to use fWebDir to specify the image path. This path is relative to the "<ProjectName>_WEB" directory.

Remark: The size of images should be set to 16 x 16 pixels (size of small icons).

Component: wd280obj.dll