Article ID: 291117 - View products that this article applies to.
This article was previously published under Q291117
This article has been archived. It is offered "as is" and will no longer be updated.
This article describes how to programmatically access the contents of both standard and custom keywords fields in Microsoft Outlook using Microsoft Visual Basic Scripting Edition (VBScript). Concepts in this article also apply to solutions based in Visual Basic or Visual Basic for Applications.
Outlook items can contain information that is stored in a keywords format. The format is typically used to represent a grouped list of information such as company names and categories. For example, you might want to use a keywords field to store a list of companies that a salesperson is responsible for.
However, keywords fields are most commonly associated with the standard Categories field, which is available on all Outlook forms. This field is used to categorize items even though they are not stored in the same location.
Standard Keywords FieldsOutlook provides three standard keywords fields.
NOTE: Task items also have a Contacts keywords field, but this field is read-only and therefore cannot be used in solutions.
Field name Forms available in: ---------- ------------------- Categories All Companies Contact, Task, Task Request, Journal Entry Children Contact
When accessing these standard keywords fields through the Outlook object model, they are treated like a standard text field. For example, if the Categories selected for a contact are Personal, Phone Calls, and Waiting, the following line of VBScript code will set the MyCategories variable equal to the entire list of categories:
You can use the VBScript Split function to assign individual elements of the field to an array variable. The following sample code takes the three keywords and places them into the first three elements of array MyArray:
User-Defined (Custom) Keywords FieldsIt is not possible to directly modify the contents of a user-defined keyword field using VBScript. Outlook uses a different variation of array data type than that supported by VBScript, and therefore a "Type mismatch" error message will appear if you try to display the text of the field in a message box, assign the field to an array variable, or perform any string-related function on it.
For example, if you create a keywords field called MyKeywords, the following two lines of code will both generate a "Type mismatch" error message:
The simplest way to work around this limitation is by accessing the text via a control or by using a standard keywords field.
Accessing the Text Via a ControlYou can work around this limitation by "filtering" the text through a control. For example, you can place a text box (Textbox1) on a form page (P.2) and bind this text box to a user-defined keywords field (MyKeywords). The following steps create sample code that adds the word "New" to the beginning of the MyKeywords field.
NOTE: If you do not want to display the text box used to gain access to the keywords text, you can right-click the text box, click Properties, and clear the Visible property on the Display tab of the Properties window.
Using a Standard Keywords FieldIf you are not using one of the standard keywords fields in a form, such as the Categories field, then you can use that field to gain access to the text in the field. You can temporarily assign the value of your custom keywords field to the standard field, modify the text while it is in the standard field, assign the standard field back to your custom keywords field, and then delete the contents of the standard field you temporarily used. The following sample code provides an overview of this process:
For additional information about available resources and answersto commonly asked questions about Microsoft Outlook solutions, click the article number below to view the article in the Microsoft Knowledge Base:
(https://support.microsoft.com/kb/287530/EN-US/ )OL2002: Questions About Custom Forms and Outlook Solutions