Document
Un objeto Document representa un documento de MapForce (un archivo MFD cargado). Un documento contiene una asignación principal y ninguna, una o más asignaciones locales de funciones definidas por el usuario.
Para navegar por el modelo del objeto, use las siguientes propiedades:
•Application
•Parent
Para gestionar archivos, use:
•Activate
•Close
•FullName
•Name
•Path
•Saved
•Save
•SaveAs
Para gestionar asignaciones, use:
•MainMapping
•Mappings
•CreateUserDefinedFunction
Para gestionar componentes, use:
•FindComponentByID
Para generar código, use:
•OutputSettings_ApplicationName
•JavaSettings_BasePackageName
•GenerateCHashCode
•GenerateCodeEx
•GenerateCppCode
•GenerateJavaCode
•GenerateXQuery
•GenerateXSLT
•GenerateXSLT2
•GenerateXSLT3
•HighlightSerializedMarker
Para ejecutar la asignación, use:
•GenerateOutput
•GenerateOutputEx
Ver acceso:
•MapForceView
Obsoleto:
•OutputSettings_Encoding
Propiedades
Nombre | Descripción |
|---|---|
De sólo lectura. Obtiene el objeto de nivel superior de la aplicación. | |
Ruta de acceso y nombre del fichero de documento. | |
Indica u obtiene el nombre del paquete base usado al generar código Java. En la interfaz gráfica de usuario de MapForce, esta opción está disponible en el cuadro de diálogo Configurar asignación (haga clic con el botón derecho en la asignación y seleccione Configurar asignación del menú contextual). | |
De sólo lectura. Obtiene las bibliotecas importadas. En la interfaz gráfica del usuario de MapForce estas se corresponden con entradas de la ventana Gestionar bibliotecas añadidas a nivel del documento. | |
De sólo lectura. Obtiene la asignación principal del documento. | |
De sólo lectura. Esta propiedad da acceso a las funciones de la vista MapForce. | |
De sólo lectura. Devuelve una colección de las asignaciones contenidas en el documento. | |
De sólo lectura. Nombre del fichero de documento sin ruta de acceso. | |
Indica u obtiene el nombre de la aplicación disponible en el cuadro de diálogo Configurar asignación (para mostrar este cuadro de diálogo en MapForce, haga clic con el botón derecho en la asignación y seleccione Configurar asignación del menú contextual). | |
Esta propiedad ya no se admite. La configuración de codificación de salida de la asignación ya no existe. Cada componente tiene su propia configuración de codificación de salida. | |
De sólo lectura. El objeto de nivel superior según el modelo del objeto. | |
De sólo lectura. Ruta del fichero de documento sin nombre. | |
De sólo lectura. True si el documento no se ha modificado desde la última que se guardó, false en caso contrario. |
Métodos
Nombre | Descripción |
|---|---|
Convierte este documento en el documento activo. | |
Cierra el documento sin guardarlo. | |
Crea una función definida por el usuario en el documento actual. | |
Busca en todo el documento y en todas las asignaciones de este el componente con el id indicado. | |
Genera el código C# que ejecutará la asignación. Usa las propiedades definidas en Application.Options para configurar la generación del código. | |
Genera el código que ejecutará la asignación. El parámetro i_nLanguage indica el lenguaje de destino. El método devuelve un objeto que se puede usar para enumerar todos los mensajes creados por el generador de código. Estos son los mismos mensajes que se muestran en la ventana Mensajes de MapForce. | |
Genera el código C++ que ejecutará la asignación. Usa las propiedades definidas en Application.Options para configurar la generación del código. | |
Genera el código Java que ejecutará la asignación. Usa las propiedades definidas en Application.Options para configurar la generación del código. | |
Genera todos los archivos de salida definidos en la asignación usando para ello un lenguaje de asignación interno de MapForce. Los nombres de los archivos de salida están definidos como propiedades de los elementos de salida en la asignación.
Nota: este método solo se puede usar cuando la ventana principal de MapForce (como servidor COM) está visible o incrustada en una interfaz gráfica de usuario. Si se llama al método mientras MapForce no está visible se generará un error. | |
Genera todos los archivos de salida definidos en la asignación usando para ello un lenguaje de asignación interno de MapForce. Los nombres de los archivos de salida están definidos como propiedades de los elementos de salida en la asignación. Este método es idéntico a GenerateOutput, salvo porque el valor que devuelve contiene los mensajes, las advertencias y los errores resultantes, organizados en estructuras en forma de árbol de AppOutputLines.
Nota: este método solo se puede usar cuando la ventana principal de MapForce (como servidor COM) está visible o incrustada en una interfaz gráfica de usuario. Si se llama al método mientras MapForce no está visible se generará un error. | |
Genera código de asignación como XQuery. Usa las propiedades definidas en Application.Options para configurar la generación del código. | |
Genera código de asignación como XSLT. Usa las propiedades definidas en Application.Options para configurar la generación del código. | |
Genera código de asignación como XSLT2. Usa las propiedades definidas en Application.Options para configurar la generación del código. | |
Genera código de asignación como XSLT 3.0. Usa las propiedades definidas en Application.Options para configurar la generación del código. | |
Use este método para resaltar la ubicación en un archivo de asignación previamente seriado. Primero se cargará el documento correspondiente si no lo ha hecho ya. En GenerateCodeEx se explica el método para obtener un indicador seriado. | |
Guarda el documento en el archivo definido por Document.FullName. | |
Guarda el documento con el nombre de archivo indicado y establece Document.FullName en este valor si la operación se realiza con éxito. |
Eventos
Nombre | Descripción |
|---|---|
Este evento se desencadena cuando se cierra un documento. No se debe llamar al objeto documento pasado al gestor de eventos. El evento de apertura correspondiente es Application.OnDocumentOpened. | |
Este evento se desencadena cuando cambia el estado de un documento. |