Note Properties

The Note object contains the following properties. See script examples below.

Property	SubType	Read Only	Description
Associations	Array of association objects	No	Returns or sets a note's array of associations. If associations have not been set, an error occurs.
Body	String	No	Returns or sets a note's body text. If a body has not been set, an error occurs.
DbKey	String	Yes	Returns The database key (DbKey) for the note.
EndDateTime	Date	No	Returns or sets a note's ending DateTime in the format MM/DD/YYYY hh:mm:ss AM/PM. (For a point-in-time note, the start date/time and end date/time are the same.) If a note is TBD, an error occurs.
HasAssociations	Boolean	Yes	Returns True if associations are loaded into a note or if they have been changed by a user. Returns False if they are not.
HasBody	Boolean	Yes	Returns True if body text is loaded into a note or if it has been changed by a user. Returns False if it is not.
IsRanged	Boolean	Yes	Returns True if a note is a ranged note (not a point-in-time note). Returns False if it is not.
IsTbd	Boolean	Yes	Returns True if a note has the TBD property set for its end date. Returns False if it does not.
NoteTag	String	Yes	Returns a note tag in the format SITE.SERVICE~NOTENUMBER. The database key (DbKey) for the note with no preceding zeroes makes up NOTENUMBER.
SiteService	String	No	Returns or sets a note's Site.Service.
StartDateTime	Date	No	Returns or sets a note's starting DateTime in the format MM/DD/YYYY hh:mm:ss AM/PM. (For a point-in-time note, the start date/time and end date/time are the same.)
Summary	String	No	Returns or sets a note's summary text. If there is no summary, an empty string is returned. Limit of 100 characters.
Type	String	No	Returns or sets a note's type text. If there is no type, an empty string is returned. Limit of 20 characters.
UserID	String	Yes	Returns the user ID of a note's creator.
VersionTimestamp	Date	Yes	Returns a note's version timestamp. The version timestamp is the timestamp of the last update to a note. It is in the format MM/DD/YYYY hh:mm:ss AM/PM.

Script Examples

The following basic examples illustrate the use of Note object properties.

Associations Example

In this example, you connect to MYSITE.NOTE, get a specific note, call its Associations property, display the association array's upper bound, and display the association tag of the second index in the array.

Copy

Note Example

1
2
3
4
5
6
7
8
9
10
11
12
Dim CxNote
Set CxNote = CreateObject("CxNote.NoteClient")
CxNote.Connect "MYSITE.NOTE"
 
Dim Test
Set Test = CxNote.GetNote("MYSITE.NOTE~1")
 
Dim Assoc
Assoc = Test.Associations
 
MsgBox UBound(Assoc)
MsgBox Assoc(1).GetTag