與其他產品整合 > API 指南 > PTC Mathcad Prime 物件 > 物件：Worksheet
  
物件：Worksheet
此物件代表 PTC Mathcad PrimeWorksheet COM 介面 Ptc.MathcadPrime.Automation.IMathcadPrimeWorksheet3。
方法
• Activate() - 在 PTC Mathcad Prime 開啟工作表列中，將工作表標籤設定為使用中 (啟動工作表標籤)。
• Close(SaveOption) - 關閉在 PTC Mathcad Prime 中開啟的工作表。
SaveOption
◦ SpSaveChanges - 關閉工作表之前，強制儲存變更，但不提示使用者。
◦ spPromptToSaveChanges - 關閉工作表之前，提示使用者儲存變更。
◦ spDiscardChanges - 捨棄所有變更並關閉工作表。
◦ 新的以及未修改的工作表之特殊行為：
▪ 即使 saveOptionArg 設定為 spPromptToSaveChanges，也不提示使用者而關閉工作表。
▪ 即使 saveOptionArg 設定為 spSaveChanges，也不提示使用者而關閉工作表。
• DefaultCalculationTimeout(arg as integer) - 取得/設定工作表的 DefaultCalculationTimeOut 值。它會定義應用程式等候引擎重新計算整份文件的預設時間，並會影響不同類型的 Get/SetValue API (以參數形式傳遞逾時值的 API 除外)。
◦ arg 以秒為單位定義
◦ 0 表示不等候
◦ -1 表示不論時間長短皆等候
◦ 預設逾時為 60 秒
• CreateMatrix(rowsArg as integer, colsArg as integer) - 建立由 NaNs 填入的指定大小矩陣。
rowsArg 是列數。
colsArg 是欄數。
傳回：
所建立的矩陣；若發生錯誤，則為 Null。
• CreateValuesSetter() - 建立雙精度或矩陣刻度值的集合，依別名設定至輸入項目。
傳回：
所建立的 ValuesSetter；若發生錯誤，則為 Null。
• GetWorkSheetReadOnlyOptionValue(WorksheetReadonlyOptionNames) - 取得工作表唯讀選項值。
WorksheetReadonlyOptionNames 是工作表選項名稱。
傳回：
工作表選項值；若選項不存在或其值無效，則為 Null。
• InputGetMatrixValue(aliasArg as string) - 擷取輸入矩陣結果，作為指定輸入別名的 InputMatrixResult 物件。
aliasArg 是輸入的別名。
傳回：
InputMatrixResult，若擷取矩陣輸入結果時發生錯誤，則為 Null。
• InputGetRealValue(aliasArg as string) - 擷取輸入結果，作為指定輸入別名的 InputResult 物件。
aliasArg 是輸入的別名。
傳回：
InputResult，若擷取輸入結果時發生錯誤，則為 Null。
• InputGetSExprValue(aliasArg as string) - 取得指定輸入別名之輸入的 SExpression 值。
aliasArg 是輸入的別名。
傳回：
以字串表示的 SExpression 值；若擷取值時發生錯誤，則為 Null。
• InputGetValue(aliasArg as string) - 取得輸入的值結果，作為指定輸入別名的 ValueResult 物件。
aliasArg 是輸入的別名。
傳回：
以 ValueResult 表示之輸入的值結果；若擷取物件實例時發生錯誤，則為 Null。
• IsOpen() - 檢查是否在 PTC Mathcad Prime 中開啟了工作表。
傳回：
True，表示已開啟工作表。
FALSE，表示未開啟工作表。
• OutputGetMatrixValue(aliasArg as string) - 擷取輸出矩陣結果，作為指定輸出別名的 OutputMatrixResult 物件。
aliasArg 是輸出的別名。
傳回：
OutputMatrixResult；若擷取矩陣輸出結果時發生錯誤，則為 Null。
• OutputGetMatrixValueAs(aliasArg as string, unitsArg as string) - 擷取輸出矩陣結果，作為指定輸出別名的 OutputMatrixResult 物件。
aliasArg 是輸出的別名。
unitsArg 是輸出的單位。
傳回：
OutputMatrixResult；若擷取矩陣輸出結果時發生錯誤，則為 Null。
• OutputGetRealValue(aliasArg as string) - 擷取輸出結果，作為指定輸出別名的 OutputResult 物件。
aliasArg 是輸出的別名。
傳回：
由別名所指定的實值。
• OutputGetRealValueAs(aliasArg as string, unitsArg as string) - 擷取輸出結果，作為以指定單位表示之指定輸出別名的 OutputResult 物件。
aliasArg 是輸出的別名。
unitsArg 是輸出的單位。
傳回：
以指定單位表示的實值。
• OutputGetValue(aliasArg as string) - 取得輸出的值結果，作為 ValueResult 物件。
aliasArg 是輸出的別名。
傳回：
以 ValueResult 表示之輸出的值結果；若擷取物件實例時發生錯誤，則為 Null。
• PauseCalculation() - 暫停計算。
• ResumeCalculation() - 繼續計算。
• SaveAs(newDocumentPathArg as string) - 以新名稱儲存工作表。
newDocumentPathArg 是儲存目的地。
工作表可儲存為使用副檔名 .mcdx 的標準工作表，或儲存為使用副檔名 .mctx 的範本。
• SetMatrixValue(aliasArg as string, valueArg as Matrix, unitsArg as string) - 以指定的別名，為輸入設定矩陣值與單位。
aliasArg 是輸入的別名。
valueArg 是要設定給輸入的矩陣值。
unitsArg 是要設定給輸入的單位。
傳回：
-1
執行此函數時發生不明的錯誤。若未開啟工作表，可能也會發生此錯誤。
0
無錯誤。函數成功。
1
找不到輸入/輸出的別名。
2
已停用輸入/輸出。
3
單位不相容。
4
輸入無效。
5
計算錯誤。
6
結果類型不相容。
7
矩陣結果無效。
8
計算逾時。
9
計算已停用。
• SetRealValue(aliasArg as string, valueArg as double, unitsArg as string) - 以指定的別名，為輸入設定雙精度值與單位。
aliasArg 是輸入的別名。
valueArg 是要設定給輸入的雙精度值。
unitsArg 是要設定給輸入的單位。
傳回：
-1
執行此函數時發生不明的錯誤。若未開啟工作表，可能也會發生此錯誤。
0
無錯誤。函數成功。
1
找不到輸入/輸出的別名。
2
已停用輸入/輸出。
3
單位不相容。
4
輸入無效。
5
計算錯誤。
6
結果類型不相容。
7
矩陣結果無效。
8
計算逾時。
9
計算已停用。
• SetSExprValue(aliasArg as string, sexpressionArg as string) - 以指定的別名，為輸入設定 SExpression 值。
aliasArg 是輸入的別名。
sexpressionArg 是要設定給輸入的 SExpression 值。
傳回：
-1
執行此函數時發生不明的錯誤。若未開啟工作表，可能也會發生此錯誤。
0
無錯誤。函數成功。
1
找不到輸入/輸出的別名。
2
已停用輸入/輸出。
3
單位不相容。
4
輸入無效。
5
計算錯誤。
6
結果類型不相容。
7
矩陣結果無效。
8
計算逾時。
9
計算已停用。
• SetStringValue(aliasArg as string, valueArg as string) - 以指定的別名，為輸入設定字串值。
aliasArg 是輸入的別名。
valueArg 是要設定給輸入的字串值。
傳回：
-1
執行此函數時發生不明的錯誤。若未開啟工作表，可能也會發生此錯誤。
0
無錯誤。函數成功。
1
找不到輸入/輸出的別名。
2
已停用輸入/輸出。
3
單位不相容。
4
輸入無效。
5
計算錯誤。
6
結果類型不相容。
7
矩陣結果無效。
8
計算逾時。
9
計算已停用。
• SetTitle(titleArg as string) - 為工作表設定 PTC Mathcad Prime 視窗標題。
titleArg 是要為工作表設定的標題。
• Synchronize() - 同步處理或重新計算工作表。
屬性
• FullName - 取得工作表的完整路徑與名稱。
傳回：
工作表的完整路徑與名稱；若是新的工作表，則為空白字串。
• Inputs - 取得工作表輸入。
傳回：
工作表輸入；若擷取輸入時發生錯誤，則為 Null。
• Modified - 取得/設定工作表的已修改屬性值。
傳回：
True，表示已修改工作表。
FALSE，表示未修改工作表。
• Name - 取得工作表的名稱。
• Outputs - 取得工作表輸出。
• 以字串表示的 WorksheetClosingPrompt=TextArg。設定「工作表關閉中提示文字」。
• 以字串表示的 WorksheetDisplayedFilePath=filePathArg。設定工作表 CustomizedFilePath。儲存工作表之檔案的自訂檔案路徑。傳遞 Null 或空白字串，會清除先前設定的顯示路徑。
• 以字串表示的 WorksheetTabIcon=iconFullPathArg。設定工作表標籤圖示 iconFullPathArg - 圖示的完整路徑。
• 以字串表示的 WorksheetTabName=tabNameArg。設定工作表標籤名稱 tabNameArg - 工作表標籤名稱。
• 以字串表示的 WorksheetWorkingDirectory=workingDirArg。設定工作表 CWD。