The absolute pathname of the default directory where some input files associated with the currently generated output are searched.

For instance, this pathname is used during the generation of the RTF output, when interpreting embedded HTML (i.e. HTML tags embedded in doc-comments). In that case, when an <img> tag is processed, the image source specified with a relative local URL will be resolved against the default directory provided by this property.

For example, if an image tag looks like this:

<img src="doc-files/image.gif">
the actual image file will be searched at the following location:
output.inputFilesPath + "doc-files/image.gif"
Note: The returned pathname uses (and always ends with) the name-separator character: '/'

See Also:

GOMOutputInfo.docFilesDir

Assigning Search Path for Input Associated Files

When the generator starts processing the main template, the initial Input Files Search Path is set accordingly to the specific DocFlex application (e.g. derived from the command line options or anything else related to the general data source).

Each subtemplate may be started with its own Input Files Search Path provided by the "Expression for Input Files Search Path" that may be specified at the Call Template Properties Dialog | Call Settings | Output Settings | Associated Files tab. When that expression is not specified, the search path currently acting in the calling template is passed to the called subtemplate.

During processing of a particular template, the Input Files Search Path may be changed as well. You may set a new search path dynamically within any FlexQuery expression specified in the template using this very inputFilesPath property. For example, the statement

output.inputFilesPath = getAttrStringValue("dir")
will assign the acting Input Files Search Path the value obtained from "dir" attribute contained in the current element.

The new search path assigned to inputFilesPath property will be processed according to the following rules:

  1. When the assignment of the inputFilesPath property takes place within the template root block or any template initialization expressions, the new search path will hold on until the template finishes (or other such an assignment happens). At that, assigning null (or empty string) value will result in restoring the initial Input Files Search Path received by this template.

  2. When the assignment of the inputFilesPath property takes place within the body of a stock-section or any its initialization expressions, the new search path will be used only during the current processing of that stock-section. After finishing, the search path is restored to the old value acting in the calling context (e.g. the template root block or another stock-section).

    When, during processing of the stock-section, the inputFilesPath property is assigned with null (or empty string) value, the acting Input Files Search Path is restored to the initial value received by the stock-section from its caller context.

  3. Each non-empty (not null) value assigned to inputFilesPath property should designate an absolute or relative file pathname. The name-separator character used in the pathname may be '/' or '\'. Any relative pathname will be converted to the absolute one against the current directory.