ControlTreeView - Revision history

Jaberwocky6669 at 16:15, 23 August 2013

2013-08-23T16:15:23Z

← Older revision		Revision as of 16:15, 23 August 2013
Line 1:		Line 1:
	~~==Description==~~		<!-- Autogenerated Wiki Page. -->
	~~Sends a command~~ to ~~a TreeView32 control~~.		<!-- Not meant to be user editable. -->
			<!-- If there is an error here then that means that there is an error in the helpfile. -->
			<!-- Report it to Trac with category 'Documentation'. -->
			<!-- See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->
			<font face='Segoe UI, Courier New, Lucida Grande, Verdana, Helvetica, sans-serif'>

	<~~pre~~>		<font size='3' weight='normal'>Sends a command to a TreeView32 control.</font>
	~~ControlTreeView ( "title", "text", controlID, "~~command~~" [, option1 [, option2]] )~~
	</~~pre~~>

	==Parameters==		<font face='Courier New'><div id='Syntax' style='background-color:#FFFFAA;'>
	{\| ~~border='1'~~ class='wikitable'
	\| title \|\| The title/hWnd/class of the window to access.
			:ControlTreeView ( "title", "text", controlID, "command" [, option1 [, option2]] )


			</div></font>



			===<font size=4><div id='Section' style='color:#DB7100;'>Parameters</div></font>===
			{\| class='wikitable'
			\|-
			\| title \|\| The title/hWnd/class of the window to access. See [http://www.autoitscript.com/autoit3/docs/intro/windowsadvanced.htm Title special definition].
	\|-		\|-
	\| text \|\| The text of the window to access.		\| text \|\| The text of the window to access.
	\|-		\|-
	\| controlID \|\| The control to interact with. See [[Controls]]		\| controlID \|\| The control to interact with. See [http://www.autoitscript.com/autoit3/docs/intro/controls.htm Controls].
	\|-		\|-
	\| command \|\| The command to send to the control (see below).		\| command \|\| The command to send to the control (see below).
	\|-		\|-
	\| option1 \|\| [optional] Additional parameter required by some commands.		\| option1 \|\| '''[optional]''' Additional parameter required by some commands.
	\|-		\|-
	\| option2 \|\| [optional] Additional parameter required by some commands.		\| option2 \|\| '''[optional]''' Additional parameter required by some commands.
	\|}		\|}

	~~==Return Value==~~
	~~Depends on command as table below shows. In case of an error (such as an invalid command or window/control could not be found) then @error is set to 1.~~

	~~{\| border~~='1' class='wikitable'		===<font size=4><div id='Section' style='color:#DB7100;'>Return Value</div></font>===
	! ~~scope='col'~~ \| '''Command''', '''Option1''', '''Option2'''		Depends on the command as table below shows. In case of an error (such as an invalid command or window/control could not be found) then @error is set to 1.

			{\| class='wikitable'
			! \| '''Command''', '''Option1''', '''Option2'''
	\|}		\|}

Line 39:		Line 53:

	Each "level" is separated by \|. An index is preceded with #. Examples:		Each "level" is separated by \|. An index is preceded with #. Examples:
	{\| ~~border='1'~~ class='wikitable'		{\| class='wikitable'
	! ~~scope=~~'~~col~~' ~~\| <b>~~Item~~</b>~~		! \| '''Item'''
	! ~~scope=~~'~~col~~' ~~\| <b>~~Item Reference~~</b>~~		! \| '''Item Reference'''
	\|-		\|-
	\| Heading2 \|\| "Heading2" or "#1"		\| Heading2 \|\| "Heading2" or "#1"
Line 51:		Line 65:
	References can also be mixed like "Heading1\|#1".		References can also be mixed like "Heading1\|#1".

	==Remarks==

			===<font size=4><div id='Section' style='color:#DB7100;'>Remarks</div></font>===
	As AutoIt is a 32-bit application some commands are not available when referencing a 64-bit application as Explorer when running on 64-bit Windows.		As AutoIt is a 32-bit application some commands are not available when referencing a 64-bit application as Explorer when running on 64-bit Windows.

	==Related==

			===<font size=4><div id='Section' style='color:#DB7100;'>Related</div></font>===
	[[ControlCommand]]		[[ControlCommand]]

	==Example==

			===<font size=4><div id='Section' style='color:#DB7100;'>Example</div></font>===
	<syntaxhighlight lang='autoit'>		<syntaxhighlight lang='autoit'>
	#include <GUIConstantsEx.au3>		#include <GUIConstantsEx.au3>
Line 98:		Line 118:
	EndFunc ;==>Example		EndFunc ;==>Example
	</syntaxhighlight>		</syntaxhighlight>
			</font>
	__NOTOC__		__NOTOC__
			__NOEDITSECTION__

Jaberwocky6669 at 07:31, 18 August 2013

2013-08-18T07:31:30Z

← Older revision		Revision as of 07:31, 18 August 2013
Line 2:		Line 2:
	Sends a command to a TreeView32 control.		Sends a command to a TreeView32 control.

	~~==Syntax==~~		<pre>
	<~~syntaxhighlight lang='autoit'~~>
	ControlTreeView ( "title", "text", controlID, "command" [, option1 [, option2]] )		ControlTreeView ( "title", "text", controlID, "command" [, option1 [, option2]] )
	</~~syntaxhighlight~~>		</pre>


	==Parameters==		==Parameters==
Line 14:		Line 12:
	\| text \|\| The text of the window to access.		\| text \|\| The text of the window to access.
	\|-		\|-
	\| controlID \|\| The control to interact with. See [[Controls]]		\| controlID \|\| The control to interact with. See [[Controls]]
	\|-		\|-
	\| command \|\| The command to send to the control (see below).		\| command \|\| The command to send to the control (see below).
Line 21:		Line 19:
	\|-		\|-
	\| option2 \|\| [optional] Additional parameter required by some commands.		\| option2 \|\| [optional] Additional parameter required by some commands.
	\|-
	\|}		\|}

	==~~ReturnValue~~==		==Return Value==
	Depends on command as table below shows. In case of an error (such as an invalid command or window/control could not be found) then @error is set to 1.		Depends on command as table below shows. In case of an error (such as an invalid command or window/control could not be found) then @error is set to 1.

	{\| border='1' class='wikitable'		{\| border='1' class='wikitable'
	~~<b>~~Command, Option1, Option2~~</b>~~		! scope='col' \| '''Command''', '''Option1''', '''Option2'''
	~~\| option2 \|\| <b>Operation</b>~~
	\|-
	~~\| "Check", "item" \|\| Checks an item (if the item supports it).~~
	\|-
	~~\| "Collapse", "item" \|\| Collapses an item to hide its children.~~
	\|-
	~~\| "Exists", "item" \|\| Returns 1 if an item exists, otherwise 0.~~
	\|-
	~~\| "Expand", "item" \|\| Expands an item to show its children.~~
	\|-
	~~\| "GetItemCount", "item" \|\| Returns the number of children for a selected item.~~
	\|-
	~~\| "GetSelected" [, UseIndex] \|\| Returns the item reference of the current selection using the text reference of the item (or index reference if UseIndex is set to 1).~~
	\|-
	~~\| "GetText", "item" \|\| Returns the text of an item.~~
	\|-
	~~\| "IsChecked" \|\| Returns the state of an item. 1:checked, 0:unchecked, -1:not a checkbox.~~
	\|-
	~~\| "Select", "item" \|\| Selects an item.~~
	\|-
	~~\| "Uncheck", "item" \|\| Unchecks an item (if the item supports it).~~
	\|-
	\|}		\|}

	The "item" parameter is a string-based parameter that is used to reference a particular treeview item using a combination of text and indices. Indices are 0-based. For example:		The "item" parameter is a string-based parameter that is used to reference a particular treeview item using a combination of text and indices. Indices are 0-based. For example:

	~~<br>~~Heading1		Heading1
	----> H1SubItem1		----> H1SubItem1
	----> H1SubItem2		----> H1SubItem2
Line 63:		Line 38:
	Heading3		Heading3

	~~<br>~~Each "level" is separated by \|. An index is preceded with #. Examples:		Each "level" is separated by \|. An index is preceded with #. Examples:
	{\| border='1' class='wikitable'		{\| border='1' class='wikitable'
	!! scope='col' \| Item		! scope='col' \| <b>Item</b>
	!! scope='col' \| Item Reference		! scope='col' \| <b>Item Reference</b>
	\|-
	~~\| Heading \|\| "Heading2" or "#1"~~
	\|-		\|-
	\| ~~H1SubItem2~~ \|\| "~~Heading1\|H1SubItem2~~" or "~~#0\|~~#1"		\| Heading2 \|\| "Heading2" or "#1"
	\|-		\|-
	\| ~~H1S1SubItem1~~ \|\| "Heading1\|~~H1SubItem3\|H1S1SubItem1~~" or "#0\|#~~2\|#0~~"		\| H1SubItem2 \|\| "Heading1\|H1SubItem2" or "#0\|#1"
	\|-		\|-
			\| H1S1SubItem1 \|\| "Heading1\|H1SubItem3\|H1S1SubItem1" or "#0\|#2\|#0"
	\|}		\|}
	References can also be mixed like "Heading1\|#1".		References can also be mixed like "Heading1\|#1".


	==Remarks==		==Remarks==
	As AutoIt is a 32-bit application some commands are not available when referencing a 64-bit application as Explorer when running on 64-bit Windows.		As AutoIt is a 32-bit application some commands are not available when referencing a 64-bit application as Explorer when running on 64-bit Windows.


	==Related==		==Related==
	[[ControlCommand]]		[[ControlCommand]]



	==Example==		==Example==
Line 128:		Line 98:
	EndFunc ;==>Example		EndFunc ;==>Example
	</syntaxhighlight>		</syntaxhighlight>

			__NOTOC__

Jaberwocky6669 at 17:41, 15 August 2013

2013-08-15T17:41:05Z

← Older revision		Revision as of 17:41, 15 August 2013
Line 65:		Line 65:
	<br>Each "level" is separated by \|. An index is preceded with #. Examples:		<br>Each "level" is separated by \|. An index is preceded with #. Examples:
	{\| border='1' class='wikitable'		{\| border='1' class='wikitable'
	!! scope='col' \| Item\| Heading \|\| "Heading2" or "#1"		!! scope='col' \| Item
			!! scope='col' \| Item Reference
			\|-
			\| Heading \|\| "Heading2" or "#1"
	\|-		\|-

	\| H1SubItem2 \|\| "Heading1\|H1SubItem2" or "#0\|#1"		\| H1SubItem2 \|\| "Heading1\|H1SubItem2" or "#0\|#1"
	\|-		\|-

	\| H1S1SubItem1 \|\| "Heading1\|H1SubItem3\|H1S1SubItem1" or "#0\|#2\|#0"		\| H1S1SubItem1 \|\| "Heading1\|H1SubItem3\|H1S1SubItem1" or "#0\|#2\|#0"
	\|-		\|-

	\|}		\|}
	References can also be mixed like "Heading1\|#1".		References can also be mixed like "Heading1\|#1".

Jaberwocky6669 at 17:31, 15 August 2013

2013-08-15T17:31:26Z

← Older revision		Revision as of 17:31, 15 August 2013
Line 67:		Line 67:
	!! scope='col' \| Item\| Heading \|\| "Heading2" or "#1"		!! scope='col' \| Item\| Heading \|\| "Heading2" or "#1"
	\|-		\|-

	\| H1SubItem2 \|\| "Heading1\|H1SubItem2" or "#0\|#1"		\| H1SubItem2 \|\| "Heading1\|H1SubItem2" or "#0\|#1"
	\|-		\|-

	\| H1S1SubItem1 \|\| "Heading1\|H1SubItem3\|H1S1SubItem1" or "#0\|#2\|#0"		\| H1S1SubItem1 \|\| "Heading1\|H1SubItem3\|H1S1SubItem1" or "#0\|#2\|#0"
	\|-		\|-

	\|}		\|}
	References can also be mixed like "Heading1\|#1".		References can also be mixed like "Heading1\|#1".

Jaberwocky6669: Created page with "==Description== Sends a command to a TreeView32 control. ==Syntax== ControlTreeView ( "title", "text", controlID, "command" [, option1 [, opti..."

2013-08-15T17:24:48Z

Created page with "==Description== Sends a command to a TreeView32 control. ==Syntax== <syntaxhighlight lang='autoit'> ControlTreeView ( "title", "text", controlID, "command" [, option1 [, opti..."

New page

==Description==
Sends a command to a TreeView32 control.

==Syntax==
<syntaxhighlight lang='autoit'>
ControlTreeView ( "title", "text", controlID, "command" [, option1 [, option2]] )
</syntaxhighlight>

==Parameters==
{| border='1' class='wikitable'
| title || The title/hWnd/class of the window to access.
|-
| text || The text of the window to access.
|-
| controlID || The control to interact with. See [[Controls]]
|-
| command || The command to send to the control (see below).
|-
| option1 || [optional] Additional parameter required by some commands.
|-
| option2 || [optional] Additional parameter required by some commands.
|-
|}

==ReturnValue==
Depends on command as table below shows. In case of an error (such as an invalid command or window/control could not be found) then @error is set to 1.

{| border='1' class='wikitable'
Command, Option1, Option2
| option2 || Operation
|-
| "Check", "item" || Checks an item (if the item supports it).
|-
| "Collapse", "item" || Collapses an item to hide its children.
|-
| "Exists", "item" || Returns 1 if an item exists, otherwise 0.
|-
| "Expand", "item" || Expands an item to show its children.
|-
| "GetItemCount", "item" || Returns the number of children for a selected item.
|-
| "GetSelected" [, UseIndex] || Returns the item reference of the current selection using the text reference of the item (or index reference if UseIndex is set to 1).
|-
| "GetText", "item" || Returns the text of an item.
|-
| "IsChecked" || Returns the state of an item. 1:checked, 0:unchecked, -1:not a checkbox.
|-
| "Select", "item" || Selects an item.
|-
| "Uncheck", "item" || Unchecks an item (if the item supports it).
|-
|}

The "item" parameter is a string-based parameter that is used to reference a particular treeview item using a combination of text and indices. Indices are 0-based. For example:

 Heading1
----> H1SubItem1
----> H1SubItem2
----> H1SubItem3
----> ----> H1S1SubItem1
Heading2
Heading3

 Each "level" is separated by |. An index is preceded with #. Examples:
{| border='1' class='wikitable'
!! scope='col' | Item| Heading || "Heading2" or "#1"
|-
| H1SubItem2 || "Heading1|H1SubItem2" or "#0|#1"
|-
| H1S1SubItem1 || "Heading1|H1SubItem3|H1S1SubItem1" or "#0|#2|#0"
|-
|}
References can also be mixed like "Heading1|#1".

==Remarks==
As AutoIt is a 32-bit application some commands are not available when referencing a 64-bit application as Explorer when running on 64-bit Windows.

==Related==
[[ControlCommand]]

==Example==
<syntaxhighlight lang='autoit'>
#include <GUIConstantsEx.au3>
#include <TreeViewConstants.au3>
#include <WindowsConstants.au3>

Example()

Func Example()
Local $hGUI = GUICreate("ControlTreeView Example", 212, 212)
Local $iTreeView_1 = GUICtrlCreateTreeView(6, 6, 200, 160, BitOR($TVS_HASBUTTONS, $TVS_HASLINES, $TVS_LINESATROOT, $TVS_CHECKBOXES), $WS_EX_CLIENTEDGE)
Local $hTreeView_1 = ControlGetHandle($hGUI, "", $iTreeView_1)

Local $iRoot = GUICtrlCreateTreeViewItem("Root", $iTreeView_1)
GUICtrlCreateTreeViewItem("Item 1", $iRoot)
GUICtrlCreateTreeViewItem("Item 2", $iRoot)
GUICtrlCreateTreeViewItem("Item 3", $iRoot)
Local $iItem_4 = GUICtrlCreateTreeViewItem("Item 4", $iRoot)
GUICtrlCreateTreeViewItem("Item 4.1", $iItem_4)
GUICtrlCreateTreeViewItem("Item 4.2", $iItem_4)
GUICtrlCreateTreeViewItem("Item 5", $iRoot)

GUISetState(@SW_SHOW, $hGUI)

ControlTreeView($hGUI, "", $hTreeView_1, "Expand", "Root")

ControlTreeView($hGUI, "", $hTreeView_1, "Exists", "Root|Item 4")
ControlTreeView($hGUI, "", $hTreeView_1, "Check", "Root|Item 4")
ControlTreeView($hGUI, "", $hTreeView_1, "Select", "Root|Item 4")
ControlTreeView($hGUI, "", $hTreeView_1, "Expand", "Root|Item 4")

While 1
Switch GUIGetMsg()
Case $GUI_EVENT_CLOSE
ExitLoop
EndSwitch
WEnd

GUIDelete($hGUI)
EndFunc ;==>Example
</syntaxhighlight>