その他の製品との統合 > 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 の値を取得/設定します。これはエンジンがドキュメント全体を再計算するのをアプリケーションが待機するデフォルト時間を定義し、タイムアウトがパラメータとして渡される 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 (文字列)。ワークシートのカレントワーキングディレクトリを設定します。