|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--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 |
<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()
Method Detail |
<static> String addContentControl(tag, title, type, insertPara, parentID)
tag
- the tag identifier for the control.
title
- the title identifier for the control.
type
- the type of control.
insertPara
- [optional] true/false; true: inserts paragraph after control, (default)false: inserts space after control.
parentID
- [optional] the id for the parent which the control should be embedded within.
<static> void addContentControlDropDownListEntries(id, text, value, index)
id
- the id of the control to add list entries to.
text
- the text to be displayed in the list entry of the control.
value
- the value for the list entry in the control. (not displayed)
index
- the index where to insert the entry in the drop down list
<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 createParagraph(textstring)
textstring
- the string to be converted into a WordprocessingML paragraph
<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> void embedOLE(tmpPath, title, url, usr, pwd)
tmpPath
- the directory (including path) where the local copy of object to be embedded will be saved.
url
- the url for the file to be downloaded and embedded
pwd
- password for MarkLogic Server url connects with
filename
- the name of the file to be embedded. tmpPath + filename should be the name and path of file on client.
user
- username for MarkLogic Server url connects with
<static> Microsoft.XMLDOM object getActiveDocStylesXml()
<static> Microsoft.XMLDOM object getActiveDocXml()
<static> Object getConfiguration()
<static> String getContentControlDropDownListEntrySelectedText(id)
<static> String getContentControlDropDownListEntrySelectedValue(id)
<static> Array getContentControlIds()
<static> String getContentControlText(id)
<static> Microsoft.XMLDOM object getContentControlWordOpenXML(id)
id
- the id of the control.
<static> Microsoft.XMLDOM object getCustomXMLPart(customXMLPartId)
customXMLPartId
- the id of the custom part to be fetched from the active package
<static> Array getCustomXMLPartIds()
<static> String getDocumentName()
<static> String getDocumentPath()
<static> Microsoft.XMLDOM object getDocumentWordOpenXML()
<static> SimpleContentControl getParentContentControlInfo()
<static> Array getSelection()
<static> Array getSelectionText(delimiter)
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.
<static> Microsoft.XMLDOM object getDocumentWordOpenXML()
<static> Microsoft.XMLDOM object getSentenceAtCursor()
<static> Array getSimpleContentControls()
<static> String getTempPath()
<static> String getVersion()
<static> void insertBlockContent(blockContentXml,stylesXml)
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.
<static> void insertContentControlImage(id, picuri, user, pwd)
id
- the id of the control where image will be inserted.
user
- the MarkLogic Server user.
pwd
- the MarkLogic Server pwd.
uri
- the uri of the image within MarkLogic Server.
<static> void insertContentControlText(id, text)
id
- the id of the control where text will be inserted.
text
- the text to be inserted as the control contents. insert is asynchronous within the active document.
<static> void insertImage(picuri,uname,pwd)
uname
- username for Server
pwd
- password for Server
picurl
- a url to an XQuery module that will return the image when evaluated.
<static> void insertText(textToInsert)
textToInsert
- the text to be inserted at the current cursor position in the ActiveDocument.
<static> void insertWordOpenXML(opc_xml)
opc_xml
- the XML to be inserted. Parameter type can be either A) an XMLDOM object that is the WordOpenXML to be inserted into the active Open XML package, or B)the string serialization of the WordOpenXML to be inserted into the active Open XML package.
<static> void lockContentControl(id)
id
- the id identifier of the Content Control to be locked in the active document.
<static> void lockContentControlContents(id)
id
- the id identifier of the Content Control containing contents to be locked.
<static> void mapContentControl(id, xpath, prefix, partid)
id
- the id identifier of the Content Control to be mapped.
xpath
- the xpath expression identifying which value to use for the control contents.
prefix
- namespace identifier for the custom XML part.
partid
- the identifier of the custom XML Part which the control is to be mapped to.
<static> void mergeWithActiveDocument(opc_xml)
opc_xml
- the XML to be compared with the active document. Parameter type can be either A) an XMLDOM object that is the WordOpenXML to be compared with the active Open XML package, or B)the string serialization of the WordOpenXML to be compared with the active Open XML package.
<static> void openDOCX(tmpPath, docuri, url, user, pwd)
tmpPath
- the directory (including path) where the local copy of document will be saved.
docuri
- the uri of the .docx within MarkLogic
url
- the url for fetching the .docx to be downloaded
user
- the username for the MarkLogic Server the url connects with
pwd
- the password for the MarkLogic Server the url connects with
<static> void removeContentControl(id, deletecontents)
id
- the id of the control to be removed.
deletecontents
- [optional] true/false ; true: deletes contents of control. (default)false: removes control but document retains control contents.
<static> String saveActiveDocument(filename, url, user, pwd)
filename
- the name of the file (including path) to be saved to MarkLogic
url
- the url on MarkLogic that the client calls to upload the presentation
user
- username for MarkLogic Server url connects with
pwd
- password for MarkLogic Server url connects with
<static> void saveLocalCopy(filename)
filename
- the filename (including path) to save Document as on client system
<static> void setActiveDocXml(documentXml)
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.
<static> void setContentControlFocus(id)
id
- the id identifying the control to which focus will be set in active document.
<static> void setContentControlPlaceholderText(id, placeholdertext, cleartext)
id
- the id of the control in which to set placeholder text.
placeholdertext
- the placeholder text to be used for the control.
cleartext
- [optional] true/false; true: delete existing text for control range. (default)false: do not delete control range text contents.
<static> void setContentControlStyle(id, style)
id
- the id of the control.
style
- the style property to be set for the control. This style can be any of the styles available in Office. For example "Subtitle","Heading 1","Heading 2", etc. For more options, see the 'styles' group on the 'Home' tab of Word.
<static> void setContentControlTag(id, tag)
id
- the id of the control.
tag
- the tag to be set for the control.
<static> void setContentControlTitle(id, title)
id
- the id of the control.
title
- the title to be set for the control.
<static> void setDocumentWordOpenXML(opc_xml)
opc_xml
- the XML to be inserted as the active document. Parameter type can be either A) an XMLDOM object that is the WordOpenXML to be inserted, or B)the string serialization of the WordOpenXML to be inserted as the active Open XML package.
<static> void unlockContentControl(id)
id
- the id identifier of the Content Control to be unlocked in the active document.
<static> void unlockContentControlContents(id)
id
- the id identifier of the Content Control containing contents to be unlocked.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |