预订演示

请注意 : 本帮助页面不适用于最新版本的Enterprise Architect. 最新的帮助文档在这里.

前页 后页

储存库类

存储库是所有结构(例如模型,包和元素)的主要容器。您可以使用Models集合开始迭代访问模型。存储库还提供了一些方便的方法来直接访问结构,而不必首先在层次结构中定位它们。

.EAP文件中的关联表

<none>

储存库属性

属性

备注

也可以看看

s

采集

注意:只读

这是系统的Authors集合,其中包含0个或多个Author对象,每个对象都可以与(例如)作为项目作者或所有者的元素或图表相关联。

使用AddNew(),Delete()和GetAt()来管理作者。

收藏类

批量追加

布尔型

注意:读/写

当您的自动化客户端必须快速插入许多元素,操作,属性和/或操作参数时,请将此属性设置为True。

工作完成时设置为False。

这可以使批量添加新元素的效率提高10到20倍。

客户群

采集

注意:只读

与项目关联的客户列表。您可以使用此集合修改,删除和添加新的Client对象。

收藏类

连接字符串

注意:只读

当前存储库的文件名/连接字符串。

对于连接字符串,DBMS存储库类型由“ DBType = n;”标识。其中,n是与DBMS类型相对应的数字,如下所示:

0-MYSQL

1-SQLSVR

2-ADOJET

3- ORACLE

4-POSTGRES

5-ASA

8-访问2007

9-火鸟

当前选择

注意:只读

提供有关选定内容和位置的信息,而无需对数据库进行任何请求。

EA选择类别

DataMinerManager

数据挖掘器对象

注意:返回指向EA.DataMinerManager接口的指针。

DataMinerManager类别

资料类型

采集

注意:只读

数据类型集合。它包含一个数据类型对象列表,每个对象代表用于数据建模或代码生成目的的数据类型定义。

收藏类

EA版

EAEditionTypes

注意:只读

返回当前可用级别的核心许可功能。

当版本为Unified或Ultimate时,此属性返回Corporate

使用“ EAEditionEx”来标识这些扩展版本中的哪些可用。

EAEditionTypes

EAEditionEx

EAEditionTypes

注意:只读

返回当前可用级别的扩展许可功能( Unified或Ultimate )。

EAEditionTypes

EnableCache

布尔型

注意:读/写

当处理大量自动化对象时,用于预加载Package对象的优化。

启用UI更新

布尔型

注意:读/写

将此属性设置为False可以提高模型更改的性能;例如,将元素批量添加到Package中。要向用户显示更改,请调用“ Repository.RefreshModelView()”。

标记更新

布尔型

注意:读/写

指示Enterprise Architect使用LastUpdate值更新存储库。

实例GUID

注意:只读

标识Enterprise Architect运行时会话的标识符字符串。

IsSecurityEnabled

布尔型

注意:只读

指示是否为当前存储库启用了用户安全性。

问题

采集

注意:只读

系统问题列表。包含ProjectIssues对象,每个对象详述与整个项目有关的特定问题。

收藏类

最后更新

注意:只读

标识符字符串,用于标识Enterprise Architect运行时会话及其设置的时间戳。

图书馆版本

注意:只读

Enterprise Architect运行时的内部版本号。

楷模

类型包的集合

注意:只读

模型的类型为Package,并且属于Packages的集合。这是Enterprise Architect项目文件的顶级入口点。每个模型都是“浏览器”窗口中的根节点,并且可以包含诸如“视图”和“包”之类的项。

模型是Package的一种特殊形式。它的ParentID为0。通过遍历所有模型,您可以访问项目层次结构中的所有元素。

您还可以使用AddNew()函数来创建新模型。可以删除模型,但是请记住,模型中包含的所有内容也将被删除。

收藏类 包装类

对象类型

对象类型

注意:只读

区分通过Dispatch接口引用的对象。

对象类型

ProjectGUID

注意:只读

返回项目的唯一ID。

项目角色

采集

注意:只读

包含0个或多个Role对象的系统Roles集合,每个对象可以与(例如)作为项目作者或所有者的元素或图表相关联。

使用AddNew(),Delete()和GetAt()来管理角色。

收藏类

属性类型

采集

注意:只读

可用于存储库的属性类型的集合。

收藏类 PropertyType类别

资源资源

采集

注意:只读

包含要分配给项目内工作项的可用ProjectResource对象。

使用“添加新()”,“修改()”和“删除()”功能来管理资源。

收藏类

搜索窗口

注意:只读

返回对Enterprise Architect搜索窗口的引用。

SearchWindow类别

安全用户

注意:只读

提供有关当前登录的安全性用户的信息。

SecurityUser类别

刻板印象

采集

注意:只读

刻板印象集合。构造型对象列表,其中包含有关构造型及其可应用的元素的信息。

收藏类 刻板印象类

禁止EA对话框

布尔型

注意:读/写

在EA_OnPostNewElement广播事件中设置此属性,以控制Enterprise Architect在创建元素时是否应禁止向用户显示默认的“属性”对话框。

EA_OnPostNewElement

禁止安全对话框

布尔型

注意:读/写

当传递给OpenFile2的用户名和密码参数无效时,禁止显示默认情况下出现的登录提示对话框。仅供外部自动化客户端使用。

任务

采集

注意:只读

系统任务列表(待办事项列表)。每个条目都是一个任务项;您可以修改,删除和添加新任务。

收藏类 任务类别

条款

采集

注意:只读

项目术语表术语。每个术语对象都是术语表中的一个条目。添加,修改和删除条款以维护词汇表。

收藏类 学期班

储存库方法

方法

备注

也可以看看

ActivateDiagram(长图ID)

注意:在Enterprise Architect主用户界面中激活一个已经打开的图(即使其成为活动选项卡)。

参数:

  • DiagramID:Long-要激活的图的ID

ActivatePerspective(字符串长)

布尔型

注意: 已弃用 -不再使用。

ActivateTab(字符串名称)

注意:激活一个打开的Enterprise Architect选项卡式视图。

参数:

  • Name:字符串-要激活的视图的名称

ActivateTechnology(字符串TechnologyID)

注意:激活已启用的MDG技术。

参数:

  • TechnologyID:字符串-要激活的技术的ID,在MDG技术向导中分配
创建MDG技术文件

ActivateToolbox(字符串工具箱,长选项)

布尔型

注意:在GUI中激活“工具箱”页面。

返回的值保留供将来使用。

参数:

  • 工具箱:字符串-要激活的工具箱页面的名称
  • 选项:长-保留以备将来使用

AddDefinedSearches(字符串sXML)

注意:用于输入一组定义的搜索,这些搜索在应用程序的整个生命周期内一直存在于Enterprise Architect中;当Enterprise Architect再次加载时,必须由您的Add-In再次插入。

参数:

  • sXML:字符串-定义的搜索的XML;您可以通过从Enterprise Architect的“管理搜索”对话框中执行搜索导出来获取此XML。
定义和修改搜索

AddDocumentationPath(字符串名称,字符串路径,长型)

注意:为Add-In提供了将书本路径插入Enterprise Architect安装目录中的功能,以显示有关用户创作的主题的学习中心页面(例如,使用Add-In )。

参数:

  • 名称:String- Add-In的学习中心文档层次结构的顶级(根)名称(例如Enterprise Architect )
  • 路径:字符串-包含学习中心文档结构的文件夹的目录路径(例如,
    C:\ Program Files(86)\ Sparx Systems \ EA \ Books
  • 类型:长-保留以备将来使用;设为0
学习中心 创建学习中心页面

AddPerspective(字符串视角,长选项)

布尔型

注意:已弃用-不再使用。

AddPropertiesTab(字符串TabName,字符串PropXML)

注意:创建一个“属性”选项卡。

如果成功创建选项卡,则返回PropertiesTab接口,否则返回NULL。

参数:

  • TabName:字符串-属性选项卡的名称
  • PropXML:字符串-一个XML字符串,用于定义选项卡中的值

XML字符串示例。

<?xml version ='1.0'?>

<属性>

<group name ='theGroup1'>

<property id ='1'type ='text'default =''readonly ='false'>

<name> TestText </ name>

<description>此ID为= 1 </ description>

</ property>

<property id ='2'type ='combobox'default =''readonly ='false'>

<name> TestCombo </ name>

<value>两个</ value>

<description>这具有id = 2 </ description>

<值列表>

<item>一个</ item>

<item>两个</ item>

<item>三个</ item>

</ valuelist>

</ property>

<property id ='3'type ='date'default ='currentdate'showcheckbox ='false'readonly ='false'>

<name> TestDate </ name>

<value> </ value>

<description>此ID = 3 </ description>

</ property>

<property id ='4'type ='checkbox'default ='true'readonly ='false'>

<name> TestCheckbox </ name>

<description>此ID = 4 </ description>

</ property>

<property id ='5'type ='spin'default ='1'min ='0'max ='100'readonly ='false'>

<name> TestSpin </ name>

<value> 7 </ value>

<description>此ID = 5 </ description>

</ property>

<property id ='6'type ='int'default ='1'readonly ='false'>

<name> TestInt </ name>

<value> 100 </ value>

<description>此ID = 6 </ description>

</ property>

<property id ='7'type ='double'default ='1'readonly ='false'>

<name> TestDouble </ name>

<value> 3.333 </ value>

<description>此ID = 7 </ description>

</ property>

<property id ='8'type ='memo'default =''readonly ='false'>

<name> TestMemo </ name>

<value> </ value>

<description>此ID = 8 </ description>

</ property>

</ group>

<group name ='theGroup2'>

<property id = '22'type ='text'default =''readonly ='false'>

<名称> Test1 </名称>

<value> </ value>

<description>这具有id = 22 </ description>

<值列表>

<item> </ item>

</ valuelist>

</ property>

</ group>

</ properties>

PropertiesTab类

AddTab(字符串TabName,字符串ControlID)

activeX自定义控件

注意:将ActiveX自定义控件添加为选项卡式窗口。 Enterprise Architect创建一个控件,如果成功,则返回其Unknown指针,调用者可以使用该指针来操纵控件。

参数:

  • TabName:字符串-用作标签标题
  • ControlID:字符串-控件的ProgID;例如,“ CS_AddinFramework.UserControl1”
创建一个自定义视图

AddWindow(字符串WindowName,字符串ControlID)

activeX自定义控件

注意:将ActiveX自定义控件作为窗口Add-Ins到“ Add-Ins停靠窗口中。 Enterprise Architect创建一个控件,如果成功,则返回其Unknown指针,调用者可以使用该指针来操纵控件。

参数:

  • WindowName:字符串-用作窗口标题
  • ControlID:字符串-控件的ProgID;例如,“ CS_AddinFramework.UserControl1”
自定义停靠窗口

AdviseConnectorChange(长ConnectorID)

注意:为Add-In或自动化客户端提供以下能力:通知Enterprise Architect用户界面特定的连接器已更改,并且如果在任何打开的图中都可见,则可以为用户重新加载和刷新该连接器。

参数:

  • ConnectorID:长-连接器的ID

AdviseElementChange(长ObjectID)

注意:为Add-In或自动化客户端提供以下能力:通知Enterprise Architect用户界面特定元素已更改,并且如果在任何打开的图中都可见,则可以为用户重新加载和刷新该元素。

参数:

  • ObjectID:长整数-元素的ID

CallSBPI(字符串sbpiPrefix,字符串方法,字符串packedParameters)

注意:返回JSON字符串,其中包含来自外部服务器的结果。

参数:

  • sbpiPrefix:字符串-外部服务器的前缀值
  • 方法:字符串-要在外部服务器上调用的函数的名称
  • packingParameters:字符串-要将名称/值附加到的JOSN字符串;不能为空

ChangeLoginUser(字符串名称,字符串密码)

布尔型

注意:将当前登录的用户设置为由名称和密码指定的用户;启用安全性后,这会将用户登录到存储库中。

如果未启用安全性,则会引发异常(未启用安全性)。

参数:

  • 名称:字符串-用户名
  • 密码:字符串-用户的密码

ClearAuditLogs(对象StartDateTime,对象EndDateTime)

布尔型

注意:从模型中清除所有审核日志。

如果StartDateTime和EndDateTime不为null,则仅清除该时间段内的日志项目。

成功返回True,失败返回False。

  • 此方法无法撤消;强烈建议您先调用“ SaveAuditLogs”以备份日志
  • 如果用户登录模型没有正确的访问权限,则此方法可能会失败
参数:
  • StartDateTime:变量(DateTime)-要清除的日志条目的最早日期和时间
  • EndDateTime:变量(DateTime)-要清除的日志条目的最新日期和时间

ClearOutput(字符串名称)

注意:从“系统输出”窗口的选项卡中删除所有文本。

参数:

  • Name:字符串-要从中删除文本的选项卡的名称

CloseAddins()

注意:由自动化控制器调用,以确保清除所有控制器对Enterprise Architect引用后,.NET中创建的Add-Ins不会持续存在。

CloseDiagram(长图ID)

注意:关闭Enterprise Architect已打开的当前图列表中的图。

参数:

  • DiagramID:长整数-要关闭的图的ID

CloseFile()

注意:关闭所有打开的文件。

CreateDocumentGenerator()

文件产生器

注意:返回指向EA.DocumentGenerator接口的指针。

文件产生器介面套件

CreateModel(CreateModelType CreateType,字符串FilePath,长ParentWnd)

布尔型

注意:基于标准Enterprise Architect Base模型创建新的.eap模型文件,或基于提供的SQL连接创建快捷方式.eap。

创建新文件时返回True,否则返回False。

参数:

  • CreateType:CreateModelType-指定是创建EABase.eap模型的新副本,还是创建指向DBMS存储库的.eap文件快捷方式;后一个选项需要打开一个对话框供用户提供SQL连接详细信息
  • FilePath:字符串-新.eap文件的目标
  • ParentWnd:长-用作“ SQL连接”对话框的父级的窗口句柄;仅在使用cmEAPFromSQLRepository时需要
CreateModelType

CreateOutputTab(字符串名称)

注意:在“系统输出”窗口中创建一个选项卡。

参数:

  • 名称:字符串-要创建的选项卡的名称

DeletePerspective(字符串视角,长选项)

布尔型

注意:已弃用-不再使用。

DeleteTechnology(字符串ID)

布尔型

注意:从存储库中删除指定的MDG技术资源。

如果技术已成功从模型中删除,则返回True。否则返回False。

  • 这适用于导入到Enterprise Architect 7.0之前的版本中的技术(导入的技术),而不适用于7.0版及更高版本中引用的技术(引用的技术)
参数:
  • ID:字符串-技术的ID
部署MDG技术

确保OutputVisible(字符串名称)

注意:检查用户是否可以看到“系统输出”窗口中的指定选项卡。如果隐藏了“系统输出”窗口,则该窗口为可见。

参数:

  • Name:字符串-要显示的选项卡的名称

ExecutePackageBuildScript(长ScriptOptions,字符串PackageGuid)

注意:帮助您根据“浏览器”窗口中的当前选择来运行活动的程序包构建脚本。您也可以通过传入Package GUID来运行脚本。

参数:

  • ScriptOptions:长整数-脚本类型;可以是下列数值之一:
1 =建立

2 =测试

3 =运行

4 =创建工作台实例

5 =调试

  • PackageGuid:字符串-要为其运行脚本的Package的ID

出口

注意:立即关闭Enterprise Architect 。由.NET程序员使用,垃圾回收器不会立即释放所有引用的COM对象。

ExtractImagesFromNote(字符串注释,字符串WriteImagePath,字符串RelativeImagePath)

注意:将任何图像管理器链接写入WriteImagePath目录。

返回修改后的注释文本,其中包含使用RelativeImagePath参数指向图像的链接。

参数:

  • 注意:字符串-所选Package,图或元素的注释
  • WriteImagePath:字符串-图像文件链接的存储路径。此路径必须存在
  • RelativeImagePath:字符串-插入修改后的字符串中的路径,该路径指示可以在哪里找到图像(例如,“ .. \ images \”)

ExtractSBPIParameter(字符串packedParameters,字符串名称)

注意:以字符串形式返回参数名称的值。

参数:

  • packingParameters:字符串-要将名称/值附加到的JOSN字符串;不能为空
  • name:字符串-参数的名称

GenerateMDGTechnology(字符串文件名)

布尔型

注意:使用给定MTS文件中的设置生成MDG技术文件。

返回的值指示成功或失败。

参数:

  • 文件名:字符串-要使用的MTS文件的名称和路径

GetActivePerspective()

注意:已弃用-不再使用。

GetAllDiagramImagesAndMap(字符串目录)

布尔型

注意:将模型中的每个图的图像和图像映射保存在指定目录位置。

图像文件将以PNG格式保存,并且每个文件都将图形GUID作为图像名称。图像地图文件将另存为TXT文件,每个文件都将图形GUID作为图像地图名称。

必须在模型选项中选择“自动创建图表图像和图像映射”选项,才能保存图像和图像映射。

参数:

  • 目录–要将图像和图像映射保存到的目录位置
Cloud页

GetAttributeByGuid(字符串Guid)

属性

注意:返回指向存储库中属性的指针,该属性由其GUID定位。通常使用属性的AttributeGUID属性找到它。

参数:

  • Guid:字符串-要定位的属性的GUID
属性类别

GetAttributeByID(字符串ID)

属性

注意:返回指向存储库中某个属性的指针,该属性按其ID定位。通常使用属性的AttributeID属性找到它。

参数:

  • ID:字符串-要查找的属性的ID
属性类别

GetConnectorByGuid(字符串Guid)

连接器

注意:返回指向存储库中连接器的指针,该连接器由其GUID定位。通常可以使用连接器的ConnectorGUID属性找到它。

参数:

  • Guid:字符串-要定位的连接器的GUID
连接器类别

GetConnectorByID(长ConnectorID)

连接器

注意:在存储库中搜索具有特定ID的连接器。

参数:

  • ConnectorID:长-要查找的连接器的ID
连接器类别

GetContextItem(对象项)

对象类型

注意:在Enterprise Architect上下文中设置指向项目的指针。

还返回相应的ObjectType。

有关ContextItems和受支持的ObjectType的其他信息,请参见“ GetContextItemType”方法。

参数:

  • 项目:对象-指向的项目
对象类型

GetContextItemType()

对象类型

注意:在Enterprise Architect上下文中返回项目的ObjectType。 ContextItem定义为在Enterprise Architect GUI中任意位置选择的项目,包括:

  • 在浏览器窗口中选择的项目
  • 在打开的图中选择的项目
  • 在某些对话框中选择的项目,例如属性“属性”对话框
支持的ObjectType可以是以下值之一:
  • otElement
  • 包装
  • otAttribute
  • 方法
  • otConnector
对象类型

GetContextObject()

目的

注意:返回当前上下文对象。

GetCounts()

注意:从基本Enterprise Architect存储库中的许多表返回一组计数。这些可用于确定是否已在检索信息的表中添加或删除了记录。

GetCurrentDiagram()

图表

注意:返回选定的图。

图类

GetCurrentLoginUser(布尔GetGuid)

注:如果未在存储库中启用安全性,那么将生成错误。

如果“ GetGuid”为True,则返回由Enterprise Architect生成的代表用户的GUID。否则,返回在“系统用户/用户详细信息/登录”中输入的文本。

GetDiagramByGuid(字符串Guid)

图表

注意:使用全局引用ID(全局ID)返回指向图的指针。通常可以使用元素的图表GUID属性找到它,并将其存储起来以供以后打开图表时使用,而不使用集合GetAt()函数。

参数:

  • Guid:字符串-要查找的图的GUID
图类

GetDiagramByID(长DiagramID)

图表

注意:使用绝对参考号(本地ID)获取指向图的指针。通常使用元素的DiagramID属性找到它,并将其存储起来以供以后打开图时使用,而不使用集合GetAt()函数。

参数:

  • DiagramID:长整数-要查找的图的ID
图类

GetDiagramImageAndMap(字符串DiagramGUID,字符串目录)

布尔型

注意:使用指定的GUID在指定的目录位置保存该图的图像和图像映射。

图像将以PNG格式保存,并具有DiagramGUID作为图像名称。图像映射将另存为TXT文件,并将DiagramGUID作为图像映射名称。

必须在特定于模型的选项中选择“自动创建图的图像和图像图”选项,此功能才能保存图像和图像图。

参数:

  • DiagramGUID –要为其保存图像和图像映射的图的GUID
  • 目录–将图像和图像映射保存到的目录
Cloud页

GetElementByGuid(字符串Guid)

元件

注意:使用元素的GUID参考编号(全局ID)返回指向存储库中元素的指针。通常可以使用元素的ElementGUID属性找到它,并将其存储起来以供以后打开元素时使用,而无需使用集合'GetAt()'函数。

参数:

  • Guid:字符串-要定位的元素的GUID
元素类别

GetElementByID(长ElementID)

元件

注意:使用绝对引用号(本地ID)获取指向元素的指针。通常可以使用元素的ElementID属性找到它,并将其存储起来以供以后打开元素时使用,而不使用集合GetAt()函数。

参数:

  • ElementID:长整数-要定位的元素的ID
元素类别

GetElementsByQuery(字符串QueryName,字符串SearchTerm)

集合(元素类型)

注意:帮助您在Enterprise Architect运行搜索,将结果作为集合返回。

例如:GetElementsByQuery('Simple','Class1'),其中结果列出了在“名称”和“注释”字段中具有“ Class1”的元素。

参数:

  • QueryName:字符串-要运行的搜索的名称,例如'Simple'
  • SearchTerm:字符串-要搜索的术语
收藏类 元素类别

GetElementSet(字符串IDList,长选项)

集合(元素类型)

注意:基于ElementID值的逗号分隔列表,将一组元素作为集合返回。默认情况下,如果IDList参数中未提供任何值,则返回整个项目的所有对象。

参量

  • IDList:字符串-ElementID值的逗号分隔列表
  • 选项:Long-修改此方法的默认行为
  1. 给定空IDList参数时,返回空集合。
  2. 使用IDList字符串作为SQL查询来填充此集合。
收藏类 元素类别

GetFieldFromFormat(字符串格式,字符串文本)

注意:将字段从您的首选格式转换为Enterprise Architect的内部格式;以该格式返回字段。

参数:

  • 格式:字符串-转换字段所用的格式。有效格式为:
    -HTML-完整HTML
    -RTF-RTF格式
    -TXT-纯文字
  • 文本:字符串-要转换的字段

GetFormatFromField(字符串格式,字符串文本)

注意:访问包含格式的字段后,请使用此方法将其转换为首选格式。以指定的格式返回该字段。

参数:

  • 格式:字符串-将该字段转换为的格式;有效格式为:
    -HTML-完整HTML
    -RTF-RTF格式
    -TXT-纯文字
  • 文本:字符串-要转换的字段

GetFormattedName(字符串Guid,长FlagInclude,字符串Separator,长FlagFormat)

注意:为指定对象的名称提供特殊格式;例如,特定元素或特征的完全限定名称。

参数:

  • Guid:字符串-要格式化的对象的GUID
  • FlagInclude:长-要包含在格式化名称中的项目:
    -fiFeature =&H01
    -fiClass =&H02
    -父母=&H04
    -fiPackage =&H08
    -fiRootNS =&H10
    -fiNiddenNS =&H20
    -fiDiagram =&H40
    -fiElemAlias =&H80
  • 分隔符:字符串-用于分隔每个包含的项目(例如包或元素)的字符串
  • FlagFormat:长-其他格式设置选项:
    -ffReplaceSpaces =&H01
    -ffLowercase =&H02
    -ffURLEncode =&H04
例:

FormattedName = Repository.GetFormattedName(Element.ElementGUID,fiFeature或fiClass或fiParents或fiPackage或fiDiagram,“ ::”,0)

GetGapAnalysisMatrix()

注意:只读

将所有差距分析作为XML文档返回。

差距分析矩阵

GetLastError()

注意:返回一个字符串值,该字符串值描述与该对象有关的最新错误。

GetLocalPath(字符串类型,字符串路径)

注意:参考在“本地路径”对话框中定义的“类型和路径”,返回从元素生成的代码的扩展本地文件路径。

参数:

  • 类型:String-元素的编码语言,例如Java,C或C ++
  • 路径:字符串-要扩展的本地路径;例如:%Desk%\ Javacode \ Motor.java
例如:

Repository.GetLocalPath(Java,%Desk%\ Javacode \ Motor.java)

这可能返回:

C:\ Users \ fbloggs \ Desktop \ Javacode \ Motor.java。

本地路径对话框

GetMailInterface()

邮件接口

注意:返回EA.MailInterface的实例;使用此界面可以自动创建和发送模型邮件消息。

邮件界面包

GetMethodByGuid(字符串Guid)

方法

注意:返回指向存储库中方法的指针。通常可以使用方法的MethodGUID属性找到它。

参数:

  • Guid:字符串-要查找的方法的GUID
方法类别

GetMethodById(字符串ID)

方法

注意:返回指向存储库中方法的指针。通常使用方法的MethodID属性找到它。

参数:

  • ID:字符串-要查找的方法的ID
方法类别

GetPackageByGuid(字符串Guid)

注意:使用程序包的GUID参考编号(全局ID)返回指向存储库中程序包的指针。通常可以使用Package的PackageGUID属性找到它。

模型中的每个Package还具有一个具有相同GUID的关联元素,因此,如果您具有Type =“ Package”的元素,则可以通过调用以下命令来加载Package:

GetPackageByGuid(Element.ElementGUID)

参数:

  • Guid:字符串-要查找的包的GUID
包装类

GetPackageByID(长PackageID)

注意:使用绝对参考号(本地ID)获取指向Package的指针。通常可以使用Package的PackageID属性找到它,并将其存储起来以供以后使用打开一个Package而不使用集合GetAt()函数。

参数:

  • PackageID:长整数-要查找的软件包的ID
包装类

GetProjectInterface()

项目

注意:返回指向EA.Project接口( Enterprise Architect基于XML的自动化服务器)的指针。使用此接口可以使用XML使用Enterprise Architect ,还可以访问实用程序功能以加载图,运行报告等。

项目接口包 项目类别

GetPropertiesTab(字符串TabName)

注意:查找现有的“属性”选项卡。

如果选项卡存在,则返回PropertiesTab接口,否则返回NULL。

参数:

  • TabName:字符串-“属性”标签的名称。
PropertiesTab类

GetReferenceList(字符串类型)

参考

注意:使用列表类型获取指向“引用列表”对象的指针。

参数:

  • 类型:字符串-指定要获取的列表类型;有效的列表类型是:
    -图
    -元素
    -约束
    -要求
    -连接器
    -  状态
    -基数
    -努力
    -公制
    -场景
    -  状态
    -测试
    -列表:难度类型
    -清单:PriorityType
    -清单:TestStatusType
    -列表:ConstStatusType
参考班

GetRelationshipMatrix()

注意:返回一个XML文档(作为字符串),其中包含当前模型中保存的所有Relationship Matrix概要文件的定义。

关系矩阵

GetTechnologyVersion(字符串ID)

注意:返回指定的MDG技术资源的版本。

参数:

  • ID:字符串-指定的技术ID

GetTreeSelectedElements()

采集

注意:返回当前在“浏览器”窗口中选择的一组元素作为一个集合。

收藏类

GetTreeSelectedItem(对象SelectedItem)

对象类型

注意:获取与树视图中当前所选项目相对应的对象变量和类型。

要使用此功能,请创建一个通用对象变量并将其作为参数传递。根据返回类型,将其强制转换为更特定的类型。

通过参数传递回的对象可以是Package,元素,图,属性或操作对象。

参数:

  • SelectedItem:Object-要获取其变量和类型的对象
对象类型

GetTreeSelectedItemType()

对象类型

注意:返回树中当前所选对象的类型。之一:

  • otElement
  • 包装
  • otAttribute
  • 方法
对象类型

GetTreeSelectedObject()

目的

注意:相关方法GetTreeSelectedItem()具有一些脚本语言无法访问的输出参数。作为替代,此方法通过返回值提供选定的项目。

GetTreeSelectedPackage()

注意:返回包含当前选定的树视图对象的Package。

包装类

HasPerspective(字符串透视图)

注意:已弃用-不再使用。

HideAddinWindow()

注意:隐藏停靠的“ Add-In窗口。

自定义停靠窗口

ImportPackageBuildScripts(字符串PackageGuid,字符串BuildScriptXML)

注意:将构建脚本导入Enterprise Architect的Package中。

参数:

  • PackageGuid:字符串-导入构建脚本的Package的GUID
  • BuildScriptXML:字符串-构建脚本XML数据,您可以从Enterprise Architect中将其导出

ImportRASAsset(字符串PackageGUID,字符串协议,字符串ServerName,字符串模型,字符串存储,字符串RASGUID,字符串密码,字符串版本)

注意:导入指定的RAS资产。

成功返回True;检查失败的GetLastError。

参数:

  • PackageGUID:字符串-将资产导入到的Package的GUID
  • 协议:字符串-服务器使用的协议
  • ServerName:字符串-RAS服务器的名称
  • Model:字符串-要使用的RAS模型的名称
  • Storage:字符串-RAS资产的存储名称
  • RASGUID:字符串-RAS资产的GUID
  • 密码:字符串-访问RAS资产的密码
  • 版本:字符串-要导入的RAS资产的版本

ImportTechnology(字符串技术)

布尔型

注意:将给定的MDG技术资源安装到资源库中。

如果技术已成功加载到模型中,则返回True。否则返回False。

这适用于导入到Enterprise Architect 7.0之前的版本中的技术(导入的技术),而不适用于7.0版及更高版本中引用的技术(引用的技术)。

参数:

  • 技术:字符串-技术资源文件的内容
部署MDG技术

InsertSBPIParameter(字符串packedParameters,字符串名称,字符串值)

注意:返回JSON字符串。

参数:

  • packingParameters:字符串-要将名称/值附加到的JOSN字符串;不能为空
  • name:字符串-参数的名称
  • 值:字符串-参数的值

InvokeConstructPicker(字符串ElementFilter)

注意:调用“选择<项目>”对话框,该对话框带有有关对象类型和构造型(可选)的过滤器。返回所选对象的ElementID;如果关闭对话框时未选择任何对象,则返回0

例如:

elementid = Repository.InvokeConstructPicker(“ IncludedTypes = Class,Component; StereoType = foo,bar”)

在此示例中,“选择<item>”对话框将允许用户选择模型中构造型为“ foo”或“ bar”的任何Class或Component元素。 “ IncludedTypes”和“ StereoType”过滤器用分号分隔。

参数:

  • ElementFilter:字符串-根据由IncludedTypes和StereoType过滤器标识的元素类型和构造型,指定哪些元素或包可供选择。
    -IncludedTypes-(强制)逗号分隔的列表
    可以在对话框中选择的元素类型;对于
    例:
    包,类,组件
    -MultiSelect-(可选)设置为True时
    (“ MultiSelect = True;”)允许结构选择器选择
    多个要素
    -选择(可选)-逗号分隔元素列表
    默认情况下将选择的GUID
    -GetNext(可选)-返回列表中的下一个ID
    选定的元素;如果没有更多元素,则为0 ;否则为0 。这个
    选项将不显示对话框,并假设第一个调用
    用MultiSelect = True进行;
    -StereoType-(可选)逗号分隔的列表
    可以在此对话框中选择的构造型
请勿在元素类型或构造型值之间使用前导或尾随空格。参数值必须以正确的大小写;元素类型名称也区分大小写。

例:

val = 仓库 InvokeConstructPicker “ IncludedTypes = Class; MultiSelect = True;” );

          (VAL != 0

{

= 仓库 InvokeConstructPicker “ GetNext = True;” );

           }

选择<项目>对话框

InvokeFileDialog(字符串FilterString,长Filterindex,长Flag)

注意:成功打开一个标准的“打开文件”对话框,并返回一个包含所选文件完整路径的字符串。如果对话框被取消,则返回一个空字符串。

参数:

  • FilterString:字符串-文件类型过滤器的列表。
  • Filterindex:长整数-默认使用的基于过滤器的索引
  • 标志:Long-用于初始化文件对话框的附加位标志;有关可接受的值,请参见MSDN文档中的OPENFILENAME结构。
项目类别

IsTabOpen(字符串TabName)

注意:检查命名的Enterprise Architect选项卡式视图是否打开并处于活动状态。这包括使用“ Repository.AddTab()”添加的打开的图表窗口或自定义控件。

返回值:

  • 2指示选项卡处于打开状态并且处于活动状态(最上面)
  • 1表示它是打开的但不是最上面的,或者
  • 0表示完全不可见
参数:
  • TabName:字符串-要检查的选项卡的名称; TabName区分大小写

IsTechnologyEnabled(字符串ID)

布尔型

注意:检查指定的字符串是否与Enterprise Architect启用的MDG技术的ID相匹配。

如果字符串与启用的技术的ID匹配,则返回True。否则返回False。

参数:

ID:字符串-要检查的技术ID;内置技术ID包括:

  • ArcGIS ArcGIS
  • 巴博
  • BIZBOK BIZBOK指南
  • BPSim BPSim
  • BRM业务规则模型
  • CMMN案例管理模型和符号
  • CODEENG代码工程
  • 数据库建模数据库建模
  • DMN1.1 DMN1.1
  • EA扩展核心扩展
  • ERD实体关系图
  • GML GML
  • MYSQLTECH MySqlTech
  • EAReview评论
  • SIMF SIMF技术
  • SOAML SOAML
  • SysML1.1 SysML1.1
  • SysML1.2 SysML1.2
  • SysML1.3 SysML1.3
  • SysML1.4 SysML1.5
  • UML2基本UML2技术
  • SYSENG系统工程
  • 262139 MDG技术生成器
  • 托加夫托加夫
  • 阿联酋
  • UPDM2 UPDM 2.0
  • Win32UI Win 32用户界面建模
  • ZF Zachman框架
从技术上讲,与Enterprise Architect集成或添加的任何技术组合(包括用户开发的技术)都可以出现在此列表中。实际上,您一次只会检查一种或两种技术。

IsTechnologyLoaded(字符串ID)

布尔型

注意:检查指定的技术是否已加载到存储库中。

如果将MDG技术资源加载到资源库中,则返回True。否则返回False。

参数:

  • ID:字符串-要检查的技术ID

LoadAddins()

注意:从自动化打开Enterprise Architect时,从资源库中加载所有Add-Ins 。

MarkupNotes(字符串注释,字符串GlossaryType,字符串替换)

笔记:

返回包含术语翻译的字符串。

参量

  • 注意:字符串-在其上执行翻译标记的值
  • GlossaryType:字符串-术语表类型的逗号分隔列表;例如,“ tx-french,tx-global”
  • replace:String-找到时替换TERM的值; “ <span class = \” notranslate \“>#TERM#,/ span>”

OpenDiagram(长DiagramID)

注意:提供了用于自动化客户端或Add-In打开图的方法。该图将添加到Enterprise Architect主视图中打开图的选项卡式列表中。

参数:

  • DiagramID:长整数-要打开的图的ID

OpenFile(字符串文件名)

布尔型

注意:这是从自动化客户端打开Enterprise Architect项目文件并使用包含的对象的要点。

如果所需项目是基于DBMS或基于Cloud的存储库,则将需要有效的Enterprise Architect连接字符串。这可以通过以下两种方式之一获得:这两种方法都需要您首先使用Enterprise Architect建立并打开与该模型的连接:

1)使用“另存为快捷方式”菜单项,创建一个包含数据库连接字符串的快捷方式.eap文件;您可以调用此快捷方式文件来访问存储库。

2)或者,您可以在“打开项目”屏幕中右键单击模型的连接条目,然后选择“编辑连接字符串”,然后OpenFile可直接使用此连接字符串。

参数:

  • 文件名:字符串-要打开的Enterprise Architect项目的文件名(或连接字符串)
管理与项目的连接

OpenFile2(字符串FilePath,字符串用户名,字符串密码)

布尔型

注意:至于“ OpenFile()”,除了这提供了密码说明。

参数:

  • Filepath:字符串-要打开的Enterprise Architect项目的文件路径
  • 用户名:字符串-用户登录ID
  • 密码:字符串-用户密码

RefreshModelView(长PackageID)

注意:重新加载软件包或整个模型,以更新用户界面。

参数:

  • PackageID:长整数-要重新加载的Package的ID:如果为0,则重新加载整个模型;否则为0。如果有效的Package ID,则仅重新加载该Package

RefreshOpenDiagrams(布尔FullReload)

注意:从资源库中为所有打开的图重新加载图内容。

参数:

  • FullReload:布尔值-如果为False,则仅重新加载元素部分的内容;否则为false。如果为True,则将重新加载每个图的全部内容

ReloadDiagram(长图ID)

注意:重新加载指定的图。这通常用于在代码导入/导出或其他需要完成刷新的批处理过程之后刷新可见的图表。

不支持在对EA_OnNotifyContextItemModified的调用中调用此方法

参数:

  • DiagramID:Long-要重新加载的图的ID
EA_OnNotifyContextItemModified

ReloadPackage(长PackageID)

注意:重新加载包及其打开的子图。

参数:

PackageID:长整数-要重新加载的Package的ID;如果有效的Package ID,则仅重新加载该Package。

RemoveOutputTab(字符串名称)

注意:从“系统输出”窗口中删除指定的选项卡。

参数:

  • 名称:字符串-要删除的选项卡的名称

RemoveWindow(字符串WindowName)

布尔型

注意:删除与指定的WindowName匹配的Add-In窗口。

参数:

  • WindowName:字符串-要删除的窗口的名称

RepositoryType()

注意:返回当前打开的数据库/存储库类型。

可以返回以下值之一:

  • JET(.EAP文件,MS Access 97至2013格式)
  • 火鸟
  • ACCESS2007(.accdb文件,MS Access 2007+格式)
  • ASA(Sybase SQL Anywhere)
  • SQLSVR(Microsoft SQL Server)
  • MYSQL(MySQL)
  • ORACLE (Oracle)
  • POSTGRES(PostgreSQL)

RunModelSearch(字符串sQueryName,字符串sSearchTerm,字符串sSearchOptions,字符串sSearchData)

注意:运行搜索,在Enterprise Architect “模型搜索”窗口中显示结果。

参数:

  • sQueryName:字符串-要运行的搜索的名称,例如Simple
  • sSearchTerm:字符串-要搜索的术语
  • sSearchOptions:字符串-当前未使用
  • sSearchData:字符串-XML形式的结果列表,该列表附加到Enterprise Architect的结果列表中-请参见XML格式主题;此参数不是必需的,因此请按常规传递空字符串以运行搜索
XML格式(搜索数据) 项目类别

SaveAllDiagrams()

注意:保存所有打开的图。

SaveAuditLogs(字符串FilePath,对象StartDateTime,对象EndDateTime)

布尔型

注意:将模型中包含的审核日志保存到指定文件。

如果“ StartDateTime”和“ EndDateTime”不为null,则仅保存该时间段内的日志项目。

成功返回True,失败返回False。

  • 如果用户登录模型没有正确的访问权限,则可能会失败
参数:
  • FilePath:字符串-将审核日志保存到的文件
  • StartDateTime:变量(DateTime)-要保存的日志条目的最早日期和时间
  • EndDateTime; Variant(DateTime)-要保存的日志条目的最新日期和时间

SaveDiagram(长图ID)

注意:保存打开的图;假定在主用户界面的“选项卡”列表中打开了该图。

参数:

  • DiagramID:Long-要保存的图的ID

SaveDiagramAsUMLProfile(字符串DiagramGUID,字符串文件名)

布尔型

注意:使用上次手动保存特定图的设置,将给定图保存为UML配置文件。

返回的值指示成功或失败。

参数:

  • DiagramGUID:字符串-要保存的概要图的GUID
  • Filename:字符串-要创建的文件的名称和路径;如果保留为空白,则该方法将使用上一次保存指定图表的文件名

SavePackageAsUMLProfile(字符串PackageGUID,字符串文件名)

布尔型

注意:使用上次手动保存特定软件包的设置,将给定软件包保存为UML配置文件。

返回的值指示成功或失败。

参数:

  • PackageGUID:字符串-要保存的配置文件包的GUID
  • Filename:字符串-要创建的文件的名称和路径;如果保留为空白,则该方法将使用上次保存指定Package的文件名

ScanXMIAndReconcile()

注意:扫描与每个项目的受控程序包相关联的程序包XMI文件,并恢复被检测为项目中缺少的任何图表对象或交叉引用。

此功能在团队环境中非常有用,在团队环境中,每个用户维护自己的模型数据库的私有副本(即多个私有EAP文件),并且通过使用受控程序包传播模型更新;当模型托管在所有团队成员都可以访问的单个共享数据库中时,它没有任何好处。

将每个受控程序包与其关联的XMI文件进行比较,如果模型中的交叉引用信息与XMI不匹配,则Enterprise Architect将使用来自XMI的信息更新模型,并将更新记录在“系统输出”窗口中。

您可以通过右键单击“系统输出”窗口中的条目并选择“回滚更新”选项(如果选择了多个条目,则选择“回滚选定的更新”)来回滚此类更新。

关闭模型会清除“系统输出”窗口中的条目;当您回滚更新时,此窗口中的条目也会被清除。

此功能将作为“获取所有最新”操作的一部分自动调用。

在使用私有模型部署的环境中工作并且您的模型包含大量交叉包引用时,建议您在重新导入受控包之后不时调用此函数,例如,使用“获取最新”来更新许多软件包,或在执行许多软件包检出后。

通常,避免在模型中未提交更改时运行此功能。通常,您:

  • 签出一些包裹
  • 调用“ ScanXMIAndReconcile”
  • 进行修改
  • 提交所有未完成的更改,然后再签出更多软件包并再次运行“ ScanXMIAndReconcile”

ShowAddinWindow(字符串TabName)

布尔型

注意: Add-In指定页面上显示停靠的“ Add-In窗口。如果现在显示指定名称的选项卡,则返回True。

参量

  • TabName:字符串-指定选项卡
自定义停靠窗口

ShowDynamicHelp(字符串主题)

注意:将帮助主题显示为视图。

参数:

  • 主题:字符串-指定帮助主题

ShowInProjectView(对象项)

注意:在“浏览器”窗口中选择一个指定的对象。

可接受的对象类型为Package,Element,Diagram,Attribute和Method;如果对象的类型无效,则抛出异常。

参数:

  • 项目:对象-要突出显示的对象

ShowWindow(长显示)

注意:显示或隐藏Enterprise Architect用户界面。

参数:

  • 显示:长

SQLQuery(字符串SQL)

注意:允许针对当前存储库执行SQL select语句。

返回结果记录集的XML格式的字符串值。

参数:

  • SQL:字符串-包含SQL Select语句

SynchProfile(字符串配置文件,字符串构造型)

布尔型

注意:使用“同步配置文件元素”对话框同步UML配置文件项的标记值和约束。

参数:

  • 配置文件:字符串-包含构造型的配置文件的名称
  • 构造型:String-要同步其默认标签和约束的配置文件构造型的名称
同步标记的值和约束

录像机

类型VersionControlResynchPkgStatuses(布尔值ClearSettings)

注意:将当前模型中每个版本控制包的版本控制状态与版本控制提供程序报告的状态同步。

参数:

  • ClearSettings:布尔值
    -如果为True,请从“软件包”中清除“版本控制”设置
    由版本控制提供程序报告为
    不受控制
    -如果为False,请保持版本控制设置不变
    套件报告为不受控制
重新同步版本控制程序包的状态

WriteOutput(字符串名称,字符串输出,长ID)

注意:将文本写入“系统输出”窗口中的指定选项卡,并将该文本与ID关联。

参数:

  • 名称:字符串-指定在其上显示文本的选项卡
  • 输出:字符串-指定要显示的文本
  • ID:长整数-指定一个数字ID值与此输出项关联,以便由Add-Ins项进行进一步处理;如果不需要处理,可以设置为0
EA_OnOutputItemClicked EA_OnOutputItemDoubleClicked