Docs

public static class Docs
Provides static access to the documentation framework.

Properties

BrowserVisible

#
public static bool BrowserVisible { get; }

Database

#
public static Database Database { get; }
Gets the one and only documentation database for this instance of Grasshopper.

Methods

BrowseDocumentationContent

#
public static void BrowseDocumentationContent()
Browse the unfinished content.

CreateNewSpecFile

#
public static void CreateNewSpecFile(bool specifyId)
Parameters:
specifyId (bool)

CreateNewTermFile

#
public static void CreateNewTermFile()

CreateNewTopicFile

#
public static void CreateNewTopicFile()

EditDocumentationContent

#
public static void EditDocumentationContent()
Pick a documentation file which exists and open it in an editor.

RestoreContent

#
public static void RestoreContent(Content content)
Restore swapped content back to its original state.
Parameters:
content (Content)

ShowExportWindow

#
public static Form ShowExportWindow()
Show the content export window.

ShowNewWindow

#
public static Form ShowNewWindow(string content)
Show a new blank documentation window.
Parameters:
content (string)

ShowSpecInNewWindow

#
public static Form ShowSpecInNewWindow(Guid specIdentifier)
Show a specification in a new window.
Parameters:
specIdentifier (Guid)Identifier of object.
Returns: New window which contains the spec if found.

ShowTermInNewWindow

#
public static Form ShowTermInNewWindow(string word)
Show a glossary term in a new window.
Parameters:
word (string)Term word to show.
Returns: New window which contains the term if found.

ShowTopicInNewWindow

#
public static Form ShowTopicInNewWindow(string topicTitle)
Show a topic in a new window.
Parameters:
topicTitle (string)Title of topic to show.
Returns: New window which contains the topic if found.

SwapContent

#
public static void SwapContent(Content content)
Swap out content with a temporary placeholder.
Parameters:
content (Content)

UpdateDatabase

#
public static void UpdateDatabase()
Force the Database instance to update its file caches. If the database currently isn't loaded, nothing will happen.

Events

ContentModified

#
public static event EventHandler<ContentModifiedEventArgs> ContentModified

ContentRemoved

#
public static event EventHandler<ContentEventArgs> ContentRemoved

ImageRequest

#
public static event EventHandler<ImageRequestEventArgs> ImageRequest