Office.SetSelectedDataOptions interface

包:: office

提供有关如何向所选内容插入数据的选项。

注解

使用方

Office.Document： setSelectedDataAsync

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/slide-management/export-import-slide.yaml

async function addImageToCurrentSlide(
  imageBase64: string,
  options?: PowerPoint.ShapeAddOptions
): Promise<PowerPoint.Shape> {
  // Adds an image to the current slide.
  const setSelectedDataOptions: Office.SetSelectedDataOptions = {
    coercionType: Office.CoercionType.Image
  };
  if (options) {
    if (options.height) {
      setSelectedDataOptions.imageHeight = options.height;
    }
    if (options.left) {
      setSelectedDataOptions.imageLeft = options.left;
    }
    if (options.top) {
      setSelectedDataOptions.imageTop = options.top;
    }
    if (options.width) {
      setSelectedDataOptions.imageWidth = options.width;
    }
  }

  return new Promise((resolve, reject) => {
    Office.context.document.setSelectedDataAsync(
      imageBase64,
      setSelectedDataOptions,
      async (result: Office.AsyncResult<void>) => {
        if (result.error) {
          console.error(`ERROR in setSelectedDataAsync(): ${result.error}`);
          reject(result.error);
        } else {
          const shape = await PowerPoint.run(async (context) => {
            const slide = context.presentation.getSelectedSlides().getItemAt(0);
            slide.shapes.load();
            await context.sync();

            return slide.shapes.items[slide.shapes.items.length - 1];
          });
          resolve(shape);
        }
      }
    );
  });
}

属性

asyncContext	在传递到回调的 AsyncResult 对象的 asyncContext 属性中返回的任何类型的用户定义项，保持不变。
cellFormat	仅与绑定类型表一起使用，以及为数据参数传递 TableData 对象时使用。指定列、行或单元格的范围，并将要应用于该区域的单元格格式作为键值对的对象数组。例如：`[{cells: Office.Table.Data, format: {fontColor: "yellow"}}, {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}]`
coercionType	显式设置数据对象的形状。如果未提供，则根据数据类型推断出来。
imageHeight	此选项适用于插入图像。表示图像高度。如果提供此选项时未提供 imageWidth，那么图像会进行缩放，以匹配图像的高度值。如果同时提供了图像的宽度和高度，那么图像会相应地调整大小。如果图像的高度或宽度均未提供，则会使用默认的图像大小和纵横比。此值以点为单位。
imageLeft	此选项适用于插入图像。表示相对于 PowerPoint 幻灯片左侧的插入位置，以及相对于 Excel 中当前选定单元格的插入位置。 Word 会忽略此值。此值以磅为单位。
imageTop	此选项适用于插入图像。指示相对于 PowerPoint 幻灯片顶部的插入位置及其与 Excel 中当前所选单元格的关系。 Word 会忽略此值。此值以磅为单位。
imageWidth	此选项适用于插入图像。表示图像宽度。如果提供此选项时未提供 imageHeight，那么图像会进行缩放，以匹配图像的宽度值。如果同时提供了图像的宽度和高度，那么图像会相应地调整大小。如果图像的高度或宽度均未提供，则会使用默认的图像大小和纵横比。此值以点为单位。
tableOptions	对于插入的表，键值对的列表，用于指定表格式选项，例如标题行、汇总行和镶边行。例如：`{bandedRows: true, filterButton: false}`

属性详细信息

asyncContext

在传递到回调的 AsyncResult 对象的 asyncContext 属性中返回的任何类型的用户定义项，保持不变。

asyncContext?: any

属性值

any

cellFormat

仅与绑定类型表一起使用，以及为数据参数传递 TableData 对象时使用。指定列、行或单元格的范围，并将要应用于该区域的单元格格式作为键值对的对象数组。

例如：[{cells: Office.Table.Data, format: {fontColor: "yellow"}}, {cells: {row: 3, column: 4}, format: {borderColor: "white", fontStyle: "bold"}}]

cellFormat?: RangeFormatConfiguration[]

属性值

Office.RangeFormatConfiguration[]

coercionType

显式设置数据对象的形状。如果未提供，则根据数据类型推断出来。

coercionType?: Office.CoercionType | string

属性值

Office.CoercionType | string

imageHeight

此选项适用于插入图像。表示图像高度。如果提供此选项时未提供 imageWidth，那么图像会进行缩放，以匹配图像的高度值。如果同时提供了图像的宽度和高度，那么图像会相应地调整大小。如果图像的高度或宽度均未提供，则会使用默认的图像大小和纵横比。此值以点为单位。

imageHeight?: number

属性值

number

imageLeft

此选项适用于插入图像。表示相对于 PowerPoint 幻灯片左侧的插入位置，以及相对于 Excel 中当前选定单元格的插入位置。 Word 会忽略此值。此值以磅为单位。

imageLeft?: number

属性值

number

imageTop

此选项适用于插入图像。指示相对于 PowerPoint 幻灯片顶部的插入位置及其与 Excel 中当前所选单元格的关系。 Word 会忽略此值。此值以磅为单位。

imageTop?: number

属性值

number

imageWidth

此选项适用于插入图像。表示图像宽度。如果提供此选项时未提供 imageHeight，那么图像会进行缩放，以匹配图像的宽度值。如果同时提供了图像的宽度和高度，那么图像会相应地调整大小。如果图像的高度或宽度均未提供，则会使用默认的图像大小和纵横比。此值以点为单位。

imageWidth?: number

属性值

number

tableOptions

对于插入的表，键值对的列表，用于指定表格式选项，例如标题行、汇总行和镶边行。例如：{bandedRows: true, filterButton: false}

tableOptions?: object

属性值

object

反馈

此页面是否有帮助？