DisplayNote Methods
The DisplayNote object contains the following methods:
GetAttributeField
The GetAttributeField method returns the string value of a specified note attribute field. Limit of 20 characters. Valid field integers are 1 - 5.
Syntax
GetAttributeField(Field As Integer) As String
Parameters
| Parameter | Description |
|---|---|
|
Field |
Specifies the integer that corresponds to the note attribute field that contains the desired value. |
Return Values
This method returns the string value of a specified note attribute field.
GetTableField
The GetTableField method returns the string value of a specified note table attribute field by referencing a TRS table entry. Limit of 10 characters. Valid field integers are 1 - 5.
Syntax
GetTableField(Field As Integer) As String
Parameters
| Parameter | Description |
|---|---|
|
Field |
Specifies the integer that corresponds to the note table attribute field that contains the desired value. |
Return Values
This method returns the string value of a specified note table attribute field.
GetYesNoField
The GetYesNoField method returns the string value of a specified note yes/no attribute field. Valid field integers are 1 - 5.
Syntax
GetYesNoField(Field As Integer) As Boolean
Parameters
| Parameter | Description |
|---|---|
|
Field |
Specifies the integer that corresponds to the note yes/no attribute field that contains the desired value. |
Return Values
This method returns the Boolean value of a specified note yes/no attribute field.
SetAttributeField
The SetAttributeField method sets the value of a note attribute field.
Syntax
SetAttributeField(Field As Integer, Attr As String)
Parameters
| Parameter | Description |
|---|---|
|
Field |
Specifies the integer that corresponds to the note attribute field that will contain the value specified by the Attr parameter. Valid field integers are 1 - 5. |
|
Attr |
Specifies the string value to insert into the note attribute field specified by the Field parameter. Limit of 20 characters. |
Return Values
This method has no return value.
SetNote
The SetNote method sets the Note object to be referenced by the DisplayNote object. A DisplayNote object instance is effectively identical to its referenced Note object instance in every way except that the DisplayNote object instance includes a Label property.
Syntax
SetNote(Note As Note)
Parameters
| Parameter | Description |
|---|---|
|
Note |
Specifies the Note object to be referenced by the DisplayNote object. |
Return Values
This method has no return value.
SetTableField
The SetTableField method sets the value of a note table attribute field.
Syntax
SetTableField(Field As Integer, Table As String)
Parameters
| Parameter | Description |
|---|---|
|
Field |
Specifies an integer that corresponds to a note table attribute field. Valid field integers are 1 - 5. |
|
Table |
Specifies a string value to insert into the note table attribute field specified by the Field parameter. The value corresponds to a table entry in the TRS. |
Return Values
This method has no return value.
SetTbd
The SetTbd method sets the end time for a note to an undetermined future date and time.
Syntax
SetTbd()
Return Values
This method has no return value.
SetYesNoField
The SetYesNoField method sets the value of a note yes/no attribute field.
Syntax
SetYesNoField(Field As Integer, YesNo As Boolean)
Parameters
| Parameter | Description |
|---|---|
|
Field |
Specifies the integer that corresponds to the note yes/no attribute field that will contain specified by the YesNo parameter. Valid field integers are 1 - 5. |
|
YesNo |
Specifies the Boolean value (True or False) to insert into the note yes/no attribute field specified by the Field parameter. |
Return Values
This method has no return value.
