Guía de API > Objetos de PTC Mathcad Prime > Objeto: Worksheet
Objeto: Worksheet
Este objeto representa la interfaz del COM Ptc.MathcadPrime.Automation.IMathcadPrimeWorksheet3 de PTC Mathcad Prime Worksheet.
Métodos
• Activate(): permite definir la ficha de hoja de trabajo como activa (se activa la ficha de hoja de trabajo) en la barra de hojas de trabajo abiertas de PTC Mathcad Prime.
• Close(SaveOption): permite cerrar la hoja de trabajo si está abierta en PTC Mathcad Prime.
SaveOption
◦ SpSaveChanges: se obliga a guardar los cambios, sin preguntar al usuario, antes de cerrar la hoja de trabajo.
◦ spPromptToSaveChanges: se solicita al usuario que guarde los cambios antes de cerrar la hoja de trabajo.
◦ spDiscardChanges: se descartan todos los cambios y se cierra la hoja de trabajo.
◦ Comportamiento especial de una hoja de trabajo nueva y no modificada:
▪ Se cierra la hoja de trabajo sin preguntar al usuario, aunque saveOptionArg se defina en spPromptToSaveChanges.
▪ Se cierra la hoja de trabajo sin preguntar al usuario, aunque saveOptionArg se defina en spSaveChanges.
• DefaultCalculationTimeout(arg): define el tiempo por defecto que la aplicación espera a que el motor vuelva a calcular el documento. El método afecta a tipos diferentes de API Get/SetValue, salvo las API que usan un parámetro para pasar el valor del tiempo de espera.
◦ arg (número entero) es el número de segundos de espera, 0 para esperar o -1 para esperar indefinidamente.
El valor del tiempo de espera por defecto son 60 segundos.
• CreateMatrix(rowsArg, colsArg): permite crear una matriz de un tamaño concreto rellenada por NaNs.
rowsArg (número entero) es el número de filas.
colsArg (número entero) es el número de columnas.
Devuelve:
La matriz creada o Null si se produce un error.
• CreateValuesSetter(): permite crear una recopilación de valores dobles o escalados por la matriz para definir el elemento de entrada por alias.
Devuelve:
El ValuesSetter creado o Null si se produce un error.
• GetWorkSheetReadOnlyOptionValue(WorksheetReadonlyOptionNames): permite obtener el valor de opción de solo lectura de la hoja de trabajo.
WorksheetReadonlyOptionNames es el nombre de opción de la hoja de trabajo.
Devuelve:
El valor de opción de la hoja de trabajo o un valor nulo si la opción no existe o su valor no es válido.
• InputGetMatrixValue(aliasArg): permite extraer los resultados de la matriz de entrada como objeto InputMatrixResult para el alias de entrada especificado.
aliasArg (cadena) es el alias de la entrada.
Devuelve:
El valor InputMatrixResult o Null si se produce un error al recuperar los resultados de entrada de la matriz.
• InputGetRealValue(aliasArg): permite extraer los resultados de entrada como objeto InputResult para el alias de entrada especificado.
aliasArg (cadena) es el alias de la entrada.
Devuelve:
El valor InputResult o Null si se produce un error al recuperar los resultados de la entrada.
• InputGetSExprValue: permite obtener el valor de SExpression de entrada del alias de entrada especificado.
aliasArg (cadena) es el alias de la entrada.
Devuelve:
El valor SExpression como una cadena o Null si se produce un error al recuperar el valor.
• InputGetValue(aliasArg): permite obtener el resultado del valor de la entrada como objeto ValueResult del alias de entrada especificado.
aliasArg (cadena) es el alias de la entrada.
Devuelve:
El resultado del valor de la entrada como ValueResult o Null si se produce un error al recuperar la instancia del objeto.
• IsOpen(): permite comprobar si la hoja de trabajo está abierta en PTC Mathcad Prime.
Devuelve:
True si la hoja de trabajo está abierta.
FALSE si la hoja de trabajo no está abierta.
• OutputGetMatrixValue(aliasArg): permite extraer los resultados de la matriz de salida como objeto OutputMatrixResult del alias de salida especificado.
aliasArg (cadena) es el alias de la salida.
◦ Todos los valores de la matriz deben estar en la misma cota. Por ejemplo, una matriz puede contener valores en metros y pies (diferentes unidades de longitud), pero no puede contener metros y kilogramos (unidades de longitud y peso).
Si los valores no tienen unidades de la misma cota, como pulgadas y segundos, la función devolverá un error.
◦ Puede usar valores sin unidades. En ese caso, todos los valores de la matriz no tendrán unidades.
◦ No se soportan cadenas.
Devuelve:
El objeto OutputMatrixResult o un valor nulo si se produce un error al recuperar los resultados de salida de la matriz.
• OutputGetMatrixValueAs(aliasArg, unitsArg): permite extraer los resultados de la matriz de salida como objeto OutputMatrixResult del alias de salida especificado.
aliasArg (cadena) es el alias de la salida.
unitsArg (cadena) es la unidad de la salida.
◦ Todos los valores de la matriz deben estar en la misma cota. Por ejemplo, una matriz puede contener valores en metros y pies (diferentes unidades de longitud), pero no puede contener metros y kilogramos (unidades de longitud y peso).
Si los valores no tienen unidades de la misma cota, como pulgadas y segundos, la función devolverá un error.
◦ Puede usar valores sin unidades. En ese caso, todos los valores de la matriz no tendrán unidades.
◦ No se soportan cadenas.
Devuelve:
El objeto OutputMatrixResult o un valor nulo si se produce un error al recuperar los resultados de salida de la matriz.
• OutputGetRealValue(aliasArg): permite extraer los resultados de salida como objeto OutputResult del alias de salida especificado.
aliasArg (cadena) es el alias de la salida.
Devuelve:
El valor real especificado por el alias.
• OutputGetRealValueAs(aliasArg, unitsArg): permite extraer los resultados de salida como objeto OutputResult del alias de salida especificado en las unidades especificadas.
aliasArg (cadena) es el alias de la salida.
unitsArg (cadena) es la unidad de la salida.
Devuelve:
El valor real en las unidades especificadas.
• OutputGetValue(aliasArg): permite obtener el resultado del valor de la salida como objeto ValueResult.
aliasArg (cadena) es el alias de la salida.
Devuelve:
El resultado del valor de la salida como ValueResult o Null si se produce un error al recuperar la instancia del objeto.
• PauseCalculation(): permite insertar una pausa en el cálculo.
• ResumeCalculation(): permite reanudar el cálculo.
• SaveAs(newDocumentPathArg): permite guardar la hoja de trabajo con un nombre nuevo.
newDocumentPathArg (cadena) es el destino de almacenamiento.
La hoja de trabajo se puede guardar como una hoja de trabajo estándar mediante la extensión de fichero .mcdx o como una plantilla mediante la extensión de fichero .mctx.
• SetMatrixValue(aliasArg, valueArg, unitsArg): permite definir el valor de la matriz y las unidades como entrada con el alias especificado.
aliasArg (cadena) es el alias de la entrada.
valueArg (matriz) es el valor de la matriz que se debe definir como entrada.
unitsArg (cadena) es la unidad que se debe definir como entrada.
Devuelve:
–1
Se ha producido un error desconocido al realizar esta función. También se puede producir si la hoja de trabajo no está abierta.
0
Ningún error. La función se ha ejecutado correctamente.
1
No se ha encontrado el alias del elemento de entrada y salida.
2
Se ha desactivado la entrada y salida.
3
Unidades incompatibles.
4
La entrada no es válida.
5
Error de cálculo.
6
Tipo de resultado incompatible.
7
Resultado de matriz no válido.
8
Tiempo de espera del cálculo superado.
9
Cálculo desactivado.
• SetRealValue(aliasArg, valueArg, unitsArg): permite definir el valor doble y las unidades como entrada con el alias especificado.
aliasArg (cadena) es el alias de la entrada.
valueArg (doble) es el valor doble que se debe definir como entrada.
unitsArg (cadena) es la unidad que se debe definir como entrada.
Devuelve:
–1
Se ha producido un error desconocido al realizar esta función. También se puede producir si la hoja de trabajo no está abierta.
0
Ningún error. La función se ha ejecutado correctamente.
1
No se ha encontrado el alias del elemento de entrada y salida.
2
Se ha desactivado la entrada y salida.
3
Unidades incompatibles.
4
La entrada no es válida.
5
Error de cálculo.
6
Tipo de resultado incompatible.
7
Resultado de matriz no válido.
8
Tiempo de espera del cálculo superado.
9
Cálculo desactivado.
• SetSExprValue(aliasArg, sexpressionArg): permite definir el valor de SExpression como entrada con el alias especificado.
aliasArg (cadena) es el alias de la entrada.
sexpressionArg (cadena) es el valor SExpression que se debe definir como entrada.
Devuelve:
–1
Se ha producido un error desconocido al realizar esta función. También se puede producir si la hoja de trabajo no está abierta.
0
Ningún error. La función se ha ejecutado correctamente.
1
No se ha encontrado el alias del elemento de entrada y salida.
2
Se ha desactivado la entrada y salida.
3
Unidades incompatibles.
4
La entrada no es válida.
5
Error de cálculo.
6
Tipo de resultado incompatible.
7
Resultado de matriz no válido.
8
Tiempo de espera del cálculo superado.
9
Cálculo desactivado.
• SetStringValue(aliasArg, valueArg): permite definir el valor de la cadena como entrada con el alias especificado.
aliasArg (cadena) es el alias de la entrada.
valueArg (cadena) es el valor de la cadena que se debe definir como entrada.
Devuelve:
–1
Se ha producido un error desconocido al realizar esta función. También se puede producir si la hoja de trabajo no está abierta.
0
Ningún error. La función se ha ejecutado correctamente.
1
No se ha encontrado el alias del elemento de entrada y salida.
2
Se ha desactivado la entrada y salida.
3
Unidades incompatibles.
4
La entrada no es válida.
5
Error de cálculo.
6
Tipo de resultado incompatible.
7
Resultado de matriz no válido.
8
Tiempo de espera del cálculo superado.
9
Cálculo desactivado.
• SetTitle(titleArg): permite definir el título de la ventana de PTC Mathcad Prime para la hoja de trabajo.
titleArg (cadena) es el título que se debe definir para la hoja de trabajo.
• Synchronize(): permite sincronizar o volver a calcular la hoja de trabajo.
Propiedades
• FullName: permite obtener la ruta completa y el nombre de la hoja de trabajo.
Devuelve:
La ruta completa y el nombre de la hoja de trabajo o una cadena vacía si la hoja de trabajo es nueva.
• Inputs: permite obtener las entradas de la hoja de trabajo.
Devuelve:
Las entradas de la hoja de trabajo o un valor Null si se produce un error al recuperar las entradas.
• Modified: permite obtener o definir el valor de atributo modificado de la hoja de trabajo.
Devuelve:
True si la hoja de trabajo se ha modificado.
FALSE si la hoja de trabajo no se ha modificado.
• Name: permite obtener el nombre de la hoja de trabajo.
• Outputs: permite obtener las salidas de la hoja de trabajo.
• WorksheetClosingPrompt=TextArg como cadena. Permite definir el texto del mensaje de cierre de la hoja de trabajo.
• WorksheetDisplayedFilePath=filePathArg como cadena. Permite definir el objeto CustomizedFilePath de la hoja de trabajo. La ruta del fichero personalizada al fichero donde se guarda la hoja de trabajo. El envío de un valor Null o una cadena vacía borra la ruta definida anteriormente.
• WorksheetTabIcon=iconFullPathArg como cadena. Permite definir el icono de ficha de la hoja de trabajo iconFullPathArg: la ruta completa al icono.
• WorksheetTabName=tabNameArg como cadena. Permite definir el nombre de la ficha de la hoja de trabajo tabNameArg: el nombre de la ficha de la hoja de trabajo.
• WorksheetWorkingDirectory=workingDirArg como cadena. Permite definir el CWD de la hoja de trabajo.
¿Fue esto útil?