使用 VBA 宏

Visual Basic for Applications (VBA) for Microsoft Word 是一种简单但功能强大的编程语言，可用于扩展功能。 Aspose.Words API 提供了三个类来访问 VBA 项目源代码：

• VBAProject 类提供对 VBA 项目信息的访问
• VBAModuleCollection 类返回 VBA 项目模块的集合
• VbaModule 类提供对 VBA 项目模块的访问
• VbaModuleType 枚举定义 VBA 项目中模型的类型。该模块可以是程序模块、文档模块、类模块或设计器模块

创建 VBA 项目

Aspose.Words API 提供 vba_project 属性来获取或设置文档中的 VbaProject。

以下代码示例演示如何创建 VBA 项目和 VBA 模块以及基本属性（例如 name 和 type）：

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document()

project = aw.vba.VbaProject()
project.name = "AsposeProject"
doc.vba_project = project

# Create a new module and specify a macro source code.
module = aw.vba.VbaModule()
module.name = "AsposeModule"
module.type = aw.vba.VbaModuleType.PROCEDURAL_MODULE
module.source_code = "New source code"

# Add module to the VBA project.
doc.vba_project.modules.add(module)

doc.save(docs_base.artifacts_dir + "WorkingWithVba.create_vba_project.docm")

读取宏

Aspose.Words 还为用户提供了读取 VBA 宏的能力。

以下代码示例显示如何从文档中读取 VBA 宏：

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document(docs_base.my_dir + "VBA project.docm")

if (doc.vba_project != None) :
    for module in doc.vba_project.modules :
        print(module.source_code)
    

编写或修改宏

使用 Aspose.Words，用户可以修改 VBA 宏。

以下代码示例显示如何使用 source_code 属性修改 VBA 宏：

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document(docs_base.my_dir + "VBA project.docm")

project = doc.vba_project

newSourceCode = "Test change source code"
project.modules[0].source_code = newSourceCode
    
doc.save(docs_base.artifacts_dir + "WorkingWithVba.modify_vba_macros.docm")

克隆 VBA 项目

使用 Aspose.Words 还可以克隆 VBA 项目。

以下代码示例演示如何使用 clone 属性克隆 VBA 项目，该属性创建现有项目的副本：

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document(docs_base.my_dir + "VBA project.docm")
destDoc = aw.Document()
destDoc.vba_project = doc.vba_project.clone() 

destDoc.save(docs_base.artifacts_dir + "WorkingWithVba.clone_vba_project.docm")

克隆 VBA 模块

如果需要，您还可以克隆 VBA 模块。

以下代码示例演示如何使用 clone 属性克隆 VBA 模块，该属性创建现有项目的副本：

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document(docs_base.my_dir + "VBA project.docm")
destDoc = aw.Document()
destDoc.vba_project = aw.vba.VbaProject() 
    
copyModule = doc.vba_project.modules.get_by_name("Module1").clone()
destDoc.vba_project.modules.add(copyModule)

destDoc.save(docs_base.artifacts_dir + "WorkingWithVba.clone_vba_module.docm")

使用 VBA 项目参考

Aspose.Words API 提供 VbaReferenceCollection 类来与代表 VBA 项目引用集合的 VBA 项目引用一起使用。

以下代码示例演示如何从 VBA 项目的引用集合中删除一些引用：

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
doc = aw.Document(docs_base.my_dir + "VBA project.docm")

# Find and remove the reference with some LibId path.
brokenPath = "brokenPath.dll"
references = doc.vba_project.references
for i in range(references.count - 1, 0) :
    
    reference = doc.vba_project.references.element_at(i)

    path = get_lib_id_path(reference)
    if (path == brokenPath) :
        references.remove_at(i)
    

doc.save(docs_base.artifacts_dir + "WorkingWithVba.remove_broken_ref.docm")

# For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Python-via-.NET
# <summary>
# Returns string representing LibId path of a specified reference. 
# </summary>
def get_lib_id_path(self, reference) :
    
    if reference.type == aw.vba.VbaReferenceType.REGISTERED or reference.type == aw.vba.VbaReferenceType.ORIGINAL or reference.type == aw.vba.VbaReferenceType.CONTROL :
        return self.get_lib_id_reference_path(reference.lib_id)
    elif reference.type == aw.vba.VbaReferenceType.PROJECT :
        return self.get_lib_id_project_path(reference.lib_id)
    else :
        raise RuntimeError()


# <summary>
# Returns path from a specified identifier of an Automation type library.
# </summary>
# <remarks>
# Please see details for the syntax at [MS-OVBA], 2.1.1.8 LibidReference. 
# </remarks>
@staticmethod
def get_lib_id_reference_path(libIdReference : str) :
    
    if (libIdReference != None) :
        
        refParts = libIdReference.split('#')
        if (refParts.length > 3) :
            return refParts[3]
        
    return ""
    

# <summary>
# Returns path from a specified identifier of an Automation type library.
# </summary>
# <remarks>
# Please see details for the syntax at [MS-OVBA], 2.1.1.12 ProjectReference. 
# </remarks>
@staticmethod
def get_lib_id_project_path(libIdProject : str) :
    
    if (libIdProject != None) :
       return libIdProject.substring(3) 
       
    return ""