メインコンテンツまでスキップ

IWorkspace インタフェース

名前空間: NextDesign.Desktop

説明

アプリケーションの作業領域情報へのアクセス手段を提供します。

所属エリア

名前説明
ワークスペース・プロジェクトアプリケーションの作業領域やアプリケーションで開いているプロジェクトにアクセスするAPI群です。

プロパティ

名前説明
CurrentEditor現在選択されているエディタビューで表示中のエディタ情報
エディタを表示していない場合は、null を返します。
CurrentModel現在のプロジェクトで選択されているモデル要素
選択されているモデルがない場合は、null を返します。
CurrentProductカレントプロジェクトにおいて現在適用状態のプロダクト
CurrentProjectカレントプロジェクト
アプリケーションのワークスペースで現在開いているプロジェクト情報を返します。
アプリケーションでプロジェクトを開いていない場合は null を返します。
Errorsエラー一覧
このオブジェクトを用いて、現在登録中のエラー情報にアクセスすることができます。
InfoDisplayStyleSetスタイルセットの定義
このオブジェクトでエラーや検索結果の表示時に指定できるスタイルを管理することができます。
MainEditor現在のメインエディタビューで表示中のエディタ情報
エディタを表示していない場合は、null を返します。
Output出力
このオブジェクトを用いて、アプリケーションの出力にアクセスすることができます。
Scm構成管理へのアクセスオブジェクト
Search検索
このオブジェクトを用いて、検索結果の一覧にアクセスすることができます。
Stateワークスペース状態
SubEditor現在のサブエディタビューで表示中のエディタ情報
エディタを表示していない場合は、null を返します。

メソッド

名前説明
CanRedo取り消した編集操作を再実行可能か調べます。
CanUndo編集操作を取り消し可能か調べます。
CleanUpProject指定されたプロジェクトをクリーンアップします。
プロジェクト未指定の場合は、現在アプリケーションで開いているカレントのプロジェクトをクリーンアップします。

プロジェクトのクリーンアップ処理は、指定されたプロジェクトの管理対象ユニットのうち編集可能なユニットに対してのみ実施します。
なお、対象プロジェクトが未保存の場合は、このメソッドの呼び出しは失敗します。
CloseProject指定されたプロジェクトを閉じます。
プロジェクト未指定の場合は、現在アプリケーションで開いているカレントのプロジェクトを閉じます。

この呼び出しは、対象プロジェクトが保存されていない場合でも警告することなく、変更を破棄してプロジェクトを閉じます。
CreateSearch[Obsolete] 検索オブジェクトを生成します。
このオブジェクトを用いて、検索の開始~終了、および検索結果の登録を行うことができます。
GenerateDocumentドキュメントを生成します。
モデルナビゲータの選択要素を出力対象の基点モデルとします。
GetModelUnitByLoadMode指定したロードモードの設定になっているモデルユニットを取得します。
LoadModelUnits(IProject,IEnumerable<IModelUnit>)指定されたプロジェクトで指定されたモデルユニットを追加読み込みします。
指定されたユニットが既に読み込み済み、もしくは指定したプロジェクトの管理対象外の場合は無視されます。

対象プロジェクトがカレントプロジェクトの場合、ビジーインジケータを表示して実行します。ただし、キャンセルはできません。
なお、対象プロジェクトが未保存の場合は、このメソッドの呼び出しは失敗します。対象プロジェクトがカレントプロジェクトの場合は、プロジェクトナビゲータから実行した場合と同様にND上にメッセージダイアログが表示され、追加ロードを中断します。カレントプロジェクト以外の場合は例外が発生します。
LoadModelUnits(IProject,IEnumerable<string>)指定されたプロジェクトで指定されたモデルユニットを追加読み込みします。
指定されたユニットが既に読み込み済み、もしくは指定したプロジェクトの管理対象外の場合は無視されます。

対象プロジェクトがカレントプロジェクトの場合、ビジーインジケータを表示して実行します。ただし、キャンセルはできません。
なお、対象プロジェクトが未保存の場合は、このメソッドの呼び出しは失敗します。対象プロジェクトがカレントプロジェクトの場合は、プロジェクトナビゲータから実行した場合と同様にND上にメッセージダイアログが表示され、追加ロードを中断します。カレントプロジェクト以外の場合は例外が発生します。
NewProject新規プロジェクトを生成します。
OpenProject指定されたプロジェクトを開きます。

Redo取り消した編集操作を再実行します。
SaveAll最新の状態に基づいてファイルを保存し直します。
プロジェクトが未指定の場合は、カレントプロジェクトを保存します。

指定されたプロジェクトに対してファイルが作られていない場合は例外をスローします。
ロードされていないユニット、および、読み取り専用であるユニットは保存されません。
SaveProject指定されたプロジェクトを保存します。
プロジェクト未指定の場合は、現在アプリケーションで開いているカレントのプロジェクトを保存します。
正常に保存できた場合はTrueを返します。
ファイルのアクセス権が取得できない、空き容量が足りない等の状況でこのメソッドを使用した場合、プロジェクトは保存されず、このメソッドはFalseを返します。

プロジェクトの保存先は、IProject.Pathで取得できるパスとなります。
したがって、新規作成後一度も保存していないプロジェクトに対してこのメソッドは実行できません。
新規プロジェクトを保存する際には、SaveProjectAs()を利用してください。
SaveProjectAs指定されたパスで、指定されたプロジェクトを保存します。
プロジェクト未指定の場合は、現在アプリケーションで開いているカレントのプロジェクトを保存します。
正常に保存できた場合はTrueを返します。

この呼び出しは、指定されたパスに既にファイルが存在する場合、警告なく上書き保存を行います。
保存が成功した場合、対象プロジェクトのPathは新しいパスに置き換わります。
SetLoadModeモデルユニットのロードモードを設定します。
指定されたユニットが指定したプロジェクトの管理対象外の場合は無視されます。
Undo編集操作を取り消します。