Save Snippet Dialog Box

This dialog box is displayed when the File | Save Snippet menu option is clicked. It is used to specify the file name, file type and formatting information for the source code snippet that is to be saved.

The source saved is that of the currently selected routine or category. If a category is selected, all its contained routines are included in the code snippet.

The dialog is a standard Windows save dialog box with a few added options.

You specify the name and folder for the file that the code snippet will be saved in in the usual way.

Use the Save as type drop down list to specify the type of file to be saved. Options are:

• A Pascal include file (.inc) - The code is written to a file with extension *.inc that can be included in any Pascal source file. The code includes comments noting the units and any other routines from the database that are required by the saved routine(s).
• A plain text file (.txt) - This is the same as the Pascal include file except that the extension is .txt rather than .inc.
• An HTML file (.html) - This option writes the source code out as a valid XHTML document that uses CSS to format the code. The document can contain syntax highlighting if the Use syntax highlighting check box is checked.
• A rich text file (.rtf) - The source code is written out as an RTF document. Again syntax highlighting can be used if the Use syntax highlighting check box is checked.

The routines in the output file can be documented with their associated descriptions placed in Pascal comments. Use the Comment style drop down list to specify the style of commenting to be used. Select No comments to omit the descriptive comments.

The output can be previewed by clicking the Preview button. This displays the source code in a dialog box, formatted according to your selections. Text in the preview can be selected and copied to the clipboard if required.

Use the Save button to write the source code to disk or Cancel to abort.