Programmer Guide/Macro Library/SHOWITEM: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:ShowItem - Display shell item properties and/or data}} | {{DISPLAYTITLE:ShowItem - Display shell item properties and/or data}} | ||
SHOWITEM itemname [ ; <var>title</var> ] | SHOWITEM itemname [ ; <var>title</var> ] | ||
:Show properties or data of the [[Programmer_Guide/Shell_Items|shell item]] <var>itemname</var> in a popup dialog. | :Show properties or data of the [[Programmer_Guide/Shell_Items|shell item]] <var>itemname</var> in a popup dialog. | ||
| Line 21: | Line 20: | ||
The displayed data depend on the type of the shell item <var>itemname</var>. | The displayed data depend on the type of the shell item <var>itemname</var>. | ||
;[[Programmer_Guide/Shell_Items/Table|''simple'' table]]: The content (data entries) of the table is displayed. The conext menu functions can be used to copy or save the data. | ;[[Programmer_Guide/Shell_Items/Table|''simple'' table]]: The content (data entries) of the table is displayed. The conext menu functions can be used to copy or save the data. | ||
;[[Programmer_Guide/Shell_Items/Table|''extended'' table and ''parameter'' table]]: The content of the table can be displayed in 3 formats ('''Format=read''', '''Format=write''', '''default'''). If the format '''default''' is selected, the table fields are displayed in separate columns. Also the field definitions ('''Field Defs.''') can be displayed. The different formats are selected in the context menu, which also implements functions to copy or save the table content. | ;[[Programmer_Guide/Shell_Items/Table|''extended'' table and ''parameter'' table]]: The content of the table can be displayed in 3 formats ('''Format=read''', '''Format=write''', '''default'''). If the format '''default''' is selected, the table fields are displayed in separate columns. Also the field definitions ('''Field Defs.''') can be displayed. The different formats are selected in the context menu, which also implements functions to copy or save the table content. Tagged entries are selected. | ||
;[[Programmer_Guide/Shell_Items/Value|value]]: Display the numerical data hold by the value item. The conext menu functions can be used to copy or save the data. | ;[[Programmer_Guide/Shell_Items/Value|value]]: Display the numerical data hold by the value item. The conext menu functions can be used to copy or save the data. | ||
;[[Programmer_Guide/Shell_Items/File|''text'' file and ''xml'' file]]: Display the content of the file item. Text files are displayed as a list (line by line) and the elements of xml files are displayed as a tree. | ;[[Programmer_Guide/Shell_Items/File|''text'' file and ''xml'' file]]: Display the content of the file item. Text files are displayed as a list (line by line) and the elements of xml files are displayed as a tree. | ||
;[[Programmer_Guide/Shell_Items/File|''section'' file]]: A list of all sections of the file is displayed, and the content of each section can be viewed in a text window. | |||
Latest revision as of 10:16, 10 January 2017
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.
- 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 and parameter table
- The content of the table can be displayed in 3 formats (Format=read, Format=write, default). If the format default is selected, the table fields are displayed in separate columns. Also the field definitions (Field Defs.) can be displayed. The different formats are selected in the context menu, which also implements functions to copy or save the table content. Tagged entries are selected.
- value
- Display the numerical data hold by the value item. The conext menu functions can be used to copy or save the data.
- text file and xml file
- Display the content of the file item. Text files are displayed as a list (line by line) and the elements of xml files are displayed as a tree.
- section file
- A list of all sections of the file is displayed, and the content of each section can be viewed in a text window.
