Code personnalisé et références d'assembly dans les expressions dans le Concepteur de rapports (SSRS)

Vous pouvez ajouter des références au code personnalisé incorporé dans un rapport ou aux assemblys personnalisés que vous générez, puis enregistrez et déployez vers le serveur de rapports. L'incorporation de code convient dans le cas de constantes personnalisées, de fonctions complexes ou de fonctions utilisées plusieurs fois dans un même rapport. Utilisez les assemblys de code personnalisés pour gérer le code en un seul et même endroit, et pour le partager en vue de son utilisation dans plusieurs rapports. Le code personnalisé peut inclure de nouvelles constantes personnalisées, variables, fonctions ou sous-routines. Vous pouvez inclure des références en lecture seule à des collections intégrées, telles que la collection de paramètres. Cependant, les fonctions personnalisées ne peuvent pas recevoir des ensembles de valeurs de données de rapport : les agrégats personnalisés ne sont notamment pas pris en charge.

Remarque relative à la sécuritéRemarque relative à la sécurité

Pour les calculs urgents qui sont évalués une seule fois au moment de l'exécution et qui doivent conserver la même valeur durant tout le traitement du rapport, déterminez s'il convient d'utiliser une variable de rapport ou une variable de groupe. Pour plus d'informations, consultez Utilisation de références à des collections de variables de rapport et de groupe (Générateur de rapports version 3.0 et SSRS).

Le Concepteur de rapports est l'environnement de création à utiliser de préférence pour l'ajout de code personnalisé à un rapport. Le Générateur de rapports version 3.0 prend en charge le traitement des rapports contenant des expressions valides, ou contenant des références à des assemblys personnalisés sur un serveur de rapports. Le Générateur de rapports ne permet pas d'ajouter de référence à un assembly personnalisé.

Notes

Gardez à l'esprit que, durant la mise à niveau d'un serveur de rapports, les rapports qui dépendent d'assemblys personnalisés peuvent nécessiter des opérations supplémentaires. Pour plus d'informations, consultez Utilisation du Conseiller de mise à niveau pour la préparation des mises à niveau.

Notes

Vous pouvez créer et modifier des définitions de rapports (.rdl) dans le Générateur de rapports version 3.0 et dans le Concepteur de rapports, dans Business Intelligence Development Studio. Chaque environnement de création offre différentes possibilités pour créer, ouvrir et enregistrer des rapports et des éléments connexes. Pour plus d'informations, consultez Conception de rapports dans le Concepteur de rapports et le Générateur de rapports version 3.0 (SSRS) sur le site Web Microsoft.

Dans cet article

Utilisation de code personnalisé dans le Générateur de rapports version 3.0

Intégration de références aux fonctions couramment utilisées

Intégration de références aux fonctions moins couramment utilisées

Intégration de références aux assemblys externes

Ajout de code incorporé

Ajout de références aux paramètres à partir du code

Ajout de références au code à partir d'assemblys personnalisés

Utilisation de code personnalisé dans le Générateur de rapports version 3.0

Dans le Générateur de rapports, vous pouvez ouvrir un rapport présent sur le serveur de rapports, contenant des références à des assemblys personnalisés. Par exemple, il est possible de modifier des rapports ayant été créés et déployés à l'aide du Concepteur de rapports dans Business Intelligence Development Studio. Les assemblys personnalisés doivent être déployés vers le serveur de rapports.

Vous ne pouvez pas effectuer les opérations suivantes :

  1. Ajouter des références ou des instances de membre de classe à un rapport.

  2. Afficher l'aperçu d'un rapport avec les références aux assemblys personnalisés en mode local.

Icône de flèche utilisée avec le lien Retour au débutRetour au début

Intégration de références aux fonctions couramment utilisées

Utilisez la boîte de dialogue Expression pour consulter une liste classée par catégorie de fonctions courantes intégrées à Reporting Services. Lorsque vous développez Fonctions communes et cliquez sur une catégorie, le volet Élément affiche la liste des fonctions que vous incluez dans une expression. Les fonctions communes incluent des classes provenant des espaces de noms .NET Framework System..::..Math et System..::..Convert ainsi que des fonctions de la bibliothèque d'exécutables Visual Basic. Pour plus de commodité, vous pouvez consulter les fonctions le plus communément utilisées dans la boîte de dialogue Expression, où elles sont répertoriées par catégorie : Texte, Date et heure, Math, Inspection, Flux de programme, Agrégat, Financier, Conversion et Divers. Les fonctions moins souvent utilisées n'apparaissent pas dans la liste, mais peuvent cependant être utilisées dans une expression.

Pour utiliser une fonction intégrée, double-cliquez sur son nom dans le volet Élément. Une description de la fonction s'affiche dans le volet Description et un exemple de l'appel de la fonction apparaît dans le volet d'exemple. Dans le volet du code, lorsque vous tapez le nom de la fonction suivi par une parenthèse ouvrante (, l'aide d'IntelliSense affiche chaque syntaxe valide pour l'appel de la fonction. Par exemple, pour calculer la valeur maximale pour un champ nommé Quantity dans une table, ajoutez l'expression simple =Max( au volet du code, puis utilisez les balises actives pour consulter toutes les syntaxes valides possibles pour l'appel de la fonction. Pour compléter cet exemple, tapez =Max(Fields!Quantity.Value). 

Pour plus d'informations sur chaque fonction, consultez System..::..Math, System..::..Convert et Membres de la bibliothèque runtime Visual Basic sur MSDN.

Icône de flèche utilisée avec le lien Retour au débutRetour au début

Intégration de références aux fonctions moins couramment utilisées

Pour inclure une référence à d'autres espaces de noms CLR moins couramment utilisés, vous devez utiliser une référence complète, par exemple System.Text..::..StringBuilder. IntelliSense n'est pas pris en charge dans le volet du code de la boîte de dialogue Expression pour ces fonctions moins couramment utilisées.

Pour plus d'informations, consultez Membres de la bibliothèque Runtime Visual Basic sur MSDN.

Intégration de références aux assemblys externes

Pour inclure une référence à une classe dans un assembly externe, vous devez identifier l'assembly pour le processeur de rapports. Utilisez la page Références de la boîte de dialogue Propriétés du rapport pour spécifier le nom complet de l'assembly à ajouter au rapport. Dans votre expression, vous devez utiliser le nom complet de la classe dans l'assembly. Les classes dans un assembly externe n'apparaissent pas dans la boîte de dialogue Expression ; vous devez fournir le nom correct de la classe. Un nom complet comprend l'espace de noms, le nom de la classe et le nom du membre.

Icône de flèche utilisée avec le lien Retour au débutRetour au début

Ajout de code incorporé

Pour ajouter du code incorporé à un rapport, utilisez l'onglet Code de la boîte de dialogue Propriétés du rapport. Le bloc de code que vous créez peut contenir plusieurs méthodes. Les méthodes du code incorporé doivent être écrites dans Microsoft Visual Basic et être basées sur des instances. Le processeur de rapports ajoute automatiquement des références pour les espaces de noms System.Convert et System.Math. Utilisez la page Références de la boîte de dialogue Propriétés du rapport pour ajouter des références d'assemblys. Pour plus d'informations, consultez Procédure : ajouter une référence d'assembly à un rapport (SSRS).

Les méthodes du code incorporé sont disponibles par l'intermédiaire d'un membre Code globalement défini. Pour y accéder, vous devez faire référence au membre Code et au nom de la méthode. L'exemple ci-dessous appelle la méthode ToUSD, qui convertit la valeur du champ StandardCost en une valeur exprimée en dollars :

=Code.ToUSD(Fields!StandardCost.Value)

Pour faire référence à des collections intégrées dans votre code personnalisé, incluez une référence à l'objet Report intégré :

=Report.Parameters!Param1.Value

Les exemples ci-dessous indiquent comment définir des variables et des constantes personnalisées.

Public Const MyNote = "Authored by Bob"
Public Const NCopies As Int32 = 2
Public Dim  MyVersion As String = "123.456"
Public Dim MyDoubleVersion As Double = 123.456

Bien que les constantes personnalisées n'apparaissent pas dans la catégorie Constantes de la boîte de dialogue Expression (qui affiche uniquement les constantes intégrées), vous pouvez leur ajouter des références à partir de n'importe quelle expression, comme le montrent les exemples suivants. Dans une expression, une constante personnalisée est traitée comme une valeur de type Variant.

=Code.MyNote
=Code.NCopies
=Code.MyVersion
=Code.MyDoubleVersion

L'exemple suivant inclut la référence au code et l'implémentation de code de la fonction FixSpelling, qui substitue le texte "Bicycle" à toutes les occurrences du texte « Bike » dans le champ SubCategory.

=Code.FixSpelling(Fields!SubCategory.Value)

Le code suivant, lorsqu'il est incorporé dans un bloc de code de définition de rapport, affiche une implémentation de la méthode FixSpelling. Cet exemple indique comment utiliser une référence complète à la classe Microsoft .NET Framework StringBuilder.

Public Function FixSpelling(ByVal s As String) As String
   Dim strBuilder As New System.Text.StringBuilder(s)
   If s.Contains("Bike") Then
      strBuilder.Replace("Bike", "Bicycle")
      Return strBuilder.ToString()
      Else : Return s
   End If
End Function

Pour plus d'informations sur les collections d'objets intégrées et l'initialisation, consultez Utilisation de références à des champs Globals et Users prédéfinis (Report Builder 3.0 et SSRS) et Initialisation d'objets Assembly personnalisés.

Icône de flèche utilisée avec le lien Retour au débutRetour au début

Ajout de références aux paramètres à partir du code

Vous pouvez référencer la collection globale de paramètres via du code personnalisé dans un bloc de code de la définition de rapport ou dans un assembly personnalisé que vous fournissez. La collection de paramètres est en lecture seule et ne possède aucun itérateur public. Vous ne pouvez pas utiliser de construction Visual Basic For Each pour parcourir la collection. Vous devez connaître le nom du paramètre défini dans la définition de rapport pour pouvoir ensuite le référencer dans votre code. Cependant, vous pouvez effectuer une itération dans toutes les valeurs d'un paramètre à valeurs multiples.

Le tableau suivant présente des exemples du référencement de la collection Parameters intégrée à partir du code personnalisé :

Description

Référence dans une expression

Définition de code personnalisé

Transmission de l'intégralité de la collection globale de paramètres au code personnalisé.

Cette fonction retourne la valeur d'un paramètre de rapport spécifique MyParameter.

=Code.DisplayAParameterValue(Parameters)

Public Function DisplayAParameterValue(

ByVal parameters as Parameters) as Object

Return parameters("MyParameter").Value

End Function

Transmission d'un seul paramètre au code personnalisé.

Cet exemple retourne la valeur du paramètre transmis. Si le paramètre est un paramètre à valeurs multiples, la chaîne retournée est une concaténation de toutes les valeurs.

=Code.ShowParametersValues(Parameters!DayOfTheWeek)

Public Function ShowParameterValues(ByVal parameter as Parameter)
 as String
   Dim s as String 
   If parameter.IsMultiValue then
      s = "Multivalue: " 
      For i as integer = 0 to parameter.Count-1
         s = s + CStr(parameter.Value(i)) + " " 
      Next
   Else
      s = "Single value: " + CStr(parameter.Value)
   End If
   Return s
End Function

Icône de flèche utilisée avec le lien Retour au débutRetour au début

Ajout de références au code à partir d'assemblys personnalisés

Pour utiliser un assembly personnalisé dans un rapport, vous devez créer l'assembly, le rendre accessible au Concepteur de rapports, ajouter une référence à l'assembly dans le rapport et utiliser une expression dans le rapport qui fait référence aux méthodes contenues dans cet assembly. Lorsque le rapport est déployé sur le serveur de rapports, vous devez également déployer l'assembly personnalisé sur le serveur de rapports.

Pour plus d'informations sur la création d'un assembly personnalisé et sur la façon de le rendre disponible pour Reporting Services, consultez Utilisation d'assemblys personnalisés avec des rapports.

Pour faire référence à du code personnalisé dans une expression, vous devez appeler le membre d'une classe au sein de l'assembly. La procédure pour ce faire dépend du type de méthode, à savoir statique ou basée sur une instance. Les méthodes statiques d'un assembly personnalisé sont disponibles de façon globale dans le rapport. Elles sont accessibles dans les expressions en spécifiant l'espace de noms, la classe et le nom de la méthode. L'exemple de code ci-dessous appelle la méthode ToGBP, qui convertit la valeur en dollars du champ StandardCost en une valeur exprimée en livres sterling :

=CurrencyConversion.DollarCurrencyConversion.ToGBP(Fields!StandardCost.Value)

Les méthodes basées sur des instances sont disponibles par l'intermédiaire d'un membre Code globalement défini. Vous pouvez y accéder en faisant référence au membre Code, suivi du nom de l'instance et de la méthode. L'exemple de code ci-dessous appelle la méthode ToEUR, qui convertit la valeur en dollars du champ StandardCost en une valeur exprimée en euros :

=Code.m_myDollarCoversion.ToEUR(Fields!StandardCost.Value)

Notes

Dans le Concepteur de rapports, un assembly personnalisé est chargé une fois et il n'est pas déchargé tant que vous ne fermez pas Visual Studio. Si vous affichez un aperçu d'un rapport, modifiez un assembly personnalisé utilisé dans ce rapport, puis affichez à nouveau l'aperçu, vos modifications n'apparaissent pas dans ce deuxième aperçu. Pour recharger l'assembly, fermez et rouvrez Visual Studio, puis affichez l'aperçu du rapport.

Pour plus d'informations sur l'accès à votre code, consultez Accès aux assemblys personnalisés par le biais d'expressions.

Icône de flèche utilisée avec le lien Retour au débutRetour au début

Passage de collections intégrées dans les assemblys personnalisés

Si vous souhaitez passer des collections intégrées, telles que la collection Globals ou Parameters, dans un assembly personnalisé pour le traitement, vous devez ajouter une référence d'assembly dans votre projet de code à l'assembly qui définit les collections intégrées et accède à l'espace de noms approprié. Selon que vous développez l'assembly personnalisé pour un rapport exécuté sur un serveur de rapports (rapport de serveur) ou un rapport exécuté localement dans une application .NET (rapport local), l'assembly que vous devez référencer est différent. Pour plus d'informations, reportez-vous au passage correspondant ci-dessous.

  • Espace de noms : Microsoft.ReportingServices.ReportProcessing.ReportObjectModel

  • Assembly (rapport local) : Microsoft.ReportingServices.ProcessingObjectModel.dll

  • Assembly (rapport de serveur) : Microsoft.ReportViewer.ProcessingObjectModel.dll

Dans la mesure où le contenu des collections Fields et ReportItems peut changer dynamiquement pendant l'exécution, vous ne devez pas les conserver d'un appel à l'autre dans l'assembly personnalisé (par exemple, dans une variable membre). La même recommandation s'applique en général à toutes les collections intégrées.