|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--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> Object
|
addAutoFilter(coord1, coord2, criteria1, operator, criteria2)
Adds AutoFilter to specified range in active worksheet. |
<static> String
|
addCustomXMLPart(customPartXml)
Adds custom part to active Open XML package. |
<static> Object
|
addNamedRange(coord1,coord2,rngName)
Names a range in the active worksheet |
<static> String
|
addWorkbook(worksheetname)
Adds workbook of type Excel.XlWBATemplate.xlWBATWorksheet. |
<static> Object
|
addWorksheet(name)
Adds worksheet to active workbook. |
<static> Object
|
clearNamedRange(name)
Clears all cells in the range identified by name |
<static> Object
|
clearRange(coord1,coord2)
Clears all cells in the range identified by coordinates provide in A1 notation |
<static> Object
|
clearWorksheet()
Clears the contents of the active worksheet in the active workbook |
<static> Object
|
convertA1ToR1C1(coord)
Converts an A1 notation coordinate to R1C1 notations |
<static> Object
|
convertR1C1ToA1(rowIdx, colIdx)
Converts a row index and column index to an A1 notation coordinate |
<static> Object
|
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> Object
|
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> Object
|
getConfiguration()
Returns MLA.config. |
<static> Microsoft.XMLDOM object
|
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> Object
|
getNamedRangeNames()
Returns all NamedRange names for the active workbook |
<static> Object
|
getSelectedCells()
Returns cells selected in active workbook. |
<static> Object
|
getSelectedRangeCoordinates()
Returns the selected range coordinates. |
<static> Object
|
getTempPath()
Returns the path being used for the /temp dir on the client system |
<static> String
|
getVersion()
Returns version of MarkLogicExcelAddin.js library. |
<static> Object
|
openXlsx(tmpPath, docuri, url, uname, pwd)
Open a .xlsx from MarkLogic into Excel |
<static> Object
|
removeNamedRange(name)
Removes the NamedRange from the active workbook. |
<static> Object
|
saveActiveWorkbook(tmpPath, doctitle, url, uname,pwd)
Saves the active workbook to MarkLogic |
<static> Object
|
setActiveCellValue(value)
Set the value for the cell at the current cursor position. |
<static> Object
|
setActiveRangeByName(name)
Returns all NamedRange names for the active workbook |
<static> Object
|
setActiveWorkbook(workbookname)
Sets the active workbook in Excel. |
<static> Object
|
setActiveWorksheet(sheetname)
Sets the active worksheet in Excel. |
<static> Object
|
setCellValue(cells, sheetname)
Sets the values for the cells identified by Cell.coordinate |
Constructor Detail |
MLA()
Method Detail |
<static> Object addAutoFilter(coord1, coord2, criteria1, operator, criteria2)
coord1
- - starting coordinate of range in A1 notation
coord2
- - end coordinate of range in A1 notation
criteria1
- - (optional) default '<>'
operator
- - (optional) default 'AND'
criteria2
- - (optional) default 'missing'
<static> String addCustomXMLPart(customPartXml)
customPartXML
- Either A) an XMLDOM object that is the custom part to be added to the active Open XML package, or B)The string serialization of the XML to be added as a custom part to the active Open XML package. ( The XML must be well-formed. )
<static> Object addNamedRange(coord1,coord2,rngName)
coord1
- - starting coordinate of range in A1 notation
coord2
- - end coordinate of range in A1 notation
rngName
- - the name to be assigned to the range
<static> String addWorkbook(worksheetname)
worksheetname
- - a string that names the worksheet
<static> Object addWorksheet(name)
name
- - the name of the worksheet to be added
<static> Object clearNamedRange(name)
name
- - the name of the range to be cleared in the active workbook
<static> Object clearRange(coord1,coord2)
coord1
- - starting coordinate of range to be cleared in A1 notation
coord2
- - end coordinate of range to be cleared in A1 notation
<static> Object clearWorksheet()
<static> Object convertA1ToR1C1(coord)
coord
- - the A1 coordinate to be converted
<static> Object convertR1C1ToA1(rowIdx, colIdx)
rowIdx
- - the row index
colIdx
- - the column index
<static> Object createXMLDOM(xmlstring)
xmlString
- the string to be loaded into a XMLDOM object. The string must be serialized, well-formed XML
<static> void deleteCustomXMLPart(customXMLPartId)
customXMLPartId
- the id of the custom part to be deleted from the active Open XML package.
<static> Object getActiveCell()
<static> String getActiveCellText()
<static> String getActiveWorkbookName()
<static> Array getActiveWorkbookWorksheetNames()
<static> String getActiveWorksheetName()
<static> Array getAllWorkbookNames()
<static> Object getConfiguration()
<static> Microsoft.XMLDOM object getCustomXMLPart(customXMLPartId)
customXMLPartId
- the id of the custom part to be fetched from the active package
<static> Array getCustomXMLPartIds()
<static> Object getNamedRangeNames()
<static> Object getSelectedCells()
<static> Object getSelectedRangeCoordinates()
<static> Object getTempPath()
<static> String getVersion()
<static> Object openXlsx(tmpPath, docuri, url, uname, pwd)
tmpPath
- - the path for the /tmp dir on the client system. (have to save a local copy)
docuri
- - the uri for the document in MarkLogic Server
url
- - the url on MarkLogic Server where the XQuery to open the document specified by docuri can be found
uname
- - the username for MarkLogic Server
pwd
- - the password for MarkLogic Server
<static> Object removeNamedRange(name)
name
- - the name of the NamedRange to be removed from the active workbook
<static> Object saveActiveWorkbook(tmpPath, doctitle, url, uname,pwd)
tmpPath
- - the path for the /tmp dir on the client system. (have to save a local copy)
url
- - the url on MarkLogic Server where the XQuery to save can be found
uname
- - the username for MarkLogic Server
pwd
- - the password for MarkLogic Server
docTitle
- - the title of the document
<static> Object setActiveCellValue(value)
value
- - the value to be inserted in the active cell
<static> Object setActiveRangeByName(name)
name
- - the name of the range to be set active in the workbook
<static> Object setActiveWorkbook(workbookname)
workbookname
- - a string that is the name of the workbook to receive focus
<static> Object setActiveWorksheet(sheetname)
worksheetname
- - a string that is the name of the worksheet to receive focus
<static> Object setCellValue(cells, sheetname)
cells
- - an array of MLA.Cell objects, the values of which will be used for the values for the given cells in the active workbook.
sheetname
- - (optional) the name of the worksheet where the Cell values should be populated. If no sheetname is provided, the cells will be populated in the active worksheet.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |