Clase Diagrama

Un Diagrama corresponde a un único diagrama UML. Es accedido a través de la colección de Diagramas de Paquete y a su vez contiene un colección de objetos de diagrama y conectores de diagrama. Agregar a la Clase DiagramObject agrega un elemento existente al diagrama. Al agregar un nuevo diagrama, debe configurar el tipo de diagrama a uno de los tipos válidos:

•

Actividad

•

Análisis

•	Componente

•	Personalizado

•	Despliegue

•

Lógico

•

Secuencia

•	Diagrama de Estado

•	Caso de Uso

Para un diagrama de Colaboración (Comunicación), utilice el tipo Análisis.

Tabla asociada en archivo .EAP t_diagram

Atributos de Diagrama

Atributo	Tipo	Notas	Ver También
Autor	String	Lectura/Escritura El nombre del autor.
CreatedDate	Fecha	Lectura/Escritura La fecha en la que el diagrama fue creado.
cx	Long	Lectura/Escritura La dimensión X del diagrama (lo predeterminado es 800).
cy	Long	Lectura/Escritura La dimensión Y del diagrama (lo predeterminado es 1100).
DiagramGUID	Variante	Lectura/Escritura Un ID global único para este diagrama.
DiagramID	Long	Sólo lectura Un ID local para el diagrama.
Vínculos de Diagrama	Colección	Sólo lectura Una lista de objetos DiagramLink , cada uno conteniendo información sobre la visualización de características de un conector en un diagrama.	Clase de Vínculo de Diagrama
DiagramObjects	Colección	Sólo lectura Una colección de referencias para DiagramObjects. Un DiagramObject es una instancia de un elemento en un diagrama, e incluye características de tamaño y visualización.	Clase DiagramObject
ExtendedStyle	String	Lectura/Escritura Un atributo de estilo extendido.
HighlightImports	Boolean	Lectura/Escritura Una bandera para indicar que elementos desde otros paquetes deberían ser resaltados. Corresponde con la opción 'Mostrar Espacio de Nombre' en la ventana de propiedades de diagrama.	Configurar Visualización de Diagrama
IsLocked	Boolean	Lectura/Escritura Una bandera indicando si este diagrama está bloqueado o no.
MetaType	String	Sólo lectura El meta tipo específico de dominio del diagrama, como se define por una Tecnología MDG
ModifiedDate	Variante	Lectura/Escritura La fecha en la que el diagrama fue modificado por última vez.
Nombre	String	Lectura/Escritura El nombre del diagrama.
Notas	String	Lectura/Escritura Establecer o recuperar notas para este diagrama.
ObjectType	ObjectType	Sólo lectura Distingue objetos referidos a través de una interfaz de Envío.
Orientación	String	Lectura/Escritura La orientación de la página: P para Vertical (Portrait) o L para Horizontal (Landscape).
PackageID	Long	Lectura/Escritura El ID del Paquete al que pertenece este diagrama.
PageHeight	Long	Lectura El número de alto de páginas que tiene el diagrama.
PageWidth	Long	Lectura El número de ancho de páginas que tiene el diagrama.
ParentID	Long	Lectura/Escritura El ID opcional de un elemento que es 'dueño' de este diagrama; por ejemplo, un diagrama de Secuencia perteneciente a un Caso de Uso.
Escala	Long	Lectura/Escritura La escala de zoom (lo predeterminado es 100).
SelectedConnector	Conector	Lectura/Escritura El conector actualmente seleccionado en este diagrama. Nulos si no hay ningún diagrama actualmente seleccionado.
SelectedObjects	Colección	Sólo lectura Obtiene una colección representando los elementos actualmente seleccionados en el diagrama. Puede eliminar objetos desde una colección para deseleccionarlos, y agregar elementos a la colección al pasar el ID del objeto como un nombre para seleccionarlos.
ShowDetails	Long	Lectura/Escritura Una bandera para indicar que el texto de Detalles de Diagrama debería mostrarse: 1 = Mostrar, 0 = Ocultar.
ShowPackageContents	Boolean	Lectura/Escritura Una bandera para indicar que los contenidos de paquete deberían ser mostrados en el diagrama actual.
ShowPrivate	Boolean	Lectura/Escritura Una bandera para mostrar u ocultar características Privadas.
ShowProtected	Boolean	Lectura/Escritura Una bandera para mostrar u ocultar características Protegidas.
ShowPublic	Boolean	Lectura/Escritura Una bandera para mostrar u ocultar características Públicas.
Estereotipo	String	Lectura/Escritura Establece u obtiene el estereotipo para este diagrama.
StyleEx	String	Lectura/Escritura Configuraciones avanzadas de estilo, reservadas para el uso de Sparx Systems.
Carriles	String	Lectura/Escritura Información sobre carriles contenidos en el diagrama. Por favor note que esta propiedad es suprimida por SwimlaneDef.	Clase SwimlaneDef
SwimlaneDef	SwimlaneDef	Lectura/Escritura Información sobre carriles contenidos en el diagrama.
Tipo	String	Sólo lectura El tipo de diagrama; vea la tablat_diagramtypes en el archivo .EAP para más información.
Versión	String	Lectura/Escritura La versión del diagrama.

Métodos de Diagrama

Método

Tipo

Notas

Ver También

ApplyGroupLock (

string aGroupName)

Boolean

Aplica un bloqueo de grupo para este objeto de diagrama, para el grupo especificado, de parte del usuario actual.

Devuelve verdadero si la operación es exitosa; devuelve falso si la operación no es exitosa. UtiliceGetLastError() para recuperar información de error.

Parámetro:

•	aGroupName: Cadena - el nombre del grupo de usuario para el cual configurar el bloqueo de grupo

ApplyUserLock ()

Boolean

Aplica un bloqueo de usuario para este objeto de diagrama, para el usuario actual.

Devuelve verdadero si la operación es exitosa; devuelve falso si la operación no es exitosa. UtiliceGetLastError() para recuperar información de error.

GetDiagramObjectByID (

long ID,

string DUID)

DiagramObject

Devuelve el objeto DiagramObject, si existe en el diagrama.

Parámetros:

•	ID: Long - el ElementID del objeto de diagrama

•	DUID: Cadena - el ID único de Diagrama Opcional del objeto de diagrama.

Clase DiagramObject

GetLastError ()

String

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

ReadStyle (

string StyleName)

String

Devuelve el valor actual del estilo de diagrama nombrado.

UtiliceGetLastError() para recuperar información de error.

Parámetros:

•	StyleName: Cadena - el nombre del estilo de diagrama cuyo valor no es recuperado; los StyleNames válidos son:

•	Mostrar Cadena de Propiedad de Elemento

•	Mostrar Cadena de Propiedad de Conector

•	Mostrar Cadena de Propiedad de Característica

ReleaseUserLock ()

Boolean

Libera un bloqueo de grupo o de bloqueo de usuario en este objeto de diagrama.

Devuelve verdadero si la operación es exitosa; devuelve falso si la operación no es exitosa. UtiliceGetLastError() para recuperar información de error.

ReorderMessages ()

Vacío

Resetea el orden de visualización de mensajes de Secuencia y Colaboración.

Esto es generalmente utilizado después de insertar o eliminar mensajes en el diagrama.

SaveAsPDF (

string FileName)

Boolean

Exportar el diagrama a documento PDF. Devuelve verdadero si es exitoso.

Parámetros:

•	Nombre de Archivo: Cadena - ruta completa de la ubicación de archivo

SaveImagePage (

longx,

longy,

longSizeX,

long sizeY,

string filename,

long flags)

Boolean

Guarda la página del diagrama al disco.

Devuelve verdadero si la operación es exitosa; devuelve falso si la operación no es exitosa.

UtiliceGetLastError() para recuperar información de error.

Parámetros:

•	x: Long - la página horizontal

•	y: Long - la página vertical

•	sizeX: Long - el ancho de página para utilizar

•	sizeY: Long - el alto de página para utilizar

•	Nombre de Archivo: Cadena - el nombre de archivo con el cual guardar la imagen.

•	banderas: Long - opciones

El tipo de imagen se determinad por la extensión del nombre de archivo Actualmente sólo los formatos .EMF, .BMP y .PNG son soportados.

ShowAsElementList (

bool ShowAsList,

bool Persist)

Boolean

Alterna la visualización del diagrama entre formato de diagrama y Lista de Diagrama dependiendo del valor deShowAsList.

Si se establece Persistir, el formato de visualización se escribe en la base de datos para que el diagrama siempre se abra en ese formato (diagrama o lista). De lo contrario, el formato de visualización vuelve a caer en el predeterminado (diagrama) una vez que se cierra la pantalla.

Parámetros:

•	ShowAsList: Boolean - Indica diagrama o Lista de Diagrama

•	Persistir: Boolean - indica establecido (mantener valor ShowAsList) o no (revertir a predeterminado)

Lista de Diagrama

Update ()

Boolean

Actualiza este objeto de diagrama después de modificar o anexar un nuevo ítem.

Si se devuelve falso, utiliceGetLastError() para recuperar información de error.

WriteStyle (

string StyleName,

string StyleValue)

Vacío

Establece el valor del estilo de diagrama nombrado.

UtiliceGetLastError() para recuperar información de error.

Parámetros:

•	StyleName: Cadena - el nombre del estilo de diagrama cuyo valor no es recuperado; los StyleNames válidos son:

•	Mostrar Cadena de Propiedad de Elemento

•	Mostrar Cadena de Propiedad de Conector

•	Mostrar Cadena de Propiedad de Característica

•	StyleValue: Cadena - el valor a ser configurado se encuentra en el estilo de diagrama nombrado; valores válidos para los StyleNames listados arriba son 0 y 1.