|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--MLA
Defined in MarkLogicPowerPointAddin.js
Nested Class Summary | |
<static class> |
MLA.ShapeRangeView |
Constructor Summary | |
MLA()
The MLA namespace is used for global attribution. |
Method Summary | |
<static> string
|
addCustomXMLPart(customPartXml)
Adds custom part to active Open XML package. |
<static> string
|
addPresentationTag(tagName, tagValue)
Adds tag to active presentation |
<static> string
|
addPresentationTags(jsonTags)
Adds tags (tag names and associated values) to active presentation from jsonSerialization of tags. |
<static> string
|
addShape(slideIndex, shapeRangeView)
Add a shape to the active presentation |
<static> string
|
addShapeRangeTag(tagName, tagValue)
Adds tag to all selected shapes in the active slide |
<static> string
|
addShapeTag(slideIndex, shapeName, tagName, tagValue)
Adds tag to shape. |
<static> string
|
addShapeTags(slideIndex, shapeName, jsonTags)
Adds tags (tag names and associated values) to shape from jsonSerialization of tags. |
<static> string
|
addSlide(slideIndex, customLayout)
Adds a slide to the active presentation. |
<static> string
|
addSlideTag(slideIndex, tagName, tagValue)
Adds tag to slide. |
<static> string
|
addSlideTags(slideIndex, jsonTags)
Adds tags (tag names and associated values) to slide from jsonSerialization of tags. |
<static> string
|
convertFilenameToImageDir(filename)
Converts .pptx filename to image directory name. |
<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> string
|
deletePresentationTag(tagName)
Deletes tag from active presentation. |
<static> string
|
deleteShape(slideIndex, shapeName)
Deletes a shape from the active slide in the active presentation. |
<static> string
|
deleteShapeTag(slideIndex, shapeName, tagName)
Deletes tag from shape. |
<static> string
|
deleteSlide(slideIndex)
Deletes a slide from the active presentation. |
<static> string
|
deleteSlideTag(slideIndex, tagName)
Deletes tag from slide. |
<static> string
|
embedOLE(tmpPath, title, url, usr, pwd)
Embeds OLE into the Presentation. |
<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> string
|
getPresentationName()
Returns the name being used for the active Presentation on the client system. |
<static> string
|
getPresentationPath()
Returns the path being used for the active Presentation on the client system. |
<static> string
|
getPresentationSlideCount()
Returns count of slides for active presentation. |
<static> string
|
getPresentationTags()
Gets the json serialization of tags for the active presentation. |
<static> string
|
getShapeRangeCount()
Returns the count of how many shapes are currently selected in the active slide. |
<static> string
|
getShapeRangeName()
Returns the name of the currently selected shape. |
<static> Array
|
getShapeRangeShapeNames()
Gets the names of all currently selected shapes in the active slide. |
<static> ShapeRangeView
|
getShapeRangeView(slideIndex, shapeName)
Gets a shapeRangeView object |
<static> string
|
getSlideIndex()
Returns index of active slide. |
<static> string
|
getSlideName()
Returns slide name of active slide. |
<static> Array
|
getSlideShapeNames(slideIndex)
Gets the names of all shapes for the slide specified by slideIndex. |
<static> string
|
getSlideTags(slideIndex)
Gets the json serialization of tags for a slide in the active presentation. |
<static> string
|
getTempPath()
Returns the path being used for the /temp dir on the client system. |
<static> string
|
getVersion()
Returns version of MarkLogicPowerPointAddin.js library. |
<static> string
|
insertImage(url,user,pwd)
Inserts image into the Presentation. |
<static> string
|
insertJSONTable(table)
Inserts JSON string as table in Active Presentation. |
<static> string
|
insertSlide(tmpPath, filename, slideidx, url, user, pwd,retain)
Inserts slide, identified by slideIdx, into the active presentation at current slide position. |
<static> string
|
insertText(text)
Inserts text into the Presentation at cursor position. |
<static> string
|
jsonParse(jsonString, reviver)
Deserializes a JSON string into an object. |
<static> string
|
jsonStringify(jsObject, replacer)
Serializes an object as JSON. |
<static> string
|
openPPTX(tmpPath, docuri, url, user, pwd)
Opens .pptx into PowerPoint from local copy saved to client from MarkLogic. |
<static> string
|
saveActivePresentation(filename, url, user, pwd)
Saves active Presentation to MarkLogic from client system. |
<static> string
|
saveActivePresentationAndImages(saveasdir, saveasname, url, user, pwd)
Saves Presentation on client as .pptx. |
<static> string
|
saveImages(imgdir, url, user, pwd)
Saves directory of images on client. |
<static> string
|
saveLocalCopy(filename)
Saves .pptx for active Presentation on the client system. |
<static> string
|
setPictureFormat(slideIndex, shapeName, jsonPicFormat)
Sets the picture attributes for an inserted msoPicture shape. |
<static> string
|
setShapeRangeName(slideIndex, origName,newName)
Sets the name being used for the active Presentation on the client system. |
<static> string
|
useSaveFileDialog()
Launches Windows form on client as simple SaveAs text box. |
Constructor Detail |
MLA()
Method Detail |
<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> string addPresentationTag(tagName, tagValue)
tagName
- the name of the tag
tagValue
- the value of the tag
<static> string addPresentationTags(jsonTags)
jsonTags
- the tags (name, value) to be added to the presentation
<static> string addShape(slideIndex, shapeRangeView)
slideIndex
- the index of the slide to add the shape to
shapeRangeView
- the json serialization of a ShapeRangeView object.
<static> string addShapeRangeTag(tagName, tagValue)
tagName
- the name of the tag
tagValue
- the value of the tag
<static> string addShapeTag(slideIndex, shapeName, tagName, tagValue)
slideIndex
- the index of the slide containing the shape
shapeName
- the name of the shape to be tagged
tagName
- the name of the tag
tagValue
- the value of the tag
<static> string addShapeTags(slideIndex, shapeName, jsonTags)
slideIndex
- the index of the slide containing the shape
shapeName
- the name of the shape to be tagged
jsonTags
- the tags (name, value) to be added to the shape
<static> string addSlide(slideIndex, customLayout)
slideIndex
- the index of where to add the slide
customLayout
- the layout to use for the added slide
<static> string addSlideTag(slideIndex, tagName, tagValue)
slideIndex
- the index of the slide to be tagged
tagName
- the name of the tag
tagValue
- the value of the tag
<static> string addSlideTags(slideIndex, jsonTags)
slideIndex
- the index of the slide containing the shape
jsonTags
- the tags (name, value) to be added to the slide
<static> string convertFilenameToImageDir(filename)
filename
- the name to be converted
<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> string deletePresentationTag(tagName)
tagName
- the name of the tag to be deleted
<static> string deleteShape(slideIndex, shapeName)
slideIndex
- the index of slide containing shape to be deleted
shapeName
- the name of the shape to be deleted
<static> string deleteShapeTag(slideIndex, shapeName, tagName)
slideIndex
- the index of the slide containing the shape
shapeName
- the name of the tagged shape
tagName
- the name of the tag to be deleted
<static> string deleteSlide(slideIndex)
slideIndex
- the index of slide to delete
<static> string deleteSlideTag(slideIndex, tagName)
slideIndex
- the index of the slide
tagName
- the name of the tag to be deleted
<static> string 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> 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> string getPresentationName()
<static> string getPresentationPath()
<static> string getPresentationSlideCount()
<static> string getPresentationTags()
<static> string getShapeRangeCount()
<static> string getShapeRangeName()
<static> Array getShapeRangeShapeNames()
<static> ShapeRangeView getShapeRangeView(slideIndex, shapeName)
slideIndex
- the index of the slide containing the shape
shapeName
- the name of the shape
<static> string getSlideIndex()
<static> string getSlideName()
<static> Array getSlideShapeNames(slideIndex)
slideIndex
- the index of the slide
<static> string getSlideTags(slideIndex)
slideIndex
- the index of the slide
<static> string getTempPath()
<static> string getVersion()
<static> string insertImage(url,user,pwd)
url
- a url to XQuery module that will return the image when evaluated
user
- username for the MarkLogic Server the picuri connects with
pwd
- password for the MarkLogic Server the picuri connects with
<static> string insertJSONTable(table)
table
- the JSON representation of the table to be inserted
<static> string insertSlide(tmpPath, filename, slideidx, url, user, pwd,retain)
tmpPath
- the directory (including path) where the local copy of presentation will be saved.
filename
- the name of the .pptx file
url
- the url of the .pptx to be downloaded
user
- the username of the MarkLogic Server the url connects with
pwd
- the password of the MarkLogic Server the url connects with
retain
- true or false setting determines whether background style of copied slide will be retained when copied to active presentation
slideIdx
- the index of the slide within the source powerpoint file to be copied
<static> string insertText(text)
text
- text to inser
<static> string jsonParse(jsonString, reviver)
reviver
- optional reviver parameter
jsString
- the JSON string to convert to object.
<static> string jsonStringify(jsObject, replacer)
jsObject
- the object to be serialized as JSON
replacer
- optional replacer parameter
<static> string openPPTX(tmpPath, docuri, url, user, pwd)
tmpPath
- the directory (including path) where the local copy of presentation will be saved.
docuri
- the uri of the .pptx within MarkLogic
url
- the url for fetching the .pptx 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> string saveActivePresentation(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> string saveActivePresentationAndImages(saveasdir, saveasname, url, user, pwd)
saveasdir
- the name of the directory (including path) where to save the local copies
saveasname
- the name to save the .pptx as (no path)
url
- the url on MarkLogic that the client calls to upload the Presentation and images to MarkLogic
user
- username for MarkLogic Server url connects with
pwd
- password for MarkLogic Server url connects with
<static> string saveImages(imgdir, url, user, pwd)
imgdir
- the name of the directory (including path) where to save the images on the client system
url
- the url on MarkLogic that the client calls to upload the image directory and contents to MarkLogic
user
- username for MarkLogic Server url connects with
pwd
- password for MarkLogic Server url connects with
<static> string saveLocalCopy(filename)
filename
- the filename (including path) to save Presentation as on client system
<static> string setPictureFormat(slideIndex, shapeName, jsonPicFormat)
slideIndex
- the index of the slide containing the picture
shapeName
- the name of the picture shape
jsonPicFormat
- the JSON serialization of picture format, available by using MLA.jsonStringify(shapeRangeView.pictureFormat)
<static> string setShapeRangeName(slideIndex, origName,newName)
slideIndex
- the index of the slide containing the shape
origName
- the original name of the shape
newName
- the name to set for the shape
<static> string useSaveFileDialog()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |