VB.Net 2005 : le namespace My

Cet objet fournit des méthodes et des propriétés permettant d'obtenir des informations sur l'application courante, son environnement d'exécution, sa culture ou encore son assembly. Comme pour tous les autres objets du namespace My, certaines méthodes et propriétés ne sont pas disponibles selon le mode de l'application (Console, WinForms…), tout cela est détaillé dans la documentation. L'objet My.Application utilise une terminologie claire et intuitive, ainsi aidé de l'IntelliSense, vous n'aurez pas de difficulté à l'utiliser, et ce, même sans la documentation. Avec l'objet MyComputer, l'objet My.Application est sûrement celui que vous utiliserez le plus fréquemment. Cet objet n'est pas utilisable dans les applications ASP.Net.

Voici une impression d'écran des méthodes et propriétés proposées par My.Application :

Exemples d'utilisation de cet objet

Je ne pense pas qu'il soit utile de commenter à outrance ces deux exemples de code, ils sont extrêmement simples, ils consistent en deux fonctions retournant respectivement, le chemin complet du répertoire où se situe l'exécutable de votre application et le nom de l'assembly de votre application.

    Public Function getRepertoireAppli() As String

        Dim maString As String = String.Empty

        ' Récupération du chemin de l'application
        maString = My.Application.Info.DirectoryPath

        Return maString

    End Function

    Public Function getNomAssembly() As String

        Dim maString As String = String.Empty

        ' Récupération du nom de l'assembly
        maString = My.Application.Info.AssemblyName

        Return maString

    End Function

Passons maintenant à l'objet My.Computer, qui avec l'objet My.Application vous sera très utile.

L'objet My.Computer est, selon moi, le plus utile dans les « développements de tous les jours », en effet il permet d'accéder à une foule d'informations à propos de la machine sur laquelle s'exécute votre programme et de plus il offre un accès direct aux composants principaux tels la carte réseau, la carte son, le système de fichiers, le registre…
Voyons rapidement deux exemples illustrant l'utilisation de cet objet.

Exemples d'utilisation de cet objet 

Ci-dessous voilà un morceau de code permettant de récupérer le nom de la machine où s'exécute votre application.

    Public Function getNomMachine() As String

        Dim maString As String = String.Empty

        ' Récupération du nom de la machine
        maString = My.Computer.Name

        Return maString

    End Function

Le code suivant permet de réaliser la copie du contenu d'un répertoire. Pour ceux ayant déjà voulu copier l'ensemble des fichiers d'un répertoire, ils savent que c'est une chose qui n'est forcément très simple à mettre en œuvre et qui tient sur plusieurs lignes de code. Ici, de par l'apport du My, on voit que l'on possède une méthode (CopyDirectory) toute prête. En une ligne de code, il est désormais possible de réaliser cette opération. Cette méthode repose sur les mêmes méthodes que vous utilisez tous les jours pour faire de la copie de fichiers, mais le namespace My apporte une grande simplicité à cette opération.

    Public Function copieRepertoire(ByVal repSource As String, ByVal repDestination As String) As Boolean

        Try
            ' Copie du contenu d'un répertoire
            My.Computer.FileSystem.CopyDirectory(repSource, repDestination, True, FileIO.UICancelOption.DoNothing)

            Return True

        Catch ex As Exception

            Return False

        End Try

    End Function

Enfin, voici le troisième et dernier exemple, qui permet de lire un fichier audio, vous voyez ici que l'on peut difficilement faire plus simple. Le namespace My montre, dans cet exemple, à quel point il peut se montrer pratique.

    Public Function jouerSon() As Boolean

        Try

            ' Lecture d'un fichier Wave en arrière-plan de l'application
            My.Computer.Audio.Play("c:\maMusique.wav", AudioPlayMode.Background)

            Return True

        Catch ex As Exception

            Return False

        End Try


    End Function

Allez, on continue notre tour d'horizon du My, maintenant le My.Forms…

My.Forms offre un accès à l'ensemble des formulaires de votre application. Les fonctionnalités qu'il offre sont très nombreuses, mais nous ne les aborderons pas, car vous y êtes fréquemment confrontés lors de la réalisation des interfaces graphiques de vos applications .Net. Cet objet n'est pas utilisable dans les applications ASP.Net.

Exemple

Cet exemple vous montre comment griser le bouton « maximize » de la Form1.

    Public Function maximizeForm(ByVal valeur As Boolean) As Boolean

        Try
            ' Permet de désactiver le bouton permettant de maximiser la taille de votre Form
            ' (Le bouton se trouvant dans le coin supérieur droit de la fenêtre.)
            My.Forms.Form1.MaximizeBox = valeur

            Return True

        Catch ex As Exception

            Return False

        End Try

    End Function

L'objet My.Settings permet d'accéder aux paramètres des fichiers de configuration de l'application et de l'utilisateur. Il vous permettra par exemple de récupérer la valeur d'une chaine de connexion ou d'un mot de passe dans un fichier utilisateur. Cet objet n'est pas utilisable dans les applications ASP.Net.

Voici une copie d'un fichier de configuration contenant une seule clé (maChaine1) :

<?xml version="1.0" encoding="utf-8" ?> 
<SettingsFile xmlns="http://schemas.microsoft.com/VisualStudio/2004/01/settings" CurrentProfile="(Default)">

<Profiles>
  <Profile Name="(Default)" /> 
</Profiles>

<Settings>
  <Setting Name="maChaine1" Type="System.String" Scope="Application">
    <Value Profile="(Default)">ma chaine numéro 1</Value> 
  </Setting>
</Settings>
        
</SettingsFile>

Exemples

Les exemples suivants permettent de récupérer et de modifier la valeur de la clé « maChaine1 » dans le fichier de configuration d'une application.

    Public Function getMySetting() As String

        Dim monParam As String = String.Empty
        monParam = My.Settings.Item("maChaine1").ToString

        Return monParam

    End Function

    Public Function setMySetting(ByVal monParam As String) As String

        My.Settings.Item("maChaine1") = monParam

        Return monParam

    End Function

Maintenant vient le tour de l'objet My.User…

Les deux méthodes et les trois propriétés de l'objet My.User vous permettent d'accéder aux informations essentielles relatives à l'utilisateur courant de votre application. Cet objet permet de savoir comment est authentifié l'utilisateur, qui il est, et quel utilisateur est utilisé par votre application pour s'exécuter.

Exemple d'utilisation de l'objet My.User

Cet exemple permet simplement de retourner dans une chaine de caractères le nom de l'utilisateur authentifié.

    Public Function getUtilisateur() As String

        Dim monUtilisateur As String = String.Empty
        monUtilisateur = My.User.Name

        Return monUtilisateur

    End Function

Allez, on s'accroche ! Et on passe à My.WebServices…

Cet objet vous permet d'accéder aux Web Services référencés dans votre projet. Attention, cette fonctionnalité n'est pas accessible dans les applications ASP.Net. Il est ainsi possible de faire appel à une instance d'un WebService en une seule ligne de code. Une fois de plus, vu l'intuitivité de l'objet My.WebService, nous n’entrerons pas dans les détails. Sachez seulement que pour ajouter un Web Service à votre projet, vous devez utiliser « Ajouter une référence Web » dans l'explorateur de solution de Visual Studio 2005, puis vous laisser guider par l'assistant.

Pour consommer ce Web Service, il ne vous reste plus qu'à utiliser la ligne de code My.WebServices.« nom du web service ». « nom de la méthode souhaitée », l'IntelliSense vous listera les Web Services référencés dans votre projet, ainsi que leurs méthodes respectives.

Passons maintenant aux objets du namespace My qui sont spécifiques à ASP.Net.

Les objets que nous allons voir dans cette partie appartiennent également au namespace My, mais ne sont utilisables qu'avec les applications ASP.Net, cela signifie qu'ils ne seront pas dans une application WinForm ou console. Ces trois objets sont My.Log, My.Request et My.Response. Ils regroupent un bon nombre de fonctionnalités que les développeurs Web sont appelés à utiliser fréquemment, voyons cela sans plus tarder, en commençant par l'objet My.Log.

1. My.Log

Cet objet est équivalent aux fonctionnalités en matière d'accès aux fichiers log fournies par My.Application, mais il a la particularité d'être dédié aux applications ASP.Net. Il permet notamment d'inscrire des informations relatives au fonctionnement de votre application et aux exceptions qui y sont levées directement dans le fichier Log. Le gain intéressant apporté ici par le namespace My est que cette opération est effectuée en une seule ligne de code ! Qui dit mieux ?

1. My.Request et My.Response

Tout comme l'objet My.Log, les objets My.Request et My.Response sont spécifiques à ASP.Net. Ce qui est tout à fait logique, car vu leur nature ils seraient absolument inutiles en WinForms… :) Voyons deux exemples qui montrent comment utiliser cet objet.

Exemples d'utilisation de My.request

Le premier exemple nous montre simplement comment récupérer le chemin physique complet de notre application.

   Public Function getCheminPhysique() As String

        Try

            Dim cheminPhysique As String = String.Empty
            ' Récupération du chemin physique de l'application sur le serveur
            cheminPhysique = My.Request.PhysicalApplicationPath

            Return cheminPhysique

        Catch ex As Exception

            Return "Une erreur est survenue."

        End Try

    End Function

Dans une optique de statistique ou de contrôle de fonctionnement, il peut être intéressant d'accéder aux différentes variables du serveur, nous allons voir ici comment récupérer très simplement l'ensemble de ces variables à l'aide de My.Request.

    Public Function getVariablesServeur() As String


        ' Remarque : vous devez faire un Imports System.Text pour pouvoir
        ' utiliser l'objet String.Builder

        Dim maListe As Array
        Dim mesVariablesServeur As New StringBuilder
        Dim uneVariableServeur As String = String.Empty
        Dim maChaineVariables As String = String.Empty

        Try

            ' Récupère dans un tableau la liste des variables serveur
            maListe = My.Request.ServerVariables.AllKeys


            ' Parcourt le tableau de variables et les place dans un StringBuilder
            For Each uneVariableServeur In maListe

                mesVariablesServeur.Append(uneVariableServeur & "</BR>")

            Next

            ' Place le StringBuilder dans une chaine de caractères
            maChaineVariables = mesVariablesServeur.ToString

            Return maChaineVariables

        Catch ex As Exception

            Return ex.Message

        End Try

    End Function

Exemples d'utilisation de My.Response :

    Public Function getEncodageHeader() As String

        Dim monHeader As String = String.Empty

        Try

            ' Récupération de l'encodage du header de la page
            monHeader = My.Response.HeaderEncoding.HeaderName
            Return monHeader

        Catch ex As Exception

            Return ex.Message

        End Try

    End Function

    Public Function getDureeCache() As String

        Dim dureeCache As String = String.Empty

        Try

            ' Récupération de la durée d'expiration de la page dans
            ' le cache du navigateur Web
            dureeCache = My.Response.Expires.ToString
            Return dureeCache

        Catch ex As Exception

            Return ex.Message

        End Try

    End Function

Voilà, nous avons fait le tour de l'ensemble des objets que nous propose le namespace My. Je ne suis pas trop rentré dans le détail pour éviter d'alourdir l'article, en effet, ce namespace seul pourrait faire l'objet d'un livre complet si l'on souhaitait être exhaustif. Si vous souhaitez connaître en détail les méthodes et propriétés de ces neuf objets, je vous renvoie à la lecture de la documentation, vous trouverez tous les liens nécessaires dans la partie « Documentation MSDN » de cet article.

Après avoir vu comment utiliser ce que nous propose nativement le namespace My, voyons comment nous pouvons y ajouter nos propres objets, méthodes et propriétés.

Voici un fichier Zip contenant les fichiers mesMethodes.vb et maClasse.vb correspondant à l'intégralité du code présent dans cet article.

Voici les liens pointant vers la documentation MSDN relative au namespace My et aux objets s'y rattachant. Cette documentation n'est pour le moment pas définitive et est susceptible d'évoluer d'ici la sortie de la version finale du Framework .Net 2.0.