Método Document.Clean (Visio)
Examina, relata e corrige condições selecionadas em um documento.
Sintaxe
expressão. Limpar (nTargets, nActions, nAlerts, nFixes, bStopOnError, bLogFileName, nReserved)
Expressão Uma variável que representa um objeto Document .
Parâmetros
| Nome | Obrigatório/Opcional | Tipo de dados | Descrição |
|---|---|---|---|
| nTargets | Opcional | Variant | Indica que partes do documento deve ser examinada. Consulte Comentários para valores possíveis. |
| nActions | Opcional | Variant | Indica que condições devem ser detectadas. Consulte Comentários para valores possíveis. |
| nAlerts | Opcional | Variant | Indica que condições detectadas devem ser relatadas. Consulte Comentários para valores possíveis. |
| nFixes | Opcional | Variant | Indica que condições detectadas devem ser corrigidas. Consulte Comentários para valores possíveis. |
| bStopOnError | Opcional | Variant | Diferente de zero (True) para interromper o processamento se um erro for encontrado ao tentar corrigir uma condição detectada; zero (False) para permitir que o processamento continue. |
| bLogFileName | Opcional | Variant | Reserved for future use. |
| nReserved | Opcional | Variant | Reserved for future use. |
Valor de retorno
Nada
Comentários
Desenvolvedores internos do Microsoft Visio usam o método Clean para validar e otimizar os documentos fornecidos com o Visio; desenvolvedores terceiros podem usar esse método em seus próprios documentos.
É sugerido que os desenvolvedores usem valores padrão para nTargets , nActions , nAlerts e nFixes e faça uma cópia de backup de um documento antes de ser limpo.
Você pode identificar alterações no documento feitas pelo método Clean comparando versões salvas VDX (XML) do documento, uma versão salva antes que o método Clean seja executado e outra depois.
O argumento nTargets pode ser qualquer combinação dos valores das constantes definidas em VisDocCleanTargets na biblioteca de tipos do Visio e descritos na tabela a seguir.
| Constant | Valor | Descrição |
|---|---|---|
| visDocCleanTargAll | &HFF | Examine todos os objetos (padrão para nTargets ). |
| visDocCleanTargFPages | &H1 | Examinar páginas do primeiro plano. |
| visDocCleanTargBPages | &H2 | Examinar páginas do plano de fundo. |
| visDocCleanTargMasters | &H4 | Examinar mestres. |
| visDocCleanTargStyles | &H8 | Examinar estilos. |
| visDocCleanTargDoc | &H10 | Examinar folha do documento. |
| visDocCleanTargPageSheet | &H100 | Examinar folha(s) da página. |
Os argumentos nActions, nAlerts e nFixes podem ser qualquer combinação dos valores das constantes definidos em VisDocCleanActions na biblioteca de tipos do Visio e descritos na tabela a seguir.
| Constant | Valor | Descrição |
|---|---|---|
| visDocCleanActLocalFormulas | &H1 | Detectar substituições locais desnecessárias. |
| visDocCleanActEmptyRowsAndSects | &H2 | Detectar seções e linhas locais vazias. |
| visDocCleanActNonDefaultFonts | &H4 | Detectar configurações de fonte não-padrão. |
| visDocCleanActStaleResults | &H8 | Detectar resultados que não correspondam às fórmulas. |
| visDocCleanActMissingSubs | &H10 | Detectar assinaturas ausentes (dependências de células). |
| visDocCleanActConstantFormulas | &H20 | Detectar fórmulas que possam ser geradas a partir do resultado. |
| visDocCleanActNearZero | &H40 | Detectar resultados próximos de zero e alterá-los para zero. |
| visDocCleanActDuplicateSubs | &H80 | Detectar assinaturas duplicadas (dependências de células). |
| visDocCleanActBadDisplayLists | &H100 | Detectar ligações inválidas de lista de exibição. |
| visDocCleanActDeletedFields | &H400 | Detectar campos excluídos. |
| visDocCleanActBadFieldFormulas | &H800 | Detectar campos com fórmulas ausentes ou não padrão. |
| visDocCleanActBadFieldMarks | &H1000 | Detectar campos com contagem fora de sincronização e valores de marcador. Altere a posição de caracteres de escape para corresponder às contagens de caracteres. |
| visDocCleanActBadReferences | &H2000 | Detectar fórmulas com erros #Ref(). |
| visDocCleanActAll | &H3FFF | Executar todas as ações. |
| visDocCleanActDefault | &H1FD8 | Condições padrão a serem detectadas (valor padrão de nActions ). |
| visDocCleanAlertDefault | &H0 | Condições padrão para relatar (valor padrão de nAlerts ). |
| visDocCleanFixDefault | &H3D8 | Condições padrão a serem corrigidas (valor padrão para nFixes ). |
Exemplo
O seguinte procedimento demonstra um uso do método Clean. Neste caso, o padrão de linha de um retângulo é substituído pelo mesmo valor herdado originalmente, que cria uma substituição local desnecessária. O método Clean é então executado, o que detecta a condição e envia um alerta que permite ao usuário escolher se deseja corrigir a condição ou não.
Crie um novo desenho em branco.
Use a ferramenta Retângulo para desenhar um retângulo na página de desenho. Se você exibir a forma na janela ShapeSheet, poderá ver que a cor do valor ("1") na célula LinePattern é preta, indicando que o valor é herdado.
Clique com o botão direito do mouse na forma, aponte para Formatar, clique em Linha e, na caixa de diálogo Linha, reaplique o mesmo padrão de linha. Esta ação cria um valor local na forma ou uma substituição local. Agora, se você exibir a forma na janela ShapeSheet, poderá ver que a cor do valor na célula LinePattern é azul, indicando que o valor é local.
Insira o procedimento Clean_Example exibido abaixo no projeto do seu documento do Microsoft Visual Basic for Applications:
Execute o procedimento Clean_Example (na guia Exibição, clique em Macros; e, em seguida, na caixa de diálogo Macros, na lista de macros, selecione ThisDocument.Clean_Example e clique em Executar).
Public Sub Clean_Example()
ActiveDocument.Clean, visDocCleanActLocalFormulas, _
visDocCleanActLocalFormulas, visDocCleanActLocalFormulas
End Sub
Alertas aparecem na página de desenho perguntando se você deseja remover a substituição local desnecessária. Se você clicar em Sim e reabrir a janela ShapeSheet, poderá ver que a cor do valor na célula LinePattern fica preta de novo, indicando que o valor herdado foi restaurado.
Suporte e comentários
Tem dúvidas ou quer enviar comentários sobre o VBA para Office ou sobre esta documentação? Confira Suporte e comentários sobre o VBA para Office a fim de obter orientação sobre as maneiras pelas quais você pode receber suporte e fornecer comentários.