Share via

Método Document.Clean (Visio)

  • Artículo

Examina, notifica y repara las condiciones seleccionadas en un documento.

Sintaxis

expresión. Clean (nTargets, nActions, nAlerts, nFixes, bStopOnError, bLogFileName, nReserved)

Expresión Variable que representa un objeto Document .

Parameters

Nombre Obligatorio/opcional Tipo de datos Descripción
nTargets Opcional Variant Indica las partes del documento que se van a examinar. Vea la sección Comentarios para obtener los posibles valores.
nActions Opcional Variant Indica qué condiciones se van a detectar. Vea la sección Comentarios para obtener los posibles valores.
nAlerts Opcional Variant Indica qué condiciones detectadas se van a notificar. Vea la sección Comentarios para obtener los posibles valores.
nFijos Opcional Variant Indica qué condiciones detectadas se van a reparar. Vea la sección Comentarios para obtener los posibles valores.
bStopOnError Opcional Variant Su valor no es cero (True) para que se detenga el procesamiento si se detecta un error mientras se intenta reparar una condición detectada; su valor es cero (False) para permitir que continúe el procesamiento.
bLogFileName Opcional Variant Reservado para uso futuro.
nReserved Opcional Variant Reservado para uso futuro.

Valor devuelto

Nothing

Comentarios

Los programadores internos de Microsoft Visio usan el método Clean para validar y optimizar los documentos proporcionados con Visio; otros programadores pueden usar este método en sus propios documentos.

Se sugiere que los desarrolladores usen valores predeterminados para nTargets , nActions , nAlerts y nFixes y realicen una copia de seguridad de un documento antes de limpiarlo.

Para identificar los cambios realizados en un documento por el método Clean, compare las versiones VDX (XML) guardadas del documento, una de las cuales se guarda antes de ejecutar el método Clean y la otra después de ejecutar el método.

El argumento nTargets puede ser cualquier combinación de los valores de las constantes definidas en VisDocCleanTargets en la biblioteca de tipos de Visio y se describe en la tabla siguiente.

Constante Valor Descripción
visDocCleanTargAll &HFF Examine todos los objetos (valor predeterminado para nTargets ).
visDocCleanTargFPages &H1 Se examinan las páginas de primer plano.
visDocCleanTargBPages &H2 Se examinan las páginas de fondo.
visDocCleanTargMasters &H4 Se examinan los patrones.
visDocCleanTargStyles &H8 Se examinan los estilos.
visDocCleanTargDoc &H10 Se examina la hoja de documento.
visDocCleanTargPageSheet &H100 Se examinan las hojas de página.

Los argumentos nActions, nAlerts y nFixes pueden ser cualquier combinación de los valores de las constantes definidas en VisDocCleanActions en la biblioteca de tipos de Visio y se describen en la tabla siguiente.

Constante Valor Descripción
visDocCleanActLocalFormulas &H1 Se detectan los reemplazos locales innecesarios.
visDocCleanActEmptyRowsAndSects &H2 Se detectan las secciones y filas locales vacías.
visDocCleanActNonDefaultFonts &H4 Se detectan los valores de fuente que no sean predeterminados.
visDocCleanActStaleResults &H8 Se detectan los resultados que no coincidan con las fórmulas.
visDocCleanActMissingSubs &H10 Se detectan las suscripciones que faltan (dependencias de celda).
visDocCleanActConstantFormulas &H20 Se detectan las fórmulas que se pueden generar a partir del resultado.
visDocCleanActNearZero &H40 Se detectan los resultados que son casi cero y se cambian a cero.
visDocCleanActDuplicateSubs &H80 Se detectan las suscripciones duplicadas (dependencias de celda).
visDocCleanActBadDisplayLists &H100 Se detectan los vínculos no válidos de la lista de presentación.
visDocCleanActDeletedFields &H400 Se detectan los campos eliminados.
visDocCleanActBadFieldFormulas &H800 Se detectan los campos con fórmulas que faltan o fórmulas no estándar.
visDocCleanActBadFieldMarks &H1000 Se detectan los campos con valores de recuento y marcador sin sincronizar. Cambie la posición de los caracteres de escape para que coincidan los recuentos de caracteres.
visDocCleanActBadReferences &H2000 Se detectan las fórmulas con errores #Ref().
visDocCleanActAll &H3FFF Se llevan a cabo todas las acciones.
visDocCleanActDefault &H1FD8 Condiciones predeterminadas que se van a detectar (valor predeterminado de nActions ).
visDocCleanAlertDefault &H0 Condiciones predeterminadas que se van a notificar (valor predeterminado de nAlerts ).
visDocCleanFixDefault &H3D8 Condiciones predeterminadas que se van a corregir (valor predeterminado para nFixes ).

Ejemplo

En el siguiente procedimiento se muestra uno de los usos del método Clean. En este caso, se reemplaza la trama de línea de un rectángulo con el mismo valor que heredó originalmente, lo cual crea un reemplazo local innecesario. A continuación, se ejecuta el método Clean, que detecta la condición y envía una alerta al usuario para que elija si va a reparar la condición o no.

  1. Cree un dibujo en blanco.

  2. Utilice la herramienta Rectángulo para dibujar un rectángulo en la página de dibujo. Si ve la forma en la ventana ShapeSheet, comprobará que el color del valor ("1") en la celda LinePattern es negro, lo que indica que se trata de un valor heredado.

  3. Haga clic con el botón secundario en la forma, seleccione Formato, haga clic en Línea y, en el cuadro de diálogo Línea, vuelva a aplicar la misma trama de línea. De este modo, se crea un valor local en la forma o una invalidación local. Si ve ahora la forma en la ventana ShapeSheet, comprobará que el color del valor en la celda LinePattern es azul, lo que indica que el valor es local.

  4. Inserte el procedimiento Clean_Example que se muestra a continuación en el proyecto de Microsoft Visual Basic para Aplicaciones del documento:

  5. Ejecute el procedimiento Clean_Example (en la ficha Ver, haga clic en Macros; a continuación, en el cuadro de diálogo Macros, en la lista de macros, seleccione ThisDocument.Clean_Example y haga clic en Ejecutar).

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

En la página de dibujo aparecen mensajes de alerta en los que se pregunta al usuario si desea quitar el reemplazo local innecesario. Si hace clic en Sí y, a continuación, abre de nuevo la ventana ShapeSheet, podrá ver que el color del valor en la celda LinePattern es otra vez negro, lo que indica que se ha restaurado el valor heredado.

Soporte técnico y comentarios

¿Tiene preguntas o comentarios sobre VBA para Office o esta documentación? Vea Soporte técnico y comentarios sobre VBA para Office para obtener ayuda sobre las formas en las que puede recibir soporte técnico y enviar comentarios.