Share via

FormDescription.ScriptText Property

  • Article
Outlook Developer Reference

Returns a String containing all the VBScript code in the form's Script Editor. Read-only.

Syntax

expression.ScriptText

expression   A variable that represents a FormDescription object.

Example

This Microsoft Visual Basic Scripting Edition (VBScript) example uses the Open event to access the HTMLBody property of a MailItem. This sets the EditorType property of the MailItem’s Inspector to olEditorHTML. When the MailItem's Body property is set, the EditorType property is changed to the default. For example, if the default e-mail editor is set to RTF, the EditorType is set to olEditorRTF. If this code is placed in the Script Editor of a form in design mode, the message boxes during run time will reflect the change in the EditorType as the body of the form changes. The final message box uses the Script Text property to display all the VBScript code in the Script Editor.

Visual Basic Scripting Edition 
  Function Item_Open()
    'Set the HTMLBody of the item.
    Item.HTMLBody = "<HTML><H2>My HTML page.</H2><BODY>My body.</BODY></HTML>"
    'Item displays HTML message.
    Item.Display
    'MsgBox shows EditorType is 2.
    MsgBox "HTMLBody EditorType is " & Item.GetInspector.EditorType
    'Access the Body and show
    'the text of the Body.
    MsgBox "This is the Body: " & Item.Body
    'After accessing, EditorType
    'is still 2.
    MsgBox "After accessing, the EditorType is " & Item.GetInspector.EditorType
    'Set the item's Body property.
    Item.Body = "Back to default body."
    'After setting, EditorType is
    'now back to the default.
    MsgBox "After setting, the EditorType is " & Item.GetInspector.EditorType
    'Access the items's
    'FormDescription object.
    Set myForm = Item.FormDescription
    'Display all the code
    'in the Script Editor.
    MsgBox myForm.ScriptText
End Function

See Also