Class MLA

Object
   |
   +--MLA

class MLA

Defined in MarkLogicExcelAddin.js


Nested Class Summary
<static class> MLA.Cell
 
Constructor Summary
MLA()
            The MLA namespace is used for global attribution.
 
Method Summary
<static> void addAutoFilter(coord1, coord2, sheetName, criteria1, operator, criteria2)
           Adds AutoFilter to specified range in active worksheet.
<static> void addChartObjectMouseDownEvents(sheetName)
           Adds chartObjectMouseDown events for each chart on sheet specified by sheetName.
<static> String addCustomXMLPart(customPartXml)
           Adds custom part to active Open XML package.
<static> void addMacro(source, componenType)
           Adds macro to active workbook.
<static> void addNamedRange(coord1,coord2,rngName, sheetName)
           Names a range in the worksheet specified by sheetName.
<static> String addWorkbook(worksheetname)
           Adds workbook of type Excel.XlWBATemplate.xlWBATWorksheet.
<static> String addWorksheet(sheetName)
           Adds worksheet to active workbook.
<static> String base64EncodeImage(chartPath)
           Returns image found at chartPath as base64 encoded string
<static> void clearNamedRange(rangeName)
           Clears all cells in the range identified by name.
<static> void clearRange(coord1,coord2)
           Clears all cells in the range identified by coordinates provide in A1 notation.
<static> void clearWorksheet(sheetName)
           Clears the contents of the active worksheet in the active workbook.
<static> String convertA1ToR1C1(coord)
           Converts an A1 notation coordinate to R1C1 notation.
<static> String convertR1C1ToA1(rowIdx, colIdx)
           Converts a row index and column index to an A1 notation coordinate.
<static> Microsoft.XMLDOM createXMLDOM(xmlstring)
           Utility function for creating Microsoft.XMLDOM object from string.
<static> void deleteCustomXMLPart(customXMLPartId)
           Deletes custom part from Active Open XML package identified by id.
<static> void deleteFile(filePath)
           Deletes file found with full path at parameter filePath, from the filesystem.
<static> void deletePicture(sheetName, imageName)
           Deletes picture (image), specified by name, from specified sheet in Excel Workbook.
<static> void exportChartImagePNG(chartPath)
           Saves chart in Excel Workbook to filesystem as .png.
<static> MLA.Cell getActiveCell()
           Returns active cell from the active worksheet in active workbook.
<static> String getActiveCellText()
           Get the Text for the cell at the current cursor position.
<static> String getActiveWorkbookName()
           Returns the name of the active workbook.
<static> Array getActiveWorkbookWorksheetNames()
           Returns the names of all worksheets for active workbook as array of strings.
<static> String getActiveWorksheetName()
           Returns the name of the active worksheet.
<static> Array getAllWorkbookNames()
           Returns the names of all workbooks available as array of strings.
<static> MLA.config getConfiguration()
           Returns MLA.config.
<static> Microsoft.XMLDOM getCustomXMLPart(customXMLPartId)
           Returns the custom XML part, identified by customXMLPartId, that is part of the active Open XML package.
<static> Array getCustomXMLPartIds()
           Returns ids for custom parts (not built-in) that are part of the active Open XML package.
<static> String getMacroComments(index)
           Returns macro comments for macro component specified by index for active workbook.
<static> String getMacroCount()
           Returns count of macros in active workbook.
<static> String getMacroName(index)
           Returns macro name for macro component specified by index for active workbook.
<static> String getMacroProcedureName(index)
           Returns macro procedure name for macro component specified by index for active workbook.
<static> String getMacroSignature(index)
           Returns macro signature for macro component specified by index for active workbook.
<static> String getMacroText(index)
           Returns macro code as text from macro component specified by index for active workbook.
<static> String getMacroType(index)
           Returns macro type for macro component specified by index for active workbook.
<static> Array getNamedRangeNames()
           Returns all NamedRange names for the active workbook.
<static> MLA.Cell getSelectedCells()
           Returns cells selected in active workbook.
<static> String getSelectedChartName()
           Returns the name for the selected chart.
<static> String getSelectedRangeCoordinates()
           Returns the selected range coordinates.
<static> String getSelectedRangeName()
           Returns the name for the selected range if name exists.
<static> String getSheetType(sheetName)
           Returns the type of the sheet specified by sheetName.
<static> String getTempPath()
           Returns the path being used for the /temp dir on the client system.
<static> String getVersion()
           Returns version of MarkLogicExcelAddin.js library.
<static> Array getWorksheetChartNames(sheetName)
           Returns all Chart names for any charts found on sheet specified by sheetName.
<static> Array getWorksheetNamedRangeNames(sheetName)
           Returns all named range names for any named ranges found on sheet specified by sheetName.
<static> void insertBase64ToImage(base64String, sheetName)
           Inserts a base64 encoded string into sheet, specified by sheetName, as an image.
<static> Object openXlsx(tmpPath, docuri, url, uname, pwd)
           Open a .xlsx from MarkLogic into Excel.
<static> void removeChartObjectMouseDownEvents(sheetName)
           Removes chartObjectMouseDown events for each chart on sheet specified by sheetName.
<static> void removeMacro(macroName)
           Removes macro, specified by macroName, from active workbook.
<static> void removeNamedRange(name)
           Removes the NamedRange from the active workbook.
<static> void runMacro(macroName)
           Runs macro, specified by macro name, in the active workbook.
<static> void saveActiveWorkbook(tmpPath, doctitle, url, uname,pwd)
           Saves the active workbook to MarkLogic.
<static> void setActiveCellValue(value)
           Set the value for the cell at the current cursor position.
<static> void setActiveRangeByName(name)
           Sets focus to named range, specified by name, on active worksheet.
<static> void setActiveWorkbook(workbookname)
           Sets the active workbook in Excel.
<static> void setActiveWorksheet(sheetname)
           Sets the active worksheet in Excel.
<static> void setCellValue(cells, sheetname)
           Sets the values for the cells identified by Cell.coordinate.

Constructor Detail

MLA

MLA()

Method Detail

addAutoFilter

<static> void addAutoFilter(coord1, coord2, sheetName, criteria1, operator, criteria2)

addChartObjectMouseDownEvents

<static> void addChartObjectMouseDownEvents(sheetName)

addCustomXMLPart

<static> String addCustomXMLPart(customPartXml)

addMacro

<static> void addMacro(source, componenType)

addNamedRange

<static> void addNamedRange(coord1,coord2,rngName, sheetName)

addWorkbook

<static> String addWorkbook(worksheetname)

addWorksheet

<static> String addWorksheet(sheetName)

base64EncodeImage

<static> String base64EncodeImage(chartPath)

clearNamedRange

<static> void clearNamedRange(rangeName)

clearRange

<static> void clearRange(coord1,coord2)

clearWorksheet

<static> void clearWorksheet(sheetName)

convertA1ToR1C1

<static> String convertA1ToR1C1(coord)

convertR1C1ToA1

<static> String convertR1C1ToA1(rowIdx, colIdx)

createXMLDOM

<static> Microsoft.XMLDOM createXMLDOM(xmlstring)

deleteCustomXMLPart

<static> void deleteCustomXMLPart(customXMLPartId)

deleteFile

<static> void deleteFile(filePath)

deletePicture

<static> void deletePicture(sheetName, imageName)

exportChartImagePNG

<static> void exportChartImagePNG(chartPath)

getActiveCell

<static> MLA.Cell getActiveCell()

getActiveCellText

<static> String getActiveCellText()

getActiveWorkbookName

<static> String getActiveWorkbookName()

getActiveWorkbookWorksheetNames

<static> Array getActiveWorkbookWorksheetNames()

getActiveWorksheetName

<static> String getActiveWorksheetName()

getAllWorkbookNames

<static> Array getAllWorkbookNames()

getConfiguration

<static> MLA.config getConfiguration()

getCustomXMLPart

<static> Microsoft.XMLDOM getCustomXMLPart(customXMLPartId)

getCustomXMLPartIds

<static> Array getCustomXMLPartIds()

getMacroComments

<static> String getMacroComments(index)

getMacroCount

<static> String getMacroCount()

getMacroName

<static> String getMacroName(index)

getMacroProcedureName

<static> String getMacroProcedureName(index)

getMacroSignature

<static> String getMacroSignature(index)

getMacroText

<static> String getMacroText(index)

getMacroType

<static> String getMacroType(index)

getNamedRangeNames

<static> Array getNamedRangeNames()

getSelectedCells

<static> MLA.Cell getSelectedCells()

getSelectedChartName

<static> String getSelectedChartName()

getSelectedRangeCoordinates

<static> String getSelectedRangeCoordinates()

getSelectedRangeName

<static> String getSelectedRangeName()

getSheetType

<static> String getSheetType(sheetName)

getTempPath

<static> String getTempPath()

getVersion

<static> String getVersion()

getWorksheetChartNames

<static> Array getWorksheetChartNames(sheetName)

getWorksheetNamedRangeNames

<static> Array getWorksheetNamedRangeNames(sheetName)

insertBase64ToImage

<static> void insertBase64ToImage(base64String, sheetName)

openXlsx

<static> Object openXlsx(tmpPath, docuri, url, uname, pwd)

removeChartObjectMouseDownEvents

<static> void removeChartObjectMouseDownEvents(sheetName)

removeMacro

<static> void removeMacro(macroName)

removeNamedRange

<static> void removeNamedRange(name)

runMacro

<static> void runMacro(macroName)

saveActiveWorkbook

<static> void saveActiveWorkbook(tmpPath, doctitle, url, uname,pwd)

setActiveCellValue

<static> void setActiveCellValue(value)

setActiveRangeByName

<static> void setActiveRangeByName(name)

setActiveWorkbook

<static> void setActiveWorkbook(workbookname)

setActiveWorksheet

<static> void setActiveWorksheet(sheetname)

setCellValue

<static> void setCellValue(cells, sheetname)


Documentation generated by JSDoc on Mon May 9 09:07:22 2011