前页 | 后页 |
项目类别
可以使用GetProjectInterface()从存储库访问Project接口。返回的接口提供对基于XML的Enterprise Architect自动化接口的访问。使用此接口可获取各种内部元素的XML,并运行一些实用程序功能来执行任务,例如负载图或运行报告。
项目属性
属性 |
备注 |
也可以看看 |
---|---|---|
对象类型 |
对象类型 注意:只读 区分通过Dispatch接口引用的对象。 |
对象类型 |
项目方法
方法 |
备注 |
也可以看看 |
---|---|---|
BuildExecutableStatemachine(字符串ElementGUID,字符串ExtraOptions) |
布尔型 注意:为<< executable statemachine >> Artifact元素构建可执行StateMachine代码。 参数:
|
|
CancelValidation() |
空洞 注意:取消验证过程。 |
模型验证 |
CanValidate() |
布尔型 注意:返回一个值,指示已加载“模型验证”组件。 |
|
ExportReferenceData(字符串FileName,字符串表) |
布尔型 注意:导出参考数据。 参数:
|
|
ImportReferenceData(字符串FileName,字符串DataSet) |
布尔型 注意:导入参考数据 参数:
|
|
GenerateBuildRunExecutableStateMachine(字符串ElementGUID,字符串ExtraOptions) |
布尔型 注意:为<< executable statemachine >> Artifact元素生成,构建和运行Executable StateMachine代码,这将开始模拟StateMachine。 参数:
|
|
CreateBaseline(字符串PackageGUID,字符串版本,字符串注释) |
布尔型 注意:创建指定包的基准。 参数:
|
|
CreateBaselineEx(字符串PackageGUID,字符串版本,字符串注释,EA.CreateBaselineFlag标志) |
布尔型 注意:创建指定包的基准,并带有标志以排除低于第一级的包内容。 参数:
|
创建基准 CreateBaselineFlag |
DefineRule(字符串CategoryID,EA.EnumMVErrorType ErrorType,字符串ErrorMessage) |
串 注意:定义可以在模型验证期间执行的各个规则。必须为每个规则从EA_OnInitializeUserRules广播处理程序中调用一次。 返回值是RuleId,当Enterprise Architect在模型验证期间执行单个规则时,可以将其用作参考。 有关使用此方法的详细示例,请参见模型验证示例 。 参数:
|
EA_OnInitializeUserRules 模型验证示例 项目类别 |
DefineRuleCategory(字符串CategoryName) |
串 注意:定义可以在模型验证期间执行的规则类别(每个Add-In通常有一个类别)。必须从EA_OnInitializeUserRules广播处理程序中调用一次。 返回值是必须传递给DefineRule方法的CategoryId。 有关使用此方法的详细示例,请参见模型验证示例 。 参数:
|
EA_OnInitializeUserRules 项目类别 模型验证示例 |
RunExecutableStatemachine(字符串ElementGUID,字符串ExtraOptions) |
布尔型 注意:为<< executable statemachine >> Artifact元素运行Executable StateMachine代码,这将开始模拟StateMachine 参数:
|
|
DeleteBaseline(字符串BaselineGUID) |
布尔型 注意:从存储库中删除由BaselineGUID标识的基准。 如果将存储库配置为在可重用资产服务注册表中存储基准,则无法删除该基准,并返回False值。 参数:
|
|
DoBaselineCompare(字符串PackageGUID,字符串Baseline,字符串ConnectString) |
串 注意:使用提供的Package GUID和Baseline GUID(从GetBaselines的结果列表中获得)执行Baseline比较。 (可选)如果基线存在于其他模型文件中,则可以包括查找基线所需的连接字符串。 此方法返回在差异过程中找到并比较的所有元素的状态的日志文件。您可以将此日志信息用作DoBaselineMerge的输入-自动合并Baseline中的信息。 参数:
|
项目类别 |
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” /> </合并> 参数:
|
项目类别 |
EnumDiagramElements(字符串DiagramGUID) |
受保护的摘要:字符串 注意:获取图中所有元素的XML列表。 参数:
|
|
EnumDiagrams(字符串PackageGUID) |
受保护的摘要:字符串 注意:获取指定包中所有图的XML列表。 参数:
|
|
EnumElements(字符串PackageGUID) |
受保护的摘要:字符串 注意:获取指定Package中元素的XML列表。 参数:
|
|
EnumLinks(字符串ElementGUID) |
受保护的摘要:字符串 注意:获取指定元素的连接器XML列表。 参数:
|
|
EnumPackages(字符串PackageGUID) |
受保护的摘要:字符串 注意:获取父包内的子包的XML列表。 参数:
|
|
EnumProjects() |
受保护的摘要:字符串 注意:获取当前文件中的项目列表;对应于存储库中的模型。 |
储存库类 |
EnumViews() |
受保护的摘要:字符串 注意:枚举项目的视图。作为XML文档返回。 |
|
EnumViewEx(字符串ProjectGUID) |
受保护的摘要:字符串 注意:获取当前项目中的视图列表。 参数:
|
|
出口 () |
受保护的摘要:字符串 注意:退出Enterprise Architect的当前实例;维护此函数是为了向后兼容,永远不要调用此函数。 当您不再使用任何提供的对象时, Enterprise Architect自动退出。 |
|
ExportPackageXMI(字符串PackageGUID,enumXMIType XMIType,长DiagramXML,长DiagramImage,长FormatXML,长UseDTD,字符串FileName) |
受保护的摘要:字符串 注意:导出指定程序包的XMI。 参数:
|
XMI类型 |
ExportPackageXMIEx(字符串PackageGUID,enumXMIType XMIType,长DiagramXML,长DiagramImage, |
受保护的摘要:字符串 注意:导出指定包的XMI,并带有标志来确定导出是否包括低于第一级的包内容。 参数:
|
配置软件包 XMI类型 ExportPackageXMIFlag |
GenerateClass(字符串ElementGUID,字符串ExtraOptions) |
布尔型 注意:为单个类生成代码。 参数:
|
|
GenerateDiagramFromScenario(字符串ElementGUID,EnumScenarioDiagramType DiagramType,长OverwriteExistingDiagram) |
布尔型 注意:根据元素的场景规范生成各种图表。 参数:
|
场景图类型 |
GenerateElementDDL(字符串ElementGUID,字符串FileName,字符串ExtraOptions) |
布尔型 注意:使用当前在“生成DDL”屏幕上设置的选项为元素生成DDL。 |
|
GenerateExecutableStatemachine(字符串ElementGUID,字符串ExtraOptions) |
布尔型 注意:为<< executable statemachine >> Artifact元素生成Executable StateMachine代码。 参数:
|
|
GeneratePackage(字符串PackageGUID, |
布尔型 注意:为包内的所有类生成代码。 例如: recurse = 1; overwrite = 1; dir = C:\ 参数:
|
|
GeneratePackageDDL(字符串PackageGUID,字符串FileName,字符串ExtraOptions) |
布尔型 注意:使用“生成DDL”屏幕上当前设置的选项,为“包”中的所有元素生成DDL。 |
|
GenerateTestFromScenario(字符串ElementGUID,EnumScenarioTestType TestType) |
布尔型 注意:根据元素的方案规范生成垂直测试套件,水平测试套件,内部测试或外部测试。 参数:
|
生成测试用例 ScenarioTestType |
GenerateWSDL(字符串WSDLComponentGUID,字符串文件名,字符串编码,字符串ExtraOptions) |
布尔型 注意:为指定的WSDL原型组件生成WSDL。 参数:
|
WSDL |
GenerateXSD(字符串PackageGUID, |
布尔型 注意:为程序包创建一个XML模式,由其GUID指定。成功返回True。 参数:
|
|
GetBaselines(字符串PackageGUID,字符串ConnectString) |
串 注意:返回与提供的Package GUID相关的基准列表(XML格式)。 参数:
|
|
GetDiagram(字符串DiagramGUID) |
受保护的摘要:字符串 注意:以XML格式获取图的详细信息。 参数:
|
|
GetElement(字符串ElementGUID) |
受保护的摘要:字符串 注意:获取指定元素的XML。 参数:
|
|
GetElementConstraints(字符串ElementGUID) |
受保护的摘要:字符串 注意:以XML格式获取元素的约束。 参数:
|
|
GetElementEffort(字符串ElementGUID) |
受保护的摘要:字符串 注意:努力为XML格式的元素。 参数:
|
|
GetElementFiles(字符串ElementGUID) |
受保护的摘要:字符串 注意:以XML格式获取元素的指标。 参数:
|
|
GetElementMetrics(字符串ElementGUID) |
受保护的摘要:字符串 注意:以XML格式获取元素的文件。 参数:
|
|
GetElementProblems(字符串ElementGUID) |
受保护的摘要:字符串 注意:以XML格式获取与元素相关的问题(问题)列表。 参数:
|
|
GetElementProperties(字符串ElementGUID) |
受保护的摘要:字符串 注意:以XML格式获取元素的标记值。 参数:
|
|
GetElementRequirements(字符串ElementGUID) |
受保护的摘要:字符串 注意:以XML格式获取元素的要求列表。 参数:
|
|
GetElementResources(字符串ElementGUID) |
受保护的摘要:字符串 注意:以XML格式获取元素的资源列表。 参数:
|
|
GetElementRisks(字符串ElementGUID) |
受保护的摘要:字符串 注意:以XML格式获取与元素关联的风险列表。 参数:
|
|
GetElementScenarios(字符串ElementGUID) |
受保护的摘要:字符串 注意:以XML格式获取元素的方案列表。 参数:
|
|
GetElementTests(字符串ElementGUID) |
受保护的摘要:字符串 注意:以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文件。 参数:
|
|
GetLastError() |
受保护的摘要:字符串 注意:返回一个字符串值,该字符串值描述与该对象有关的最新错误。 |
|
GetLink(字符串LinkGUID) |
受保护的摘要:字符串 注意:以XML格式获取连接器详细信息。 参数:
|
|
GUIDtoXML(字符串GUID) |
串 注意:将内部GUID更改为XML中使用的形式。 参数:
|
|
ImportDirectory(字符串PackageGUID,字符串语言,字符串DirectoryPath,字符串ExtraOptions) |
布尔型 注意:将源代码目录导入模型。 参数:
|
|
ImportFile(字符串PackageGUID,字符串语言,字符串FileName,字符串ExtraOptions) |
布尔型 注意:在每个名称空间样式的“包”中,将单个文件或二进制模块导入到模型中。 参数:
|
|
ImportPackageXMI(字符串PackageGUID,字符串文件名,长ImportDiagrams,长StripGUID) |
串 注意:在树中的某个点导入XMI文件。如果成功,则返回一个空字符串,如果失败,则返回一条错误消息。 参数:
|
|
LayoutDiagram(字符串DiagramGUID,长LayoutStyle) |
布尔型 注意:不推荐使用。使用LayoutDiagramEx 。 调用该函数以分层方式自动布置图。仅建议用于类图和对象图。 参数:
|
|
LayoutDiagramEx(字符串DiagramGUID,长LayoutStyle,长迭代,长LayerSpacing,长ColumnSpacing,布尔SaveToDiagram) |
布尔型 注意:调用该函数以分层方式自动布置图。仅建议用于类图和对象图。 LayoutStyle接受这些选项
-lsProgramDefault
-lsCycleRemoveDFS
-lsLayeringLongestPathSource -lsLayeringOptimalLinkLength
-IsInitializeDFSOut -IsInitializeDFSIn
-lsLayoutDirectionDown -lsLayoutDirectionLeft -lsLayoutDirectionRight 参数:
|
ConstLayoutStyles |
LoadControlledPackage(字符串PackageGUID) |
串 注意:加载已标记并配置为受控的软件包。文件名详细信息存储在Package控件数据中。 参数:
|
|
LoadDiagram(字符串DiagramGUID) |
受保护的摘要:布尔值 注意:通过其GUID加载图。 参数:
|
项目类别 |
LoadProject(字符串FileName) |
受保护的摘要:布尔值 注意:加载Enterprise Architect项目文件。 如果您已经从存储库访问了已经加载了文件的Project界面,请不要使用此方法。 参数:
|
|
迁移(字符串GUID,字符串SourceType,字符串DestinationType) |
空洞 注意:将模型(或模型的一部分)从BPMN,ArchiMate,UPDM或SysML格式迁移到升级格式。 参数:
|
|
MigrateToBPMN11(字符串GUID, |
空洞 注意:将包或元素(包括元素,属性,图表和连接器)中的每个BPMN 1.0构造迁移到BPMN 1.1。 参量
|
|
ProjectTransfer(字符串SourceFilePath, |
布尔型 注意:将项目从源.eap文件或DBMS传输到目标.eap文件,.eapx文件或.feap文件。 参数:
|
|
ExportProjectXML(字符串DirectoryPath) |
布尔型 注意:将整个当前项目导出到指定目录中的本机XML文件。在导出项目数据之前,目录的内容将被删除 参数:
|
|
PublishResult(字符串CategoryID, |
串 注意:返回在模型验证期间可以执行的每个规则的结果。必须为每个规则从EA_OnInitializeUserRules广播处理程序中调用一次。 返回值是RuleId,当Enterprise Architect在模型验证期间执行单个规则时,可以将其用作参考。 有关使用此方法的详细示例,请参见模型验证示例。 参数:
|
EA_OnInitializeUserRules 模型验证示例 项目类别 |
PutDiagramImageOnClipboard(字符串DiagramGUID, |
受保护的摘要:布尔值 注意:将指定图的图像复制到剪贴板。 参数:
|
|
PutDiagramImageToFile(字符串图GUID, |
受保护的摘要:布尔值 注意:将指定图的图像保存到文件中。 参数:
|
|
ReloadProject() |
受保护的摘要:布尔值 注意:重新加载当前项目。 这是一种刷新当前加载项目的便捷方法(如果对.eap文件进行了外部更改)。 |
|
RunModelSearch(字符串搜索,字符串SearchTerm,bool ShowInEA) |
空洞 注意:调用“模型搜索”组件。 参数:
|
型号搜寻 储存库类 |
RunReport(字符串PackageGUID, |
受保护的摘要:无效 注意:运行命名文档报告。 参数:
|
文件产生器介面套件 产生文件 虚拟文件 |
RunHTMLReport(字符串PackageGUID, |
串 注意:运行HTML报告(当您单击“浏览器”窗口中的“包”和“ 图标时,与“文档|以HTML形式发布”一样)。 参数:
|
创建网页报告 示范文件和报告包 |
SaveControlledPackage(字符串PackageGUID) |
串 注意:将已配置为受控程序包的程序包保存到XMI。只需要Package GUID, Enterprise Architect从Package控件信息中选择其余的信息。 参数:
|
|
SaveDiagramImageToFile(字符串文件名) |
受保护的摘要:字符串 注意:将当前图的图图像保存到文件中。 参数:
|
|
ShowWindow(长显示) |
受保护的摘要:无效 注意:显示或隐藏Enterprise Architect用户界面。 参数:
|
|
SynchronizeClass(字符串ElementGUID, |
布尔型 注意:将类与最新的源代码同步。 参数:
|
|
SynchronizePackage(字符串PackageGUID, |
布尔型 注意:将包中的每个类与最新的源代码同步。 参数:
|
|
TransformElement(字符串TransformName, |
布尔型 注意:将元素转换为Package。 参数:
|
|
TransformPackage(字符串TransformName, |
布尔型 注意:对包内容进行转换。 参数:
|
|
ValidateDiagram(字符串DiagramGUID) |
布尔型 注意:调用Enterprise Architect模型验证组件,然后验证图(以确保正确性)以及图中的元素和连接器。 可以通过“开始>桌面>设计>系统输出>模型验证”查看输出。 无论验证结果如何,都返回一个布尔值以指示该过程的成功或失败。 参数:
|
模型验证 |
ValidateElement(字符串ElementGUID) |
布尔型 注意:调用Enterprise Architect模型验证组件,然后验证元素和所有子元素,图,连接器,属性和操作。 可以通过“开始>桌面>设计>系统输出>模型验证”查看输出。 无论验证结果如何,都返回一个布尔值以指示该过程的成功或失败。 参数:
|
|
ValidatePackage(字符串PackageGUID) |
布尔型 注意:调用Enterprise Architect模型验证组件,然后验证包及其中的所有子包,元素,连接器和图。 可以通过“>桌面>设计>系统输出>模型验证”查看输出。 无论验证结果如何,都返回一个布尔值以指示该过程的成功或失败。 参数:
|
|
XMLtoGUID(字符串GUID) |
串 注意:将XML格式的GUID更改为Enterprise Architect内使用的格式。 参数:
|
笔记
- 这些方法都需要XML格式的输入GUID。使用GUIDtoXML将Enterprise Architect GUID更改为XML GUID