GH_GlossaryItem

Represents a single glossary entry in the Grasshopper help.

Properties

public IGH_Content Author { get; }

Gets the author of this glossary entry. This field is optional and may not be defined.

public IGH_Content Contact { get; }

Gets the contact information for the glossary entry author. This field is optional and may not be defined.

public List<IGH_Content> Descriptions { get; }

Gets the description (definition) for this glossary entry.

public string Path { get; }

Gets the source file for this glossary entry.

public IGH_Content Pronunciation { get; }

Gets the pronunciation guide to the word. This field is optional and may not be defined.

public ReadOnlyCollection<string> Synonyms { get; }

Gets the synonyms for this glossary entry.

public string Word { get; }

Gets the word this glossary entry is about.

public static GH_GlossaryItem ParseFile(string path)

Parse a *.glossary file and return a glossary entry.

Parameters:

path (string)

File to parse.

Returns: The glossary entry defined by the file. This function always returns a valid glossary or it throws an exception.