Component Palette Icon:

On this page ...

The File Explorer component displays a filesystem tree to the user. It can be rooted at any folder, even network folders. It can also filter the types of files that are displayed by their file extension (i.e., " pdf "). The path to the file that the user selects in the tree is exposed in the bindable property  Selected Path .  

The File Explorer component is typically used in conjunction with the PDF Viewer component in order to create a PDF viewing window. This is very useful for viewing manuals, documents, or reports from within your project. To use this component to drive a PDF Viewer component, refer to the section on File Explorer and PDF Viewer.

The following feature is new in Ignition version 8.1.14
Click here to check out the other new features
Users can right-click on the File Explorer to refresh the component in a Vision Client.




Property Type



Background ColorThe background color of the component. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector.Color.backgroundAppearance

The border surrounding this component. Options are: No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Field Border, and Line Border.

Note: The border is unaffected by rotation.
This feature was changed in Ignition version 8.1.21:

As of 8.1.21, the "Button Border" and "Other Border" options are removed.
CursorThe mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE
EnabledIf disabled, the component can't be used.boolean.componentEnabledCommon
File extension filterSemi-colon separated list of extensions to filter out files, such as pdf or txt. Example "pdf;html;txt" shows pdf, html, and text documents.String.fileFilterBehavior
FontFont of text on this component.Font.fontAppearance
Foreground ColorThe foreground color of the component. See  Color Selector.Color.foregroundAppearance
Mouseover TextThe text that is displayed in the tooltip which pops up on mouseover of this component.String.toolTipTextCommon
NameThe name of this component.String.nameCommon
Root DirectoryA directory to act as the root of the file explorer.String.rootDirBehavior
Selected PathThe selected file or folder's path.String.selectedPathData
VisibleIf disabled, the component will be hidden.boolean.visibleCommon


Component Functions

This component does not have component functions associated with it.

Extension Functions

This component does not have extension functions associated with it.

Event Handlers

Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page.


The File Explorer component does not have a customizer.


Refer to the examples on the File Explorer and PDF Viewer pages.

  • No labels