Programmer Guide/Macro Library/SHOWITEM: Difference between revisions

From STX Wiki
Jump to navigationJump to search
m (1 revision: Initial import)
No edit summary
Line 1: Line 1:
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
{{DISPLAYTITLE:ShowItem - Display shell item properties and/or data}}
==SHOWITEM==


Provides a way of viewing shell items. Currently <code>WAVE</code>, <code>TABLE</code>, <code>VALUE</code> and <code>FILE</code> items are supported.
SHOWITEM itemname [ ; <var>title</var> ]
:Show properties or data of the shell item <var>itemname</var> in a popup dialog.


=====Usage:=====
{|class="einrahmen"
!argument !!description
|-
|<var>itemname</var>
|The name of the shell item to be displayed
|-
|<var>title</var>
|The dialog window caption
|-
!RESULT !!description
|-
|''undefined'' || the return value of this macro is undefined and should always be ignored
|}


<code>SHOWITEM <var>item</var> [; <var>title</var>]</code>
:The displayed data depend on the type of the shell item <var>itemname</var>.
 
;tables simple table: The content (data entries) of the table is displayed. The conext menu functions can be used to copy or save the data.
<code>SHOWITEM <var>numericItem</var> [; <var>title</var> ; <var>wndPos</var> ]</code>
;extended table, parameter table:
 
<code>SHOWITEM <var>tableItem</var> [; <var>title</var> ; <var>text</var> ; <var>width</var> ; <var>font</var> ; <var>wndPos</var>]</code>
 
=====Parameters:=====
 
itemThe id of a shell item.tableItemThe id of a table item.numericItemThe id of a numeric item.titleThe string to use as the title of the dialog.textA string to be shown at the top of the dialog (but below the title). This parameter is ignored if the table is a parameter table.widthThe width of the table listbox. This parameter is ignored if the table is a parameter table.fontThe font to use for the table listbox. This parameter is ignored if the table is a parameter table.;<var>wndPos</var>
 
The position at which to display the window. These are the four values 'x y w h' as used by [[Programmer Guide/Macro Library/SETWINDOWPOS|SetWindowPos]].=====Result:=====
 
An empty string.
 
=====Notes:=====
 
This macro replaces <code>SHOWTABLE</code> and <code>SHOWFILE</code> as of version 3.7.0.
 
Vector and array value items as well as parameter table items are shown using the same method as numeric tables.

Revision as of 12:56, 8 February 2016


SHOWITEM itemname [ ; title ]
Show properties or data of the shell item itemname in a popup dialog.
argument description
itemname The name of the shell item to be displayed
title The dialog window caption
RESULT description
undefined the return value of this macro is undefined and should always be ignored
The displayed data depend on the type of the shell item itemname.
tables simple table
The content (data entries) of the table is displayed. The conext menu functions can be used to copy or save the data.
extended table, parameter table
Retrieved from "https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=Programmer_Guide/Macro_Library/SHOWITEM&oldid=8920"

Navigation menu

Personal tools