Navisworks: Comments¶
4 nodes. Types ending in [] are lists. An input with a default is optional.
Nodes¶
SavedItem.AddComment¶
Adds a comment to a saved viewpoint, selection/search set, folder, clash result or result group — the Review-tab Comments feature, scriptable; lace over results for review notes in bulk. Every run adds another comment: running the graph twice leaves two identical comments (SavedItem.ClearComments empties the thread first, SavedItem.SetCommentStatus changes the status of one that is already there).
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
item required |
SavedItem |
— | The saved item (a viewpoint, selection/search set, one of their folders, or a clash result or group). |
body required |
string |
— | The comment text. |
status |
string |
"New" |
"New", "Active", "Approved" or "Resolved". |
author |
string |
"" |
Comment author ("" uses the Navisworks user name). |
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type | What it gives |
|---|---|---|
item |
SavedItem |
The stored item the comment was added to (pass-through for chaining). |
Tags: comment add review note viewpoint set annotate
SavedItem.ClearComments¶
Deletes every comment on a saved viewpoint, selection/search set, folder, clash result or result group (replace-all with an empty thread). Rebuild the thread afterwards with SavedItem.AddComment. A clash test itself has no comment thread here.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
item required |
SavedItem |
— | The saved item (a viewpoint, selection/search set, one of their folders, or a clash result or group). |
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type | What it gives |
|---|---|---|
item |
SavedItem |
The stored item (pass-through for chaining). |
Tags: comment clear delete remove review reset
SavedItem.Comments¶
The comment thread on any saved item (viewpoint, set, folder, clash test): bodies, authors, statuses and creation dates, index-aligned.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
item required |
SavedItem |
— | The saved item (viewpoint, set, folder or clash test). |
Outputs
| Output | Type |
|---|---|
bodies |
string[] |
authors |
string[] |
statuses |
string[] |
dates |
datetime[] |
Returns: Index-aligned comment bodies, authors, statuses and creation dates.
Tags: comment comments read review thread notes
SavedItem.SetCommentStatus¶
Changes the status (New, Active, Approved, Resolved) of one comment, or of every comment, on a saved viewpoint, selection/search set, folder, clash result or result group, keeping its text, its author and its place in the thread — close out review comments without clearing the thread. Navisworks cannot edit a comment in place, so a changed comment is replaced by a copy: its date becomes the time of the change. Comments that already have the status are left alone. Wire a list of items to change several threads.
Inputs
| Input | Type | Default | What it does |
|---|---|---|---|
item required |
SavedItem |
— | The saved item (a viewpoint, selection/search set, one of their folders, or a clash result or group). Wire a list to change several items. |
status required |
string |
— | "New", "Active", "Approved" or "Resolved". |
index |
integer |
-1 |
The 0-based position of the comment in the thread (0 is the first); -1 changes every comment. |
document |
Document |
null |
The document (defaults to the active document). |
Outputs
| Output | Type | What it gives |
|---|---|---|
item |
SavedItem |
The item (pass-through for chaining). |
Tags: comment status resolve resolved approve approved close review active new set