API 指南 > PTC Mathcad Prime 对象 > 对象：Worksheet
对象：Worksheet
此对象表示 PTC Mathcad Prime Worksheet COM 接口 Ptc.MathcadPrime.Automation.IMathcadPrimeWorksheet3。
方法
• Activate() - 在 PTC Mathcad Prime 打开的工作表栏中将工作表标签设置为活动状态 (激活工作表标签)。
• Close(SaveOption) - 如果工作表在 PTC Mathcad Prime 中处于打开状态，则关闭工作表。
SaveOption
◦ SpSaveChanges - 关闭工作表之前，强制保存更改而不提示用户。
◦ spPromptToSaveChanges - 关闭工作表之前，提示用户保存更改。
◦ spDiscardChanges - 放弃所有更改并关闭工作表。
◦ 未修改的新工作表的特殊行为：
▪ 关闭工作表而不提示用户，即使 saveOptionArg 设置为 spPromptToSaveChanges 也是如此。
▪ 关闭工作表而不提示用户，即使 saveOptionArg 设置为 spSaveChanges 也是如此。
• DefaultCalculationTimeout(arg) - 定义应用程序等待引擎重新计算文档的默认时间。此方法会影响不同类型的 Get/SetValue API，但不包括使用参数传递超时值的 API。
◦ arg (整数) 为等待的秒数，0 表示不等待，-1 表示无限期等待。
默认超时值为 60 秒。
• CreateMatrix(rowsArg, colsArg) - 创建由 NaNs 填充的给定大小的矩阵。
rowsArg (整数) 为行数。
colsArg (整数) 为列数。
返回：
已创建的矩阵，或 Null (如果出错的话)。
• CreateValuesSetter() - 创建双精度或矩阵换算值的集合以按别名设置为输入项。
返回：
已创建的 ValuesSetter，或 Null (如果出错的话)。
• GetWorkSheetReadOnlyOptionValue(WorksheetReadonlyOptionNames) - 获得工作表只读选项值。
WorksheetReadonlyOptionNames 是工作表选项名称。
返回：
工作表选项值，或 Null (如果选项不存在或其值无效)。
• InputGetMatrixValue(aliasArg) - 将输入矩阵结果提取为指定输入别名的 InputMatrixResult 对象。
aliasArg (字符串) 为输入的别名。
返回：
InputMatrixResult，或 Null (如果在检索矩阵输入结果时出错)。
• InputGetRealValue(aliasArg) - 将输入结果提取为指定输入别名的 InputResult 对象。
aliasArg (字符串) 为输入的别名。
返回：
InputResult 或 Null (如果在检索输入结果时出错)。
• InputGetSExprValue - 获得指定输入别名的输入的 SExpression 值。
aliasArg (字符串) 为输入的别名。
返回：
作为字符串的 SExpression 值，或 Null (如果在检索值时出错)。
• InputGetValue(aliasArg) - 获得作为指定输入别名的 ValueResult 对象的输入的值结果。
aliasArg (字符串) 为输入的别名。
返回：
作为 ValueResult 的输入的值结果，或 Null (如果在检索对象实例时出错)。
• IsOpen() - 检查工作表是否已在 PTC Mathcad Prime 中打开。
返回：
True (如果工作表已打开)。
FALSE (如果工作表未打开)。
• OutputGetMatrixValue(aliasArg) - 将输出矩阵结果提取为指定输出别名的 OutputMatrixResult 对象。
aliasArg (字符串) 为输出的别名。
◦ 矩阵中的所有值必须具有相同的量纲。例如，一个矩阵可以包含不同长度单位 (例如米和英尺) 的值，但不能同时包含长度和重量单位 (例如米和千克)。
如果值不具有相同量纲的单位，例如英寸和秒，则函数将返回错误。
◦ 可以使用无单位值。此时矩阵中的所有值必须都是无单位值。
◦ 不支持字符串。
返回：
OutputMatrixResult，或 Null (如果在检索矩阵输出结果时出错)。
• OutputGetMatrixValueAs(aliasArg, unitsArg) - 将输出矩阵结果提取为指定输出别名的 OutputMatrixResult 对象。
aliasArg (字符串) 为输出的别名。
unitsArg (字符串) 为输出的单位。
◦ 矩阵中的所有值必须具有相同的量纲。例如，一个矩阵可以包含不同长度单位 (例如米和英尺) 的值，但不能同时包含长度和重量单位 (例如米和千克)。
如果值不具有相同量纲的单位，例如英寸和秒，则函数将返回错误。
◦ 可以使用无单位值。此时矩阵中的所有值必须都是无单位值。
◦ 不支持字符串。
返回：
OutputMatrixResult，或 Null (如果在检索矩阵输出结果时出错)。
• OutputGetRealValue(aliasArg) - 将输出结果提取为指定输出别名的 OutputResult 对象。
aliasArg (字符串) 为输出的别名。
返回：
通过别名指定的实数值。
• OutputGetRealValueAs(aliasArg, unitsArg) - 使用指定单位将输出结果提取为指定输出别名的 OutputResult 对象。
aliasArg (字符串) 为输出的别名。
unitsArg (字符串) 为输出的单位。
返回：
以指定单位表示的实数值。
• OutputGetValue(aliasArg) - 获得作为 ValueResult 对象的输出的值结果。
aliasArg (字符串) 为输出的别名。
返回：
作为 ValueResult 的输出的值结果，或 Null (如果在检索对象实例时出错)。
• PauseCalculation() - 暂停计算。
• ResumeCalculation() - 恢复计算。
• SaveAs(newDocumentPathArg) - 以新名称保存工作表。
newDocumentPathArg (字符串) 为保存目的地。
可使用文件扩展名 .mcdx 将工作表保存为标准工作表，也可使用文件扩展名 .mctx 将其保存为模板。
• SetMatrixValue(aliasArg, valueArg, unitsArg) - 将矩阵值和单位设置为具有指定别名的输入。
aliasArg (字符串) 为输入的别名。
valueArg (矩阵) 为要设置为输入的矩阵值。
unitsArg (字符串) 为要设置为输入的单位。
返回：
–1
执行此函数时发生未知错误。如果工作表未打开，也可能会发生未知错误。
0
无错误。函数成功。
1
未找到输入/输出项的别名。
2
输入/输出已禁用。
3
单位不兼容。
4
输入无效。
5
计算错误。
6
结果类型不兼容。
7
矩阵结果无效。
8
计算超时。
9
已禁用计算。
• SetRealValue(aliasArg, valueArg, unitsArg) - 将双精度值和单位设置为具有指定别名的输入。
aliasArg (字符串) 为输入的别名。
valueArg (双精度) 为要设置为输入的双精度值。
unitsArg (字符串) 为要设置为输入的单位。
返回：
–1
执行此函数时发生未知错误。如果工作表未打开，也可能会发生未知错误。
0
无错误。函数成功。
1
未找到输入/输出项的别名。
2
输入/输出已禁用。
3
单位不兼容。
4
输入无效。
5
计算错误。
6
结果类型不兼容。
7
矩阵结果无效。
8
计算超时。
9
已禁用计算。
• SetSExprValue(aliasArg, sexpressionArg) - 将 SExpression 值设置为具有指定别名的输入。
aliasArg (字符串) 为输入的别名。
sexpressionArg (字符串) 为要设置为输入的 SExpression 值。
返回：
–1
执行此函数时发生未知错误。如果工作表未打开，也可能会发生未知错误。
0
无错误。函数成功。
1
未找到输入/输出项的别名。
2
输入/输出已禁用。
3
单位不兼容。
4
输入无效。
5
计算错误。
6
结果类型不兼容。
7
矩阵结果无效。
8
计算超时。
9
已禁用计算。
• SetStringValue(aliasArg, valueArg) - 将字符串值设置为具有指定别名的输入。
aliasArg (字符串) 为输入的别名。
valueArg (字符串) 为要设置为输入的字符串值。
返回：
–1
执行此函数时发生未知错误。如果工作表未打开，也可能会发生未知错误。
0
无错误。函数成功。
1
未找到输入/输出项的别名。
2
输入/输出已禁用。
3
单位不兼容。
4
输入无效。
5
计算错误。
6
结果类型不兼容。
7
矩阵结果无效。
8
计算超时。
9
已禁用计算。
• SetTitle(titleArg) - 为工作表设置 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。
这对您有帮助吗?