预订演示

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

前页 后页

项目类别

可以使用GetProjectInterface()从存储库访问Project接口。返回的接口提供对基于XML的Enterprise Architect自动化接口的访问。使用此接口可获取各种内部元素的XML,并运行一些实用程序功能来执行任务,例如负载图或运行报告。

项目属性

属性

备注

也可以看看

对象类型

对象类型

注意:只读

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

对象类型

项目方法

方法

备注

也可以看看

BuildExecutableStatemachine(字符串ElementGUID,字符串ExtraOptions)

布尔型

注意:为<< executable statemachine >> Artifact元素构建可执行StateMachine代码。

参数:

  • ElementGUID:字符串-要生成的元素的GUID(XML格式)
  • ExtraOptions:字符串-可以为命令提供其他选项(当前未使用)

CancelValidation()

空洞

注意:取消验证过程。

模型验证

CanValidate()

布尔型

注意:返回一个值,指示已加载“模型验证”组件。

ExportReferenceData(字符串FileName,字符串表)

布尔型

注意:导出参考数据。

参数:

  • FileName:字符串-输出参考数据到的文件的名称
  • 表:字符串-要输出的参考数据表的列表;数据表的分度为“;”
    如果字符串为空, Enterprise Architect将提示对话框以选择要输出的表

ImportReferenceData(字符串FileName,字符串DataSet)

布尔型

注意:导入参考数据

参数:

  • FileName:字符串-要从中导入的参考数据文件的名称
  • DataSets:字符串-要导入的参考数据集的列表;数据集分隔符为“;”
    如果字符串为空, Enterprise Architect显示一个对话框提示,以选择要导入的数据集

GenerateBuildRunExecutableStateMachine(字符串ElementGUID,字符串ExtraOptions)

布尔型

注意:为<< executable statemachine >> Artifact元素生成,构建和运行Executable StateMachine代码,这将开始模拟StateMachine。

参数:

  • ElementGUID:字符串-要生成的元素的GUID(XML格式)
  • ExtraOptions:字符串-可以为命令提供其他选项(当前未使用)

CreateBaseline(字符串PackageGUID,字符串版本,字符串注释)

布尔型

注意:创建指定包的基准。

参数:

  • PackageGUID:字符串-要基线的包的GUID(XML格式)
  • 版本:字符串-基准版本
  • 注释:字符串-有关基准的任何注释

CreateBaselineEx(字符串PackageGUID,字符串版本,字符串注释,EA.CreateBaselineFlag标志)

布尔型

注意:创建指定包的基准,并带有标志以排除低于第一级的包内容。

参数:

  • PackageGUID:字符串-要作为基线的包的GUID(XML格式)
  • 版本:字符串-基准版本
  • 注释:字符串-有关基准的任何注释
  • 标志:EA.CreateBaselineFlag-是否排除低于第一级的软件包内容
创建基准 CreateBaselineFlag

DefineRule(字符串CategoryID,EA.EnumMVErrorType ErrorType,字符串ErrorMessage)

注意:定义可以在模型验证期间执行的各个规则。必须为每个规则从EA_OnInitializeUserRules广播处理程序中调用一次。

返回值是RuleId,当Enterprise Architect在模型验证期间执行单个规则时,可以将其用作参考。

有关使用此方法的详细示例,请参见模型验证示例

参数:

  • CategoryId:字符串-应该传递DefineRuleCategory方法的返回值
  • ErrorType:EA.EnumMVErrorType-根据要验证的错误的严重性,可以是:
    -mvErrorCritical
    -mvError
    -mvWarning,或
    -mvInformation
  • ErrorMessage:字符串-可以包含默认错误字符串,尽管它可能被PublishResult调用覆盖
EA_OnInitializeUserRules 模型验证示例 项目类别

DefineRuleCategory(字符串CategoryName)

注意:定义可以在模型验证期间执行的规则类别(每个Add-In通常有一个类别)。必须从EA_OnInitializeUserRules广播处理程序中调用一次。

返回值是必须传递给DefineRule方法的CategoryId。

有关使用此方法的详细示例,请参见模型验证示例

参数:

  • CategoryName:字符串-在“模型验证配置”对话框中可见的文本字符串
EA_OnInitializeUserRules 项目类别 模型验证示例

RunExecutableStatemachine(字符串ElementGUID,字符串ExtraOptions)

布尔型

注意:为<< executable statemachine >> Artifact元素运行Executable StateMachine代码,这将开始模拟StateMachine

参数:

  • ElementGUID:字符串-要生成的元素的GUID(XML格式)
  • ExtraOptions:字符串-可以为命令提供其他选项(当前未使用)

DeleteBaseline(字符串BaselineGUID)

布尔型

注意:从存储库中删除由BaselineGUID标识的基准。

如果将存储库配置为在可重用资产服务注册表中存储基准,则无法删除该基准,并返回False值。

参数:

  • BaselineGUID:字符串-要删除的基线的GUID(XML格式)

DoBaselineCompare(字符串PackageGUID,字符串Baseline,字符串ConnectString)

注意:使用提供的Package GUID和Baseline GUID(从GetBaselines的结果列表中获得)执行Baseline比较。

(可选)如果基线存在于其他模型文件中,则可以包括查找基线所需的连接字符串。

此方法返回在差异过程中找到并比较的所有元素的状态的日志文件。您可以将此日志信息用作DoBaselineMerge的输入-自动合并Baseline中的信息。

参数:

  • PackageGUID:字符串-要在其上进行比较的Package的GUID(XML格式)
  • 基准:字符串-基准的GUID(XML格式),用于在该基准上进行比较
  • ConnectString:字符串-外部.eap文件或DBMS的位置,以从中提取基准
项目类别

DoBaselineMerge(字符串PackageGUID,字符串基线,字符串MergeInstructions,字符串ConnectString)

注意:根据XML文件(MergeInstructions)中包含的指令执行批合并。如果基准位于另一个模型中,则可以提供可选的连接字符串。

在MergeInstructions文件中,每个MergeItem节点从XML差异日志中提供差异项目的GUID。由于合并是单向的,并且仅以一种可能的方式进行操作,因此不需要其他参数。 Enterprise Architect根据“差异”结果选择正确的过程。

<合并>

<MergeItem guid =“ {XXXXXX}” />

<MergeItem guid =“ {XXXXXX}” />

</合并>

另外,您可以为单个Mergeitem提供RestoreAll的GUID。在这种情况下, Enterprise Architect批量处理所有差异。

<合并>

<MergeItem guid =“ RestoreAll”已更改=“ true” baselineOnly =“ true” modelOnly =“ true”已移动=“ true” fullRestore =“ false” />

</合并>

参数:

  • PackageGUID:字符串-要将基线合并到的Package的GUID(XML格式)
  • 基准:字符串-基准的GUID(XML格式),以合并到Package中
  • MergeInstructions:字符串-包含DoBaselineCompare()返回的XML差异日志中每个差异项的GUID的文件
  • ConnectString:字符串-要从中获取基准的EAP文件或DBMS的位置(如果与Package不在同一模型中)
项目类别

EnumDiagramElements(字符串DiagramGUID)

受保护的摘要:字符串

注意:获取图中所有元素的XML列表。

参数:

  • DiagramGUID:字符串-要获取其元素的逻辑示意图的GUID(XML格式)

EnumDiagrams(字符串PackageGUID)

受保护的摘要:字符串

注意:获取指定包中所有图的XML列表。

参数:

  • PackageGUID:字符串-包的GUID(XML格式)以列出其图表

EnumElements(字符串PackageGUID)

受保护的摘要:字符串

注意:获取指定Package中元素的XML列表。

参数:

  • PackageGUID:字符串-包的GUID(XML格式),用于获取元素的列表

EnumLinks(字符串ElementGUID)

受保护的摘要:字符串

注意:获取指定元素的连接器XML列表。

参数:

  • ElementGUID:字符串-元素的GUID(XML格式),用于获取所有关联的连接器

EnumPackages(字符串PackageGUID)

受保护的摘要:字符串

注意:获取父包内的子包的XML列表。

参数:

  • PackageGUID:字符串-父Package的GUID(XML格式)

EnumProjects()

受保护的摘要:字符串

注意:获取当前文件中的项目列表;对应于存储库中的模型。

储存库类

EnumViews()

受保护的摘要:字符串

注意:枚举项目的视图。作为XML文档返回。

EnumViewEx(字符串ProjectGUID)

受保护的摘要:字符串

注意:获取当前项目中的视图列表。

参数:

  • ProjectGUID:字符串-项目的GUID(XML格式)以获取其视图

出口 ()

受保护的摘要:字符串

注意:退出Enterprise Architect的当前实例;维护此函数是为了向后兼容,永远不要调用此函数。

当您不再使用任何提供的对象时, Enterprise Architect自动退出。

ExportPackageXMI(字符串PackageGUID,enumXMIType XMIType,长DiagramXML,长DiagramImage,长FormatXML,长UseDTD,字符串FileName)

受保护的摘要:字符串

注意:导出指定程序包的XMI。

参数:

  • PackageGUID:字符串-要导出的包的GUID(XML格式)
  • XMIType:EnumXMIType-指定XMI类型和版本信息。有关可接受的值,请参见XMIType枚举
  • DiagramXML:Long-如果需要用于图表的XML,则为True;否则为True。接受的值:
    0 =不导出图表
    1 =导出图
    2 =导出图表以及备用图像
  • DiagramImage:Long-同时创建的图表图像的格式;接受的值:
    -1 =无
    0 =电动势
    1 = BMP
    2 = GIF
    3 = PNG
    4 = JPG
  • FormatXML:长整数-如果在保存之前应格式化XML输出,则为True
  • UseDTD:长-如果应使用DTD,则为True
  • FileName:字符串-输出到的文件名
XMI类型

ExportPackageXMIEx(字符串PackageGUID,enumXMIType XMIType,长DiagramXML,长DiagramImage,
长FormatXML,长UseDTD,字符串FileName,ea.ExportPackageXMIFlag标志)

受保护的摘要:字符串

注意:导出指定包的XMI,并带有标志来确定导出是否包括低于第一级的包内容。

参数:

  • PackageGUID:字符串-要导出的包的GUID(XML格式)
  • XMIType:EnumXMIType-指定XMI类型和版本信息。有关可接受的值,请参见XMIType枚举
  • DiagramXML:Long-如果需要用于图表的XML,则为true;否则为true。接受的值:
    0 =不导出图表
    1 =导出图
    2 =导出图表以及备用图像
  • DiagramImage:Long-同时创建的图表图像的格式;接受的值:
    -1 =无
    0 =电动势
    1 = BMP
    2 = GIF
    3 = PNG
    4 = JPG
  • FormatXML:长整数-如果在保存之前应格式化XML输出,则为True
  • UseDTD:长-如果应使用DTD,则为True。
  • FileName:字符串-输出到的文件名
  • 标志:ea.ExportPackageXMIFlag-指定是否包含低于第一级的软件包内容(当前支持xmiEADefault),是否从导出中排除特定于工具的信息
配置软件包 XMI类型 ExportPackageXMIFlag

GenerateClass(字符串ElementGUID,字符串ExtraOptions)

布尔型

注意:为单个类生成代码。

参数:

  • ElementGUID:字符串-要生成的元素的GUID(XML格式)
  • ExtraOptions:字符串-启用附加选项给命令;目前未使用

GenerateDiagramFromScenario(字符串ElementGUID,EnumScenarioDiagramType DiagramType,长OverwriteExistingDiagram)

布尔型

注意:根据元素的场景规范生成各种图表。

参数:

  • ElementGUID:字符串-包含场景规范的元素的GUID(XML格式)
  • DiagramType:EnumScenarioDiagramType-要生成的图的类型;请参阅ScenarioDiagramType枚举以获取可接受的值
  • OverwriteExistingDiagram:长整数-确定是覆盖现有图还是将现有元素与方案步骤同步
    0 =删除现有的图和元素,并创建一个新的图和元素
    1 =将现有元素与场景步骤同步并保留图布局
    2 =将现有元素与场景步骤同步,然后重新绘制图布局
    3 =如果已经存在,则不生成图表
场景图类型

GenerateElementDDL(字符串ElementGUID,字符串FileName,字符串ExtraOptions)

布尔型

注意:使用当前在“生成DDL”屏幕上设置的选项为元素生成DDL。

GenerateExecutableStatemachine(字符串ElementGUID,字符串ExtraOptions)

布尔型

注意:为<< executable statemachine >> Artifact元素生成Executable StateMachine代码。

参数:

  • ElementGUID:字符串-要生成的元素的GUID(XML格式)
  • ExtraOptions:字符串-可以为命令提供其他选项(当前未使用)

GeneratePackage(字符串PackageGUID,
字符串ExtraOptions)

布尔型

注意:为包内的所有类生成代码。

例如:

recurse = 1; overwrite = 1; dir = C:\

参数:

  • PackageGUID:字符串-包的GUID(XML格式),以生成用于
  • ExtraOptions:字符串-启用附加选项给命令;目前启用:
    -生成所有子包(递归)
    -强制覆盖所有文件(覆盖),然后
    -自动生成所有路径的规范(目录)

GeneratePackageDDL(字符串PackageGUID,字符串FileName,字符串ExtraOptions)

布尔型

注意:使用“生成DDL”屏幕上当前设置的选项,为“包”中的所有元素生成DDL。

GenerateTestFromScenario(字符串ElementGUID,EnumScenarioTestType TestType)

布尔型

注意:根据元素的方案规范生成垂直测试套件,水平测试套件,内部测试或外部测试。

参数:

  • ElementGUID:字符串-包含场景规范的元素的GUID(XML格式)
  • TestType:EnumScenarioTestType-要生成的测试的类型;请参阅ScenarioTestType枚举以获取可接受的值
生成测试用例 ScenarioTestType

GenerateWSDL(字符串WSDLComponentGUID,字符串文件名,字符串编码,字符串ExtraOptions)

布尔型

注意:为指定的WSDL原型组件生成WSDL。

参数:

  • WSDLComponentGUID:字符串-WSDL定型组件的GUID(XML格式)
  • 文件名:字符串-目标文件路径
  • 编码:字符串-代码页指令的XML编码
  • ExtraOptions:字符串-启用附加选项给命令;目前未使用
WSDL

GenerateXSD(字符串PackageGUID,
字符串FileName,
字符串编码,
字符串选项)

布尔型

注意:为程序包创建一个XML模式,由其GUID指定。成功返回True。

参数:

  • PackageGUID:字符串-包的GUID(XML格式)
  • FileName:字符串-目标文件路径
  • 编码:字符串-代码页指令的XML编码
  • 选项:字符串-允许以逗号分隔的字符串为命令提供额外的选项;目前启用:
    -GenGlobalElement-将全局元素的生成用于
    所有全局ComplexTypes打开或关闭;例如:
    GenGlobalElement = 1
    -UseRelativePath-打开或关闭使用相对选项的选项
    XSD导入或XSD包含语句中的路径何时
    提供schemaLocation标记,引用外部Package
    在引用的软件包上为空;例如:
    UseRelativePath = 1

GetBaselines(字符串PackageGUID,字符串ConnectString)

注意:返回与提供的Package GUID相关的基准列表(XML格式)。

参数:

  • PackageGUID:字符串-软件包的GUID(XML格式),用于获取基线
  • ConnectString:字符串-当前未使用

GetDiagram(字符串DiagramGUID)

受保护的摘要:字符串

注意:以XML格式获取图的详细信息。

参数:

  • DiagramGUID:字符串-图的GUID(XML格式)以获取有关的详细信息

GetElement(字符串ElementGUID)

受保护的摘要:字符串

注意:获取指定元素的XML。

参数:

  • ElementGUID:字符串-要为其检索XML的元素的GUID(XML格式)

GetElementConstraints(字符串ElementGUID)

受保护的摘要:字符串

注意:以XML格式获取元素的约束。

参数:

  • ElementGUID:字符串-元素的GUID(XML格式)

GetElementEffort(字符串ElementGUID)

受保护的摘要:字符串

注意:努力为XML格式的元素。

参数:

  • ElementGUID:字符串-元素的GUID(XML格式)

GetElementFiles(字符串ElementGUID)

受保护的摘要:字符串

注意:以XML格式获取元素的指标。

参数:

  • ElementGUID:字符串-元素的GUID(XML格式)

GetElementMetrics(字符串ElementGUID)

受保护的摘要:字符串

注意:以XML格式获取元素的文件。

参数:

  • ElementGUID:字符串-元素的GUID(XML格式)

GetElementProblems(字符串ElementGUID)

受保护的摘要:字符串

注意:以XML格式获取与元素相关的问题(问题)列表。

参数:

  • ElementGUID:字符串-元素的GUID(XML格式)

GetElementProperties(字符串ElementGUID)

受保护的摘要:字符串

注意:以XML格式获取元素的标记值。

参数:

  • ElementGUID:字符串-元素的GUID(XML格式)

GetElementRequirements(字符串ElementGUID)

受保护的摘要:字符串

注意:以XML格式获取元素的要求列表。

参数:

  • ElementGUID:字符串-元素的GUID(XML格式)

GetElementResources(字符串ElementGUID)

受保护的摘要:字符串

注意:以XML格式获取元素的资源列表。

参数:

  • ElementGUID:字符串-元素的GUID(XML格式)

GetElementRisks(字符串ElementGUID)

受保护的摘要:字符串

注意:以XML格式获取与元素关联的风险列表。

参数:

  • ElementGUID:字符串-元素的GUID(XML格式)

GetElementScenarios(字符串ElementGUID)

受保护的摘要:字符串

注意:以XML格式获取元素的方案列表。

参数:

  • ElementGUID:字符串-元素的GUID(XML格式)

GetElementTests(字符串ElementGUID)

受保护的摘要:字符串

注意:以XML格式获取元素的测试列表。

参数:

  • ElementGUID:字符串-元素的GUID(XML格式)

GetFileNameDialog(字符串文件名,字符串FilterString,长FilterIndex,长Flag,字符串InitialDirectory,
长时间打开或保存)

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

例如:

文件名=“”

FilterString =“ CSV文件(* .csv)| * .csv |所有文件(*。*)| *。* ||”

Filterindex = 1

标志=&H2'OFN_OVERWRITEPROMPT

InitialDirectory =“”

OpenOrSave = 1

文件路径= Project.GetFileNameDialog(文件名,FilterString,Filterindex,标志,InitialDirectory,OpenOrSave)

在此示例中,“另存为”对话框将提示您输入CSV文件。

参数:

  • 文件名:字符串-对话框中指定的默认文件名
  • FilterString:字符串-可用文件类型过滤器的分隔列表
  • Filterindex:长整数-默认使用的基于过滤器的索引
  • 标志:Long-用于初始化文件对话框的附加位标志;有关可接受的值,请参见MSDN文档中的OPENFILENAME结构。
  • InitialDirectory:字符串-打开此对话框的目录路径
  • OpenOrSave:长-将对话框显示为“打开”或“另存为”样式对话框;接受的值:0 =打开,1 =另存为

GetLastError()

受保护的摘要:字符串

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

GetLink(字符串LinkGUID)

受保护的摘要:字符串

注意:以XML格式获取连接器详细信息。

参数:

  • LinkGUID:字符串-连接器的GUID(XML格式),用于获取以下内容的详细信息:

GUIDtoXML(字符串GUID)

注意:将内部GUID更改为XML中使用的形式。

参数:

  • GUID:字符串-转换为XML格式的Enterprise Architect样式的GUID

ImportDirectory(字符串PackageGUID,字符串语言,字符串DirectoryPath,字符串ExtraOptions)

布尔型

注意:将源代码目录导入模型。

参数:

  • PackageGUID:字符串-包的GUID(XML格式),可将工程代码反向转换为
  • 语言:字符串-指定要导入的代码的语言
  • DirectoryPath:字符串-指定在计算机上找到代码的路径
  • ExtraOptions:字符串-启用附加选项给命令;当前允许从所有子目录导入源(递归)-例如:recurse = 1

ImportFile(字符串PackageGUID,字符串语言,字符串FileName,字符串ExtraOptions)

布尔型

注意:在每个名称空间样式的“包”中,将单个文件或二进制模块导入到模型中。

参数:

  • PackageGUID:字符串-包的GUID(XML格式),用于将工程代码反向转换为;这应该是命名空间根包
  • 语言:字符串-指定要导入的代码的语言
    使用值“ DNPE”导入二进制模块;这会导入.NET程序集或Java .class文件,但不会导入.jar文件
  • 文件名:字符串-指定在计算机上找到代码或模块的路径
  • ExtraOptions:字符串-启用附加选项给命令;目前未使用

ImportPackageXMI(字符串PackageGUID,字符串文件名,长ImportDiagrams,长StripGUID)

注意:在树中的某个点导入XMI文件。如果成功,则返回一个空字符串,如果失败,则返回一条错误消息。

参数:

  • PackageGUID:字符串-目标包的GUID(XML格式),用于将XMI文件导入(或用XMI文件覆盖)
  • Filename或XMLText:字符串-XMI文件的名称。如果String的类型为filename,则将其解释为源文件,否则将String导入为XML文本
  • ImportDiagrams:长-1用于导入图,0用于跳过导入图
  • StripGUID:长
    -1替换导入时的元素UniqueID;如果剥离,则
    软件包的副本可以导入到同一企业
    建筑师模型为两个不同的版本
    -0,以保留导入时的元素UniqueID;的副本
    无法在同一企业模型中创建包
    建筑师

LayoutDiagram(字符串DiagramGUID,长LayoutStyle)

布尔型

注意:不推荐使用。使用LayoutDiagramEx

调用该函数以分层方式自动布置图。仅建议用于类图和对象图。

参数:

  • DiagramGUID:字符串-布局图的GUID(XML格式)
  • LayoutStyle:长-始终被忽略

LayoutDiagramEx(字符串DiagramGUID,长LayoutStyle,长迭代,长LayerSpacing,长ColumnSpacing,布尔SaveToDiagram)

布尔型

注意:调用该函数以分层方式自动布置图。仅建议用于类图和对象图。

LayoutStyle接受这些选项

  • 默认选项:
-lsDiagramDefault

-lsProgramDefault

  • 循环删除选项:
-lsCycleRemoveGreedy

-lsCycleRemoveDFS

  • 分层选项:
-lsLayeringLongestPathSink

-lsLayeringLongestPathSource

-lsLayeringOptimalLinkLength

  • 初始化选项:
-IsInitialize天真

-IsInitializeDFSOut

-IsInitializeDFSIn

  • 减少交叉路口选项:
-lsCrossReduceAggressive
  • 布局选项-方向
-lsLayoutDirectionUp

-lsLayoutDirectionDown

-lsLayoutDirectionLeft

-lsLayoutDirectionRight

参数:

  • DiagramGUID:字符串-布局图的GUID(XML格式)
  • LayoutStyle:长-布局样式
  • 迭代次数:长-布局过程执行交叉缩减所需的布局迭代次数(默认值= 4)
  • LayerSpacing:长-布局过程应使用的每个元素的层间距(默认值= 20)
  • ColumnSpacing:长-布局过程应使用的每个元素的列间距(默认值= 20)
  • SaveToDiagram:布尔值-指定Enterprise Architect是否应将提供的布局选项默认保存为所讨论的图
ConstLayoutStyles

LoadControlledPackage(字符串PackageGUID)

注意:加载已标记并配置为受控的软件包。文件名详细信息存储在Package控件数据中。

参数:

  • PackageGUID:字符串-要加载的包的GUID(XML格式)

LoadDiagram(字符串DiagramGUID)

受保护的摘要:布尔值

注意:通过其GUID加载图。

参数:

  • DiagramGUID:字符串-要加载的图的GUID(XML格式);如果使用图界面检索GUID,请使用GUIDtoXML函数将其转换为XML格式
项目类别

LoadProject(字符串FileName)

受保护的摘要:布尔值

注意:加载Enterprise Architect项目文件。

如果您已经从存储库访问了已经加载了文件的Project界面,请不要使用此方法。

参数:

  • FileName:字符串-要加载的项目文件的名称

迁移(字符串GUID,字符串SourceType,字符串DestinationType)

空洞

注意:将模型(或模型的一部分)从BPMN,ArchiMate,UPDM或SysML格式迁移到升级格式。

参数:

  • GUID:字符串-要为其迁移内容的Package或元素的GUID
  • SourceType:字符串-要升级的模型的类型;接受的值:
    -BPMN
    -BPMN1.1
    -UPDM
    -SysML1.1
    -SysML1.2
    -SysML1.3
    -ArchiMate
    -ArchiMate2
    -UPDM2
  • DestinationType:字符串-要升级到的模型的类型;默认值为0。接受的值:
    -BPMN1.1
    -BPMN1.1 :: BPEL
    -BPMN2.0
    -UPDM2
    -SysML1.2
    -SysML1.3
    -SysML1.4
    -ArchiMate2
    -ArchiMate3
    -无人机

MigrateToBPMN11(字符串GUID,
字符串类型)

空洞

注意:将包或元素(包括元素,属性,图表和连接器)中的每个BPMN 1.0构造迁移到BPMN 1.1。

参量

  • GUID:字符串-包或元素的GUID,其内容将迁移到BPMN 1.1
  • 类型:字符串-升级到BPMN 1.1或BPMN 1.1和BPEL的类型。可接受的值为:
    -BPMN =迁移到BPMN 1.1
    -BPEL =迁移到BPMN 1.1并更新:
    -任何将BPMN构造为BPEL的图
    -任何具有从BPELProcess到构造型BusinessProcess的元素
在Enterprise Architect的Ultimate和Unified版本中,可以迁移到BPEL。

ProjectTransfer(字符串SourceFilePath,
字符串TargetFilePath,
字符串LogFilePath)

布尔型

注意:将项目从源.eap文件或DBMS传输到目标.eap文件,.eapx文件或.feap文件。

参数:

  • SourceFilePath:字符串-要传输的源文件的路径
  • TargetFilePath:字符串-目标文件的路径,包括文件类型的扩展名; Enterprise Architect在该位置创建一个新的Base项目(使用TargetFilePath作为其名称),然后将源项目的内容传输到该文件中
  • LogFilePath:字符串-传输过程状态已更新的日志文件的路径
在自动化中,目标文件以前不能存在。 Enterprise Architect使用指定的目标名称和扩展名创建一个新的空Base。*文件,并将源项目转移到其中。

ExportProjectXML(字符串DirectoryPath)

布尔型

注意:将整个当前项目导出到指定目录中的本机XML文件。在导出项目数据之前,目录的内容将被删除

参数:

  • DirectoryPath:字符串-保存导出的本机XML文件的目录路径

PublishResult(字符串CategoryID,
EA.EnumMVErrorType错误类型,
字符串ErrorMessage)

注意:返回在模型验证期间可以执行的每个规则的结果。必须为每个规则从EA_OnInitializeUserRules广播处理程序中调用一次。

返回值是RuleId,当Enterprise Architect在模型验证期间执行单个规则时,可以将其用作参考。

有关使用此方法的详细示例,请参见模型验证示例。

参数:

  • CategoryId:字符串-应该传递DefineRuleCategory方法的返回值
  • ErrorType:EA.EnumMVErrorType-根据要验证的错误的严重性,可以是:
    -mvErrorCritical
    -mvError
    -mvWarning,或
    -mvInformation
  • ErrorMessage:字符串-包含错误字符串
EA_OnInitializeUserRules 模型验证示例 项目类别

PutDiagramImageOnClipboard(字符串DiagramGUID,
长型)

受保护的摘要:布尔值

注意:将指定图的图像复制到剪贴板。

参数:

  • DiagramGUID:字符串-要复制的图的GUID(XML格式)
  • 类型:长-文件类型
    -如果Type = 0,则它是一个图元文件
    -如果Type = 1,则它是与设备无关的位图

PutDiagramImageToFile(字符串图GUID,
字符串FileName,
长型)

受保护的摘要:布尔值

注意:将指定图的图像保存到文件中。

参数:

  • DiagramGUID:字符串-要保存的图的GUID(XML格式)
  • FileName:字符串-将图保存到的文件的名称
  • 类型:长-文件类型
    -如果type = 0,则它是一个图元文件
    -如果type = 1,则使用扩展名中的文件类型
    (即.bmp,.jpg,.gif,.png,.tga)

ReloadProject()

受保护的摘要:布尔值

注意:重新加载当前项目。

这是一种刷新当前加载项目的便捷方法(如果对.eap文件进行了外部更改)。

RunModelSearch(字符串搜索,字符串SearchTerm,bool ShowInEA)

空洞

注意:调用“模型搜索”组件。

参数:

  • 搜索:字符串Enterprise Architect定义的搜索的名称
  • SearchTerm:字符串-项目中要搜索的术语
  • ShowInEA:布尔值-在“模型搜索”窗口中执行搜索并输出
型号搜寻 储存库类

RunReport(字符串PackageGUID,
字符串TemplateName,
字符串文件名)

受保护的摘要:无效

注意:运行命名文档报告。

参数:

  • PackageGUID:字符串-用于运行报表的Package或主文档的GUID
  • TemplateName:字符串-要使用的文档报告模板;如果PackageGUID具有MasterDocument的构造型,则不需要模板
  • FileName:字符串-存储生成的报告的文件名和路径;指定的文件扩展名将确定生成的文档的格式-例如,RTF,PDF
文件产生器介面套件 产生文件 虚拟文件

RunHTMLReport(字符串PackageGUID,
字符串ExportPath,
字符串ImageFormat,
字符串样式
字符串扩展名)

注意:运行HTML报告(当您单击“浏览器”窗口中的“包”和“ Hamburger arrow.图标时,与“文档|以HTML形式发布”一样)。

参数:

  • PackageGUID:字符串-要在其上运行报告的Package或主文档的GUID(XML格式)
  • ExportPath:字符串-存储生成的报告文件的目录路径
  • ImageFormat:字符串-存储图像的文件格式-.png或.gif
  • 样式:字符串-要应用的网络样式模板的名称;将<default>用于标准的系统提供的模板
  • 扩展名:字符串-生成的HTML文件的文件扩展名(例如:.htm)
创建网页报告 示范文件和报告包

SaveControlledPackage(字符串PackageGUID)

注意:将已配置为受控程序包的程序包保存到XMI。只需要Package GUID, Enterprise Architect从Package控件信息中选择其余的信息。

参数:

  • PackageGUID:字符串-要保存的Package的GUID(XML格式)

SaveDiagramImageToFile(字符串文件名)

受保护的摘要:字符串

注意:将当前图的图图像保存到文件中。

参数:

  • FileName:字符串-要保存的图像的文件名

ShowWindow(长显示)

受保护的摘要:无效

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

参数:

  • 显示:长

SynchronizeClass(字符串ElementGUID,
字符串ExtraOptions)

布尔型

注意:将类与最新的源代码同步。

参数:

  • ElementGUID:字符串-要从代码更新的元素的GUID(XML格式)
  • ExtraOptions:字符串-启用附加选项给命令;目前未使用

SynchronizePackage(字符串PackageGUID,
字符串ExtraOptions)

布尔型

注意:将包中的每个类与最新的源代码同步。

参数:

  • PackageGUID:字符串-包的GUID(XML格式),包含要从代码更新的元素
  • ExtraOptions:字符串-启用附加选项给命令;当前启用所有子包(子包)的同步-例如:children = 1

TransformElement(字符串TransformName,
字符串ElementGUID,
字符串TargetPackage,
字符串ExtraOptions)

布尔型

注意:将元素转换为Package。

参数:

  • TransformName:字符串-指定应执行的转换
  • ElementGUID:字符串-要转换的元素的GUID(XML格式)
  • TargetPackageGUID:字符串-要转换为的包的GUID(XML格式)
  • ExtraOptions:字符串-可以为命令提供额外的选项:
    -GenCode = True / False-从
    转换后的元素;该选项取代当前
    模型设定

TransformPackage(字符串TransformName,
字符串SourcePackage,
字符串TargetPackage,
字符串ExtraOptions)

布尔型

注意:对包内容进行转换。

参数:

  • TransformName:字符串-指定应执行的转换
  • SourcePackageGUID:字符串-要转换的包的GUID(XML格式)
  • TargetPackageGUID:字符串-要转换为的包的GUID(XML格式)
  • ExtraOptions:字符串-可以为命令提供额外的选项:
    -GenCode = True / False-从转换后的元素清楚地生成代码;
    此选项取代当前模型设置
    -SubPackages = True / False-指定是否在同时包含子包
    转换包

ValidateDiagram(字符串DiagramGUID)

布尔型

注意:调用Enterprise Architect模型验证组件,然后验证图(以确保正确性)以及图中的元素和连接器。

可以通过“开始>桌面>设计>系统输出>模型验证”查看输出。

无论验证结果如何,都返回一个布尔值以指示该过程的成功或失败。

参数:

  • DiagramGUID:字符串-Diagram类对象的GUID
模型验证

ValidateElement(字符串ElementGUID)

布尔型

注意:调用Enterprise Architect模型验证组件,然后验证元素和所有子元素,图,连接器,属性和操作。

可以通过“开始>桌面>设计>系统输出>模型验证”查看输出。

无论验证结果如何,都返回一个布尔值以指示该过程的成功或失败。

参数:

  • ElementGUID:字符串-元素类对象的GUID

ValidatePackage(字符串PackageGUID)

布尔型

注意:调用Enterprise Architect模型验证组件,然后验证包及其中的所有子包,元素,连接器和图。

可以通过“>桌面>设计>系统输出>模型验证”查看输出。

无论验证结果如何,都返回一个布尔值以指示该过程的成功或失败。

参数:

  • PackageGUID:字符串-包类对象的GUID

XMLtoGUID(字符串GUID)

注意:将XML格式的GUID更改为Enterprise Architect内使用的格式。

参数:

  • GUID:字符串-转换为Enterprise Architect内部格式的XML样式GUID

笔记

  • 这些方法都需要XML格式的输入GUID。使用GUIDtoXML将Enterprise Architect GUID更改为XML GUID

学到更多