Docs API Reference

File.getSliceAsync method

Returns the specified slice.

Hosts: PowerPoint, Word
Available in Requirement set File
Added in 1.0
File.getSliceAsync(sliceIndex, callback);

Parameters

sliceIndex
    Type: number
    Specifies the zero-based index of the slice to be retrieved. Required.

callback
    Type: object
    A function that is invoked when the callback returns, whose only parameter is of type AsyncResult. Optional.

Callback Value

When the function you passed to the callback parameter executes, it receives an AsyncResult object that you can access from the callback function's only parameter.

In the callback function passed to the getSliceAsync method, you can use the properties of the AsyncResult object to return the following information.

Property Use to...
AsyncResult.value Access the Slice object.
AsyncResult.status Determine the success or failure of the operation.
AsyncResult.error Access an Error object that provides error information if the operation failed.
AsyncResult.asyncContext Access your user-defined object or value, if you passed one as the asyncContext parameter.

Support details

A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Office for Windows desktop Office Online (in browser) Office for iPad
PowerPoint Y Y Y
Word Y Y Y
Available in requirement set File
Minimum permission level ReadDocument (ReadAllDocument required to get Office OpenXML)
Add-in types Content, task pane
Library Office.js
Namespace Office

Support history

Version Changes
1.1 Added support for PowerPoint and Word in Office for iPad.
1.0 Introduced