Archive. Posts from 2004 to 2016, kept as they were written. My current blog is at dariuszparys.com.

Hier nochmal die Referenzen zu den bisherigen Artikeln:

Bisher habe ich nur ein kleines Grundgerüst für die Factory erstellt und alles unnötige rausgeworfen. Zudem schrieb ich meine 1.203.839 Millionste "Hello, world." Implementierung.

Ein wichtiger Bestandteil von MyFactory wird die Darstellung im Kontextmenü vom Solution Explorer sein. Die Menüeinträge sollen nämlich nur erscheinen wenn es sich um Projekte handelt die für MyFactory entsprechend konfiguriert sind.

Es wird zwei Wege geben ein Projekt für den Directory Zugriff freizuschalten.

  1. Das Projekt wird gleich mit dem MyFactory Projekt-Template erstellt
  2. Ein existierendes Projekt wird nachträglich durch die MyFactory für den Zugriff konfiguriert.

Ich betrachte jetzt einfach den Fall 2, da Fall 1 wesentlich leichter zu implementieren ist. Ein geladenes Projekt soll durch den Eintrag "Enable MyFactory" für den Directory Zugriff freigeschalten werden.

Um das ganze ein wenig zu veranschaulichen, hier ein Screenshot aus der Web Service Software Factory die auch mit Kontextmenü Befehlen arbeitet.

shot1

In das Kontextmenü ist unser Hello, world Beispiel aus Teil 2 auch angezeigt worden. Hier möchte ich eine Verschachtelung ebenso erhalten wie auch die Funktionalität das sich der Befehl eben nur bei Directory aktivierten Projekten ins Kontextmenü einblendet.

Ein Projekt das für die Directory Komponente aufbereitet wird erhält neben einem Flag um später zu Erkennen das es sich eben um ein solches handelt, noch ein paar Assembly Referenzen die die notwendige Core-Funktionalität für den Zugriff enthalten. Es geht ja bei dieser Factory lediglich darum die Attribute anpassbar zu machen und eine stabile Implementierung weiter zu nutzen.

Ich benötige ein Rezept das ich im Kontextmenü von Projekten und Solutions anzeigen lasse. Diese Bindung ist also nicht speziell Template bezogen und ist dementsprechend "Unbound".

Ein großes Manko des bestehenden Guidance Automation Toolkits ist die spartanische Funktionsbibliothek die zur Verfügung steht um eigene Software Factories zu bauen. Das GAT kommt gerade mit sovielen Funktionen um das mitgelieferte Beispiel zu implementieren. Benötigt man etwas mehr ist man nun auf sich allein gestellt.

Das Erweitern des GAT ist allerdings kein Hexenwerk. Unser Rezept binden wir dementsprechend mit einer eigenen "Rezept-Referenz".

Eine neue Klasse names AddProjectReference ist jetzt in der Lösung enthalten und sieht folgendermaßen aus:

using System;
using EnvDTE;
using EnvDTE80;
using VSLangProj;
using System.Runtime.Serialization;
using Microsoft.Practices.RecipeFramework;

namespace Microsoft.Germany.Sample.References
{
    [Serializable]
    public class AddProjectsReference : UnboundRecipeReference
    {
        public AddProjectsReference( string recipe )
            : base( recipe )
        {
        }

        protected AddProjectsReference( SerializationInfo info,
            StreamingContext context ) : base( info, context )
        {
        }

        public override bool IsEnabledFor( object target )
        {
            if( target is Solution ||
                target is Project )
            {
                return true;
            }
            else
            {
                return false;
            }

        }

        public override string AppliesTo
        {
            get
            {
                return "Solution Folders or Projects";
            }
        }
    }
}

Abgeleitet von UnboundRecipeReference implementiert man einfach IsEnabledFor. Hier wird geprüft ob das Ziel ein Projekt oder eine Solution ist. Das ist schon alles.

Diese Klasse kann ich nun in den CreateBindings.xml nutzen um das noch zu erstellende EnableMyFactoryRecipe zu binden. Hier die Erweiterung der CreateBindings.xml Datei.

<?xml version="1.0" encoding="utf-8" ?>
<Recipe xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
Name="CreateBindings"
xmlns="http://schemas.microsoft.com/pag/gax-core">
  <Types>
    <TypeAlias
Name="RefCreator"
Type="Microsoft.Practices.RecipeFramework.Library.Actions.CreateUnboundReferenceAction,
Microsoft.Practices.RecipeFramework.Library"/>
  </Types>
  <Caption>All MyFactory Bindings</Caption>
  <Actions>
    <Action
        Name="EnableMyFactoryRef"
        Type="RefCreator"
        AssetName="EnableMyFactoryRecipe"
        ReferenceType="Microsoft.Germany.Sample.References.AddProjectsReference,
                     MyFactory"/>
  </Actions>
</Recipe>

Das HelloWorld Rezept habe ich rausgeworfen.

Drei Dinge muss ich noch tun bevor das Rezept im Kontextmenü auftaucht. Anpassen der MyFactory.xml, erstellen des EnableMyFactoryRecipe und Implementieren einer DoNothingAction.

Die MyFactory.xml erweitere ich um ein paar Menüeinträge. Ich möchte ebenfalls ein kaskadierendes Menü für meine Factory haben. Des Weiteren füge ich noch in Zeile 33 das EnableMyFactoryRecipe hinzu.

<?xml version="1.0" encoding="utf-8" ?>
<GuidancePackage xmlns="http://schemas.microsoft.com/pag/gax-core"
    Name="MyFactory"
    Caption="MyFactory"
    Description="A simple factory sample"
    BindingRecipe="CreateBindings"
    Guid="ef0581dd-9b0d-48ae-acd9-599d5a92fc6b"
    SchemaVersion="1.0">
  <Overview Url="documentation\Overview.htm"/>
  <HostData>
    <Menu Name="MySolution" Text="My Software Factory" Priority="1">
      <CommandBar Name="Solution"/>
    </Menu>
    <Menu Name="MyProject" Text="My Software Factory" Priority="1">
      <CommandBar Name="Project"/>
    </Menu>
    <Menu Name="MyItem" Text="My Software Factory" Priority="1">
      <CommandBar Name="Item"/>
    </Menu>
    <Menu Name="MyFolder" Text="My Software Factory" Priority="1">
      <CommandBar Name="Solution Folder"/>
    </Menu>
    <Menu Name="MyWebProject" Text="My Software Factory" Priority="1">
      <CommandBar Name="Web Project"/>
    </Menu>
    <Menu Name="MyWebProjectItem" Text="My Software Factory" Priority="1">
      <CommandBar Name="Web Item"/>
    </Menu>
  </HostData>
  <Recipes>
    <xi:include href="Recipes\CreateBindings.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"/>
    <xi:include href="Recipes\EnableMyFactoryRecipe.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"/>
  </Recipes>
</GuidancePackage>

Die Zeilen 10 - 29 definieren das Kontextmenü Root Entry mit dem Text "My Software Factory". Vorsorglich für noch mehr Projekttypen als notwendig.

Ein Rezept benötigt immer eine Aktion damit es in ein Guidance Package implementiert werden kann. Da ich jetzt noch keine Aktion ausführen möchte, implementiere ich einfach ein NOP. Hier der Code

using System;
using Microsoft.Practices.ComponentModel;
using Microsoft.Practices.RecipeFramework;

namespace Microsoft.Germany.Sample.Actions
{
    class DoNothingAction : Action
    {
        public override void Execute()
        {
            // nop - no operation
        }

        public override void Undo()
        {
            // nop - no operation
        }
    }
}

Nun endlich kann die EnableMyFactoryRecipe.xml Datei erstellt werden. Nicht vergessen das die Properties auf Content und Copy Always / Copy if newer stehen sollten damit diese ins Paket wandert. Hier das Rezept

<?xml version="1.0" encoding="utf-8" ?>
<Recipe xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:xsd="http://www.w3.org/2001/XMLSchema"
        Name="EnableMyFactoryRecipe"
        xmlns="http://schemas.microsoft.com/pag/gax-core"
        Bound="false">
  <xi:include href="Common\TypeAlias.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
  <Caption>Enable My Factory for this project</Caption>
  <HostData>
    <CommandBar Menu="MyProject"/>
  </HostData>
  <Actions>
    <Action Name="DoNothingAction"
        Type="Microsoft.Germany.Sample.Actions.DoNothingAction, MyFactory">
    </Action>
  </Actions>
</Recipe>

Wichtig ist in Zeile 10 das man hier das Attribut Menu anstatt Nameverwendet. Sonst funktioniert das ganze nicht.

Nun noch kompilieren und registrieren. Über den Guidance Package Manager in ein bestehendes Projekt laden und dann auf das Kontextmenü gehen. Voilâ!

shot2

Ein kaskadierendes Menü das nichts tut, aber es erscheint nun wie es soll.

Im nächsten Teil implementiere ich die Funktionalität weiter und zeige wie man Projekte um Attribute erweitert damit man weiß ob die Factory hier eingesetzt wurde oder nicht.