Questo oggetto rappresenta l'interfaccia COM Worksheet di PTC Mathcad PrimePtc.MathcadPrime.Automation.IMathcadPrimeWorksheet3.
Metodi
• Activate() - Imposta la scheda del foglio di lavoro in modo che sia attiva (attiva la scheda del foglio di lavoro) nella barra dei fogli di lavoro aperti di PTC Mathcad Prime.
• Close(SaveOption) - Chiude il foglio di lavoro se è aperto in PTC Mathcad Prime.
SaveOption
◦ SpSaveChanges - Forza il salvataggio delle modifiche, senza chiedere conferma all'utente, prima della chiusura del foglio di lavoro.
◦ spPromptToSaveChanges - Consente di richiedere all'utente di salvare le modifiche prima della chiusura del foglio di lavoro.
◦ spDiscardChanges - Scarta tutte le modifiche e chiude il foglio di lavoro.
◦ Per i fogli di lavoro nuovi e non modificati viene applicato un comportamento speciale, come illustrato di seguito.
▪ Il foglio di lavoro viene chiuso senza chiedere conferma all'utente, anche se l'impostazione di saveOptionArg è spPromptToSaveChanges.
▪ Il foglio di lavoro viene chiuso senza chiedere conferma all'utente, anche se l'impostazione di saveOptionArg è spSaveChanges.
• DefaultCalculationTimeout(arg as integer) - Ottiene/imposta il valore DefaultCalculationTimeOut del foglio di lavoro. Definisce il tempo di default per l'attesa, da parte dell'applicazione, affinché il motore ricalcoli l'intero documento e si applica a diversi tipi di API Get/SetValue per le quali il timeout viene passato come parametro.
◦ arg è definito in secondi:
◦ 0 indica nessuna attesa
◦ –1 indica di attendere per tutto il tempo necessario
◦ Il timeout di default è 60 secondi.
• CreateMatrix(rowsArg as integer, colsArg as integer) - Crea una matrice della dimensione specificata contenente oggetti NaNs.
rowsArg rappresenta il numero di righe.
colsArg rappresenta il numero di colonne.
Restituisce:
La matrice creata o Null se si verifica un errore.
• CreateValuesSetter() - Crea una raccolta di valori scalari di tipo double o matrice da impostare sull'elemento di input in base all'alias.
Restituisce:
L'oggetto ValuesSetter creato o Null se si verifica un errore.
• GetWorkSheetReadOnlyOptionValue(WorksheetReadonlyOptionNames) - Ottiene il valore dell'opzione di sola lettura del foglio di lavoro.
WorksheetReadonlyOptionNames rappresenta il nome dell'opzione del foglio di lavoro.
Restituisce:
Il valore dell'opzione del foglio di lavoro o Null se l'opzione non esiste o il relativo valore non è valido.
• InputGetMatrixValue(aliasArg as string) - Estrae i risultati della matrice di input come oggetto InputMatrixResult per l'alias di input specificato.
aliasArg rappresenta l'alias dell'input.
Restituisce:
L'oggetto InputMatrixResult o Null se si verifica un errore durante il recupero dei risultati dell'input della matrice.
• InputGetRealValue(aliasArg as string) - Estrae i risultati dell'input come oggetto InputResult per l'alias di input specificato.
aliasArg rappresenta l'alias dell'input.
Restituisce:
L'oggetto InputResult o Null se si verifica un errore durante il recupero dei risultati dell'input.
• InputGetSExprValue(aliasArg as string) - Ottiene il valore dell'input SExpression per l'alias di input specificato.
aliasArg rappresenta l'alias dell'input.
Restituisce:
Il valore SExpression sotto forma di stringa o Null se si verifica un errore durante il recupero del valore.
• InputGetValue(aliasArg as string) - Ottiene il risultato del valore dell'input come oggetto ValueResult per l'alias di input specificato.
aliasArg rappresenta l'alias dell'input.
Restituisce:
Il risultato del valore dell'input come oggetto ValueResult o Null se si verifica un errore durante il recupero dell'istanza dell'oggetto.
• IsOpen() - Verifica se il foglio di lavoro è aperto in PTC Mathcad Prime.
Restituisce:
True se il foglio di lavoro è aperto.
FALSE se il foglio di lavoro non è aperto.
• OutputGetMatrixValue(aliasArg as string) - Estrae i risultati della matrice di output come oggetto OutputMatrixResult per l'alias di output specificato.
aliasArg rappresenta l'alias dell'output.
Restituisce:
L'oggetto OutputMatrixResult o Null se si verifica un errore durante il recupero dei risultati dell'output della matrice.
• OutputGetMatrixValueAs(aliasArg as string, unitsArg as string) - Estrae i risultati della matrice di output come oggetto OutputMatrixResult per l'alias di output specificato.
aliasArg rappresenta l'alias dell'output.
unitsArg rappresenta le unità dell'output.
Restituisce:
L'oggetto OutputMatrixResult o Null se si verifica un errore durante il recupero dei risultati dell'output della matrice.
• OutputGetRealValue(aliasArg as string) - Estrae i risultati dell'output come oggetto OutputResult per l'alias di output specificato.
aliasArg rappresenta l'alias dell'output.
Restituisce:
Il valore reale specificato dall'alias.
• OutputGetRealValueAs(aliasArg as string, unitsArg as string) - Estrae i risultati dell'output come oggetto OutputResult per l'alias di output specificato nelle unità specificate.
aliasArg rappresenta l'alias dell'output.
unitsArg rappresenta le unità dell'output.
Restituisce:
Il valore reale nelle unità specificate.
• OutputGetValue(aliasArg as string) - Ottiene il risultato del valore dell'output come oggetto ValueResult.
aliasArg rappresenta l'alias dell'output.
Restituisce:
Il risultato del valore dell'output come oggetto ValueResult o Null se si verifica un errore durante il recupero dell'istanza dell'oggetto.
• PauseCalculation() - Sospende il calcolo.
• ResumeCalculation() - Riprende il calcolo.
• SaveAs(newDocumentPathArg as string) - Salva il foglio di lavoro con un nuovo nome.
newDocumentPathArg rappresenta la destinazione del salvataggio.
È possibile salvare il foglio di lavoro come foglio di lavoro standard utilizzando l'estensione file .mcdx o come modello utilizzando l'estensione file .mctx.
• SetMatrixValue(aliasArg as string, valueArg as Matrix, unitsArg as string) - Imposta il valore di matrice e le unità per l'input con l'alias specificato.
aliasArg rappresenta l'alias dell'input.
valueArg rappresenta il valore di matrice da impostare per l'input.
unitsArg rappresenta le unità da impostare per l'input.
Restituisce:
–1
Si è verificato un errore sconosciuto durante l'esecuzione di questa funzione. Può verificarsi anche se il foglio di lavoro non è aperto.
0
Nessun errore. La funzione ha avuto esito positivo.
1
Non è stato trovato un alias di elemento di input/output.
2
L'input/output è stato disattivato.
3
Unità non compatibili.
4
Input non valido.
5
Errore di calcolo.
6
Tipo di risultato non compatibile.
7
Risultato della matrice non valido.
8
Timeout del calcolo.
9
Calcolo disattivato.
• SetRealValue(aliasArg as string, valueArg as double, unitsArg as string) - Imposta il valore di tipo double e le unità per l'input con l'alias specificato.
aliasArg rappresenta l'alias dell'input.
valueArg rappresenta il valore di tipo double da impostare per l'input.
unitsArg rappresenta le unità da impostare per l'input.
Restituisce:
–1
Si è verificato un errore sconosciuto durante l'esecuzione di questa funzione. Può verificarsi anche se il foglio di lavoro non è aperto.
0
Nessun errore. La funzione ha avuto esito positivo.
1
Non è stato trovato un alias di elemento di input/output.
2
L'input/output è stato disattivato.
3
Unità non compatibili.
4
Input non valido.
5
Errore di calcolo.
6
Tipo di risultato non compatibile.
7
Risultato della matrice non valido.
8
Timeout del calcolo.
9
Calcolo disattivato.
• SetSExprValue(aliasArg as string, sexpressionArg as string) - Imposta il valore SExpression per l'input con l'alias specificato.
aliasArg rappresenta l'alias dell'input.
sexpressionArg rappresenta il valore di SExpression da impostare per l'input.
Restituisce:
–1
Si è verificato un errore sconosciuto durante l'esecuzione di questa funzione. Può verificarsi anche se il foglio di lavoro non è aperto.
0
Nessun errore. La funzione ha avuto esito positivo.
1
Non è stato trovato un alias di elemento di input/output.
2
L'input/output è stato disattivato.
3
Unità non compatibili.
4
Input non valido.
5
Errore di calcolo.
6
Tipo di risultato non compatibile.
7
Risultato della matrice non valido.
8
Timeout del calcolo.
9
Calcolo disattivato.
• SetStringValue(aliasArg as string, valueArg as string) - Imposta il valore di stringa per l'input con l'alias specificato.
aliasArg rappresenta l'alias dell'input.
valueArg rappresenta il valore di stringa da impostare per l'input.
Restituisce:
–1
Si è verificato un errore sconosciuto durante l'esecuzione di questa funzione. Può verificarsi anche se il foglio di lavoro non è aperto.
0
Nessun errore. La funzione ha avuto esito positivo.
1
Non è stato trovato un alias di elemento di input/output.
2
L'input/output è stato disattivato.
3
Unità non compatibili.
4
Input non valido.
5
Errore di calcolo.
6
Tipo di risultato non compatibile.
7
Risultato della matrice non valido.
8
Timeout del calcolo.
9
Calcolo disattivato.
• SetTitle(titleArg as string) - Imposta il titolo della finestra di PTC Mathcad Prime per il foglio di lavoro.
titleArg rappresenta il titolo da impostare per il foglio di lavoro.
• Synchronize() - Sincronizza o ricalcola il foglio di lavoro.
Proprietà
• FullName - Ottiene il percorso completo e il nome del foglio di lavoro.
Restituisce:
Il percorso completo e il nome del foglio di lavoro o una stringa vuota se il foglio di lavoro è nuovo.
• Inputs - Ottiene gli input del foglio di lavoro.
Restituisce:
Gli input del foglio di lavoro o Null se si verifica un errore durante il recupero degli input.
• Modified - Ottiene/imposta il valore dell'attributo Modified del foglio di lavoro.
Restituisce:
True se il foglio di lavoro è stato modificato.
FALSE se il foglio di lavoro non è stato modificato.
• Name - Ottiene il nome del foglio di lavoro.
• Outputs - Ottiene gli output del foglio di lavoro.
• WorksheetClosingPrompt=TextArg come stringa. Imposta il testo del prompt visualizzato alla chiusura del foglio di lavoro.
• WorksheetDisplayedFilePath=filePathArg come stringa. Imposta l'oggetto CustomizedFilePath del foglio di lavoro. Rappresenta il percorso personalizzato del file in cui è memorizzato il foglio di lavoro. Se si passa un valore Null o una stringa vuota, il percorso di visualizzazione impostato in precedenza viene cancellato.
• WorksheetTabIcon=iconFullPathArg come stringa. Imposta l'oggetto iconFullPathArg (percorso completo dell'icona) dell'icona della scheda del foglio di lavoro.
• WorksheetTabName=tabNameArg come stringa. Imposta l'oggetto tabNameArg (nome della scheda del foglio di lavoro) del nome della scheda del foglio di lavoro.
• WorksheetWorkingDirectory=workingDirArg come stringa. Imposta la directory di lavoro corrente (CWD) del foglio di lavoro.