Интеграция с другими продуктами > Руководство по API > Объекты PTC Mathcad Prime > Объект: Worksheet
  
Объект: Worksheet
Этот объект представляет собой COM-интерфейс WorksheetPTC Mathcad PrimePtc.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 для документа. Это значение определяет время по умолчанию, в течение которого приложение ожидает повторного вычисления обработчиком всего документа, и влияет на различные типы API-интерфейса Get/SetValue, за исключением 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.