ModifyBrowser

ModifyBrowser [/M] [ keyword = value [, keyword = value ...] ]

The ModifyBrowser operation modifies the state of the Data Browser according to the specified keywords.

If the /M flag is present, the ModifyBrowser command applies to the modal data browser. Otherwise it applies to the regular data browser. See CreateBrowser for a discussion of modal versus regular.

The order in which keywords in a single command are executed is undefined. If the behavior of one keyword depends on another keyword being executed first, use multiple ModifyBrowser commands instead of using both keywords in one command.

Flags

/M	Modifies the modal data browser, if one has been created using CreateBrowser/M. An error will result if no modal data browser has been created.

Keywords

animation=mode	Controls the display of 3D and 4D waves in the plot pane of the Data Browser.
	Use mode=0 to stop the animation and mode=1 to start animation. "Animation" refers the the sequencing through the various layers of the 3D or 4D wave.
appendUserButton={buttonName,buttonCmdStr [,options]}
	Appends a user-defined button below the Execute Cmd button in the Data Browser window.
	buttonName must be valid as an Igor liberal name. It is used as the button's title as well as its name.
	buttonCmdStr is a standard Data Browser command string as described for the command1 keyword. The command can apply to the current selection in the Data Browser's main list, using %s to represent the selected item or items, or it can be completely independent.
	options is defined as follows:
	0: Delete button on new experiment (default) 1: Retain button on new experiment
	All other values are reserved for future use.
	New buttons are appended below the currently existing buttons and the Data Browser's window is sized to accomodate them. Don't add too many buttons or the window height will exceed the screen height.
	If you use appendUserButton with a button name that already exists, the new buttonCmdStr and options are applied to the already existing button.
	For more information see the documentation for the keyword deleteUserButton and Managing Data Browser User-Defined Buttons.
	appendUserButton is not allowed when the /M flag is used.
aspectRatio=mode	Controls the aspect ratio of image plots in the plot pane.
	mode =0: Scales the image to fill the pane. mode =1: Retaining the original image aspect ratio.
case=state	Controls the case sensitivity of the find and select operations.
	state =0: Case-insensitive state =1: Case-sensitive
	This setting is saved in preferences and remembered between sessions.
clearSelection	Deselects any selected items.
close	Closes the Data Browser. If an exit command is specified, the Data Browser executes the command before it is closed.
collapse=lineNum	lineNum is the zero-based line number of the data folder icon to collapse. The line number to use for a given data folder depends on the current sorting, filtering, and data folder expansion state of the browser.
collapseAll	Collapses all visible data folders.
command1=cmdStr	cmdStr contains the command that you want the Data Browser to execute when the executeCmd keyword is executed. It is the main command that is executed on selections.
	See Data Browser Command String Limitations for further discussion.
command2=cmdStr	cmdStr contains the secondary command that the Data Browser executes when the list of selected items exceeds the maximum command length and bit 1 of executeMode is set. command2 is ignored when command1 is empty.
	See Data Browser Command String Limitations for further discussion.
command3=cmdstr	cmdStr contains the command that the Data Browser executes each time the current data folder is changed from within the Data Browser.
dataFolderHistory=h	h is a bitwise setting that controls the printing of messages in the history area of the command window.
	Bit 0: Print a command in the history each time you change the current data folder from within the Data Browser. Bit 1: Print the name of the experiment from which data is loaded using the Browse Expt button.
	See Setting Bit Parameters for details about bit settings.
	This setting is saved in preferences and remembered between sessions.
deleteUserButton=buttonName
	Use this keyword to delete a named user button. This keyword is not allowed when the /M flag is used.
deleteAllUserButtons	Deletes all user buttons.
echoCommands=mode	Set mode to zero to prevent printing of Data Browser-generated commands in the history area of the command window. This setting is saved in preferences and remembered between sessions.
executeCmd	Executes the Data Browser commands set using the command1 and command2 keywords on the current selection.
	See Data Browser Command String Limitations for details.
executeExitCmd	Execute the exit command if one exists. This does not close the Data Browser.
executeMode=mode	mode is a bitwise setting that controls the execution of commands specified by the command1 and command2 keywords.
	Bit 0: Executes command1 on each selected item, one-at-a-time. This is the default setting. Bit 1: Execute the commands on the entire list of selected items at once, if possible. The command specified by command1 is executed first. If the list of all selected items exceeds the maximum command length, the command specified by command2 is executed on the remaining selections. Bit 2: If set, when the user clicks the Execute Cmds button, the commands are executed without displaying the Execute on Browser selection dialog.
	See Setting Bit Parameters for details about bit settings.
exitCommand=cmdStr	cmdStr contains the command that you want the Data Browser to execute before it is closed via the command line using close or executeExitCmd keywords.
	This command is not executed if the user closes the Data Browser using the close boc.
	If the browser is modal, the exit command is executed only if command1 is empty or if the ModifyBrowser/M executeExitCmd keyword is used.
expand=lineNum	lineNum is the zero-based line number of the data folder icon to expand. The line number to use for a given data folder depends on the current sorting, filtering, and data folder expansion state of the browser.
expandAll	Expands all visible data folders as well as the top data folder.
find=findStr	Finds an item in the Data Browser list. If a matching object is found, the item is scrolled into view, if necessary.
	The match depends on the case-sensitivity and-whole word settings. See the case and wholeWord keywords.
	Repeated applications of the command are equivalent to using the Find Same command in the menu. The find command uses the same settings that are set in the Find in Data Browser dialog which you access by choosing Edit→Find.
infoFont=fontNameStr	Sets the font for the information pane. This setting is saved in preferences and remembered between sessions. Pass "" for fontNameStr to use the default font.
infoFontSize=size	Sets the size in points of the text in the information pane. This setting is saved in preferences and remembered between sessions. Pass -1 for size to use the default font size.
palette=palName	Sets the color table used for displaying plots of 2D, 3D, and 4D data in the plot pane. palName is a name of one of the built-in color tables listed in Color Table Details.
saveExpandedFolders	Creates a text wave named DB_FolderReference that contains the full unquoted paths to all expanded data folders. The first entry in the text wave is empty and represents the current top data folder displayed in the browser. You can use the paths stored in this wave with the function GetBrowserLine to obtain the line in which the expanded data folder is displayed.
saveOnlyDisplayedTypes=mode
	Controls what happens when you click the Save Copy button.
	mode =0: All types will be saved even if they are not displayed. mode =1: Only displayed types are saved.
	This setting is saved in preferences and remembered between sessions.
select=findStr	Selects all item names that match findStr.
	The match depends on the case-sensitivity and-whole word settings. See the case and wholeWord keywords.
selectList=strList	Toggles the selection state of all items specified in strList , a semicolon-separated list containing the full path for each data object. strList must be terminated with a semicolon. Liberal names may be quoted but quoting is not required.
setDataFolder=path	Sets the top data folder. This is equivalent to double-clicking the data folder icon. path is a full path to the data folder. This does not change Igor's current data folder. Liberal names may be quoted but quoting is not required.
setDefaults	Overwrites user Data Browser preferences with factory defaults. All user-defined buttons are also deleted.
showInfo=mode	Controls the visibility of the info pane.
	mode =0: Hides the info pane. mode =1: Shows the info pane.
	This setting is saved in preferences and remembered between sessions.
showModalBrowser	When used with the /M flag, shows the modal data browser, previously created by CreateBrowser/M, and waits for the user to click the OK or Cancel button. This keyword is only allowed when the /M flag is used. See CreateBrowser for details.
showPlot=mode	Controls the visibility of the plot pane.
	mode =0: Hides the plot pane. mode =1: Shows the plot pane.
	This setting is saved in preferences and remembered between sessions.
showStrs=mode	Controls the visibility of string variables.
	mode =0: Hides string variables. mode =1: Shows string variables.
	This setting is saved in preferences and remembered between sessions.
showVars=mode	Controls the visibility of numeric variables.
	mode =0: Hides numeric variables. mode =1: Shows numeric variables.
	This setting is saved in preferences and remembered between sessions.
showWaves=mode	Controls the visibility of waves.
	mode =0: Hides waves. mode =1: Shows waves.
	This setting is saved in preferences and remembered between sessions.
showWaveStats=mode	Controls what is displayed in the info pane.
	mode =0: Shows general information for the wave. mode =1: Shows statistics for the wave.
	This setting is saved in preferences and remembered between sessions.
slashK=k	Controls the kill mode used when the Data Browser creates a window such as a table, graph or Gizmo plot.
	k =0: Normal with dialog (default). k =1: Kills with no dialog. k =2: Disables killing. k =3: Hides the window.
sort=sortKey	Controls the sorting of items.
	mode =0: Sort by creation time. mode =1: Sort by name. mode =2: Sort by name and data type.
startLine=lineNum	lineNum is the zero-based line number from which the next find operation is started if there is no selection. If there is a selection, the first selected line is used as the starting line and lineNum is ignored.
	The lineNum to use for any given data folder may change depending on the current sorting and filtering of the browser and which data folders are expanded.
topLine=lineNum	Moves lineNum so that it is visible in the browser. If there are enough items below lineNum, it is positioned so that it is the top line in the browser. This keyword does not affect the expanded state of data folders.
	If necessary, lineNum is clipped to the largest line number in the browser.
	The lineNum to use for any given data folder may change depending on the current sorting and filtering of the browser.
wholeWord=state	Controls the whole-word behavior of the find and select operations.
	state =0: The find and select keywords match items whose names contain the specified search string state =1: The find and select keywords match items whose names equal the specified search string.
	This setting is saved in preferences and remembered between sessions.

Output Variables

ModifyBrowser creates two outputs, V_Flag and S_BrowserList, each time it is executed. The values of these outputs are meaningful only when you use the showModalBrowser keyword with the /M flag after creating a modal data browser using CreateBrowser/M.

These output variables are local when CreateBrowser is executed from a procedure. There is no reason for you to show the modal data browser from the command line, but if you do, the output variables are global and are created in the current data folder at the time the ModifyBrowser operation was invoked with the showModalBrowser keyword.

V_flag	Set to 1 if the user clicks the OK button.
	Set to 0 if the user clicks the Cancel button or the window's close button.
S_BrowserList	Contains a semicolon-separated list of the full path, quoted if necessary, of each selected item. The order of items in the list is undefined.

See Also

The Data Browser, CreateBrowser, GetBrowserSelection