FileType enumeration (JavaScript API for Office)

apps for Office

Specifies the format in which to return the document.

Last modified: June 22, 2015

Note Note

The name "apps for Office" is changing to "Office Add-ins". During the transition, the documentation and the UI of some Office host applications and Visual Studio tools might still use the term "apps for Office". For details, see New name for apps for Office and SharePoint.

Hosts:

PowerPoint, Word

Last changed in

1.1

See all support details

Office.FileType

Values

Enumeration

Value

Description

Office.FileType.Compressed

"compressed"

Returns the entire document (.pptx or .docx) in Office Open XML (OOXML) format as a byte array.

Office.FileType.Pdf

"pdf"

Returns the entire document in PDF format as a byte array.

Office.FileType.Text

"text"

Returns only the text of the document as a string. (Word only)

A checkmark (√) in the following matrix indicates that this enumeration is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this enumeration.

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

Supported hosts, by platform

Office for Windows desktop

Office Online
(in browser)

Office for iPad

PowerPoint

Word

App types

Content, task pane

Library

Office.js

Namespace

Office

Version

Changes

1.1

Added support for Word in Office for iPad.

1.1

Added support for saving as PDF.

1.0

Introduced

Show:
© 2015 Microsoft