ISLetterTemplate.ReasonID

Description

ID of the short code of type ‘Letter Reason’.

Syntax

object.ReasonID

Part Attribute Type Description
object Required
The object always implements the ISLetterTemplate interface

Return Value

int

Example

Display some information about the letter templates, including IDs of the short codes of type ‘Letter Reason’.

Dim aPatient
Dim aLetters, aLetter
Dim i
Dim aTemplatesIds
Dim aLetterTemplate
Dim aReason
Dim aMessage

Set aPatient = Profile.SelectPatient
set aLetters = aPatient.GetLetters (1) ' slcfWordRTF

aMessage =_
  "The number of the letters of the selected format is " & aLetters.Count

set aTemplatesIds = Profile.CreateIntCollection

for i = 0 to aLetters.Count - 1
  set aLetter = aLetters.Item(i)
  set aLetterTemplate = aLetter.Template
  
  if aTemplatesIds.IndexOf(aLetterTemplate.ID) < 0 then
    aMessage = aMessage & vbNewLine &_
      "Letter Template Information: " & vbNewLine &_ 
      "   - ID: " & aLetterTemplate.ID & vbNewLine &_                       
      "   - Subject: " & aLetterTemplate.Subject & vbNewLine &_
      "   - Key Words: " & aLetterTemplate.KeyWords & vbNewLine &_
      "   - Category ID: " & aLetterTemplate.CategoryID & vbNewLine &_
      "   - Reason ID: " & aLetterTemplate.ReasonID & vbNewLine
    set aReason = Profile.LoadShortCode(aLetterTemplate.ReasonID)
    if not aReason is nothing then 
      aMessage = aMessage &_
        "   - Reason Description: " & aReason.Description
    end if 
    aTemplatesIds.Add aLetterTemplate.ID 
  end if
next    
Profile.MsgBox (aMessage)     
Note:

In Profile Client v8 on User Interface Reason ID cannot be found. Reason can be found in Maintain > Templates > Documents > Open the document > Information and Recipients > Reason field.

Version information

Added in v7.8.0