AssignHeader (FPScript)
Affecte les informations d'en-tête à une valeur.
Syntaxe
AssignHeader(Value, [ DataObject ] [ , ElementNames ])
La syntaxe de la fonction AssignHeader se compose des éléments suivants :
Section |
Description |
|---|---|
Value |
La valeur à laquelle l'information d'en-tête est attribuée. Toutes les structures de données sont autorisées. Tous les types de données sont autorisés. |
DataObject |
Une référence à un objet de données dont l'information d'en-tête doit être assignée, ou une valeur avec une information d'en-tête attachée qui doit être assignée. Si vous omettez l'argument, des informations d'en-tête sont créées et attribuées qui ne sont pas liées à un objet de données. Si vous passez comme argument de DataObject un lien vers la formule dans laquelle vous appelez la fonction AssignHeader, les paramètres de l'onglet "Résultats" de cette formule sont pris en compte. Toutes les structures de données sont autorisées. Tous les types de données ainsi que les références d'objets sont autorisés. |
ElementNames |
Une liste dont les noms d'éléments doivent être utilisés pour former les noms d'éléments du résultat. Cet argument n'est utilisé que si, en tant qu'argument de DataObject vous avez spécifié un lien vers la formule dans laquelle vous appelez la fonction AssignHeader et la valeur de sa propriété "Nom d'élément de liste" est "Automatique ». AssignHeader attribue alors les noms aux éléments de la liste de résultats. Ces noms sont formés à partir des noms des éléments de la liste passée et des paramètres de l'onglet "Résultat" de la formule. L'utilisation de AssignHeader avec cet argument est obsolète. Utilisez à la place la variable locale SourceData comme indiqué sous Exemples . Toutes les structures de données sont autorisées. Tous les types de données ainsi que les références d'objets sont autorisés. |
Remarques
Le résultat est la valeur passée à laquelle l'information d'en-tête a été transmise ou dont elle a été retirée. Si Value est une liste, alors l'information d'en-tête est attribuée à chaque élément de la liste. Si un élément de liste est nommé, une copie séparée des informations d'en-tête est ajoutée pour cet élément et le nom de l'élément de liste est saisi comme attribut "Nom".
Disponible dans
FlexPro View, Basic, Professional, Developer Suite
Exemples
Result = AssignHeader(Result, This) |
Attribue les informations d'en-tête de la formule avec le code FPScript à la valeur "Result". |
Result = AssignHeader(Result, Formula As Object) |
Affecte les informations d'en-tête de la formule à la valeur "Result". |
Result = AssignHeader(Result, Formula) |
Affecte à la valeur "Result" l'information d'en-tête, qui est annexée au résultat de la formule "Formula". |
Result = AssignHeader(Result, $"\Data\Channel1"$) |
Affecte à la valeur "Result" les informations d'en-tête de l'ensemble de données avec le nom de chemin spécifié dans la chaîne. |
Result = AssignHeader(Integral(Data)) |
Attribue la valeur "Result" aux informations d'en-tête qui ne sont pas liées à un objet de données, puis leur attribue un nom. |
Dim Data = [Signal1, Signal2] |
Calcule l'intégrale de deux ensembles de données et renvoie le résultat sous forme de liste. Une copie séparée des informations d'en-tête de la formule contenant le code FPScript est attribuée à chaque élément de la liste. Si l'option "Automatique" est sélectionnée dans l'onglet "Résultat" de la formule sous "Liste des noms d'éléments" et que "(Automatique)" est défini comme modèle, l'attribut "Nom" est alors défini comme "Signal1Integral" ou "Signal2Integral". Cela signifie que l'expression Result.[0].Name renverrait "Signal1Integral", par exemple. |
Dim SourceData = [Signal1, Signal2] |
Ce code est l'équivalent de l'exemple précédent sans la fonction AssignHeader. Si vous attribuez les données sources à la variable locale SourceData, après le calcul, FlexPro peut accéder aux noms des éléments des données sources et attribuer automatiquement les informations d'en-tête. |