GH_RuntimeFile

Public Class

Runtime representation of a Grasshopper help file. A GH_RuntimeFile is nothing more than a collection of keywords with associated content. This class does not interpret a file or check its validity, it merely figures out the different content section based on “Keyword:” entries.

Inheritance Hierarchy

System.Object
Grasshopper.Documentation.GH_RuntimeFile

Namespace: Grasshopper.Documentation

Assembly: Grasshopper (in Grasshopper.dll)

Syntax

public class GH_RuntimeFile

The GH_RuntimeFile type exposes the following members.

Properties

Name

Description

---

Public Property

Content

Gets the data associated with a certain key. For every time the key appears in the file, an array of content strings will be returned.

---

Public Property

Keys

Gets a list of all the keys present in the File.

---

Public Property

Path

Gets the path of this help file.

---

Public Property
Static Member

Tags

Gets a collection of all the pre-defined keywords. Use IsKeyword(string) if you want to know whether a string equals a keyword. It’s both faster and more reliable than comparing against this collection.

---

Methods

Name

Description

---

Public Method

ContainsKey

Test whether a certain key is present in the File.

---

Public Method
Static Member

IsTag

Tests whether a string is a predefined Grasshopper Help keyword.

---

Public Method
Static Member

IsTagLine

Tests whether a line of text starts with a Grasshopper Help keyword.

---

Public Method
Static Member

ParseFile

Parse a file and return the runtime representation of said file.

---

Fields

Name

Description

---

Public Field
Static Member
TagAuthor

String tag used to identify Author fields in documentation source files.

---

Public Field
Static Member
TagAutoLink

String tag used to signal whether automatic linking to a topic is allowed.

---

Public Field
Static Member
TagBeginner

String tag used t o identify Beginner Level Help Content in documentation source files.

---

Public Field
Static Member
TagCategory

String tag used to identify Category fields in documentation source files.

---

Public Field
Static Member
TagComponent

String tag used to identify Component IDs in documentation source files.

---

Public Field
Static Member
TagContact

String tag used to identify Author contact details in documentation source files.

---

Public Field
Static Member
TagDescription

String tag used t o identify Description fields in glossary source files.

---

Public Field
Static Member
TagErranyms

String tag used to identify Do Not Confuse collections in documentation source files.

---

Public Field
Static Member
TagExpert

String tag used t o identify Expert Level Help Content in documentation source files.

---

Public Field
Static Member
TagInclude

String tag used to signal whether inclusion of a topic is allowed.

---

Public Field
Static Member
TagIntermediate

String tag used t o identify Intermediate Level Help Content in documentation source files.

---

Public Field
Static Member
TagKeywords

String tag used to identify Keyword collections in documentation source files.

---

Public Field
Static Member
TagPronunciation

String tag used to identify Pronunciaion Guide fields (IPA) in glossary source files.

---

Public Field
Static Member
TagRhinoCommand

String tag used to identify Similar Rhino Commands in documentation source files.

---

Public Field
Static Member
TagSeeAlso

String tag used to identify See Also collections in documentation source files.

---

Public Field
Static Member
TagSynonyms

String tag used to identify Synonym collections in glossary source files.

---

Public Field
Static Member
TagTitle

String tag used to identify title fields in documentation source files.

---