Aspose::Words::Vba::VbaProject class

VbaProject class

Provides access to VBA project information. A VBA project inside the document is defined as a collection of VBA modules. To learn more, visit the Working with VBA Macros documentation article.

class VbaProject : public System::Object

Methods

MethodDescription
Clone()Performs a copy of the VbaProject.
get_CodePage() constGets or sets the VBA project’s code page.
get_IsProtected()Shows whether the VbaProject is password protected.
get_IsSigned()Shows whether the VbaProject is signed or not.
get_Modules()Returns collection of VBA project modules.
get_Name() constGets or sets VBA project name.
get_References()Gets a collection of VBA project references.
GetType() const override
Is(const System::TypeInfo&) const override
set_CodePage(int32_t)Setter for Aspose::Words::Vba::VbaProject::get_CodePage.
set_Name(const System::String&)Setter for Aspose::Words::Vba::VbaProject::get_Name.
static Type()
VbaProject()Creates a blank VbaProject.

Examples

Shows how to access a document’s VBA project information.

auto doc = MakeObject<Document>(MyDir + u"VBA project.docm");

// A VBA project contains a collection of VBA modules.
SharedPtr<VbaProject> vbaProject = doc->get_VbaProject();
std::cout << (vbaProject->get_IsSigned() ? String::Format(u"Project name: {0} signed; Project code page: {1}; Modules count: {2}\n",
                                                          vbaProject->get_Name(), vbaProject->get_CodePage(), vbaProject->get_Modules()->LINQ_Count())
                                         : String::Format(u"Project name: {0} not signed; Project code page: {1}; Modules count: {2}\n",
                                                          vbaProject->get_Name(), vbaProject->get_CodePage(), vbaProject->get_Modules()->LINQ_Count()))
          << std::endl;

SharedPtr<VbaModuleCollection> vbaModules = doc->get_VbaProject()->get_Modules();

ASSERT_EQ(vbaModules->LINQ_Count(), 3);

for (const auto& module_ : vbaModules)
{
    std::cout << "Module name: " << module_->get_Name() << ";\nModule code:\n" << module_->get_SourceCode() << "\n" << std::endl;
}

// Set new source code for VBA module. You can access VBA modules in the collection either by index or by name.
vbaModules->idx_get(0)->set_SourceCode(u"Your VBA code...");
vbaModules->idx_get(u"Module1")->set_SourceCode(u"Your VBA code...");

// Remove a module from the collection.
vbaModules->Remove(vbaModules->idx_get(2));

See Also

Aspose::Words::Vba::VbaModuleCollection class Aspose::Words::Vba::VbaReference class