Class MLA

Object
   |
   +--MLA

class MLA

Defined in MarkLogicWordAddin.js

Constructor Detail

MLA

MLA()

The MLA namespace is used for global attribution. The methods within this namespace provide ways of interacting with an active Open XML document through a WebBrowser control. The control must be deployed within an Addin in Office 2007. The functions here provide ways for interacting with the ActiveDocument in Word; however, the functions getCustomXMLPart(), getCustomXMLPartIds(), addCustomXMLPart(), and deleteCustomXMLPart() will work for any Open XML package, provided they are used within the context of an Addin for the appropriate Office application.

addCustomXMLPart

<static> String addCustomXMLPart(customPartXml)

Adds custom part to active Open XML package. Returns the id of the part added.

Parameters:
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. )

Returns:
id for custom part added

Throws:
- Exception if unable to add custom part

createParagraph

<static> Object createParagraph(textstring)

Utility function to create a default WordprocessingML paragraph , with no styles, for a given string.

Parameters:
textstring - the string to be converted into a WordprocessingML paragraph

Returns:
Microsoft.XMLDOM object that is a WordprocessingML paragraph

Throws:
- Exception if unable to create the paragraph

createXMLDOM

<static> Object createXMLDOM(xmlstring)

Utility function for creating Microsoft.XMLDOM object from string

Parameters:
xmlString - the string to be loaded into a XMLDOM object. The string must be serialized, well-formed XML.

Returns:
Microsoft.XMLDOM object

Throws:
- Exception if unable to create the XMLDOM object

deleteCustomXMLPart

<static> void deleteCustomXMLPart(customXMLPartId)

Deletes custom part from Active Open XML package identified by id.

Parameters:
customXMLPartId - the id of the custom part to be deleted from the active Open XML package.

Throws:
- Exception if unable to delete custom part

getActiveDocStylesXml

<static> Microsoft.XMLDOM object getActiveDocStylesXml()

Returns the Styles.xml for the ActiveDocument as XMLDOM object.

Returns:
Styles.xml if no Styles.xml present in ActiveDocument package, returns null.

Throws:
- Exception if unable to retrieve Styles.xml from the ActiveDocument.

getActiveDocXml

<static> Microsoft.XMLDOM object getActiveDocXml()

Returns the document.xml for the ActiveDocument as XMLDOM object.

Returns:
document.xml from the active Open XML package -- NOTE: This is the materialized view of the document. If you have Content Controls bound to XML data islands within the .docx package, you'll only see the inline text, not the references, nor the original XML from which the value was mapped.

Throws:
- Exception if unable to retrieve Styles.xml from the ActiveDocument.

getConfiguration

<static> Object getConfiguration()

Returns MLA.config. The fields for this object are version, url, and theme. version - the version of the Addin library, url - the url used by the Addin WebBrowser control, theme - the current color scheme used by Office.

Throws:
- Exception if unable to create MLA.config object

getCustomXMLPart

<static> Microsoft.XMLDOM object getCustomXMLPart(customXMLPartId)

Returns the custom XML part, identified by customXMLPartId, that is part of the active Open XML package. (.docx, .xlsx, .pptx, etc.)

Parameters:
customXMLPartId - the id of the custom part to be fetched from the active package

Returns:
the XML for the custom part as a DOM object.

Throws:
- Exception if there is error retrieving the custom part

getCustomXMLPartIds

<static> Array getCustomXMLPartIds()

Returns ids for custom parts (not built-in) that are part of the active Open XML package. (.docx, .xlsx, .pptx, etc.)

Returns:
the ids for custom XML parts in active Open XML package as array of string

getSelection

<static> Array getSelection()

Returns the XML that represents what is currently selected (highlighted) by the user in the ActiveDocument as an XMLDOM object. Whatever is highlighted by the user will be returned in this function as a block level element. A user may highlight text that will be materialized as multiple sibling block elements in the XML. For this reason, the function returns an array, where each element of the array is an XMLDOM object that contains the XML for the blocks highlighted by the user in the ActiveDocument. The order of elements in the array represents the order of items that are highlighted in the ActiveDocument.

Returns:
the blocks of XML currently selected by the user in the ActiveDocument as XMLDOM objects. If nothing is selected, an empty array is returned.

Throws:
- Exception if unable to retrieve the Selection

getSelectionText

<static> Array getSelectionText(delimiter)

Returns the text currently selected (highlighted) by the user in the ActiveDocument. Whatever is highlighted by the user will be returned in this function as a string. A user may highlight text from multiple paragraphs or from tables. For this reason, the function returns an array, where each element of the array is a string that contains the text contained by the structure highlighted by the user in the ActiveDocument. The order of elements in the array represents the order of items that are highlighted in the ActiveDocument.

Parameters:
delimiter - (optional) Text from tables will be returned as a single string, with cells delimited by tabs (default). This param may be used to assign a different delimiter. Note: there is no delimiter for text from paragraphs, as each paragraph will be captured in separate array elements.

Returns:
the text selected by the user in the ActiveDocument as strings. If nothing is selected, an empty array is returned.

Throws:
- Exception if unable to retrieve the Selection

getSentenceAtCursor

<static> Microsoft.XMLDOM object getSentenceAtCursor()

Returns the final XML block that represents the Sentence at the current cursor position. Nothing is required to be highlighted in the ActiveDocument. If a selection is highlighted, this returns the XML for the sentence at the the current cursor position. If there is no selection, the XML for the sentence at the current cursor position is still returned.

Returns:
the block of XML, as XMLDOM object, for the Sentence immediately preceding the cursor position.

Throws:
- Exception if unable to retrieve the XML for the Sentence.

getVersion

<static> String getVersion()

Returns version of MarkLogicWordAddin.js library

Returns:
the version of MarkLogicWordAddin.js

insertBlockContent

<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). If stylesxml parameter is defined, the blockxml will be inserted and the Styles.xml will be overwritten with the stylesxml contents. If stylesxml is not defined, then only the blockxml will be inserted ; the assumption being that whatever styles required by the blockxml are already present in the .docx Styles.xml. There are two main levels of content in the document.xml; block-level and inline content. Block level describes the structure of the document, and includes paragraphs and tables. Anything that can be inserted under may be inserted here

Parameters:
stylesXml - (optional) this parameter is either A) an XMLDOM object that contains Styles.xml for the pacakge, or B)a String, which is the serialized, well-formed XML that represents Styles.xml for the ActiveDocument package in Word.
blockXml - this parameter may either be A) and XMLDOM object that is the block-level XML to be inserted,or an array of such objects,or B) a String, that is the serialized, well-formed XML of the block to be inserted, or an Array of such Strings.

Throws:
- Exception if unable to insert the blockContent or Styles.xml

insertText

<static> void insertText(textToInsert)

Inserts text into the ActiveDocument at current cursor position. Text will be styled according to whatever is the currently chosen style for text within Word.

Parameters:
textToInsert - the text to be inserted at the current cursor position in the ActiveDocument.

Throws:
- Exception if unable to insert text

setActiveDocXml

<static> void setActiveDocXml(documentXml)

Inserts document.xml into the ActiveDocument package in Word. This will replace the contents of the entire document the user is currently viewing. As this only allows insert of document.xml, it is assumed that whatever references required by document.xml by other xml files in the package currently being authored (styles, themes, etc.) already exist.

Parameters:
documentXml - this parameter may either be A) an XMLDOM object that is the XML equivalent of the document.xml to be inserted,or B) a String, that is the serialized, well-formed XML of the document.xml to be inserted.

Throws:
- Exception if unable to set the documentXml