2.14.2.18 pe_dir


Brief Information

List Project Explorer subfolders and windows

Additional Information

X-Function not designed for Auto GetN Dialog.

Command Line Usage

1. pe_dir;

2. pe_dir page:=W;

3. pe_dir name:=B*

4. pe_dir name:="B*" recursive:=1 display:=1 sensitive:=1;

5. pe_dir recursive:=1 display:=1 sep:=##;

Variables

Display
Name
Variable
Name
I/O
and
Type
Default
Value
Description
Page Name name

Input

string

name of the desired page; "*" will match all the pages

Page Type page

Input

string

W = Workbook, G = Graph

Output Name oname

Output

string

names of the pages found

Recursive recursive

Input

int

0

Specify whether to search the subfolders for files.
Option lists:

  • 0
Do not search the subfolders.
  • 1
Search the subfolders.
Display display

Input

int

0

Specify the list display form. Only available when recursive=1.
Option lists:

  • 0
Display as the tree list.
  • 1
Display as the tree list with description. (For the folders, the description is Comments; for the windows, the description is LongName)
Note: If there are multiple lines in the folder's comment, only the first line will be displayed in the tree list.
  • 2
Display as the flat list.
Case Sensitive sensitive

Input

int

0

Specify whether the page name display is case sensitive or not.
Option lists:

  • 0
Non case sensitive
  • 1
Case sensitive
Separator sep

Input

string

///

Specify the separators for the description. Only available when display=1 to show the description for the folders and windows.

Note: If use the left bracket (for example: (, [, { and < ) as the separators, it will be converted to right bracket for the right side separators.

Description

This X-Function is used to display pages/subfolders inside the current folder.

Examples

To give a list of all subfolders as well as pages, use

pe_dir

To give a list of all pages, use

pe_dir name:=*

To give a list of all graph pages, use

pe_dir page:=g

To give a list of all worksheet pages, use

pe_dir page:=w

To output all page names to a string variable, use

pe_dir oname:=stringName

Related X-Functions

pe_cd