Pocket Outlook Object Model Registry Settings

4/8/2010

This topic covers Source Provider registry settings, and settings for other types of customization.

Source Provider Registry Settings

Settings Overview

Source Providers and their associated Source ID's are part of a mechanism that supports per-provider customization of the Personal Information Management (PIM) experience on Windows® phones. A Source Provider is a custom function that customizes the PIM user experience. Typically, a Source Provider has a corresponding associate function that is responsible for synchronizing PIM data with the phone. Data synchronized with the phone by this associate function is marked with a Source identification tag (Source ID). When Outlook Mobile displays a PIM item, it checks to see if the item has a Source ID. If it finds one, it invokes the Source Provider, which customizes the user interface for the PIM item.

You register a Source Provider on a Windows phone under the HKEY_LOCAL_MACHINE\System\PIMSources registry key, using the registry paths and values defined in the following tables.

Start by creating a <SourceID> subkey under PIMSources. The subkey name will be your Source ID. Choose a SourceID that follows the sequence 1, 2, 4, etc. (exactly one bit set).

The following table lists the constants that denote the registry paths, keys, and values you can use to programmatically register your Source Provider.

Remarks

When users enter new PIM data on the Windows phone, they will be able to select the Source Provider to use.

PIM items with a Source ID value of zero just use the default user interface.

As part of your Source Provider uninstall procedure, make sure that all PIM items associated with your Source Provider have their Source ID's changed to zero.

Example

Description

The following code example shows a portion of source provider registration code that changes the contact type icon that is used in the dialog box that appears to ask users to choose a contact type.

Code

const LPWSTR g_szIconID   = L",101";
WCHAR szIconFullPath[256] = {0};

// Set the icon for this provider.
hr = GetModuleFileName(GetModuleHandle(g_szDllName), szIconFullPath, 250);
CHR(hr);

wcscat(szIconFullPath, g_szIconID);

hr = RegistrySetString(hkeySource, NULL, PIMSRC_REGVALUE_ICON, szIconFullPath);
CHR(hr);

Contacts Groups Registry Settings

To specify whether email contact groups, messaging contact groups, or both group types appear in the contact type chooser user interface, you must set the following HKCU\Security\Software\Microsoft\ActiveSync registry key value.

The email contact groups and the messaging contact groups can be included in the suggestion list that appears when the user begins typing in the “To” or “CC” fields of an email message. Two registry keys control this. One key enables the inclusion of contact groups in the list. The other registry key specifies which contact groups will be included in the list.

You set the following HKEY_LOCAL_MACHINE\SYSTEM\Inbox\RecipientAutocomplete\SuggestionGenerators registry key value to enable the inclusion of contacts groups in the suggestion list.

To specify which contact groups will appear in the suggestion list, you must set the following HKEY_LOCAL_MACHINE\SYSTEM\Inbox\RecipientAutocomplete IncludeContactsGroups registry key value.

Contact Chooser Customization Registry Settings

Providing a Custom Contact Chooser for use during E-mail Composition

Applies to Windows Mobile 6.5.3

A user composing an e-mail can invoke contact chooser control, which provides access to the Contact application interface for selecting Contacts in your application. An OEM can provide a custom contact chooser to be invoked instead of the default Windows Mobile contact chooser. The technique to do this is to write a function named CustomChooseMultipleContacts and to set a registry key that specifies the module that implements this function. When this registry key and function exists, e-mail compose view will invoke the custom function rather than ChooseContact.

CustomChooseMultipleContacts takes one parameter - LPCHOOSEMULTIPLECONTACTS which can hold multiple contacts selection information. This function returns a standard HRESULT.

HRESULT CustomChooseMultipleContacts(
  LPCHOOSEMULTIPLECONTACTS
);

The registry key is:

HKEY_LOCAL_MACHINE\Security\Contacts

The registry value is:

Setting List View Characteristics

The following Contact Chooser settings are stored in the registry key HKEY_LOCAL_MACHINE\Security\Contacts\Chooser.

These settings do not apply to the property picker list view that appears when CCF_CHOOSEPROPERTYONLY flag is TRUE (see Contact Chooser Flags).

Title Box Customization

OEMs can customize the title box of the Contacts Chooser on Windows Mobile Professional. The following elements of the title box can be customized.

• Control height
• Background color
• Background bitmap
• Transparency
• Text Color
• Text positioning
• Text background color
• Text font

To customize the title box of Contact Chooser, create the following registry key and values.

HKEY_LOCAL_MACHINE\Security\Contacts\Chooser\Title.

Title Box Text

To customize the text for the title box of the Contacts Chooser, create the following registry key and values.

HKEY_LOCAL_MACHINE\Security\Contacts\Chooser\Title\Text.

The following font settings **are used to populate a LOGFONT structure. The member that each value populates is specified in the descriptions below. For a complete description of each member, see LOGFONT.

Search Bar Customization

OEMs can customize the search bar for the Contacts Chooser. The search bar consists of a tool bar that contains a combo box and an edit control.

To customize the search bar for the Contacts chooser, create the following registry key and values.

HKEY_LOCAL_MACHINE\Security\Contacts\Chooser\Search.

Search Bar Text

To customize the text of the search bar for the Contacts Chooser, create the following registry key and values.

HKEY_LOCAL_MACHINE\Security\Contacts\Chooser\Search\Text.

The following font settings **are used to populate a LOGFONT structure. The member that each value populates is specified in the descriptions below. For a complete description of each member, see LOGFONT.

Empty List View Text

OEMs can customize the font and color of the text in the body of the Contact Chooser list view when the list view is empty.

Use the following registry key and values to make this customization. HKEY_LOCAL_MACHINE\Security\Contacts\Chooser\ListView\Text.

The following font settings **are used to populate a LOGFONT structure. The member that each value populates is specified in the descriptions below. For a complete description of each member, see LOGFONT.

Other Customization Registry Settings

A developer can customize what happens in response to a user selecting a hyperlink in the calendar application. The developer must provide event handlers to implement the desired behavior. The event handlers are the OnEmail and OnPhoneNumber methods of the ICalContactLinkHandler interface.

The interface must be placed into a COM object, and the CLSID of the COM object must be specified in registry key:

HKEY_LOCAL_MACHINE]\Software\Microsoft\Calendar\OEM

The value is:

For an overview of Action key customization, see Customizing Action Key Behavior for Calendar Hyperlinks.

Requirements

See Also

Reference

PIMSRC_COLOR
IPimSrcContactListIcon::Paint
IPimSrcContactSummaryCard::Display
ICalContactLinkHandler
Pocket Outlook Object Model Registry Settings

Concepts

Customizing Action Key Behavior for Calendar Hyperlinks

Other Resources

Pocket Outlook Object Model (POOM)