ApiPresentation

Class representing a presentation.

Methods

The following table lists the available methods.

Method	Returns	Description
AddMaster	boolean	Adds the slide master to the presentation slide masters collection.
AddMathEquation	boolean	Adds a math equation to the current presentation.
AddSlide	None	Appends a new slide to the end of the presentation.
ApplyTheme	boolean	Applies a theme to all the slides in the presentation.
CreateNewHistoryPoint	None	Creates a new history point.
EnterText	boolean	Add text to the document on the cursor position.
GetActiveShape	ApiShape | null	Returns the shape that is currently selected or being edited in the presentation.
GetActiveTable	ApiTable | null	Returns the table that is currently selected or being edited in the presentation.
GetAllCharts	ApiChart[]	Returns an array with all the chart objects from the presentation slides, excluding slide layouts and slide masters.
GetAllComments	ApiComment[]	Returns all comments from the current presentation.
GetAllDrawings	Drawing[]	Returns all drawing objects from the presentation slides, excluding slide layouts and slide masters.
GetAllImages	ApiImage[]	Returns an array with all the image objects from the presentation slides, excluding slide layouts and slide masters.
GetAllOleObjects	ApiOleObject[]	Returns an array with all the OLE objects from the presentation slides, excluding slide layouts and slide masters.
GetAllShapes	ApiShape[]	Returns an array with all the shape objects from the presentation slides, excluding slide layouts and slide masters.
GetAllSlideMasters	ApiMaster[]	Returns an array of all slide masters from the current presentation.
GetAllSlides	ApiSlide[]	Returns an array of all slides from the current presentation.
GetAllTables	ApiTable[]	Returns an array with all tables from the presentation slides, excluding slide layouts and slide masters.
GetClassType	"presentation"	Returns a type of the ApiPresentation class.
GetCore	ApiCore	Returns the core properties interface for the current presentation.
GetCurSlideIndex	number	Returns the index for the current slide.
GetCurrentSentence	string	Returns the current sentence or a part of the current sentence at the cursor.
GetCurrentSlide	ApiSlide | null | undefined	Returns the current slide.
GetCurrentVisibleSlide	ApiSlide | null	Returns the current visible slide.
GetCurrentWord	string	Returns the current word or a part of the current word at the cursor.
GetCustomProperties	ApiCustomProperties	Returns the custom properties from the current presentation.
GetCustomXmlParts	ApiCustomXmlParts | null	Retrieves the custom XML manager associated with the presentation.
GetDocumentInfo	object	Returns the document information:
GetDrawingsByName	Drawing[]	Returns a collection of drawing objects from the presentation slides filtered by their names, excluding drawing objects from slide layouts and slide masters.
GetHeight	EMU	Returns the presentation height in English measure units.
GetLoopUntilStopped	boolean	Returns whether the presentation loops continuously until the user stops it.
GetMaster	ApiMaster | null	Returns a slide master by its position in the presentation.
GetMastersCount	number	Returns a number of slide masters.
GetSelection	ApiSelection	Returns the selection from the current presentation.
GetSlideByIndex	ApiSlide | null | undefined	Returns a slide by its position in the presentation.
GetSlideCount	number	Returns a number of slides.
GetSlidesCount	number	Returns a number of slides.
GetStyle	ApiStyle | null	Returns the presentation style by its name.
GetVisitor	ApiPresentationVisitor	Returns a visitor object for traversing the slides, layouts, masters, speaker notes, drawings and text of the presentation.
GetWidth	EMU	Returns the presentation width in English measure units.
InsertFromFile	number	Inserts slides from the specified file into the current presentation.
InsertParagraphBreak	boolean	Add paragraph to the document on the cursor position.
MoveCursorDown	boolean	Moves the cursor down.
MoveCursorLeft	boolean	Moves the cursor to the left.
MoveCursorRight	boolean	Moves the cursor to the right.
MoveCursorUp	boolean	Moves the cursor up.
MoveToNextCell	boolean	Moves the cursor to the next table cell.
MoveToPrevCell	boolean	Moves the cursor to the previous table cell.
RemoveSlide	boolean	Removes a slide at the specified position from the presentation.
RemoveSlides	boolean	Removes a range of slides from the presentation.
ReplaceCurrentImage	None	Replaces the current image with an image specified.
ReplaceCurrentSentence	boolean	Replaces the current sentence or a part of the current sentence at the cursor with the specified text. If there is no sentence at the cursor, for example, in an empty paragraph, the specified text is inserted at the cursor position.
ReplaceCurrentWord	boolean	Replaces the current word or a part of the current word at the cursor with the specified text.
Search	ApiTextRange[]	Searches for the specified text in the presentation and returns all found occurrences as text ranges.
SearchAndReplace	boolean	Finds and replaces the text in the presentation.
SelectCurrentSentence	boolean	Selects the sentence at the cursor. The current text selection, if any, is removed first.
SelectCurrentWord	boolean	Selects the word at the cursor. The current text selection, if any, is removed first.
SetLanguage	boolean	Specifies the languages which will be used to check spelling and grammar (if requested).
SetLoopUntilStopped	boolean	Sets whether the presentation loops continuously until the user stops it.
SetSizes	None	Sets the size to the current presentation.
SlidesToJSON	JSON | null	Converts the slides from the current ApiPresentation object into the JSON objects.
ToJSON	JSON	Converts the ApiPresentation object into the JSON object.