Guide de l'API > Objets PTC Mathcad Prime > Objet : Worksheet
Objet : Worksheet
Cet objet représente l'interface COM de PTC Mathcad Prime Worksheet Ptc.MathcadPrime.Automation.IMathcadPrimeWorksheet3.
Méthodes
• Activate() : définit l'onglet du document à activer (active l'onglet Document) de la barre des documents ouverts de PTC Mathcad Prime.
• Close(SaveOption) : ferme le document s'il est ouvert dans PTC Mathcad Prime.
SaveOption
◦ SpSaveChanges : force à enregistrer les modifications, sans intervention de l'utilisateur, avant la fermeture du document.
◦ spPromptToSaveChanges : invite l'utilisateur à enregistrer les modifications avant la fermeture du document.
◦ spDiscardChanges : ignore toutes les modifications et ferme le document.
◦ Comportement spécial pour un document nouveau et non modifié :
▪ Le document est fermé sans inviter l'utilisateur, même si saveOptionArg est défini sur spPromptToSaveChanges.
▪ Le document est fermé sans inviter l'utilisateur, même si saveOptionArg est défini sur spSaveChanges.
• DefaultCalculationTimeout(arg) : Définit l'heure par défaut à laquelle l'application attend que le moteur recalcule le document. La méthode affecte différents types d'API Get/SetValue, à l'exception des API qui utilisent un paramètre pour transmettre la valeur de délai d'indisponibilité.
◦ arg (entier) représente le nombre de secondes à attendre, 0 n'attend pas ou –1 pour attendre indéfiniment.
La valeur du délai d'inactivité par défaut est de 60 secondes.
• CreateMatrix(rowsArg, colsArg) : crée une matrice d'une taille donnée remplie par NaNs.
rowsArg (entier) est le nombre de lignes.
colsArg (entier) est le nombre de colonnes.
Renvoie :
La matrice créée ou la valeur Null si une erreur se produit.
• CreateValuesSetter() : crée une collection de valeurs doubles ou de matrices mises à l'échelle pour définir l'élément d'entrée par alias.
Renvoie :
ValuesSetter créé ou la valeur Null si une erreur se produit.
• GetWorkSheetReadOnlyOptionValue(WorksheetReadonlyOptionNames) : renvoie la valeur de l'option en lecture seule du document.
WorksheetReadonlyOptionNames est le nom d'option du document.
Renvoie :
La valeur de l'option du document ou la valeur Null si l'option n'existe pas ou sa valeur n'est pas valide.
• InputGetMatrixValue(aliasArg) : extrait les résultats de la matrice d'entrée sous la forme de l'objet InputMatrixResult pour l'alias d'entrée spécifié.
aliasArg (chaîne) est l'alias de l'entrée.
Renvoie :
La valeur InputMatrixResult ou la valeur Null si une erreur se produit lors de la récupération des résultats d'entrée de la matrice.
• InputGetRealValue(aliasArg) : extrait les résultats d'entrée sous la forme de l'objet InputResult pour l'alias d'entrée spécifié.
aliasArg (chaîne) est l'alias de l'entrée.
Renvoie :
La valeur InputResult ou la valeur Null si une erreur se produit lors de la récupération des résultats d'entrée.
• InputGetSExprValue : renvoie la valeur SExpression de l'entrée pour l'alias d'entrée spécifié.
aliasArg (chaîne) est l'alias de l'entrée.
Renvoie :
La valeur SExpression sous forme de chaîne ou la valeur Null si une erreur se produit lors de la récupération de la valeur.
• InputGetValue(aliasArg) : renvoie le résultat de la valeur d'entrée sous la forme de l'objet ValueResult pour l'alias d'entrée spécifié.
aliasArg (chaîne) est l'alias de l'entrée.
Renvoie :
Le résultat de la valeur d'entrée sous la forme de la valeur ValueResult ou la valeur Null si une erreur se produit lors de la récupération de l'instance d'objet.
• IsOpen() : Vérifie si le document est ouvert dans PTC Mathcad Prime.
Renvoie :
True si le document est ouvert.
FALSE si le document n'est pas ouvert.
• OutputGetMatrixValue(aliasArg) : extrait les résultats de la matrice de sortie sous la forme de l'objet OutputMatrixResult pour l'alias de sortie spécifié.
aliasArg (chaîne) est l'alias de la sortie.
◦ Toutes les valeurs de la matrice doivent être de la même dimension. Par exemple, une matrice peut contenir des valeurs en mètres et en pieds : des unités de longueur différentes, mais ne peut pas contenir des valeurs en mètres et en kilogrammes : unités de longueur et de poids.
Si les valeurs n'ont pas d'unités de même dimension, telles que les pouces et les secondes, la fonction renvoie une erreur.
◦ Vous pouvez utiliser des valeurs sans unités. Dans ce cas, aucune des valeurs de la matrice ne doit comporter d'unité.
◦ Les chaînes ne sont pas prises en charge.
Renvoie :
La valeur OutputMatrixResult ou la valeur Null si une erreur se produit lors de la récupération des résultats de sortie de la matrice.
• OutputGetMatrixValueAs(aliasArg, unitsArg) : extrait les résultats de la matrice de sortie sous la forme de l'objet OutputMatrixResult pour l'alias de sortie spécifié.
aliasArg (chaîne) est l'alias de la sortie.
unitsArg (chaîne) est l'unité de la sortie.
◦ Toutes les valeurs de la matrice doivent être de la même dimension. Par exemple, une matrice peut contenir des valeurs en mètres et en pieds : des unités de longueur différentes, mais ne peut pas contenir des valeurs en mètres et en kilogrammes : unités de longueur et de poids.
Si les valeurs n'ont pas d'unités de même dimension, telles que les pouces et les secondes, la fonction renvoie une erreur.
◦ Vous pouvez utiliser des valeurs sans unités. Dans ce cas, aucune des valeurs de la matrice ne doit comporter d'unité.
◦ Les chaînes ne sont pas prises en charge.
Renvoie :
La valeur OutputMatrixResult ou la valeur Null si une erreur se produit lors de la récupération des résultats de sortie de la matrice.
• OutputGetRealValue(aliasArg) : extrait les résultats de sortie sous la forme de l'objet OutputResult pour l'alias de sortie spécifié.
aliasArg (chaîne) est l'alias de la sortie.
Renvoie :
La valeur réelle spécifiée par l'alias.
• OutputGetRealValueAs(aliasArg, unitsArg) : extrait les résultats de sortie sous la forme de l'objet OutputResult pour l'alias de sortie spécifié dans les unités spécifiées.
aliasArg (chaîne) est l'alias de la sortie.
unitsArg (chaîne) est l'unité de la sortie.
Renvoie :
La valeur réelle dans les unités spécifiées.
• OutputGetValue(aliasArg) : renvoie le résultat de la valeur de la sortie sous la forme de l'objet ValueResult.
aliasArg (chaîne) est l'alias de la sortie.
Renvoie :
Le résultat de la valeur de sortie sous la forme de la valeur ValueResult ou la valeur Null si une erreur se produit lors de la récupération de l'instance d'objet.
• PauseCalculation() : suspend le calcul.
• ResumeCalculation() : reprend le calcul.
• SaveAs(newDocumentPathArg) : enregistrez le document sous un nouveau nom.
newDocumentPathArg (chaîne) est la destination de l'enregistrement.
Le document peut être enregistré comme un document standard à l'aide de l'extension de fichier .mcdx ou comme modèle à l'aide de l'extension de fichier .mctx.
• SetMatrixValue(aliasArg, valueArg, unitsArg) : définit la valeur de matrice et les unités à entrer avec l'alias spécifié.
aliasArg (chaîne) est l'alias de l'entrée.
valueArg (matrice) est la valeur de matrice à définir comme entrée.
unitsArg (chaîne) représente les unités à définir comme entrée.
Renvoie :
-1
Une erreur inconnue s'est produite lors de l'exécution de cette fonction. Elle peut également se produire si le document n'est pas ouvert.
0
Aucune erreur. La fonction a réussi.
1
Un alias de l'élément d'entrée/sortie est introuvable.
2
Entrée/sortie désactivée.
3
Unités incompatibles.
4
Entrée non valide.
5
Erreur de calcul.
6
Type de résultat incompatible.
7
Le résultat de la matrice n'est pas valide.
8
Expiration du délai de calcul.
9
Calcul désactivé.
• SetRealValue(aliasArg, valueArg, unitsArg) : définit la valeur double et les unités à entrer avec l'alias spécifié.
aliasArg (chaîne) est l'alias de l'entrée.
valueArg (double) est la valeur double à définir comme entrée.
unitsArg (chaîne) représente les unités à définir comme entrée.
Renvoie :
-1
Une erreur inconnue s'est produite lors de l'exécution de cette fonction. Elle peut également se produire si le document n'est pas ouvert.
0
Aucune erreur. La fonction a réussi.
1
Un alias de l'élément d'entrée/sortie est introuvable.
2
Entrée/sortie désactivée.
3
Unités incompatibles.
4
Entrée non valide.
5
Erreur de calcul.
6
Type de résultat incompatible.
7
Le résultat de la matrice n'est pas valide.
8
Expiration du délai de calcul.
9
Calcul désactivé.
• SetSExprValue(aliasArg, sexpressionArg) : définit la valeur SExpression à entrer avec l'alias spécifié.
aliasArg (chaîne) est l'alias de l'entrée.
sexpressionArg (chaîne) est la valeur de SExpression à définir comme entrée.
Renvoie :
-1
Une erreur inconnue s'est produite lors de l'exécution de cette fonction. Elle peut également se produire si le document n'est pas ouvert.
0
Aucune erreur. La fonction a réussi.
1
Un alias de l'élément d'entrée/sortie est introuvable.
2
Entrée/sortie désactivée.
3
Unités incompatibles.
4
Entrée non valide.
5
Erreur de calcul.
6
Type de résultat incompatible.
7
Le résultat de la matrice n'est pas valide.
8
Expiration du délai de calcul.
9
Calcul désactivé.
• SetStringValue(aliasArg, valueArg) : définit la valeur de chaîne à entrer avec l'alias spécifié.
aliasArg (chaîne) est l'alias de l'entrée.
valueArg (chaîne) est la valeur de chaîne à définir comme entrée.
Renvoie :
-1
Une erreur inconnue s'est produite lors de l'exécution de cette fonction. Elle peut également se produire si le document n'est pas ouvert.
0
Aucune erreur. La fonction a réussi.
1
Un alias de l'élément d'entrée/sortie est introuvable.
2
Entrée/sortie désactivée.
3
Unités incompatibles.
4
Entrée non valide.
5
Erreur de calcul.
6
Type de résultat incompatible.
7
Le résultat de la matrice n'est pas valide.
8
Expiration du délai de calcul.
9
Calcul désactivé.
• SetTitle(titleArg) : définit le titre de la fenêtre PTC Mathcad Prime pour le document.
titleArg (chaîne) est le titre à définir pour le document.
• Synchronize() : synchronise ou recalcule le document.
Propriétés
• FullName : renvoie le chemin d'accès complet et le nom du document.
Renvoie :
Le chemin d'accès complet et le nom du document ou une chaîne vide si le document est nouveau.
• Inputs : renvoie les entrées de document.
Renvoie :
Les entrées de document ou une valeur Null si une erreur se produit lors de la récupération des entrées.
• Modified : renvoie/définit la valeur d'attribut modifiée du document.
Renvoie :
True si le document est modifié.
FALSE si le document n'est pas modifié.
• Name : renvoie le nom du document.
• Outputs : renvoie les sorties du document.
• WorksheetClosingPrompt=TextArg en tant que chaîne. Définit le texte de l'invite de fermeture du document.
• WorksheetDisplayedFilePath=filePathArg en tant que chaîne. Définit le document CustomizedFilePath. Le chemin d'accès personnalisé du fichier de stockage du document. Le transfert d'une valeur Null ou d'une chaîne vide efface le chemin d'affichage précédemment défini.
• WorksheetTabIcon=iconFullPathArg en tant que chaîne. Définit l'icône d'onglet Document iconFullPathArg : chemin complet vers l'icône.
• WorksheetTabName=tabNameArg en tant que chaîne. Définit le nom de l'onglet Document tabNameArg - nom de l'onglet Document.
• WorksheetWorkingDirectory=workingDirArg en tant que chaîne. Définit le document CWD.
Est-ce que cela a été utile ?