Class Note
Notes are for authoring and reviewing comments related the the model or to the project.
Inherited Members
Namespace: DesignData.SDS2.Model
Assembly: DesignData.SDS2.Model.dll
Syntax
public sealed class NoteConstructors
Note()
Notes are for authoring and reviewing comments related the the model or to the project.
Declaration
public Note()Properties
Color
The color of the note
Declaration
public Color Color { get; set; }Property Value
| Type | Description |
|---|---|
| Color |
Comments
A deep copy of the comments assocated with the note
Declaration
public NoteCommentList Comments { get; set; }Property Value
| Type | Description |
|---|---|
| NoteCommentList |
CreateTime
Seconds between when this note was created and the unix epoch, January 1, 1970.
Declaration
public int CreateTime { get; }Property Value
| Type | Description |
|---|---|
| int |
CreateUser
Name of the user who created the note
Declaration
public string CreateUser { get; }Property Value
| Type | Description |
|---|---|
| string |
CustomTags
A deep copy of the custom tags assocated with the note. Beware, the user can change actual name of the Custom category. The actual name of this category can be read from the returned object.
Declaration
public StringList CustomTags { get; set; }Property Value
| Type | Description |
|---|---|
| StringList |
DisciplineTags
A deep copy of the discipline tags associated with the note. Beware, the user can change actual name of the Discipline category. The actual name of this category can be read from the returned object.
Declaration
public StringList DisciplineTags { get; set; }Property Value
| Type | Description |
|---|---|
| StringList |
IsShownInModel
Specifies whether the note has graphics displayed in the model
Declaration
public bool IsShownInModel { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
LastModifyTime
Seconds between when this note was last edited and the unix epoch, January 1, 1970.
Declaration
public int LastModifyTime { get; }Property Value
| Type | Description |
|---|---|
| int |
LastModifyUser
Name of the user who last modified the note
Declaration
public string LastModifyUser { get; }Property Value
| Type | Description |
|---|---|
| string |
Location
Location of the note in global coordinates. If the note is associated with a member, then the note's global location moves as the member is moved. However, the location relative to the member remains fixed.
Declaration
public Point3D Location { get; set; }Property Value
| Type | Description |
|---|---|
| Point3D |
MemberHandle
A handle to the member the note is linked to
Declaration
public MemberHandle MemberHandle { get; set; }Property Value
| Type | Description |
|---|---|
| MemberHandle |
StatusTags
A deep copy of the status tags associated with the note. Beware, the user can change actual name of the Status category. The actual name of this category can be read from the returned object.
Declaration
public StringList StatusTags { get; set; }Property Value
| Type | Description |
|---|---|
| StringList |
Subject
Subject of the note
Declaration
public string Subject { get; set; }Property Value
| Type | Description |
|---|---|
| string |
View
The view associated with a note. SDS2 will change to this view when the user clicks on the note the note viewer tool.
Declaration
public View View { get; set; }Property Value
| Type | Description |
|---|---|
| View |
Methods
Add(Note)
Add the view to the current transaction
Declaration
public static void Add(Note note)Parameters
| Type | Name | Description |
|---|---|---|
| Note | note |
AppendComment(NoteComment)
Append the specified comment to the list of comments
Declaration
public void AppendComment(NoteComment comment)Parameters
| Type | Name | Description |
|---|---|---|
| NoteComment | comment |
~Note()
Notes are for authoring and reviewing comments related the the model or to the project.
Declaration
protected ~Note()Get(NoteHandle)
Get a Note object for the NoteHandle passed in.
Declaration
public static Note Get(NoteHandle handle)Parameters
| Type | Name | Description |
|---|---|---|
| NoteHandle | handle |
Returns
| Type | Description |
|---|---|
| Note |
GetHandle()
A handle for this note. Notes that have not been added to the model will have null handles.
Declaration
public NoteHandle GetHandle()Returns
| Type | Description |
|---|---|
| NoteHandle |
RefreshDatabaseTable()
Refresh the the primary table for objects of this type.
Declaration
public static void RefreshDatabaseTable()