VSTO3 SP1 est arrivé

by Nicolas Calvi 13. août 2008 13:42

Ca y est, Microsoft à rendu disponible le premier service pack pour VSTO3. Vous pouvez le télécharger ici mais est inclus dans le service pack 1 de Visual Studio 2008.

Beaucoup de bugs corrigés mais aussi une interopérabilité bien plus poussée avec Word et Excel, notamment par la création de nouveaux événements.

Changer les Forms par défaut VSTO - Outlook

by Nicolas Calvi 30. juin 2008 17:26
Il est possible avec VSTO de surcharger les formulaires par défauts d'Outlook, comme le formulaire d'ajout d'un contact par exemple. Pour cela il y a deux méthodes, l'un avec l'assistant (via Form Region) de Visual Studio, l'autre avec du code en interceptant l'ouverture de celle-ci. Dans le premier cas on surcharge ou on remplace définitivement un formulaire, mais si l'on veut par exemple ajouter un second répertoire contact dans Outlook et qu'en fonction du répertoire, afficher un formulaire différent, comme le formulaire par défaut pour le premier répertoire et un formulaire personnalisé sur le second, et bien avec la première méthode ce n'est pas possible.
Vient alors la seconde méthode qui consiste à surcharger le contrôleur d'instanciation (en fait une liste) des formulaires, nommé Inspectors sur l'objet d'application. Pour information un Inspector est un modèle de formulaire affichable dans Outlook pour la gestion d'un type d'objet précis (Appointement, Contact, ...) Quand, par exemple, on ajoute un nouveau contact, un nouvel Inspector est créé, dans le cas d'un contact c'est l'Inspector de type ContactItem qui est instancié. Si l'on veut donc substituer ce formulaire par notre propre WinForm, il faut d'abord s'abonner sur l'événement NewInspector du contrôleur pour qu'il nous informe de la création d'un nouvel Inspector.
public class ThisAddIn
{
  private Outlook.Inspectors m_oInspectors = null;

  private void ThisAddIn_Startup(object sender, System.EventArgs e)
  {
    this.m_oInspectors = this.Application.Inspectors;
    this.m_oInspectors.NewInspector += new Outlook.InspectorsEvents_NewInspectorEventHandler(this.Inspectors_NewInspector);
  }

  private void Inspectors_NewInspector(Outlook.Inspector p_oInspector)
  {
  }
}
Une fois abonné on peut donc intercepter les ouvertures et les empêcher en s'abonnant sur l'événement Open du nouvel Inspector. Dans cet événement on empêchera son ouverture avec la propriété Cancel de l'argument et ensuite on ouvrira notre propre WinForm.
private void Inspectors_NewInspector(Outlook.Inspector p_oInspector)
{
  // On vérifie que c'est le bon objet que l'on veut intercepter 
  if ( oItem is Outlook.ContactItem )
  {
    // On s'abonne pour pouvoir empêcher l'ouverture
    ((Outlook.ContactItem)oItem).Open += new Microsoft.Office.Interop.Outlook.ItemEvents_10_OpenEventHandler(InspectorItem_Open);

    // Affichage de notre propore WinForm
    using ( MaForm oForm = new MaForm )
    {
      oForm.ShowModal();
    }
  }
}

// Fonction qui va empêcher l'Inspector Contact de s'ouvrir
private void InspectorItem_Open(ref bool Cancel)
{
  Cancel = true;
}
Nous pouvons aussi effectuer cette opération seulement sur certaine actions, comme pour l'ajout d'un contact sur un répertoire que nous avons créé. Pour cela il suffit de vérifier si nous somme bien sur le bon répertoire et de traiter l'action si c'est le cas.
private void Inspectors_NewInspector(Outlook.Inspector p_oInspector)
{
  // On vérifie que c'est le bon objet que l'on veut intercepter 
  // Si c'est le bon on vérifie le nom du répertoire, si il est bon on substitue, sinon on laisse le formulaire par défaut
  if ( oItem is Outlook.ContactItem && this.Application.ActiveExplorer().CurrentFolder.Name == "Mon répertoire contact" )
  {
    // On s'abonne pour pouvoir empêcher l'ouverture
    ((Outlook.ContactItem)oItem).Open += new Microsoft.Office.Interop.Outlook.ItemEvents_10_OpenEventHandler(InspectorItem_Open);

    // Affichage de notre propore WinForm
    using ( MaForm oForm = new MaForm )
    {
      oForm.ShowModal();
    }
  }
}

// Fonction qui va empêcher l'Inspector Contact de s'ouvrir
private void InspectorItem_Open(ref bool Cancel)
{
  Cancel = true;
}
Voilà comment gérer de façon précise l'ouverture des formulaires sous Outlook.

Astuce pour les événements COM en VSTO

by Nicolas Calvi 18. juin 2008 22:54

Si vous développez sous VSTO, il y a une petite chose à savoir qui peut éviter bien des heures de prise de tête. En effet si on se branche sur un événement provenant d'un objet obtenu par la couche d'Interop Office, il faut systématiquement garder en référence membre l'objet sur lequel vous vous êtes branché.

Imaginons la situation suivante, la création d'un bouton sur une Toolbar, il est tentant comme en Winform de créer une variable locale pour la création du bouton et de lui affecter l'événement dans la foulé, comme le code ci-dessous :

private void CreerToolbarEtBouton()
{
  // Création de la barre
  Office.CommandBar oBar = null;

  oBar  = this.Application.ActiveExplorer().CommandBars.Add(MTSInterface._CustomMenuBarName, Office.MsoBarPosition.msoBarTop, Missing.Value, true);
  oBar .Visible = true;

  // Création bouton
  Office.CommandBarButton oButton = null;

  oButton = (Office.CommandBarButton) oBar .Controls.Add(Office.MsoControlType.msoControlButton, Missing.Value, Missing.Value, Missing.Value, Missing.Value);
  oButton.Style = Office.MsoButtonStyle.msoButtonCaption;
  oButton.Caption = "Mon bouton";
  oButton.Visible = true;
  oButton.Click += new Office._CommandBarButtonEvents_ClickEventHandler(this.ButtonOptionsEvent);
}

Jusque là rien de bien méchant, cependant le problème avec l'Interop c'est qu'à la fin de la vie d'un objet .Net et ce même si il existe encore du coté COM, tous les abonnements à des événements fait depuis la partie .Net sont supprimés. Du coup dans le cadre de notre bouton, il ne réagira pas au Click.

Vous l'aurez donc compris, pour pouvoir conserver les abonnements il faut systématiquement conserver une référence à l'objet COM dans la partie .Net, la plupart du temps mettre cette référence dans une variable membre suffit amplement. Il faut donc déplacer la déclaration de notre oBouton au niveau de la classe pour résoudre le problème.

J'attire aussi l'attention sur une subtilité au niveau de l'objet Inspectors qui est déclaré au niveau de l'objet Application qui se trouve dans l'Addin. Prenons cet exemple :

this.Application.Inspectors.NewInspector += new Outlook.InspectorsEvents_NewInspectorEventHandler(this.Inspectors_NewInspector);

Dans cette exemple on peut penser à juste titre qu'il n'y aura pas de problème, car l'événement est bien rattaché à une variable toujours disponible du coté .Net, mais en réalité il n'en est rien. Le désabonnement se fera comme sur l'exemple de notre bouton déclaré localement. Il faut donc extraire l'Inspectors en variable membre pour contourner le problème. Il faut donc déclarer une variable membre et écrire ceci :

private Outlook.Inspectors m_oInspectors;

// ...
// Plus loin dans le code

this.m_oInspectors = this.Application.Inspectors;
this.m_oInspectors.NewInspector += new Outlook.InspectorsEvents_NewInspectorEventHandler(this.Inspectors_NewInspector);

Sachant cela, vous n'aurez plus de surprise avec la gestion des événements qui viennent de l'Interop.