C# Class Sage.DevTools.Modules.DirectoryTreeModule

Provides a module that reads directories.
The configuration element for this module has the following structure: 

<mod:config> <mod:path /> <mod:recursive /> <mod:directoriesOnly /> <mod:filesOnly /> <mod:pattern /> <mod:expression /> </mod:config>

name type description path string specifies the path of the directory to read. Unless absolute, the path will be server-mapped within the current application. Required. recursive boolean If true, the path's subdirectories should be scanned recursively as well. Optional. Default is false. directoriesOnly boolean If true, the only directories will be returned. Optional. Default is false. filesOnly boolean If true, the only files will be returned. Note that if both directoriesOnly and filesOnly options are specified, only the files will be returned. Optional. Default is false. pattern string File pattern to match (e.g. *.txt). Optional. Default is '*'. expression string The regular expression string that the files and/or folders should match to be returned. Optional.
Inheritance: IModule
Datei anzeigen Open project: igorfrance/sage

Public Methods

Method Description
ProcessElement ( XmlElement moduleElement, ViewConfiguration configuration ) : ModuleResult

Private Methods

Method Description
GetDirectoryPath ( XmlElement moduleElement, SageContext context ) : string
ScanDirectory ( string path, SageContext context ) : XmlElement

Method Details

ProcessElement() public method

public ProcessElement ( XmlElement moduleElement, ViewConfiguration configuration ) : ModuleResult
moduleElement System.Xml.XmlElement
configuration Sage.Views.ViewConfiguration
return Sage.Modules.ModuleResult