Méthode Document.Clean (Visio)

Examine, génère des rapports sur les conditions sélectionnées dans un document et les répare.

Syntaxe

expression. Clean (nTargets, nActions, nAlerts, nFixes, bStopOnError, bLogFileName, nReserved)

Expression Variable qui représente un objet Document .

Paramètres

Valeur renvoyée

Aucune

Remarques

Les développeurs de Microsoft Visio utilisent la méthode Clean pour valider et optimiser les documents proposés par Visio. Les développeurs tiers peuvent appliquer cette méthode à leurs documents.

Il est suggéré aux développeurs d’utiliser les valeurs par défaut pour nTargets , nActions , nAlerts et nFixes , et d’effectuer une copie de sauvegarde d’un document avant qu’il ne soit nettoyé.

Vous pouvez identifier les changements apportés aux documents à l'aide de la méthode Clean en comparant les versions VDX (XML) sauvegardées du document, une version sauvegardée avant l'exécution de la méthode Clean et l'autre après.

L’argument nTargets peut être n’importe quelle combinaison des valeurs des constantes définies dans VisDocCleanTargets dans la bibliothèque de types Visio et décrites dans le tableau suivant.

Les arguments nActions, nAlerts et nFixes peuvent être n’importe quelle combinaison des valeurs des constantes définies dans VisDocCleanActions dans la bibliothèque de types Visio et décrites dans le tableau suivant.

Exemple

La procédure suivante illustre une utilisation de la méthode Clean . Dans ce cas, le modèle de ligne d’un rectangle est remplacé par la même valeur que celle héritée à l’origine, ce qui crée un remplacement local inutile. La méthode Clean est ensuite exécutée, qui détecte la condition et publie une alerte permettant à l’utilisateur de choisir de corriger la condition ou non.

1. Créez un dessin vierge.

2. Utilisez l'outil Rectangle pour dessiner un rectangle sur la page de dessin. Si vous affichez la forme dans la fenêtre ShapeSheet, vous pouvez constater que la valeur ("1") dans la cellule LinePattern est de couleur noire, indiquant que la valeur est héritée.

3. Cliquez avec le bouton droit sur la forme, pointez sur Format, cliquez sur Trait, puis, dans la boîte de dialogue Trait, réappliquez le même motif de trait. Cette action crée une valeur locale dans la forme ou une substitution locale. Maintenant, si vous affichez la forme dans la fenêtre ShapeSheet, vous pouvez constater que la valeur dans la cellule LinePattern est de couleur bleue, indiquant que la valeur est locale.

4. Insérez la procédure Clean_Example figurant ci-dessous dans le projet Microsoft Visual Basic pour Applications de votre document :

5. Exécutez la procédure Clean_Example (sous l’onglet Affichage, cliquez sur Macros, puis, dans la boîte de dialogue Macros, dans la liste des macros, sélectionnez ThisDocument.Clean_Example et cliquez sur Exécuter).

 
    Public Sub Clean_Example() 
     
        ActiveDocument.Clean, visDocCleanActLocalFormulas, _  
           visDocCleanActLocalFormulas, visDocCleanActLocalFormulas 
     
End Sub

Des alertes apparaissent sur la page de dessin vous demandant si vous voulez déplacer ou non la substitution locale non nécessaire. Si vous cliquez sur Oui et que vous rouvrez ensuite la fenêtre ShapeSheet, vous pouvez constater que la valeur dans la cellule LinePattern est redevenue noire, indiquant que la valeur héritée a été rétablie.

Assistance et commentaires

Avez-vous des questions ou des commentaires sur Office VBA ou sur cette documentation ? Consultez la rubrique concernant l’assistance pour Office VBA et l’envoi de commentaires afin d’obtenir des instructions pour recevoir une assistance et envoyer vos commentaires.