cftree

name

Required;All

Name for a tree control.

align

Optional;Applet, object

• top
• left
• bottom
• baseline
• texttop
• absbottom
• middle
• absmiddle
• right

appendKey

Optional;All

yes

• yes: if you use cftreeitem href attributes, ColdFusion appends a CFTREEITEMKEY query string variable with the value of the selected tree item to the cfform action URL.
• no: does not append the tree item value to the URL.

bold

Optional;Applet, Flash, HTML

no

• yes: displays tree control text in bold.
• no

border

Optional;Applet, object

yes

• yes: displays a border around the tree control.
• no

cache

Optional;HTML

yes

Applies only if the tree's child treeitem tag uses a bind expression. A Boolean value that specifies whether to get new data each time the user expands tree nodes, as follows:

• yes: fetches a node's child items only once, when the node is first expanded
• no: fetches child items each time the node is expanded.

completePath

Optional;Applet, HTML, object

no

• yes: starts the Form.treename.path variable with the root of the tree path when cftree is submitted.
• no: omits the root level from the Form.treename.path variable; the value starts with the first child node in the tree.
  For the preserveData attribute of cfform to work with the tree, set this attribute to yes. For tree items populated by a query, if you use the cftreeitem queryasroot attribute to specify a root name, that value is returned. If you do not specify a root name, ColdFusion returns the query name.

delimiter

Optional;All

{{\\\\}}

Character to separate elements in the Forms.treename.path variable of the action page.

enabled

Optional;Flash

yes

Flash format only: Boolean value that specifies whether the control is enabled. A disabled control appears in light gray.

font

Optional;Applet, HTML

Font name for text in the tree control.

fontSize

Optional;Applet, Flash, HTML

Font size for text in the tree control, in pixels.

format

Optional;All

applet

• applet: displays the tree using a Java applet in the browser.
• flash: displays the tree using a Flash control
• html: displays the tree uses Ajax-based HTML
• object: returns the tree as a ColdFusion structure with the name specified by the name attribute, For details of the structure contents, see the section object format.
• xml: generates an XML representation of the tree. In XML format forms, includes the generated XML in the form. In HTML format forms, puts the XML in a string variable with the name specified by the name attribute.

height

Optional;Applet, Flash

320(applet only)

Tree control height, in pixels. If you omit this attribute in Flash format, Flash automatically sizes the tree.

highlightHref

Optional;Applet, Object

yes

• yes: highlights as a link the displayed value for any cftreeitem tag that specifies an href attribute.
• no: disables highlighting.

hScroll

Optional;Applet, object

yes

• yes: permits horizontal scrolling.
• no

hSpace

Optional;Applet

Horizontal spacing to left and right of tree control, in pixels.

italic

Optional;Applet, Flash, HTML

no

• yes: displays tree control text in italics.
• no

label

Optional;HTML,

lookAndFeel

Optional;Applet, object

windows

• motif: renders the tree in Motif style.
• windows: renders the tree in Windows style.
• metal: renders the tree in Java Swing style.
  If the platform does not support a style option, the tag uses the default style for the platform.

message

Optional;Applet, HTML

Message to display if validation fails.

notSupported

Optional;Applet

See Description

Text to display if a page that contains a Java applet-based cfform control is opened by a browser that does not support Java or has Java support disabled, for example;"<b> Browser must support Java to view ColdFusion Java Applets</b>"}}Default message:{{<b>Browser must support Java to <br>view ColdFusion Java Applets!</b>

onBlur

Optional;Flash

ActionScript to run when the tree loses focus.

onChange

Optional;Flash

ActionScript to run when the control changes due to user action.
If you specify an onChange event handler, the Form scope of the ColdFusion action page does not automatically get information about selected items. The ActionScript onChange event handler must handle all changes and selections.

onError

Optional;Applet, HTML

A JavaScript function to run if validation fails.

onFocus

Optional;Flash

ActionScript to run when the tree gets focus. The JavaScript DOM form object, value of the name attribute, value that failed validation, and any error text specified by the message attribute are passed to the method.

onValidate

Optional;Applet, HTML

JavaScript function to validate user input. The JavaScript DOM form object, input object, and input object value are passed to the specified routine, which must return true if validation succeeds; false, otherwise.

required

Optional;Applet, Flash, HTML

no

• yes: users must select an item in the tree control.
• no

style

Optional;Flash, HTML

Must be a style specification in CSS format. In HTML format, this attribute corresponds to the value of an HTML style attribute. In Flash format, use the same syntax and contents as used in Flex for the corresponding Flash element.

tooltip

Optional;Flash

Flash format only: Text to display when the mouse pointer hovers over the control.

value

Optional;HTML,

visible

Optional;Flash

yes

Flash format only: Boolean value that specifies whether to show the control. Space that would be occupied by an invisible control is blank.

vScroll

Optional;Applet, object

yes

• yes: permits vertical scrolling.
• no

vSpace

Optional;Applet

Vertical margin above and below tree control, in pixels.

width

Optional;Applet, Flash

200 (applet only)

Tree control width, in pixels. If you omit this attribute in Flash format, Flash automatically sizes the tree.

path

The path through the tree to the selected node, in the form [root]node_1_node_2_\.... In applet format, the path includes the root node only if the completePath attribute is true. In Flash format, the path always includes the root node.

node

The value of the selected tree node.

align

completePath

highlightHref

lookAndFeel

appendKey

delimiter

hScroll

name

bold

fontWeight

italic

vscroll

border

children

This item's child items; an array of item structures.

display

Tree item label, as determined by the cftreeitem display attribute.

expand

Whether to expand the item to display any children; value of cftreeitem expand attribute.

href

The URL to link to when the user selects the item; value of the cftreeitem href attribute.

img

The tree image icon Image to display as an icon for the tree item; value of cftreeitem img attribute. You can use the img attribute to display custom icons only in the Applet version; not in the Flash version.

imgOpen

Image to display when the tree item is open (expanded); value of cftreeitem imgopen attribute.

parent

Value of this item's parent item in the tree.

path

The node path from the tree root to the current element.

queryAsRoot

Whether the query is the root of the item; value of cftreeitem queryAsRoot attribute.

target

The link target, such as _blank; value of the item's cftreeitem target attribute.

value

The item's value, as determined by the cftreeitem value attribute.