Guida dell'API > Oggetti di PTC Mathcad Prime > Oggetto: Worksheet
Oggetto: Worksheet
Questo oggetto rappresenta l'interfaccia COM Worksheet di PTC Mathcad Prime Ptc.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) - Definisce l'intervallo di tempo di default in cui l'applicazione attende che il motore ricalcoli il documento. Il metodo influisce su diversi tipi di API Get/SetValue, escluse le API che utilizzano un parametro per il passaggio del valore di timeout.
◦ arg (numero intero) indica il numero di secondi di attesa, 0 per nessuna attesa o - 1 per un tempo di attesa indefinito.
Il valore di timeout di default è 60 secondi.
• CreateMatrix(rowsArg, colsArg) - Crea una matrice della dimensione specificata contenente oggetti NaNs.
rowsArg (numero intero) rappresenta il numero di righe.
colsArg (numero intero) 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) - Estrae i risultati della matrice di input come oggetto InputMatrixResult per l'alias di input specificato.
aliasArg (stringa) 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) - Estrae i risultati dell'input come oggetto InputResult per l'alias di input specificato.
aliasArg (stringa) rappresenta l'alias dell'input.
Restituisce:
L'oggetto InputResult o Null se si verifica un errore durante il recupero dei risultati dell'input.
• InputGetSExprValue - Ottiene il valore dell'input SExpression per l'alias di input specificato.
aliasArg (stringa) 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) - Ottiene il risultato del valore dell'input come oggetto ValueResult per l'alias di input specificato.
aliasArg (stringa) rappresenta l'alias dell'input.
Restituisce:
Il risultato del valore di 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) - Estrae i risultati della matrice di output come oggetto OutputMatrixResult per l'alias di output specificato.
aliasArg (stringa) rappresenta l'alias dell'output.
◦ Tutti i valori nella matrice devono essere della stessa quota. Ad esempio, una matrice può contenere valori in metri e piedi, unità di lunghezza diverse, ma non può contenere metri e chilogrammi, unità di lunghezza e peso.
Se i valori non hanno unità della stessa dimensione, come pollici e secondi, la funzione restituisce un errore.
◦ È possibile utilizzare valori senza unità. In questo caso, tutti i valori nella matrice devono essere senza unità.
◦ Non sono supportati dati di tipo string.
Restituisce:
L'oggetto OutputMatrixResult o Null se si verifica un errore durante il recupero dei risultati dell'output della matrice.
• OutputGetMatrixValueAs(aliasArg, unitsArg) - Estrae i risultati della matrice di output come oggetto OutputMatrixResult per l'alias di output specificato.
aliasArg (stringa) rappresenta l'alias dell'output.
unitsArg (stringa) rappresenta le unità dell'output.
◦ Tutti i valori nella matrice devono essere della stessa quota. Ad esempio, una matrice può contenere valori in metri e piedi, unità di lunghezza diverse, ma non può contenere metri e chilogrammi, unità di lunghezza e peso.
Se i valori non hanno unità della stessa dimensione, come pollici e secondi, la funzione restituisce un errore.
◦ È possibile utilizzare valori senza unità. In questo caso, tutti i valori nella matrice devono essere senza unità.
◦ Non sono supportati dati di tipo string.
Restituisce:
L'oggetto OutputMatrixResult o Null se si verifica un errore durante il recupero dei risultati dell'output della matrice.
• OutputGetRealValue(aliasArg) - Estrae i risultati dell'output come oggetto OutputResult per l'alias di output specificato.
aliasArg (stringa) rappresenta l'alias dell'output.
Restituisce:
Il valore reale specificato dall'alias.
• OutputGetRealValueAs(aliasArg, unitsArg) - Estrae i risultati dell'output come oggetto OutputResult per l'alias di output specificato nelle unità specificate.
aliasArg (stringa) rappresenta l'alias dell'output.
unitsArg (stringa) rappresenta le unità dell'output.
Restituisce:
Il valore reale nelle unità specificate.
• OutputGetValue(aliasArg) - Ottiene il risultato del valore dell'output come oggetto ValueResult.
aliasArg (stringa) 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) - Salva il foglio di lavoro con un nuovo nome.
newDocumentPathArg (stringa) 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, valueArg, unitsArg) - Imposta il valore di matrice e le unità per l'input con l'alias specificato.
aliasArg (stringa) rappresenta l'alias dell'input.
valueArg (matrice) rappresenta il valore di matrice da impostare per l'input.
unitsArg (stringa) 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 disabilitato.
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 disabilitato.
• SetRealValue(aliasArg, valueArg, unitsArg) - Imposta il valore di tipo double e le unità per l'input con l'alias specificato.
aliasArg (stringa) rappresenta l'alias dell'input.
valueArg (doppio) rappresenta il valore di tipo double da impostare per l'input.
unitsArg (stringa) 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 disabilitato.
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 disabilitato.
• SetSExprValue(aliasArg, sexpressionArg) - Imposta il valore SExpression per l'input con l'alias specificato.
aliasArg (stringa) rappresenta l'alias dell'input.
sexpressionArg (stringa) rappresenta il valore 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 disabilitato.
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 disabilitato.
• SetStringValue(aliasArg, valueArg) - Imposta il valore di stringa per l'input con l'alias specificato.
aliasArg (stringa) rappresenta l'alias dell'input.
valueArg (stringa) rappresenta il valore di tipo string 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 disabilitato.
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 disabilitato.
• SetTitle(titleArg) - Imposta il titolo della finestra di PTC Mathcad Prime per il foglio di lavoro.
titleArg (stringa) 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 modificato 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.
È stato utile?