Trabajar con macros VBA

Visual Basic para Aplicaciones (VBA) para Microsoft Word es un lenguaje de programación simple pero potente que se puede utilizar para ampliar la funcionalidad. Aspose.Words API proporciona tres clases para obtener acceso al código fuente del proyecto VBA:

• La clase VBAProject proporciona acceso a la información del proyecto VBA.
• La clase VBAModuleCollection devuelve la colección de módulos del proyecto VBA.
• La clase VbaModule proporciona acceso al módulo de proyecto VBA.
• La enumeración VbaModuleType define los tipos de un modelo en un proyecto VBA. El módulo puede ser un módulo de procedimiento, un módulo de documento, un módulo de clase o un módulo de diseñador.

Crear un proyecto VBA

Aspose.Words API proporciona la propiedad VbaProject para obtener o configurar VbaProject en el documento.

El siguiente ejemplo de código demuestra cómo crear un proyecto VBA y un módulo VBA junto con propiedades básicas, por ejemplo, Nombre y Tipo:

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

// Create a new VBA project.
VbaProject project = new VbaProject();
project.Name = "AsposeProject";
doc.VbaProject = project;

// Create a new module and specify a macro source code.
VbaModule module = new VbaModule();
module.Name = "AsposeModule";
module.Type = VbaModuleType.ProceduralModule;
module.SourceCode = "New source code";

// Add module to the VBA project.
doc.VbaProject.Modules.Add(module);

doc.Save(dataDir + "VbaProject_out.docm");

Leer macros

Aspose.Words también brinda a los usuarios la capacidad de leer macros de VBA.

El siguiente ejemplo de código muestra cómo leer macros de VBA del documento:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
Document doc = new Document(dataDir + "Document.dot");

if (doc.VbaProject != null)
{
    foreach (VbaModule module in doc.VbaProject.Modules)
    {
        Console.WriteLine(module.SourceCode);
    }
}

Escribir o modificar macros

Usando Aspose.Words, los usuarios pueden modificar macros de VBA.

El siguiente ejemplo de código muestra cómo modificar macros de VBA utilizando la propiedad SourceCode:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
Document doc = new Document(dataDir + "test.docm");
VbaProject project = doc.VbaProject;

const string newSourceCode = "Test change source code";

// Choose a module, and set a new source code.
project.Modules[0].SourceCode = newSourceCode;

Clonar proyecto VBA

Con Aspose.Words también es posible clonar proyectos VBA.

El siguiente ejemplo de código muestra cómo clonar el proyecto VBA utilizando la propiedad Clone que crea una copia del proyecto existente:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
Document doc = new Document(dataDir + "VbaProject_source.docm");
VbaProject project = doc.VbaProject;

Document destDoc = new Document();

// Clone the whole project.
destDoc.VbaProject = doc.VbaProject.Clone();

destDoc.Save(dataDir + "output.docm");

Clonar módulo VBA

También puede clonar módulos VBA si es necesario.

El siguiente ejemplo de código muestra cómo clonar el módulo VBA usando la propiedad Clone que crea una copia del proyecto existente:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
Document doc = new Document(dataDir + "VbaProject_source.docm");
VbaProject project = doc.VbaProject;

Document destDoc = new Document();

destDoc.VbaProject = new VbaProject();

// Clone a single module.
VbaModule copyModule = doc.VbaProject.Modules["Module1"].Clone();
destDoc.VbaProject.Modules.Add(copyModule);

destDoc.Save(dataDir + "output.docm");

Trabajar con las referencias del proyecto VBA

Aspose.Words API proporciona la clase VbaReferenceCollection para trabajar con referencias de proyectos VBA que representan una colección de referencias de proyectos VBA.

El siguiente ejemplo de código muestra cómo eliminar algunas referencias de la colección de referencias de un proyecto VBA:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
Document doc = new Document(dataDir + "VbaProject.docm");

// Find and remove the reference with some LibId path.
const string brokenPath = "brokenPath.dll";
VbaReferenceCollection references = doc.VbaProject.References;
for (int i = references.Count - 1; i >= 0; i--)
{
    VbaReference reference = doc.VbaProject.References.ElementAt(i);
    string path = GetLibIdPath(reference);
    if (path == brokenPath)
        references.RemoveAt(i);
}

doc.Save(dataDir + "NoBrokenRef.docm");

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-.NET
/// <summary>
/// Returns string representing LibId path of a specified reference. 
/// </summary>
private static string GetLibIdPath(VbaReference reference)
{
    switch (reference.Type)
    {
        case VbaReferenceType.Registered:
        case VbaReferenceType.Original:
        case VbaReferenceType.Control:
            return GetLibIdReferencePath(reference.LibId);
        case VbaReferenceType.Project:
            return GetLibIdProjectPath(reference.LibId);
        default:
            throw new ArgumentOutOfRangeException();
    }
}

/// <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>
private static string GetLibIdReferencePath(string libIdReference)
{
    if (libIdReference != null)
    {
        string[] 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>
private static string GetLibIdProjectPath(string libIdProject)
{
    return (libIdProject != null) ? libIdProject.Substring(3) : "";
}