Click or drag to resize

Menu toolbar

Sandcastle Help File Builder HelpAssistant

View the Project on GitHub

[This is preliminary documentation and is subject to change.]

Options from "File" menu

After clicking on “File” menu from the toolbar three menu elements appear:

File menu
Figure: File menu

Controls in the File menu:

  1. “Open project”. Clicking on this element causes opening “Open file” dialog.

  2. “Refresh”. Clicking on this element causes reloading the project.

  3. “Exit”. Clicking on this element causes quitting the application.

Options from "Help" menu

After clicking on “Help” menu from the toolbar two menu elements appear:

Help menu
Figure: Help menu

Controls in the “Help” menu:

  1. “Help”. Opens help file.

  2. “About”. Opens AboutBox with information about application.

Open file dialog

After clicking “Open project” (1) from “File” menu - “Open file” dialog appears:

Open file dialog
Figure: Open file dialog

Controls in the “Open file” dialog:

  1. “Open”. Clicking this button opens the Sandcastle Help File Builder project file

  2. “Cancel”. Clicking this button closes dialog.

After clicking “Open” it is possible, that the deserialization for some reasons is impossible. In this situation below dialog appears:

Deserialization failed
Figure: Deserialization failed

The next possible situation is when some identifiers (i.e. GUIDs) are doubled in the project. User can see below dialog:

GUID doubled
Figure: GUID doubled
Refresh

After clicking “Refresh” (2) from “File” menu, if there was not any project opened or the file was incorrect, the information appears:

Incorrect file
Figure: Incorrect file
Help

Next clickable element is “Help” from “Help” menu. After clicking it, appears help file.

Help file
Figure: Help file
About

After clicking on “About” appears window with information about application:

AboutBox
Figure: AboutBox