Document.Clean-Methode (Visio)
Überprüft, meldet und repariert ausgewählte Bedingungen in einem Dokument.
Syntax
Ausdruck. Clean (nTargets, nActions, nAlerts, nFixes, bStopOnError, bLogFileName, nReserved)
Ausdruck Eine Variable, die ein Document-Objekt darstellt.
Parameter
| Name | Erforderlich/Optional | Datentyp | Beschreibung |
|---|---|---|---|
| nTargets | Optional | Variant | Gibt an, welche Teile des Dokuments überprüft werden sollen. Mögliche Werte finden Sie in den Hinweisen. |
| nAktionen | Optional | Variant | Gibt an, welche Bedingungen ermittelt werden sollen. Mögliche Werte finden Sie in den Hinweisen. |
| nAlerts | Optional | Variant | Gibt an, welche erkannten Bedingungen gemeldet werden sollen. Mögliche Werte finden Sie in den Hinweisen. |
| nFixes | Optional | Variant | Gibt an, welche erkannten Bedingungen repartiert werden sollen. Mögliche Werte finden Sie in den Hinweisen. |
| bStopOnError | Optional | Variant | Mit einem Wert ungleich Null (True) wird die Verarbeitung beendet, falls beim Reparieren einer erkannten Bedingung ein Fehler gefunden wird. Mit Null (False) kann die Verarbeitung fortgesetzt werden. |
| bLogFileName | Optional | Variant | Reserviert für zukünftige Verwendung. |
| nReserved | Optional | Variant | Reserviert für zukünftige Verwendung. |
Rückgabewert
Nichts
Bemerkungen
Interne Microsoft Visio-Entwickler verwenden die Clean-Methode, um die mit Visio bereitgestellten Dokumente zu überprüfen und zu optimieren. Entwickler von Drittanbietern können diese Methode für ihre eigenen Dokumente verwenden.
Es wird empfohlen, dass Entwickler Standardwerte für nTargets , nActions , nAlerts und nFixes verwenden und eine Sicherungskopie eines Dokuments erstellen, bevor es bereinigt wird.
Von der Clean-Methode vorgenommene Dokumentänderungen können Sie durch Vergleichen gespeicherter VDX (XML)-Versionen des Dokuments identifizieren, und zwar eine Version, die vor und eine Version, die nach dem Ausführen der Clean-Methode gespeichert wurde.
Das nTargets-Argument kann eine beliebige Kombination der Werte der Konstanten sein, die in VisDocCleanTargets in der Visio-Typbibliothek definiert und in der folgenden Tabelle beschrieben werden.
| Konstante | Wert | Beschreibung |
|---|---|---|
| visDocCleanTargAll | &HFF | Untersuchen Sie alle Objekte (Standardeinstellung für nTargets ). |
| visDocCleanTargFPages | &H1 | Vordergrundblätter überprüfen. |
| visDocCleanTargBPages | &H2 | Hintergrundblätter überprüfen. |
| visDocCleanTargMasters | &H4 | Master-Shape überprüfen. |
| visDocCleanTargStyles | &H8 | Formatvorlagen überprüfen. |
| visDocCleanTargDoc | &H10 | Dokumentblatt überprüfen. |
| visDocCleanTargPageSheet | &H100 | Seitenblätter überprüfen. |
Die Argumente nActions, nAlerts und nFixes können eine beliebige Kombination der Werte der Konstanten sein, die in VisDocCleanActions in der Visio-Typbibliothek definiert und in der folgenden Tabelle beschrieben werden.
| Konstante | Wert | Beschreibung |
|---|---|---|
| visDocCleanActLocalFormulas | &H1 | Unbenötigte lokale Überschreibungen erkennen. |
| visDocCleanActEmptyRowsAndSects | &H2 | Leere lokale Zeilen und Abschnitte erkennen. |
| visDocCleanActNonDefaultFonts | &H4 | Nicht standardmäßige Schriftarteinstellungen erkennen. |
| visDocCleanActStaleResults | &H8 | Ergebnisse erkennen, die nicht mit Formeln übereinstimmen. |
| visDocCleanActMissingSubs | &H10 | Fehlende Abonnements erkennen (Zellabhängigkeiten). |
| visDocCleanActConstantFormulas | &H20 | Formeln erkennen, die vom Ergebnis generiert werden können. |
| visDocCleanActNearZero | &H40 | Ergebnisse erkennen, die fast Null sind, und in Null ändern. |
| visDocCleanActDuplicateSubs | &H80 | Doppelte Abonnements erkennen (Zellabhängigkeiten). |
| visDocCleanActBadDisplayLists | &H100 | Ungültige Anzeigelistenverknüpfungen erkennen. |
| visDocCleanActDeletedFields | &H400 | Gelöschte Felder erkennen. |
| visDocCleanActBadFieldFormulas | &H800 | Felder mit fehlenden oder nicht standardmäßigen Formeln erkennen. |
| visDocCleanActBadFieldMarks | &H1000 | Felder mit nicht synchronisierten Werten für Anzahl und Marker. Die Position von Escapezeichen ändern, um die Anzahl der Zeichen abzugleichen. |
| visDocCleanActBadReferences | &H2000 | Formeln mit #Ref()-Fehlern erkennen. |
| visDocCleanActAll | &H3FFF | Alle Aktionen ausführen. |
| visDocCleanActDefault | &H1FD8 | Zu erkennende Standardbedingungen (Standardwert von nActions ). |
| visDocCleanAlertDefault | &H0 | Zu meldende Standardbedingungen (Standardwert von nAlerts ). |
| visDocCleanFixDefault | &H3D8 | Zu korrigierende Standardbedingungen (Standardwert für nFixes ). |
Beispiel
Das folgende Verfahren veranschaulicht eine Verwendung der Clean-Methode . In diesem Fall wird das Linienmuster eines Rechtecks mit demselben Wert überschrieben, der ursprünglich geerbt wurde, wodurch eine unnötige lokale Außerkraftsetzung entsteht. Anschließend wird die Clean-Methode ausgeführt, die die Bedingung erkennt und eine Warnung ausgibt, mit der der Benutzer auswählen kann, ob die Bedingung behoben werden soll.
Erstellen Sie eine neue leere Zeichnung.
Verwenden Sie das Rechtecktool , um ein Rechteck auf dem Zeichenblatt zu zeichnen. Wenn Sie die Form im ShapeSheet-Fenster anzeigen, können Sie sehen, dass die Farbe des Werts ("1") in der Zelle LinePattern schwarz ist, was angibt, dass der Wert geerbt wird.
Klicken Sie mit der rechten Maustaste auf die Form, zeigen Sie auf Format, klicken Sie auf Linie, und übernehmen Sie im Dialogfeld Linie das gleiche Linienmuster erneut. Diese Aktion erstellt einen lokalen Wert in der Form oder eine lokale Außerkraftsetzung. Wenn Sie nun die Form im ShapeSheet-Fenster anzeigen, können Sie sehen, dass die Farbe des Werts in der Zelle LinePattern blau ist, was angibt, dass der Wert lokal ist.
Fügen Sie die im Folgenden aufgeführte Clean_Example-Prozedur in das Microsoft Visual Basic für Applikationen-Projekt Ihres Dokuments ein:
Führen Sie die Clean_Example-Prozedur (klicken Sie auf der Registerkarte Ansicht auf Makros. Wählen Sie dann im Dialogfeld Makros in der Makroliste die Option ThisDocument.Clean_Example aus, und klicken Sie dann auf Ausführen).
Public Sub Clean_Example()
ActiveDocument.Clean, visDocCleanActLocalFormulas, _
visDocCleanActLocalFormulas, visDocCleanActLocalFormulas
End Sub
Auf dem Zeichenblatt werden Warnungen mit der Frage angezeigt, ob Sie die nicht benötigte lokale Außerkraftsetzung entfernen möchten. Wenn Sie auf Ja klicken und dann das ShapeSheet-Fenster erneut öffnen, können Sie sehen, dass die Farbe des Werts in der Zelle LinePattern erneut schwarz ist, was angibt, dass der geerbte Wert wiederhergestellt wurde.
Support und Feedback
Haben Sie Fragen oder Feedback zu Office VBA oder zu dieser Dokumentation? Unter Office VBA-Support und Feedback finden Sie Hilfestellung zu den Möglichkeiten, wie Sie Support erhalten und Feedback abgeben können.