File.getSliceAsync method (JavaScript API for Office)

apps for Office

Returns the specified slice.

Last modified: March 02, 2015

Hosts:

PowerPoint, Word

Available in Requirement set

File

Added in

1.0

See all support details

File.getSliceAsync(sliceIndex, callback);

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.

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.

A checkmark (√) 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 apps for Office.

Office for Windows desktop

Office for Windows RT

Office Online
(in browser)

PowerPoint

Word

Available in requirement set

File

Minimum permission level

ReadDocument (ReadAllDocument required to get Office OpenXML)

App types

Content, task pane

Library

Office.js

Namespace

Office

Version

Changes

1.0

Introduced

Show:
© 2015 Microsoft