Click or drag to resize
Sandcastle Help File BuilderContent File Editors

This topic describes the content file editor preferences (standalone GUI only).

This tab allows you to define custom editors for project files that are not recognized by the standalone GUI as being editable text files based on their filename extension. In such cases, the standalone GUI will look for a custom editor definition and, if found, will launch the associated application. If no custom editor definition is found, the GUI attempts to launch the file using the shell to let it decide how the file should be edited.

To add a new content file editor, click the Add button located next to the upper right corner of the editor list. Select the new entry in the list and use the property grid at the bottom of the tab to alter its settings.

  • Description - Enter a description for the editor.

  • Extensions - Enter a list of filename extensions with which this editor will be associated. If specifying multiple extensions, separate them with a space, semi-colon, period, or a comma.

  • ApplicationPath - Enter the path to the editor application. As with other project properties, this can be an absolute or a relative path and can contain environment variable references for expansion when actually invoked.

  • Arguments - Specify any necessary command line arguments. At the minimum, the $ContentItem macro should be specified so that the file to edit is passed to the application. Enclose arguments in quote marks if the value will contain spaces. Macros that you can use are as follows:

    • $ContentItem - This expands to the full path and filename of the item to be edited.

    • $ProjectFile - This expands to the full path and filename of the current project.

    • $ProjectFolder - This expands to the full path of the current project without the filename.

    Macro names are case-insensitive.

  • StartupFolder - An optional folder name in which the application is started. If left blank, the current project's folder is used. As with the application path, this can be an absolute or relative path and can contain environment variable references for expansion when actually invoked.

To delete an editor definition, select it in the list and click the Delete button located next to the bottom right corner of the editor list.

See Also

Other Resources