HelpNDoc version 5 includes several modifications to scripting methods. The following list helps migrate scripts (and templates) from earlier versions of HelpNDoc.
|
Older versions |
HelpNDoc v5 |
Remarks |
|
HndProjectsMeta.GetItemMetaStringValue('DefaultTopic') |
HndProjects.GetProjectDefaultTopic() |
Use this method to get the default topic |
|
HndBuilds.GetBuildCustomValue... |
HndBuildsMeta.GetItemMeta*Value |
Where * can be: Bool, Int, List or String |
|
HndBuildsEx.GetChmButtonVisibilityHex |
HndBuildsMetaEx.GetChmButtonVisibilityHex |
|
|
HndBuildsEx.GetChmNavigationPaneStyleHex |
HndBuildsMetaEx.GetChmNavigationPaneStyleHex |
|
|
HndTopics.GetTopicDirectChildrenCountVisible |
HndTopicsEx.GetTopicDirectChildrenCountGenerated |
|
|
HndTopics.GetTopicDirectChildrenListVisible |
HndTopicsEx.GetTopicDirectChildrenListGenerated |
|
|
HndTopics.GetTopicIsVisible |
HndTopicsEx.GetTopicIsGenerated |
|
|
HndTopics.GetTopicListVisible |
HndTopicsEx.GetTopicListGenerated |
|
|
HndTopics.GetTopicNextVisible |
HndTopicsEx.GetTopicNextGenerated |
|
|
HndTopics.GetTopicNextSibbilingVisible |
HndTopicsEx.GetTopicNextSibblingGenerated |
|
|
HndTopics.GetTopicPreviousVisible |
HndTopicsEx.GetTopicPreviousGenerated |
|
|
HndTopics.GetTopicPreviousSibbilingVisible |
HndTopicsEx.GetTopicPreviousSibblingGenerated |
|
|
HndTopics.SetTopicIsVisible |
HndTopics.SetTopicVisibility |
HndTopics.GetTopicVisibility |
User interface related operations
To speed-up global processing, all operations are done in memory and doesn't affect the user interface (UI). It might be required to update the UI. This is why the following methods must be considered based on the need of the script:
|
Non-UI version |
UI version |
Remarks |
|
HndTopics.GetCurrentTopic |
HndUI.GetCurrentTopic |
UI version will return the currently edited topic |
|
HndTopics.SetCurrentTopic |
HndUI.SetCurrentTopic |
UI version will set the currently edited topic |