Руководство по интерфейсу API > Объекты PTC Mathcad Prime > Объект: Worksheet
Объект: Worksheet
Этот объект представляет собой COM-интерфейс Worksheet PTC Mathcad Prime Ptc.MathcadPrime.Automation.IMathcadPrimeWorksheet3.
Методы
• Activate() - задает для вкладки документа активное состояние (активирует вкладку документа) в панели открытых документов PTC Mathcad Prime.
• Close(SaveOption) - закрывает документ, если он открыт в PTC Mathcad Prime.
SaveOption
◦ SpSaveChanges - перед закрытием документа принудительно сохраняет изменения без запроса подтверждения пользователем.
◦ spPromptToSaveChanges - перед закрытием документа предлагает пользователю сохранить изменения.
◦ spDiscardChanges - отменяет все изменения и закрывает документ.
◦ Специальное поведение для нового и неизмененного документа.
▪ Документ закрывается без запроса подтверждения пользователя, даже если saveOptionArg имеет значение spPromptToSaveChanges.
▪ Документ закрывается без запроса подтверждения пользователя, даже если saveOptionArg имеет значение spSaveChanges.
• DefaultCalculationTimeout(arg) - определяет время по умолчанию, в течение которого приложение ожидает перерасчета документа обработчиком. Этот метод затрагивает различные типы интерфейсов API Get/SetValue, за исключением интерфейсов 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.
Было ли это полезно?