図面内で選択した条件を調査、レポート、および修復します。
構文
式。クリーン (nTargets、 nActions、 nAlerts、 nFixes、 bStopOnError、 bLogFileName、 nReserved)
式Document オブジェクトを表す変数。
パラメーター
| 名前 | 必須 / オプション | データ型 | 説明 |
|---|---|---|---|
| nTargets | 省略可能 | バリアント型 (Variant) | 図面内のどの部分を調査するかを示します。 指定可能な値については、「備考」を参照してください。 |
| nActions | 省略可能 | バリアント型 (Variant) | どの条件を検出するかを示します。 指定可能な値については、「備考」を参照してください。 |
| nアラート | 省略可能 | バリアント型 (Variant) | 検出されたどの条件をレポートするかを示します。 指定可能な値については、「備考」を参照してください。 |
| nFixes | 省略可能 | バリアント型 (Variant) | 検出されたどの条件を修復するかを示します。 指定可能な値については、「備考」を参照してください。 |
| bStopOnError | 省略可能 | バリアント型 (Variant) | 0 以外の値 (True) を指定すると、検出された条件を修復する際にエラーが発生した場合に処理が停止します。0 (False) を指定すると処理は続行します。 |
| bLogFileName | 省略可能 | バリアント型 (Variant) | 将来使用するために予約されています。 |
| nReserved | 省略可能 | バリアント型 (Variant) | 将来使用するために予約されています。 |
戻り値
なし
解説
Microsoft Visio 内部では、Clean メソッドを使用して、Visio で提供されている図面の検証と最適化が行われています。サード パーティ開発者は、自分の図面にこのメソッドを使用できます。
開発者は、 nTargets 、 nActions 、 nAlerts 、 およびnFixes のデフォルト値を使用し、ドキュメントを消去する前にバックアップコピーを作成することをお勧めします。
Clean メソッドによって図面が変更されたどうかは、VDX (XML) で保存されている図面、つまり Clean メソッドを実行する前に保存したバージョンと実行した後に保存したバージョンを比較することによって確認することができます。
nTargets 引数には、Visio タイプ ライブラリの VisDocCleanTargets で定義され、次の表で説明されている定数の値の任意の組み合わせを使用できます。
| 定数 | 値 | 説明 |
|---|---|---|
| visDocCleanTargAll | &HFF | すべてのオブジェクトを調べます ( nTargets の既定値)。 |
| visDocCleanTargFPages | &H1 | 前景ページを検証します。 |
| visDocCleanTargBPages | &H2 | 背景ページを検証します。 |
| visDocCleanTargMasters | &H4 | マスター シェイプを検証します。 |
| visDocCleanTargStyles | &H8 | スタイルを検証します。 |
| visDocCleanTargDoc | &H10 | 図面シートを検証します。 |
| visDocCleanTargPageSheet | &H100 | ページ シートを検証します。 |
nActions、nAlerts、および nFixes 引数には、Visio タイプ ライブラリの VisDocCleanActions で定義され、次の表で説明されている定数の値の任意の組み合わせを使用できます。
| 定数 | 値 | 説明 |
|---|---|---|
| visDocCleanActLocalFormulas | &H1 | 不要なローカルの上書きを検出します。 |
| visDocCleanActEmptyRowsAndSects | &H2 | 空のローカル行とセクションを検出します。 |
| visDocCleanActNonDefaultFonts | &H4 | 既定以外のフォント設定を検出します。 |
| visDocCleanActStaleResults | &H8 | 数式と一致しない結果を検出します。 |
| visDocCleanActMissingSubs | &H10 | 不足している引用を検出します (セル依存)。 |
| visDocCleanActConstantFormulas | &H20 | 結果から生成できる数式を検出します。 |
| visDocCleanActNearZero | &H40 | ほとんど 0 に近い結果を検出し、0 に変更します。 |
| visDocCleanActDuplicateSubs | &H80 | 重複している引用を検出します (セル依存)。 |
| visDocCleanActBadDisplayLists | &H100 | 無効な表示リストのリンクを検出します。 |
| visDocCleanActDeletedFields | &H400 | 削除されたフィールドを検出します。 |
| visDocCleanActBadFieldFormulas | &H800 | 数式のないフィールドや標準外の数式が入っているフィールドを検出します。 |
| visDocCleanActBadFieldMarks | &H1000 | カウントとマーカーの値が非同期のフィールドを検出します。 エスケープ文字の位置を文字数と一致するよう変更します。 |
| visDocCleanActBadReferences | &H2000 | #Ref() エラーが発生した数式を検出します。 |
| visDocCleanActAll | &H3FFF | すべてのアクションを実行します。 |
| visDocCleanActDefault | &H1FD8 | 検出する既定の条件 ( nActions のデフォルト値)。 |
| visDocCleanAlertDefault | &H0 | レポートする既定の条件 ( nAlerts のデフォルト値)。 |
| visDocCleanFixDefault | &H3D8 | 修正する既定の条件 ( nFixes の既定値)。 |
例
次の手順では、 Clean メソッドの使用方法の 1 つを示します。 この場合、四角形の線パターンは、元々継承されたものと同じ値でオーバーライドされるため、不必要なローカル オーバーライドが作成されます。 その後、 Clean メソッドが実行され、条件が検出され、ユーザーが条件を修正するかどうかを選択できるアラートが投稿されます。
新しい空の図面を作成します。
四角形ツールを使用して、図面ページに四角形を描画します。 シェイプシート ウィンドウで図形を表示すると、LinePattern セルの値 ("1") の色が黒であることがわかります。これは、値が継承されていることを示しています。
図形を右クリックし、[ 書式] をポイントして、[ 線] をクリックします。[ 線 ] ダイアログ ボックスで、同じ線のパターンを再適用します。 この操作により、図形にローカル値、またはローカル オーバーライドが作成されます。 これで、シェイプシート ウィンドウで図形を表示すると、[線パターン] セル内の値の色が青であることがわかります。これは、値がローカルであることを示しています。
下の Clean_Example プロシージャを、図面の Microsoft Visual Basic for Applications プロジェクトに挿入します。
Clean_Example プロシージャを実行します ([表示] タブの [マクロ] をクリックし、[マクロ] ダイアログ ボックスのマクロの一覧で、[ThisDocument.Clean_Example] をクリックし、[実行] をクリックします)。
Public Sub Clean_Example()
ActiveDocument.Clean, visDocCleanActLocalFormulas, _
visDocCleanActLocalFormulas, visDocCleanActLocalFormulas
End Sub
不要なローカル オーバーライドを削除するかどうかを尋ねる警告が図面ページに表示されます。 [ はい ] をクリックしてシェイプシート ウィンドウを再度開くと、LinePattern セルの値の色が再び黒くなり、継承された値が復元されたことがわかります。
サポートとフィードバック
Office VBA またはこの説明書に関するご質問やフィードバックがありますか？ サポートの受け方およびフィードバックをお寄せいただく方法のガイダンスについては、Office VBA のサポートおよびフィードバックを参照してください。