Clase de Generador de Documento

La Clase deGenerador de Documento proporciona una interfaz para el documento y funcionalidades de reportes web, las cuales puede utilizar para generar informes en paquetes específicos, diagramas y elemento en su modelo. Esta clase es accedida desde la Clase Repositorio utilizando el método CreateDocumentGenerator().

Método

Tipo

Notas

Ver También

DocumentDiagram (

long diagramID,

long nDepth,

string templateName)

Boolean

Documenta un diagrama.

Parámetros:

•	diagramId: Long - el ID del diagrama

•	nDepth: Largo - la profundidad con la cual ajustar el nivel de encabezado

•	templateName: String - el nombre de una plantilla para utilizar al documentar diagramas; puede estar en blanco

DocumentElement (

long elementID,

long nDepth,

string templateName)

Boolean

Documenta un elemento.

Parámetros:

•	elementId: Long - el ID del elemento

•	nDepth: Largo - la profundidad con la cual ajustar el nivel de encabezado

•	templateName: String - el nombre de una plantilla para utilizar al documentar elementos; puede estar en blanco

DocumentModelAuthor (

string name,

long nDepth,

string templateName)

Boolean

Documenta un autor modelo.

Parámetros:

•	name: String - el nombre del autor

•	nDepth: Largo - la profundidad con la cual ajustar el nivel de encabezado

•	templateName: String - una plantilla para utilizar al documentar autores modelo; puede estar en blanco

DocumentModelClient (

string name,

long nDepth,

string templateName)

Boolean

Documenta un único cliente modelo.

Parámetros:

•	name: String - el nombre del cliente

•	nDepth: Largo - la profundidad con la cual ajustar el nivel de encabezado

•	templateName: String - una plantilla para utilizar al documentar clientes modelo; puede estar en blanco

DocumentModelGlossary (

long id,

long nDepth,

string templateName)

Boolean

Documenta un único término de glosario del modelo.

Parámetros:

•	id: Long - el ID del término

•	nDepth: Largo - la profundidad con la cual ajustar el nivel de encabezado

•	templateName: String - una plantilla para utilizar al documentar términos de glosario del modelo; puede estar en blanco

DocumentModelIssue (

long id,

long nDepth,

string templateName)

Boolean

Documenta un único problema del modelo.

Parámetros:

•	id: Long - el ID del problema

•	nDepth: Largo - la profundidad con la cual ajustar el nivel de encabezado

•	templateName: String - una plantilla para utilizar al documentar problemas del modelo; puede estar en blanco

DocumentModelResource (

string name,

long nDepth,

string templateName)

Boolean

Documenta un único recurso del modelo.

Parámetros:

•	name: String - el nombre del recurso

•	nDepth: Largo - la profundidad con la cual ajustar el nivel de encabezado

•	templateName: String - una plantilla para utilizar al documentar recursos del modelo; puede estar en blanco

DocumentModelRole (

string name,

long nDepth,

string templateName)

Boolean

Documenta un único rol del modelo.

Parámetros:

•	name: String - el nombre del rol

•	nDepth: Largo - la profundidad con la cual ajustar el nivel de encabezado

•	templateName: String - una plantilla para utilizar al documentar roles del modelo; puede estar en blanco

DocumentModelTask (

long id,

long nDepth,

string templateName)

Boolean

Documenta una única tarea del modelo.

Parámetros:

•	id: Long - el ID de la tarea

•	nDepth: Largo - la profundidad con la cual ajustar el nivel de encabezado

•	templateName: String - una plantilla para utilizar al documentar tareas del modelo; puede estar en blanco

DocumentPackage (

long packageID,

long nDepth,

string templateName)

Boolean

Documenta un paquete.

Parámetros:

•	packageId: Long - el ID del paquete

•	nDepth: Largo - la profundidad con la cual ajustar el nivel de encabezado

•	templateName: String - una plantilla para utilizar al documentar paquetes; puede estar en blanco

GetLastError()

String

Devuelve un valor de string describiendo el error más reciente que ocurrió en relación con este objeto.

InsertBreak (

long breakType)

Boolean

Inserta un salto en el informe en la ubicación actual.

Parámetros:

•	breakType: Long - 0 = salto de página, 1 = salto de sección

Interrupción de Documento

InsertCoverPageDocument (

string name)

Boolean

Inserta una página de Portada en el documentar en la ubicación actual.

Nota: La hoja de estilo se aplica al documento antes de que se inserte en el documento generado.

Parámetros:

•	name: String - el nombre del documento de la página de Portada encontrado en el árbol de Recursos.

InsertLinkedDocument (

string guid)

Boolean

Inserta un documento vinculado en el informe en la ubicación actual.

Un documento vinculado puede ser utilizado para definir el encabezado y pie de página del informe. Estos son tomados del primer documento vinculado agregado al informe.

Parámetros:

•	guid: String - el GUID del elemento que tiene un documento vinculado

InsertTableOfContents

Boolean

Inserta una Tabla de Contenidos en la posición actual.

InsertTeamReviewPost (

string path)

Boolean

Inserta una publicación de la Revisión en Equipo en el informe en la ubicación actual.

Parámetros:

•	path: String - la ruta de la publicación de la Revisión en Equipo

InsertText (

string text,

string style)

Boolean

Inserta un texto estático en el informe en la ubicación actual.

Un retorno de carro no está incluido; si necesita utilizar, puede agregarlo manualmente.

Parámetros:

•	texto: String - el texto estático para ser insertado

•	estilo: String - el nombre del estilo en la plantilla; se predetermina al estilo Normal.

InsertTOCDocument (

string name)

Boolean

Inserta la Tabla de Contenidos en el documento en la ubicación actual.

Nota: La hoja de estilo se aplica al documento antes de que se inserte en el documento generado.

Parámetros:

•	name: String - el nombre del documento de la Tabla de Contenidos encontrado en el árbol de Recursos.

NewDocument (

string templateName)

Boolean

Comienza un nuevo documento; usted llama a esto antes de intentar documentar cualquier otra cosa.

Parámetros:

•	templateName: String - el nombre de una plantilla para utilizar al documentar elementos; puede estar en blanco

ReplaceField (

string fieldname,

string fieldvalue)

Boolean

Reemplaza el campo Sección identificado por el parámetro nombre de archivo con el valor proporcionado en el valor de archivo. Por ejemplo:

ReplaceField ("Element.Alias", "MyAlias")

Si llama a esta función más de una vez con el mismo nombre de archivo, el campo sólo tiene el valor más reciente establecido.

Parámetros:

•	fieldname: String - el nombre del campo para encontrar (esto no incluye las llaves {})

•	fieldvalue: String - el valor a insertar en el campo; este puede ser una constante o un valor derivado

SaveDocument (

string filename,

long nDocType)

Boolean

Guarda el documento en el disco.

Parámetros:

•	filename: String - el nombre de archivo en el cual guardar el archivo

•	nDocType: Long - 0 = RTF, 1 = HTML, 2 = PDF, 3 = DOCX

Tipo de Documento

SetPageOrientation (

long pageOrientation)

Boolean

Establece la orientación de la página actual.

Parámetros:

•	pageOrientation: Long - 0 = Portrait, 1 = Landscape

Orientación de Página de Documento

SetStyleSheetDocument (

string name)

Boolean

Establece la hoja de estilo para ser utilizada para TOC, página de Portada y plantillas utilizadas. Esto puede ser llamado antes que NewDocument (arriba).

Parámetros:

•	name: String - el nombre de la hoja de cálculo encontrado en el árbol de Recursos.