OfficeIMO

API Reference

Class

WordMacro

Edit on GitHub
Namespace OfficeIMO.Word
Assembly OfficeIMO.Word
Source OfficeIMO.Word/WordMacro.cs:33

Represents a single macro module within a document.

Inheritance

  • Object
  • WordMacro

Remarks

Instances are returned by Macros and can be removed individually using Remove.

Methods

AddMacro 2 overloads
AddMacro(OfficeIMO.Word.WordDocument document, System.String filePath) #

Adds a VBA project from a file to the specified document.

Parameters

document OfficeIMO.Word.WordDocument required
Target document.
filePath System.String required
Path to a vbaProject.bin file.
AddMacro(OfficeIMO.Word.WordDocument document, System.Byte[] data) #

Adds a VBA project from a byte array to the specified document.

Parameters

document OfficeIMO.Word.WordDocument required
Target document.
data System.Byte[] required
VBA project data.
ExtractMacros(OfficeIMO.Word.WordDocument document) #

Returns the raw VBA project from the given document.

Parameters

document OfficeIMO.Word.WordDocument required
Document containing macros.

Returns

Byte array with the macros or null when absent.

GetMacros(OfficeIMO.Word.WordDocument document) #

Enumerates all macro modules in the specified document.

Parameters

document OfficeIMO.Word.WordDocument required
Document to inspect.

Returns

List of WordMacro instances.

public Void Remove() #
OfficeIMO.Word/WordMacro.cs:33
Returns: Void

Removes this macro module from the document.

RemoveMacro(OfficeIMO.Word.WordDocument document, System.String name) #

Removes a single macro module from a document.

Parameters

document OfficeIMO.Word.WordDocument required
Document to modify.
name System.String required
Module name to remove.
RemoveMacros(OfficeIMO.Word.WordDocument document) #

Removes the entire VBA project from the document.

Parameters

document OfficeIMO.Word.WordDocument required
Document to modify.
SaveMacros(OfficeIMO.Word.WordDocument document, System.String filePath) #

Saves the VBA project from a document to the specified file.

Parameters

document OfficeIMO.Word.WordDocument required
Source document.
filePath System.String required
Destination path.

Properties

public String Name { get; } #
OfficeIMO.Word/WordMacro.cs:22

Gets the macro module name.