ドキュメント関数のリファレンス(iLogic)

ドキュメント関数は、Inventor のパーツ、アセンブリ、または図面ドキュメントにアクセスするために使用します。

ドキュメント関数によって、ファイル名の取得やモデルの更新などの操作ができるようになります。

ドキュメント関数では、ThisDoc によってルールが記述された Inventor ドキュメントが参照されます。ドキュメントは多くの場合、アクティブなドキュメントですが、アセンブリ内のパーツの場合もあります。ルールが格納されている場合には、ThisDoc によってそのドキュメントへアクセスできます。

ドキュメント関数にアクセスするには、iLogic の[ルールを編集]ダイアログの[スニペット]領域にある[システム]タブで、[ドキュメント]ノードを展開します。

Path

ドキュメント パス(フォルダ名)をテキスト文字列で返します。

構文

ThisDoc.Path

FileName

ドキュメントのファイル名を返します。

構文

ThisDoc.FileName(False)

引数に False を指定するとファイル拡張子が省略されます。ファイル拡張子が必要な場合は、引数に True を指定します。

PathAndFileName

ドキュメントのパスとファイル名を返します。

構文

ThisDoc.PathAndFileName(False)

引数に False を指定するとファイル拡張子が省略されます。ファイル拡張子を含めるには、括弧内に True を指定します。

ChangeExtension

ドキュメントのファイル名を使用して、拡張子を変更したファイル名を作成します。

構文

changedName = ThisDoc.ChangeExtension(“.new”)

WorkspacePath

アクティブな Inventor プロジェクト作業スペースのパス(フォルダ名)を返します。作業スペースが定義されていない場合、この関数は空の文字列を返します(長さがゼロで文字を含まない文字列)。

構文

ThisDoc.WorkspacePath()

Launch

指定されたパスとファイル名(拡張子を含む)に従ってファイルを開きます。データ ファイルを指定した場合、関連付けられたアプリケーションで開かれます。実行ファイル(.exe)を指定した場合、プログラムを返します。完全なパスを指定していない場合は、Inventor ドキュメントと同じフォルダ内で、ファイルの検出が行われます。ドキュメント フォルダへの相対的なファイル名とパスも指定できます。

構文

ThisDoc.Launch(“path¥file.ext”)

Save

現在アクティブなドキュメントを保存します。この関数は、パラメータの変更イベントによってトリガされたルールでは機能しません。

構文

ThisDoc.Save

UpdateWhenDone

ルール(およびそのルールをトリガしたすべてのルール)の実行が終了した後に、ルールを含むドキュメントを更新します。この更新は、ユーザ インタフェースで[更新]ボタンをクリックした場合と同じ処理になります。

構文

iLogicVb.UpdateWhenDone = True

RuleParametersOutput

ルールによってパラメータ値が変更された場合は、この関数が Inventor モデルに新しいルール値を適用します。この関数が使用されていない場合は、ルールの実行が終了するまで値が適用されません。DocumentUpdate を使用して更新を実行する必要がある場合はこの関数を使用します。iLogicVb.RunRule 関数を使用している場合にも、この関数を使用して、他のルールにパラメータの新しい値を渡します。

構文

RuleParametersOutput()

DocumentUpdate

現在のドキュメント(ルールを含んでいるドキュメント)で、すぐに更新を実行し、表示を更新します。ジオメトリを再作成する必要がある場合(iProperties.Mass を使用して質量を計算している場合など)は、この関数を使用します。ルールが(パラメータの変更により)他のルールを起動する場合は、[ルールを編集]ダイアログ ボックスでそのルールに対して[従属ルールをすぐに実行]オプションを有効にします。このオプションにより、更新の実行時には、他のルールの実行も終了されます。

構文

InventorVb.DocumentUpdate()

DocumentUpdate(False)

ドキュメントの表示を更新することなく、現在のドキュメント(ルールを含んでいるドキュメント)ですぐに更新を実行します。InventorVb.DocumentUpdate 関数は、モデルとともに表示を更新します。表示を更新しない場合は、代わりにこの関数を使用します。

構文

InventorVb.DocumentUpdate(False)

更新のみを表示

この Inventor API 関数は、表示のみを更新し、モデルは更新しません。

構文

ThisApplication.ActiveView.Update()

CheckParameters

値を変更することなくパラメータ値を検証します。

この関数は、次のような状況で使用します。

パラメータが、基本パーツにリンクされ、その基本パーツ内で外部スプレッドシートにリンクされているとします。この場合、スプレッドシート内でパラメータ値が変更および保存され、その変更がメイン パーツに表示されない可能性があります。この関数は、メイン パーツ内のルールで、GoExcel を使用してスプレッドシート内の値を変更する前に使用します。これにより、基本パーツを(バックグラウンドで)ロードし、アセンブリのメイン パーツ全体に変更を反映できます。

構文

InventorVb.CheckParameters(“”)

File Save As

ドキュメントを新しいファイル名と新しい拡張子(オプション)で保存します。

構文

ThisDoc.Document.SaveAs(NewFileNameAndExtension , True)

True

True に設定すると[コピーを名前を付けて保存]を実行し、False に設定すると[名前を付けて保存]を実行します。