Class MLA

Object
   |
   +--MLA

class MLA

Defined in MarkLogicWordAddin.js


Nested Class Summary
<static class> MLA.SimpleContentControl
 
Constructor Summary
MLA()
            The MLA namespace is used for global attribution.
 
Method Summary
<static> String addContentControl(tag, title, type, insertPara, parentID)
           Adds Content Control to active document.
<static> void addContentControlDropDownListEntries(id, text, value, index)
           Adds dropdown list entries to a combobox or dropdownlist content control.
<static> String addCustomXMLPart(customPartXml)
           Adds custom part to active Open XML package.
<static> Object createParagraph(textstring)
           Utility function to create a default WordprocessingML paragraph , with no styles, for a given string.
<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> void embedOLE(tmpPath, title, url, usr, pwd)
           Embeds OLE into the Document.
<static> Microsoft.XMLDOM object getActiveDocStylesXml()
           Returns the Styles.xml for the ActiveDocument as XMLDOM object.
<static> Microsoft.XMLDOM object getActiveDocXml()
           Returns the document.xml for the ActiveDocument as XMLDOM object.
<static> Object getConfiguration()
           Returns MLA.config.
<static> String getContentControlDropDownListEntrySelectedText(id)
           Returns selected content control dropdown list entry range text specified by id in the active document.
<static> String getContentControlDropDownListEntrySelectedValue(id)
           Returns selected content control dropdown list entry value specified by id in the active document.
<static> Array getContentControlIds()
           Returns ids for all content controls in the active document.
<static> String getContentControlText(id)
           Returns text for range of content control identified by id in active document.
<static> Microsoft.XMLDOM object getContentControlWordOpenXML(id)
           Returns WordOpenXML property for range of control in active document specified by id.
<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> String getDocumentName()
           Returns the name being used for the active Document on the client system.
<static> String getDocumentPath()
           Returns the path being used for the active document on the client system.
<static> Microsoft.XMLDOM object getDocumentWordOpenXML()
           Returns WordOpenXML property for the active document.
<static> SimpleContentControl getParentContentControlInfo()
           Returns SimpleContentControl for nearest parent control of current cursor position in the active document.
<static> Array getSelection()
           Returns the XML that represents what is currently selected (highlighted) by the user in the ActiveDocument as an XMLDOM object.
<static> Array getSelectionText(delimiter)
           Returns the text currently selected (highlighted) by the user in the ActiveDocument.
<static> Microsoft.XMLDOM object getSelectionWordOpenXML()
           Returns WordOpenXML property for selection in active document.
<static> Microsoft.XMLDOM object getSentenceAtCursor()
           Returns the final XML block that represents the Sentence at the current cursor position.
<static> Array getSimpleContentControls()
           Returns array of SimpleContentControl objects.
<static> String getTempPath()
           Returns the path being used for the /temp dir on the client system.
<static> String getVersion()
           Returns version of MarkLogicWordAddin.js library
<static> void insertBlockContent(blockContentXml,stylesXml)
           Inserts block-level xml into the ActiveDocument in Word at the current cursor position, or over the selected range (if selected).
<static> void insertContentControlImage(id, picuri, user, pwd)
           Insert image into picture control identified by id.
<static> void insertContentControlText(id, text)
           Insert text into plain or rich text control identified by id.
<static> void insertImage(picuri,uname,pwd)
           Inserts image into the ActiveDocument at current cursor position.
<static> void insertText(textToInsert)
           Inserts text into the ActiveDocument at current cursor position.
<static> void insertWordOpenXML(opc_xml)
           Inserts WordOpenXML at the current cursor position in the active document.
<static> void lockContentControl(id)
           Locks Content Control in active document identified by id.
<static> void lockContentControlContents(id)
           Locks contents of Content Control in active document identified by id.
<static> void mapContentControl(id, xpath, prefix, partid)
           Maps Content Control in active document identified by id to Custom XML Part in .docx package.
<static> void mergeWithActiveDocument(opc_xml)
           Opens WordOpenXML alongside the active document in Word's compare functionality.
<static> void openDOCX(tmpPath, docuri, url, user, pwd)
           Opens .docx into Word from local copy saved to client from MarkLogic.
<static> void removeContentControl(id, deletecontents)
           Removes Content Control from active document.
<static> String saveActiveDocument(filename, url, user, pwd)
           Saves active Document to MarkLogic from client system.
<static> void saveLocalCopy(filename)
           Saves .docx for active Document on the client system.
<static> void setActiveDocXml(documentXml)
           Inserts document.xml into the ActiveDocument package in Word.
<static> void setContentControlFocus(id)
           Sets focus in active document to beginning of control specified by id.
<static> void setContentControlPlaceholderText(id, placeholdertext, cleartext)
           Insert image into picture control identified by id.
<static> void setContentControlStyle(id, style)
           Sets the style for the content control specified by id in active document
<static> void setContentControlTag(id, tag)
           Sets the tag for content control specified by id in active document
<static> void setContentControlTitle(id, title)
           Sets the title for content control specified by id in active document
<static> String setDocumentWordOpenXML()
           Sets WordOpenXML for the active document. The WordOpenXML property is read only in the Word Object Model. This function however rewrites the active document package with the XML passed here as a parameter.
<static> void unlockContentControl(id)
           Unlocks Content Control in active document identified by id.
<static> void unlockContentControlContents(id)
           Unlocks contents of Content Control in active document identified by id.

Constructor Detail

MLA

MLA()

Method Detail

addContentControl

<static> String addContentControl(tag, title, type, insertPara, parentID)

addContentControlDropDownListEntries

<static> void addContentControlDropDownListEntries(id, text, value, index)

addCustomXMLPart

<static> String addCustomXMLPart(customPartXml)

createParagraph

<static> Object createParagraph(textstring)

createXMLDOM

<static> Object createXMLDOM(xmlstring)

deleteCustomXMLPart

<static> void deleteCustomXMLPart(customXMLPartId)

embedOLE

<static> void embedOLE(tmpPath, title, url, usr, pwd)

getActiveDocStylesXml

<static> Microsoft.XMLDOM object getActiveDocStylesXml()

getActiveDocXml

<static> Microsoft.XMLDOM object getActiveDocXml()

getConfiguration

<static> Object getConfiguration()

getContentControlDropDownListEntrySelectedText

<static> String getContentControlDropDownListEntrySelectedText(id)

getContentControlDropDownListEntrySelectedValue

<static> String getContentControlDropDownListEntrySelectedValue(id)

getContentControlIds

<static> Array getContentControlIds()

getContentControlText

<static> String getContentControlText(id)

getContentControlWordOpenXML

<static> Microsoft.XMLDOM object getContentControlWordOpenXML(id)

getCustomXMLPart

<static> Microsoft.XMLDOM object getCustomXMLPart(customXMLPartId)

getCustomXMLPartIds

<static> Array getCustomXMLPartIds()

getDocumentName

<static> String getDocumentName()

getDocumentPath

<static> String getDocumentPath()

getDocumentWordOpenXML

<static> Microsoft.XMLDOM object getDocumentWordOpenXML()

getParentContentControlInfo

<static> SimpleContentControl getParentContentControlInfo()

getSelection

<static> Array getSelection()

getSelectionText

<static> Array getSelectionText(delimiter)

getSelectionWordOpenXML

<static> Microsoft.XMLDOM object getDocumentWordOpenXML()

getSentenceAtCursor

<static> Microsoft.XMLDOM object getSentenceAtCursor()

getSimpleContentControls

<static> Array getSimpleContentControls()

getTempPath

<static> String getTempPath()

getVersion

<static> String getVersion()

insertBlockContent

<static> void insertBlockContent(blockContentXml,stylesXml)

insertContentControlImage

<static> void insertContentControlImage(id, picuri, user, pwd)

insertContentControlText

<static> void insertContentControlText(id, text)

insertImage

<static> void insertImage(picuri,uname,pwd)

insertText

<static> void insertText(textToInsert)

insertWordOpenXML

<static> void insertWordOpenXML(opc_xml)

lockContentControl

<static> void lockContentControl(id)

lockContentControlContents

<static> void lockContentControlContents(id)

mapContentControl

<static> void mapContentControl(id, xpath, prefix, partid)

mergeWithActiveDocument

<static> void mergeWithActiveDocument(opc_xml)

openDOCX

<static> void openDOCX(tmpPath, docuri, url, user, pwd)

removeContentControl

<static> void removeContentControl(id, deletecontents)

saveActiveDocument

<static> String saveActiveDocument(filename, url, user, pwd)

saveLocalCopy

<static> void saveLocalCopy(filename)

setActiveDocXml

<static> void setActiveDocXml(documentXml)

setContentControlFocus

<static> void setContentControlFocus(id)

setContentControlPlaceholderText

<static> void setContentControlPlaceholderText(id, placeholdertext, cleartext)

setContentControlStyle

<static> void setContentControlStyle(id, style)

setContentControlTag

<static> void setContentControlTag(id, tag)

setContentControlTitle

<static> void setContentControlTitle(id, title)

setDocumentWordOpenXML

<static> void setDocumentWordOpenXML(opc_xml)

unlockContentControl

<static> void unlockContentControl(id)

unlockContentControlContents

<static> void unlockContentControlContents(id)


Documentation generated by JSDoc on Wed Nov 11 16:00:07 2009