API System.ShowHandle - Revision history

Wiki bot at 11:55, 16 January 2023

2023-01-16T11:55:32Z

Wiki bot at 11:42, 16 January 2023

2023-01-16T11:42:04Z

JonnyW: XML import

2014-01-16T15:58:00Z

XML import

JonnyW: XML import of API documentation

2013-08-09T14:27:43Z

XML import of API documentation

JonnyW at 10:52, 1 July 2013

2013-07-01T10:52:54Z

JonnyW: XML import of updated API docs

2013-06-17T09:58:28Z

XML import of updated API docs

New page

<sidebar>API contents</sidebar>
Given a handle to an object with viewable presence, shows that object on screen

<div style="width:25%; float:right" class="toc">
====Class hierarchy====
[[API System|System]]
:[[API System|ShowHandle]]
</div>
__TOC__

==Parameters==
[[Variable Types|HANDLE]] ''Handle''
:The object to display on screen

==Return value==
[[Variable Types|BOOL]]

Returns true if the operation is a success, else false

==Detailed description==
''<span style="color:red;">No additional information</span>''

==Examples==
===Calling in a calculation===
* Declare a variable 'result' of type BOOL
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.ShowHandle(handle)</pre>

''<span style="color:red;">No additional examples</span>''

← Older revision		Revision as of 11:55, 16 January 2023
Line 52:		Line 52:
	* Declare a variable 'result' of type BOOL		* Declare a variable 'result' of type BOOL
	* Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.ShowHandle(handle)</pre>		* Add to a calculation icon: <pre class="brush:[cpp]">result = ::System.ShowHandle(handle)</pre>
−
−	~~''<span style="color:red;">No additional examples</span>''~~

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Given a handle to an object with viewable presence, shows that object on screen
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ShowHandle'''
-====Class hierarchy====
+|-
-[[API System|System]]
+| colspan="2" | Given a handle to an object with viewable presence, shows that object on screen&nbsp;
-:[[API System|ShowHandle]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Handle
-==Parameters==
+|-
-[[Variable Types|HANDLE]] ''Handle''
+| colspan="2" | The object to display on screen&nbsp;
-:The object to display on screen
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
-==Return value==
+|}

← Older revision		Revision as of 15:58, 16 January 2014
Line 1:		Line 1:
−
−
	<sidebar>API Contents</sidebar>		<sidebar>API Contents</sidebar>
	Given a handle to an object with viewable presence, shows that object on screen		Given a handle to an object with viewable presence, shows that object on screen

← Older revision		Revision as of 14:27, 9 August 2013
Line 1:		Line 1:


−	<sidebar>API ~~contents~~</sidebar>	+	<sidebar>API Contents</sidebar>
	Given a handle to an object with viewable presence, shows that object on screen		Given a handle to an object with viewable presence, shows that object on screen

← Older revision		Revision as of 10:52, 1 July 2013
Line 23:		Line 23:

	==Detailed description==		==Detailed description==
−	''~~<span style~~="~~color:red;~~"~~>No additional information<~~/~~span>''~~	+	This tells Flowcode to show whatever object is represented by ''Handle''.
		+
		+
		+	The types of object that are supported are:
		+	{\| class="wikitable"
		+	\|-
		+	!Handle type
		+	!Result of this call
		+	\|-
		+	\|Component
		+	\|Moves the camera in its current viewing plane over the components position
		+	If the panel (system or dashboard) the component exists on is not shown, this will open that window
		+	\|-
		+	\|Position
		+	\|Behaves as though a component, and moves the camera to look at that position
		+	\|-
		+	\|LinkBar
		+	\|Behaves as though a component, and moves the camera to look at the center of the link
		+	\|-
		+	\|Point cloud
		+	\|Behaves as though a component, and moves the camera to look at the center of the cloud
		+	\|-
		+	\|Console
		+	\|Opens the console window and selects the appropriate console tab
		+	\|-
		+	\|Scope group/stream
		+	\|Opens the data scope window to show the scope
		+	\|}