Integration mit anderen Produkten > API-Handbuch > PTC Mathcad Prime Objekte > Objekt: Worksheet
  
Objekt: Worksheet
Dieses Objekt stellt die PTC Mathcad PrimeWorksheet COM-Schnittstelle Ptc.MathcadPrime.Automation.IMathcadPrimeWorksheet3 dar.
Methoden
• Activate() – Aktiviert die Arbeitsblattregisterkarte in der PTC Mathcad Prime Leiste für geöffnete Arbeitsblätter.
• Close(SaveOption) – Schließt das Arbeitsblatt, wenn es in PTC Mathcad Prime geöffnet ist.
SaveOption
◦ SpSaveChanges – Erzwingt vor dem Schließen des Arbeitsblatts das Speichern von Änderungen, ohne den Benutzer dazu aufzufordern.
◦ spPromptToSaveChanges – Fordert den Benutzer vor dem Schließen des Arbeitsblatts auf, Änderungen zu speichern.
◦ spDiscardChanges – Verwirft alle Änderungen und schließt das Arbeitsblatt.
◦ Spezielles Verhalten für ein neues und nicht geändertes Arbeitsblatt:
▪ Das Arbeitsblatt wird ohne Aufforderung an den Benutzer geschlossen, auch wenn saveOptionArg auf spPromptToSaveChanges festgelegt ist.
▪ Das Arbeitsblatt wird ohne Aufforderung an den Benutzer geschlossen, auch wenn saveOptionArg auf spSaveChanges festgelegt ist.
• DefaultCalculationTimeout(arg as integer) – Ruft den DefaultCalculationTimeOut-Wert für das Arbeitsblatts ab bzw. legt den Wert fest. Es wird festgelegt, wie lange diese Anwendung standardmäßig auf die Engine wartet, um das ganze Dokument neu zu berechnen. Dies wirkt sich auf verschiedene Typen von Get/SetValue-APIs aus, mit Ausnahme von APIs, deren Timeout als Parameter übergeben wird.
◦ arg wird in Sekunden angegeben.
◦ 0 bedeutet "Nicht warten".
◦ -1 bedeutet "Unbestimmte Zeit warten"
◦ Das Standard-Timeout beträgt 60 Sekunden.
• CreateMatrix(rowsArg as integer, colsArg as integer) – Erstellt eine Matrix einer gegebenen Größe, die mit NaNs gefüllt wird.
rowsArg ist die Anzahl der Zeilen.
colsArg ist die Anzahl der Spalten.
Gibt Folgendes zurück:
Die erstellte Matrix oder Null, wenn ein Fehler auftritt.
• CreateValuesSetter() – Erstellt eine Sammlung von Double- oder skalierten Matrixwerten, die über einen Alias auf das Eingabeelement festgelegt werden sollen.
Gibt Folgendes zurück:
Der erstellte ValuesSetter oder Null, wenn ein Fehler auftritt.
• GetWorkSheetReadOnlyOptionValue(WorksheetReadonlyOptionNames) – Ruft den schreibgeschützten Optionswert des Arbeitsblatts ab.
WorksheetReadonlyOptionNames ist der Optionsname des Arbeitsblatts.
Gibt Folgendes zurück:
Der Arbeitsblattoptionswert oder Null, wenn die Option nicht vorhanden oder deren Wert ungültig ist.
• InputGetMatrixValue(aliasArg as string) – Extrahiert Eingabeergebnisse der Matrix als InputMatrixResult-Objekt für den angegebenen Eingabealias.
aliasArg ist der Alias der Eingabe.
Gibt Folgendes zurück:
InputMatrixResult oder Null, wenn ein Fehler auftritt, während die Matrix-Eingabeergebnisse abgerufen werden.
• InputGetRealValue(aliasArg as string) – Extrahiert Eingabeergebnisse als InputResult-Objekt für den angegebenen Eingabealias.
aliasArg ist der Alias der Eingabe.
Gibt Folgendes zurück:
InputResult oder Null, wenn ein Fehler auftritt, während die Eingabeergebnisse abgerufen werden.
• InputGetSExprValue(aliasArg as string) – Ruft den SExpression-Wert der Eingabe für den angegebenen Eingabealias ab.
aliasArg ist der Alias der Eingabe.
Gibt Folgendes zurück:
Der SExpression-Wert als Zeichenfolge oder Null, wenn ein Fehler auftritt, während der Wert abgerufen wird.
• InputGetValue(aliasArg as string) – Ruft das Wertergebnis der Eingabe als ValueResult-Objekt für den angegebenen Eingabealias ab.
aliasArg ist der Alias der Eingabe.
Gibt Folgendes zurück:
Das Wertergebnis der Eingabe als ValueResult oder Null, wenn ein Fehler auftritt, während die Objektinstanz abgerufen wird.
• IsOpen() – Prüft, ob das Arbeitsblatt in PTC Mathcad Prime geöffnet ist.
Gibt Folgendes zurück:
True, wenn das Arbeitsblatt geöffnet ist.
FALSE, wenn das Arbeitsblatt nicht geöffnet ist.
• OutputGetMatrixValue(aliasArg as string) – Extrahiert Ausgabeergebnisse der Matrix als OutputMatrixResult-Objekt für den angegebenen Ausgabealias.
aliasArg ist der Alias der Ausgabe.
Gibt Folgendes zurück:
OutputMatrixResult oder Null, wenn ein Fehler auftritt, während die Matrix-Ausgabeergebnisse abgerufen werden.
• OutputGetMatrixValueAs(aliasArg as string, unitsArg as string) – Extrahiert Ausgabeergebnisse der Matrix als OutputMatrixResult-Objekt für den angegebenen Ausgabealias.
aliasArg ist der Alias der Ausgabe.
unitsArg ist die Einheit der Ausgabe.
Gibt Folgendes zurück:
OutputMatrixResult oder Null, wenn ein Fehler auftritt, während die Matrix-Ausgabeergebnisse abgerufen werden.
• OutputGetRealValue(aliasArg as string) – Extrahiert Ausgabeergebnisse als OutputResult-Objekt für den angegebenen Ausgabealias.
aliasArg ist der Alias der Ausgabe.
Gibt Folgendes zurück:
Der durch den Alias angegebene reelle Wert.
• OutputGetRealValueAs(aliasArg as string, unitsArg as string) – Extrahiert Ausgabeergebnisse als OutputResult-Objekt für den angegebenen Ausgabealias in den angegebenen Einheiten.
aliasArg ist der Alias der Ausgabe.
unitsArg ist die Einheit der Ausgabe.
Gibt Folgendes zurück:
Der reelle Wert in der angegebenen Einheit.
• OutputGetValue(aliasArg as string) – Ruft das Wertergebnis der Ausgabe als ValueResult-Objekt ab.
aliasArg ist der Alias der Ausgabe.
Gibt Folgendes zurück:
Das Wertergebnis der Ausgabe als ValueResult oder Null, wenn ein Fehler auftritt, während die Objektinstanz abgerufen wird.
• PauseCalculation() – Unterbricht die Berechnung.
• ResumeCalculation() – Setzt die Berechnung fort.
• SaveAs(newDocumentPathArg as string) – Speichert das Arbeitsblatt unter einem neuen Namen.
newDocumentPathArg ist das Speicherziel.
Das Arbeitsblatt kann als Standardarbeitsblatt mit der Dateierweiterung .mcdx oder als Vorlage mit der Dateierweiterung .mctx gespeichert werden.
• SetMatrixValue(aliasArg as string, valueArg as Matrix, unitsArg as string) – Legt den Matrixwert und die Einheit mit dem angegebenen Alias auf die Eingabe fest.
aliasArg ist der Alias der Eingabe.
valueArg ist der Matrixwert, der auf die Eingabe festgelegt werden soll.
unitsArg ist die Einheit, die auf die Eingabe festgelegt werden soll.
Gibt Folgendes zurück:
–1
Bei der Ausführung dieser Funktion ist ein unbekannter Fehler aufgetreten. Der Fehler kann auch auftreten, wenn das Arbeitsblatt nicht geöffnet ist.
0
Kein Fehler. Die Funktion war erfolgreich.
1
Ein Alias des Eingabe/Ausgabe-Elements wurde nicht gefunden.
2
Eingabe/Ausgabe wurde deaktiviert.
3
Inkompatible Einheiten.
4
Eingabe ist ungültig.
5
Berechnungsfehler.
6
Inkompatibler Ergebnistyp.
7
Matrixergebnis ist ungültig.
8
Berechnungstimeout.
9
Berechnung deaktiviert.
• SetRealValue(aliasArg as string, valueArg as double, unitsArg as string) – Legt den Double-Wert und die Einheit mit dem angegebenen Alias auf die Eingabe fest.
aliasArg ist der Alias der Eingabe.
valueArg ist der Double-Wert, der auf die Eingabe festgelegt werden soll.
unitsArg ist die Einheit, die auf die Eingabe festgelegt werden soll.
Gibt Folgendes zurück:
–1
Bei der Ausführung dieser Funktion ist ein unbekannter Fehler aufgetreten. Der Fehler kann auch auftreten, wenn das Arbeitsblatt nicht geöffnet ist.
0
Kein Fehler. Die Funktion war erfolgreich.
1
Ein Alias des Eingabe/Ausgabe-Elements wurde nicht gefunden.
2
Eingabe/Ausgabe wurde deaktiviert.
3
Inkompatible Einheiten.
4
Eingabe ist ungültig.
5
Berechnungsfehler.
6
Inkompatibler Ergebnistyp.
7
Matrixergebnis ist ungültig.
8
Berechnungstimeout.
9
Berechnung deaktiviert.
• SetSExprValue(aliasArg as string, sexpressionArg as string) – Legt den SExpression-Wert mit dem angegebenen Alias auf die Eingabe fest.
aliasArg ist der Alias der Eingabe.
sexpressionArg ist der SExpression-Wert, der auf die Eingabe festgelegt werden soll.
Gibt Folgendes zurück:
–1
Bei der Ausführung dieser Funktion ist ein unbekannter Fehler aufgetreten. Der Fehler kann auch auftreten, wenn das Arbeitsblatt nicht geöffnet ist.
0
Kein Fehler. Die Funktion war erfolgreich.
1
Ein Alias des Eingabe/Ausgabe-Elements wurde nicht gefunden.
2
Eingabe/Ausgabe wurde deaktiviert.
3
Inkompatible Einheiten.
4
Eingabe ist ungültig.
5
Berechnungsfehler.
6
Inkompatibler Ergebnistyp.
7
Matrixergebnis ist ungültig.
8
Berechnungstimeout.
9
Berechnung deaktiviert.
• SetStringValue(aliasArg as string, valueArg as string) – Legt den Zeichenfolgewert mit dem angegebenen Alias auf die Eingabe fest.
aliasArg ist der Alias der Eingabe.
valueArg ist der Zeichenfolgewert, der auf die Eingabe festgelegt werden soll.
Gibt Folgendes zurück:
–1
Bei der Ausführung dieser Funktion ist ein unbekannter Fehler aufgetreten. Der Fehler kann auch auftreten, wenn das Arbeitsblatt nicht geöffnet ist.
0
Kein Fehler. Die Funktion war erfolgreich.
1
Ein Alias des Eingabe/Ausgabe-Elements wurde nicht gefunden.
2
Eingabe/Ausgabe wurde deaktiviert.
3
Inkompatible Einheiten.
4
Eingabe ist ungültig.
5
Berechnungsfehler.
6
Inkompatibler Ergebnistyp.
7
Matrixergebnis ist ungültig.
8
Berechnungstimeout.
9
Berechnung deaktiviert.
• SetTitle(titleArg as string) – Legt den PTC Mathcad Prime Fenstertitel für das Arbeitsblatt fest.
titleArg ist der für das Arbeitsblatt festzulegende Titel.
• Synchronize() – Synchronisiert oder berechnet das Arbeitsblatt neu.
Eigenschaften
• FullName – Ruft den vollständigen Pfad und Namen des Arbeitsblatts ab.
Gibt Folgendes zurück:
Der vollständige Pfad und Name des Arbeitsblatts oder eine leere Zeichenfolge, wenn es sich um ein neues Arbeitsblatt handelt.
• Inputs – Ruft die Arbeitsblatteingaben ab.
Gibt Folgendes zurück:
Die Arbeitsblatteingaben oder Null, wenn beim Abrufen der Eingaben ein Fehler auftritt.
• Modified – Ruft den geänderten Attributwert des Arbeitsblatts ab bzw. legt den Wert fest.
Gibt Folgendes zurück:
True, wenn das Arbeitsblatt geändert wurde.
FALSE, wenn das Arbeitsblatt nicht geändert wurde.
• Name – Ruft den Namen des Arbeitsblatts ab.
• Outputs – Ruft die Arbeitsblattausgaben ab.
• WorksheetClosingPrompt=TextArg als Zeichenfolge. Legt den Text der Eingabeaufforderung zum Schließen des Arbeitsblatts fest.
• WorksheetDisplayedFilePath=filePathArg als Zeichenfolge. Legt den CustomizedFilePath für das Arbeitsblatt fest. Der angepasste Dateipfad zur Datei, in der das Arbeitsblatt gespeichert ist. Bei Übergabe von Null oder einer leeren Zeichenfolge wird der zuvor eingestellte Anzeigepfad gelöscht.
• WorksheetTabIcon=iconFullPathArg als Zeichenfolge. Legt das Arbeitsblattregisterkartensymbol iconFullPathArg fest, den vollständigen Pfad zum Symbol.
• WorksheetTabName=tabNameArg als Zeichenfolge. Legt den Arbeitsblattregisterkartennamen tabNameArg fest, den Arbeitsblattregisterkartennamen.
• WorksheetWorkingDirectory=workingDirArg als Zeichenfolge. Legt das aktuelle Arbeitsverzeichnis (CWD) für das Arbeitsblatt fest.