MathType API documentation

Public Sub FormatEquations(info As FormatEquationsInfo)

Formats equations in the active document based on the passed settings.

  Public Const mt_FMT_PREFS_DOCUMENT    As Long = 1   'preferences stored in document
  Public Const mt_FMT_PREFS_MATHTYPE    As Long = 2   'MathType's equation preferences
  Public Const mt_FMT_PREFS_CLIPBOARD   As Long = 3   'equation on clipboard
  Public Const mt_FMT_PREFS_FILE        As Long = 4   'preference file
  
  Public Type FormatEquationsInfo
      showStats       As Boolean   'show #equations formatted at end of processing document
      prefsSource     As Long      'source of preferences, one of the mt_FMT_PREFS constants above
      prefsFileName   As String    'prefs filename if prefsSource=mt_FMT_PREFS_FILE
      selectionOnly   As Boolean   'True=process selection only, False=whole document
      savePrefs       As Boolean   'True=save preferences in document
      count           As Long      'number of equations formatted
  End Type

Public Sub ConvertEquations(info As ConvertEquationsInfo)

Converts equations in the active document based on the passed settings.

  'Types and constants used for calling ConvertEquations
  Public Const mt_CVT_FIND_MTEE       As Long = 1 'find MathType and EE equations
  Public Const mt_CVT_FIND_WORDEQ     As Long = 2 'find Word EQ fields
  Public Const mt_CVT_FIND_TRANSLATOR As Long = 4 'find translated (text) equations
  Public Const mt_CVT_TRAN_NAME As Long = 1 'include translator name in translation
  Public Const mt_CVT_TRAN_MTEF As Long = 2 'include MathType data in translation
  
  Public Type ConvertEquationsInfo
      showStats          As Boolean 'show #equations formatted at end of processing document
      equationTypes      As Long    'types of equations to convert, one or more of the mt_CVT_FIND constants above
      selectionOnly      As Boolean 'True=process selection only, False=whole document
      promptUser         As Boolean 'True=prompt user whether to convert each equation
      translatorFileName As String  'file name of the translator to use or "" to convert to MT equations
      translatorOptions  As Long    'options to the translator, one or more of the mt_CVT_TRAN options above
      count              As Long    'number of equations converted
  End Type

Public Sub ExportEquations(info As ExportEquationsInfo)

Exports equations in the active document based on the passed settings.

  'Types and constants used for calling ExportEquations
  Public Const mt_EXP_TYPE_EPSWMF  As Long = 0 'EPS/WMF
  Public Const mt_EXP_TYPE_EPSTIFF As Long = 1 'EPS/TIFF
  Public Const mt_EXP_TYPE_EPSNONE As Long = 2 'EPS/none
  Public Const mt_EXP_TYPE_GIF     As Long = 3 'GIF
  Public Const mt_EXP_TYPE_WMF     As Long = 4 'WMF
  
  Public Type ExportEquationsInfo
      showStats       As Boolean 'show #equations formatted at end of processing document
      folderPath      As String  'path to folder to store exported equation files
      deleteAll       As Boolean 'True=delete all files in the output folder with the same extension
      fileType        As Long    'type of file to create for each equation, one of the mt_EXP_TYPE constants above
      fileNamePattern As String  'file naming pattern, with # wildcards e.g. "EQN###"
      firstNumber     As Long    'starting equation number
      replace         As Boolean 'True=replace each equation with its filename
      selectionOnly   As Boolean 'True=process selection only, False=whole document
      count           As Long    'number of equations exported
  End Type

Public Sub ToggleTexEquations(info As ToggleTexEquationsInfo)

Toggles Tex equations in the range based on the passed settings.

  'Types and constants used for calling ToggleTexEquations
  Public Const mt_RNG_TYPE_CURSOR    As Long = 0 'nearest equation to the cursor location
  Public Const mt_RNG_TYPE_SELECTION As Long = 1 'current selection
  Public Const mt_RNG_TYPE_DOCUMENT  As Long = 2 'whole document
  
  Public Type ToggleTexEquationsInfo
      rngType       As Long 'ran

The following return codes apply to all MathPage API functions, and are defined in the module MPApi:

'MathPage API return codes
mpOK = 0
mpEQN_NO_BASELINE = 1000
mpBAD_VERSION = -1000
mpMTDLL_NOT_FOUND = -1001
mpFILE_INVALID = -1002
mpFILE_NO_ACCESS = -1003
mpNOT_AN_EQUATION = -1004
mpERROR = -9999

'kind values used by MPProcessSymbol; also returned by MPAnalyzeSymbol
Public Const kSIDefault As Long = 0 'default value
Public Const kSIGIF As Long = 1 'needs a GIF
Public Const kSIEntity As Long = 2 'needs entity
Public Const kSIInsertSymbolPlaceholder As Long = 3 'maybe an inserted symbol
Public Const kSISubstituted As Long = 4 'char is being changed, 0 = delete char
Public Const kSIMissingFont As Long = 5 'font not installed

'style values used by MPProcessSymbol
Public Const kPlainText As Integer = 0
Public Const kBoldText As Integer = 1
Public Const kItalicText As Integer = 2

Type SymbolInfo
    kind As Integer         'out from MPFindSymbol, input to MPProcessSymbol (see above)
    charCode As Integer     'out from MPFindSymbol, input to MPProcessSymbol
    isUniCode As Boolean    'private to WLL
    size As Single
    style As Integer        'see style constants above
    color As Long           'RGB value
End Type

Type BorderInfo
    width As Long           'one of wdLineWidth
    style As Long           'one of wdLineStyle
    color As Long           'RGB value
End Type

Type GIFInfo
    smooth As Boolean        'True to use anti-aliasing
    bkgndColor As Long       'only needed if (smooth OR not transparent)
    size As Single           'size of surrounding text
    fillType As Long         'one of msoFillType or 0
    topBorder As BorderInfo
    leftBorder As BorderInfo
    bottomBorder As BorderInfo
    rightBorder As BorderInfo
End Type

'used for calls to MPProcessEquation2
Type GIFInfo2
    version As Integer       'MTW5.1 and above expect 1
    smooth As Boolean        'True to use anti-aliasing
    bkgndColor As Long       'only needed if (smooth OR not transparent)
    size As Single           'size of surrounding text
    fillType As Long         'one of msoFillType or 0
    topBorder As BorderInfo
    leftBorder As BorderInfo
    bottomBorder As BorderInfo
    rightBorder As BorderInfo
    display As Long          'one of mpdtXXX constants (see MPProcessEquation2)
End Type

'struct for MPEnumMathMLTarget
Type MPMathMLTarget
    browser As Integer      '0-based compatibility choice, -1 = all
    minWordVer As Integer   'min version of Word that supports target (8,9,10...)
    nameMax As Integer      'max len of name
    targetName As String    'MathML target name
    descMax As Integer      'max len of description
    targetDesc As String    'MathML target description
End Type

'struct for MPEnumMathMLTarget2
Type MPMathMLTarget2
    version As Integer      'MTW5.1 and above expect 1
    browser As Integer      '0-based compatibility choice, -1 = all
    minWordVer As Integer   'min version of Word that supports target (8,9,10...)
    nameMax As Integer      'max len of name
    targetName As String    'MathML target name
    descMax As Integer      'max len of description
    targetDesc As String    'MathML target description
    extMax As Integer       'max len of extensions
    extensions As String    'valid extensions (default is first)
End Type

Public Function MPAPIVersion(
     api As Integer
) As Long

Gets and checks the version of the MathPage API.

Public Function MTInitAPI (
    options As Integer,
    timeout As Integer
) As Long

Initializes the API (prepares for use). This function should always be called before any other API function (except MPAPIVersion). Other API functions will return an error if this function has not been called.

Calls to MTInitAPI should always be paired with calls to MTTermAPI, and they may be nested (i.e. multiple calls to MTInitAPI may be made without calling MTTermAPI, but, of course, must eventually be followed by the corresponding number of calls to MTTermAPI).

This function calls the MT6.DLL function MTAPIConnect().

mtinitLAUNCH_NOW => launch MathType server immediately
mtinitLAUNCH_AS_NEEDED => launch MathType when first needed

# of seconds to wait before timing out when attempting to launch MathType. If timeOut = -1 then will never timeout. This value is eventually passed to RPCConnectToServer where it is not currently used.

Public Function MTTermAPI () As Long

Must always call after MTInitAPI. Closes connection with MathType and terminates the API (no further usage). See MTInitAPI for more details.

This function calls the MT6.DLL function MTAPIDisconnect().

Public Function MPDocInit (
    docDir As String,
    support As String,
    wordVer As Integer,
    flags As Integer,
    target As String
) As Long

Initializes processing for a document.

Public Function MPDocTerm () As Long

Terminates the processing of the document.

Public Function MPProcessEquation (
    gifFile As String,
    info As GIFInfo,
    tagAttrs As String
) As Long

Converts equation on clipboard to GIFs or MathML based on conversion settings.

Public Function MPProcessEquation2 (
    gifFile As String,
    info As GIFInfo2,
    tagAttrs As String
) As Long

Converts equation on clipboard to GIFs or MathML based on conversion settings.

Public Function MPFindSymbol (
    range As Range,
    font As String,
    info As SymbolInfo
) As Long

Finds the first symbol in a string (if any) that must be handled specially.

Public Function MPAnalyzeSymbol (
    charCode As Integer,
    font As String,
    info As SymbolInfo
) As Long

Find the first symbol in a string (if any) that must be handled specially.

Public Function MPProcessSymbol (
    gifFile As String,
    font As String,
    info As SymbolInfo,
    symbolID As String,
    tagAttrs As String
) As Long

Process a symbol, creating a GIF or MathML fragment.

Public Function MPProcessHTML (
    inPath As String,
    outPath As String
) As Long

Reads the document into memory, filters out Word's HTML, inserts MathPage header snippets, replaces equation and symbol DSTags by MathPage HTML snippets, converts to XHTML if indicated for MathML target, and writes the modified document out.

Public Function MPProcessHTML2 (
    inPath As String,
    outPath As String,
    isMasterDoc As Boolean
) As Long

Reads the document into memory, filters out Word's HTML, inserts MathPage header snippets, replaces equation and symbol DSTags by MathPage HTML snippets, converts to XHTML if indicated for MathML target, and writes the modified document out. MTW5.1 added isMasterDoc parameter (and hence this new call), needed for proper handling of master documents.

Public Function MPFileCleanup (
    fileName As String,
    supportDir As String
) As Long

Cleans up in preparation for creating MathPage document. Deletes HTML file and/or supporting files folder, if found. Creates supporting files folder as necessary.

Public Function MPEnumMathMLTarget (
    index As Integer,
    targetInfo As MPMathMLTarget
) As Long

Enumerates the MathML targets in the MathPage dialog.

Public Function MPEnumMathMLTarget2 (
    index As Integer,
    targetInfo As MPMathMLTarget2
) As Long

Enumerates the MathML targets in the MathPage dialog. Added in MathType for Windows 5.1, returns allowable file extensions for target in targetInfo.

Public Function MPCopySupportFiles () As Long

Copies the supporting files (depending on the target) into their appropriate locations. For GIF output, this copies MathPage.js and empty.gif, while the MathML targets can specify their own supporting files.

Public Function MTInitLocaleStringDLL (
    version As Long,
    languageID As Long
) As Long

Locates locale-dependent string DLL; OK to call more than once.

Public Function MTGetLocaleDLL (
    buffer As String,
    length As Long
) As Long

Gets name of primary DLL

Public Function MTGetLocaleString (
    str As String,
    buffer As String,
    length As Long
) As Long

Returns user string in buffer.

Public Function MTGetUserString (
    str As String,
    buffer As String,
    length As Long
) As Long

Returns user string in buffer.

Public Function MTSaveFileDialog (
    title As String,
    dir As String,
    file As String,
    filterName As String,
    filterSpec As String,
    buffer As String,
    length As Long
) As Long

Displays Save File dialog.

Public Function MTCreateDirectory (
     directory As String
) As Long

Creates a directory.

Public Function MTIsFullFunctionality () As Long

Tests if MathType full functionality should be available (i.e. not an expired demo).

'Picture specifier
Public Type MTAPI_PICT
    mm    As Long
    xExt  As Long
    yExt  As Long
    hMF   As Long
End Type

Public Type RECT
    left     As Long
    top      As Long
    right    As Long
    bottom   As Long
End Type

' Picture dimensions
Public Type MTAPI_DIMS
    baseline As Integer  ' distance of baseline from bottom (points)
    bounds   As RECT     ' bounding rectangle (points)
End Type

Public Function MTAPIVersion (
     api As Integer
) As Long

Gets version info for a particular API set.

Public Function MTAPIConnect (
     options As Integer,
     timeout As Integer 
) As Long

This function initializes the API (prepares for use). This function should always be called before any other API function (except MTAPIVersion). Other API functions will return an error if this function has not been called. Calls to MTAPIConnect should always be paired with calls to MTAPIDisconnect, and they may not be nested. Prior to calling MTAPIDisconnect subsequent calls to MTAPIConnect will do nothing and just return mtOK. This function may not be called from MathPage.WLL, use the MathPage.WLL function MTInitAPI instead. Note: This function was formerly named MTInitAPI, and calling it was optional (i.e. if a given call to another API function detected that MTInitAPI had not been called it would call it for you). This is not the case with MTAPIConnect. You must call MTAPIConnect prior to any other API calls (except MTAPIVersion).

Public Function MTAPIDisconnect () As Long

This function must always be called after MTAPIConnect. It closes connection with MathType and terminates the API (no further usage). This function may not be called from MathPage.WLL, use the MathPage.WLL function MTTermAPI instead.

Check for the type of equation on the clipboard, if any.

Public Function MTEquationOnClipboard () As Long

Public Function MTClearClipboard () As Long

Clears the clipboard contents.

Public Function MTGetLastDimension (
     dimIndex As Integer 
) As Long

Gets a dimension from the last equation copied to the clipboard or written to a file.

Public Function MTOpenFileDialog (
     fileType As Integer,
     title As String,
     dir As String,
     file As String,
     fileLen As Integer
) As Long

Puts up an open file dialog (Win32 only). Calls GetForegroundWindow for parent, upon which it gets centered.

Public Function MTGetPrefsFromClipboard (
     prefs As String,
     prefsLen As Integer
) As Long

Gets equation preferences from the MathType equation currently on the clipboard.

Public Function MTGetPrefsFromFile (
     prefFile As String,
     prefs As String,
     prefsLen As Integer
) As Long

Get equation preferences from the specified preferences file.

Public Function MTConvertPrefsToUIForm (
     inPrefs As String,
     outPrefs As String,
     outPrefsLen As Integer
) As Long

Convert internal preferences string to a form to be presented to the user.

Public Function MTGetPrefsMTDefault (
     prefs As String,
     prefsLen As Integer
) As Long

Get MathType's current default equation preferences

Public Function MTSetMTPrefs (
     mode As Integer,
     prefs As String,
     timeout As Integer
) As Long

Set MathType's default preferences for new equations.

Public Function MTGetTranslatorsInfo (
     infoIndex As Integer
) As Long

Get information about the current set of translators.

Public Function MTEnumTranslators (
     index As Integer,
     transName As String,
     transNameLen As Integer,
     transDesc As String,
     transDescLen As Integer,
     transFile As String,
     transFileLen As Integer
) As Long

Enumerate the available equation (TeX, etc.) translators.

Public Function MTXFormReset () As Long

Resets to default options for MTXFormEqn (i.e. no substitutions, no translation, and use existing preferences).

Public Function MTXFormAddVarSub (
     options As Integer,
     findType As Integer,
     find As String,
     findLen As Long,
     replaceType As Integer,
     replace As String,
     replaceLen As Long,
     replaceStyle As Integer
) As Long

Adds a variable substitution to be performed with next MTXFormEqn (may be called 0 or more times).

Public Function MTXFormSetTranslator (
     options As Integer,
     transName As String
) As Long

Specify translation to be performed with the next MTXFormEqn.

Public Function MTXFormSetPrefs (
     prefType As Integer,
     prefStr As String
) As Long

Specify a new set of preferences to be used with the next MTXFormEqn.

Public Function MTXFormEqn (
     src As Integer,
     srcFmt As Integer,
     srcData As String,
     srcDataLen As Long,
     dst As Integer,
     dstFmt As Integer,
     dstData As String,
     dstDataLen As Long,
     dstPath As String,
     dims As MTAPI_DIMS
) As Long

Transforms an equation (uses options specified via MTXFormAddVarSub, MTXFormSetTranslator, and MTXFormSetPrefs)

Note: Variations involving mtxfm_PICT or dstFmt=mtxfm_HMTEF are not callable from VBA.

Public Function MTXFormGetStatus (
     index As Integer
) As Long

Check error/status after MTXFormEqn.

If index = mtxfmSTAT_PREF, status for set preferences:
     mtOK - success setting preferences
     mtBAD_DATA - bad preference data

If index = mtxfmSTAT_TRANSL, status for translation:
     mtOK - successful translation
     mtFILE_NOT_FOUND - could not find translator
     mtBAD_FILE - file found was not a translator

If index = mtxfmSTAT_ACTUAL_LEN, number of bytes of data actually returned in dstData (if MTXformEqn succeeded) or the number of bytes required (if MTXformEqn returned
     mtMEMORY - not enough memory was specified for dstData), otherwise 0L.

If index ≥1, status of the i-th (i = index) variable substitution, either # of times the substitution was performed, or, if < 0, an error status.

Public Function MTPreviewDialog (
     parent As Long,
     title As String,
     prefs As String,
     closeBtnText As String,
     helpBtnText As String,
     helpID As Long,
     helpFile As String
) As Long

Puts up a preview dialog for displaying preferences

Public Function MTGetPathToMathType (
     path As String,
     pathMax As Long
) As Long

Get the path to the MathType folder.