Office.CoercionType enum

包:

office

指定如何强制由调用方法返回或设置的数据。

注解

以下要求集说明中指定了每个项目 CoercionType 的应用程序和平台支持。

• HtmlCoercion，使用 Office.CoercionType.Html) 时 (

• 使用 Office.CoercionType.Image) 时 (ImageCoercion 1.1

• 使用 Office.CoercionType.Matrix) 时的 MatrixCoercion (

• 使用 Office.CoercionType.Ooxml) 时的 OoxmlCoercion (

• Selection

• 使用 Office.CoercionType.Table) 时的 TableCoercion (

• 使用 Office.CoercionType.Text) 时的 TextCoercion (

• 使用 Office.CoercionType.XmlSvg) 时的 ImageCoercion 1.2 (

使用方

• Office.AppointmentCompose： getSelectedDataAsync
• Office.Body： getAsync， getTypeAsync
• Office.CoercionTypeOptions： coercionType
• Office.DecryptedMessageBody： coercionType
• Office.Document： getSelectedDataAsync
• Office.GetBindingDataOptions： coercionType
• Office.MessageCompose： getSelectedDataAsync
• Office.SetBindingDataOptions： coercionType
• Office.SetSelectedDataOptions： coercionType

示例

// This function displays the currently selected text in the console.
// It uses the Common APIs.
function run() {
    Office.context.document.getSelectedDataAsync(Office.CoercionType.Text, (asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.error(asyncResult.error.message);
        } else {
            console.log(`The selected data is "${asyncResult.value}".`);
        }
    });
}

字段

Html = "html"	作为 HTML 返回或设置数据。 注意：仅适用于 Word 的加载项和适用于 Outlook (撰写模式) 的 Outlook 加载项中的数据。
Image = "image"	以映像流形式返回或设置数据。 注意：仅适用于 Excel、Word 和 PowerPoint 中的数据。
Matrix = "matrix"	以不带标题的表格数据形式返回或设置数据。 以包含一维连续文本的字符的数组的数组形式返回或设置数据。 例如，两列中的三行字符串值将为：[[“R1C1”， “R1C2”]， [“R2C1”， “R2C2”]， [“R3C1”， “R3C2”]]。 注意：仅适用于 Excel 和 Word 中的数据。
Ooxml = "ooxml"	以 Office Open XML 形式返回或设置数据。 注意：仅适用于 Word 中的数据。
SlideRange = "slideRange"	返回一个 JSON 对象，其中包含所选幻灯片的 ID、标题和索引的数组。 例如， {"slides":[{"id":257,"title":"Slide 2","index":2},{"id":256,"title":"Slide 1","index":1}]} 选定两张幻灯片。 注意：仅在调用 Document.getSelectedDataAsync 方法以获取当前幻灯片或选定的幻灯片范围时，才适用于 PowerPoint 中的数据。
Table = "table"	以带可选标题的表格数据形式返回或设置的数据。 以具有可选标题的数组的数组形式返回或设置数据。 注意：仅适用于 Excel 和 Word 中的数据。
Text = "text"	将数据返回或设置为文本 (字符串) 。 以一维连续文本的字符形式返回或设置的数据。
XmlSvg = "xmlSvg"	将数据返回或设置为包含 SVG 图像的 XML 数据。 注意：仅适用于 Excel、Word 和 PowerPoint 中的数据。