Shape

InlineShapes

ActiveDocument.InlineShapes

获取文档中的所有嵌入式图形对象。

• 语法

  表达式.ActiveDocument.InlineShapes

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取文档中的所有嵌入式图形对象
    const info = await app.ActiveDocument.InlineShapes;
  }

方法

ActiveDocument.InlineShapes.AddPicture()

通过AddPicture()方法，您可以插入嵌入式图形对象。

• 语法

  表达式.ActiveDocument.InlineShapes.AddPicture({ FileName, LinkToFile, SaveWithDocument, Range })

  表达式：文档类型应用对象

• 参数

  属性	数据类型	是否必填	描述
  FileName	String	是	图形对象的路径和文件名。
  LinkToFile	Boolean	否	是否将图片链接到创建图片的文件。取值范围如下： true：将图形对象链接到创建图片的文件。 false（默认）：使图形对象文件成为独立副本。
  SaveWithDocument	Boolean	否	图形对象是否随文档保存。取值范围如下： true：链接的图形对象随文档一起保存。 false（默认）：链接的图形对象不随文档一起保存。
  Range	String	否	图形对象置于文本中的位置。

• 返回值

  返回一个嵌入式图形对象。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取文档中的所有嵌入式图形对象
    const inlineShapes = await app.ActiveDocument.InlineShapes;
  
     //插入嵌入式图形对象
    const inlineShape = await inlineShapes.AddPicture({
      FileName: 'example.com/a.jpg',
      LinkToFile: false,
      SaveWithDocument: false,
      Range: {
        start: 1,
        end: 2,
      }
    });
  }

属性

ActiveDocument.InlineShapes.Count

通过Count属性，您可以获取文档中所有嵌入式图形对象的个数。

• 语法

  表达式.ActiveDocument.InlineShapes.Count

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取文档中的所有嵌入式图形对象
    const shapes = await app.ActiveDocument.InlineShapes;
  
    //获取文档中所有嵌入式图形对象的个数
    const count = await shapes.Count;
    console.log(count);
  
  }

InlineShape

ActiveDocument.InlineShapes.Item(Index)

获取单个嵌入式图形对象。

• 语法

  表达式.ActiveDocument.InlineShapes.Item(Index)

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有嵌入式图形对象
    const InlineShapes = await app.ActiveDocument.InlineShapes;
  
    //获取第1个嵌入式图形对象
    await InlineShapes.Item(1);
  }

方法

ActiveDocument.InlineShapes.Item(Index).ConvertToShape()

通过ConvertToShape()方法，您可以将单个嵌入式图形转换为非嵌入式图形。

• 语法

  表达式.ActiveDocument.InlineShapes.Item(Index).ConvertToShape()

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有嵌入式图形对象
    const shapes = await app.ActiveDocument.InlineShapes;
  
    //插入嵌入式图形对象
    await shapes.AddPicture({
      FileName: 'https://example.aliyundoc.com/image_01.png', 
      LinkToFile: false,
      SaveWithDocument: false,
    });
  
    //获取第1个嵌入式图形对象
    const shape = await shapes.Item(1);
  
    //将嵌入式图形对象转换为非嵌入式图形对象
    await shape.ConvertToShape();
  }

ActiveDocument.InlineShapes.Item(Index).Delete()

通过Delete()方法，您可以删除单个嵌入式图形对象。

• 语法

  表达式.ActiveDocument.InlineShapes.Item(Index).Delete()

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有嵌入式图形对象
    const shapes = await app.ActiveDocument.InlineShapes;
  
    //插入嵌入式图形对象
    await shapes.AddPicture({
      FileName: 'https://example.aliyundoc.com/image_01.png', 
      LinkToFile: false,
      SaveWithDocument: false,
    });
  
    //获取第1个嵌入式图形对象
    const shape = await shapes.Item(1);  
  
    //删除该嵌入式图形对象
    await shape.Delete();
  }

ActiveDocument.InlineShapes.Item(Index).Select()

通过Select()方法，您可以选中单个嵌入式图形对象。

• 语法

  表达式.ActiveDocument.InlineShapes.Item(Index).Select()

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有嵌入式图形对象
    const shapes = await app.ActiveDocument.InlineShapes;
  
    //插入嵌入式图形对象
    await shapes.AddPicture({
      FileName: 'https://example.aliyundoc.com/image_01.png', 
      LinkToFile: false,
      SaveWithDocument: false,
    });
  
    //获取第1个嵌入式图形对象
    const shape = await shapes.Item(1);  
  
    //选中该嵌入式图形对象
    await shape.Select();
  }

属性

ActiveDocument.InlineShapes.Item(Index).Data

通过Data属性，您可以获取单个嵌入式图形对象的Base64数据。

• 语法

  表达式.ActiveDocument.InlineShapes.Item(Index).Data

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有嵌入式图形对象
    const shapes = await app.ActiveDocument.InlineShapes;
  
    //插入嵌入式图形对象
    await shapes.AddPicture({
      FileName: 'https://example.aliyundoc.com/image_01.png', 
      LinkToFile: false,
      SaveWithDocument: false,
    });
  
    //获取第1个嵌入式图形对象
    const shape = await shapes.Item(1);  
  
    //异步返回该嵌入式图形对象的Base64数据
    const Data = await shape.Data;
    console.log(Data);
  }

ActiveDocument.InlineShapes.Item(Index).Height

通过Height属性，您可以设置单个嵌入式图形对象的高度。

• 语法

  表达式.ActiveDocument.InlineShapes.Item(Index).Height

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有嵌入式图形对象
    const InlineShapes = await app.ActiveDocument.InlineShapes;
  
    //获取第1个嵌入式图形对象
    await InlineShapes.Item(1);  
  
     //设置该嵌入式图形对象的高度
     shape.Height = 200;
  }

ActiveDocument.InlineShapes.Item(Index).Width

通过Width属性，您可以设置单个嵌入式图形对象的宽度。

• 语法

  表达式.ActiveDocument.InlineShapes.Item(Index).Width

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有嵌入式图形对象
    const InlineShapes = await app.ActiveDocument.InlineShapes;
  
    //获取第1个嵌入式图形对象
    await InlineShapes.Item(1);  
  
     //设置该嵌入式图形对象的宽度
     shape.Width = 200;
  }

ActiveDocument.InlineShapes.Item(Index).OLEFormat

通过OLEFormat属性，您可以获取单个嵌入式图形对象的OLE特征。

• 语法

  表达式.ActiveDocument.InlineShapes.Item(Index).OLEFormat

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有嵌入式图形对象
    const shapes = await app.ActiveDocument.InlineShapes;
  
    //插入嵌入式图形对象
    await shapes.AddPicture({
      FileName: 'https://example.aliyundoc.com/image_01.png', 
      LinkToFile: false,
      SaveWithDocument: false,
    });
  
    //获取第1个嵌入式图形对象
    const shape = await shapes.Item(1);   
  
    //获取该嵌入式图形对象的OLE特征
    const OLEFormat = await shape.OLEFormat;
  }

ActiveDocument.InlineShapes.Item(Index).OriginData

通过OriginData属性，您可以查看单个嵌入式图形对象原图的Base64数据。

• 语法

  表达式.ActiveDocument.InlineShapes.Item(Index).OriginData

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有嵌入式图形对象
    const shapes = await app.ActiveDocument.InlineShapes;
  
    //插入嵌入式图形对象
    await shapes.AddPicture({
      FileName: 'https://example.aliyundoc.com/image_01.png', 
      LinkToFile: false,
      SaveWithDocument: false,
    });
  
    //获取第1个嵌入式图形对象
    const shape = await shapes.Item(1);  
  
    //异步返回该嵌入式图形对象原图的Base64数据
    const OriginData = await shape.OriginData;
    console.log(OriginData);
  }

shapes

ActiveDocument.Shapes

获取文档中的所有非嵌入式图形对象。

• 语法

  表达式.ActiveDocument.Shapes

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有非嵌入式图形对象
    const shapes = await app.ActiveDocument.Shapes;
  }

方法

ActiveDocument.Shapes.AddPicture()

通过AddPicture()方法，您可以插入非嵌入式图形对象。

• 语法

  表达式.ActiveDocument.Shapes.AddPicture({ FileName, LinkToFile, SaveWithDocument, Left, Top, Width, Height })

  表达式：文档类型应用对象

• 参数

  属性	数据类型	是否必填	描述
  FileName	String	是	图片的路径和文件名。
  LinkToFile	Boolean	否	是否将图片链接到创建图片的文件。取值范围如下： true：将图片链接到创建图片的文件。 false（默认）：使图片文件成为独立副本。
  SaveWithDocument	Boolean	否	图片是否随文档保存。取值范围如下： true：链接的图片随文档一起保存。 false（默认）：链接的图片不随文档一起保存。
  Left	Number	否	新图片的左边缘相对于绘图画布的位置，以磅为单位。
  Top	Number	否	新图片的上边缘相对于绘图画布的位置，以磅为单位。
  Width	Number	否	图片的宽度，以磅为单位。
  Height	Number	否	图片的高度，以磅为单位。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有图形对象
    const shapes = await app.ActiveDocument.Shapes;
  
    //插入非嵌入式图形对象
    const shape = await shapes.AddPicture({
      FileName: 'https://example.com/image_01.png, //图片的路径和文件名
      LinkToFile: true,//将图片链接到创建图片的文件
      SaveWithDocument: true,//链接的图片随文档一起保存
      Left: 10, //图片距离左边位置
      Top: 10, //图片距离顶部位置
      Width: 60, //图片宽度
      Height: 120, //图片高度
    });
  }

属性

ActiveDocument.Shapes.Count

通过Count属性，您可以获取所有非嵌入式图形对象的数量。

• 语法

  表达式.ActiveDocument.Shapes.Count

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有非嵌入式图形对象
    const shapes = await app.ActiveDocument.Shapes;
  
    //获取所有非嵌入式图形对象的数量
    const count = await shapes.Count;
    console.log(count);
  }

shape

ActiveDocument.Shapes.Item()

获取单个非嵌入式图形对象。

• 语法

  表达式.ActiveDocument.Shapes.Item(Index)

  表达式：文档类型应用对象

• 参数

  属性	数据类型	是否必填	描述
  Index	String	是	第Index个图形对象。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有非嵌入式图形对象
    const shapes = await app.ActiveDocument.Shapes;
  
    //获取第1个非嵌入式图形对象
    const shape = await shapes.Item(1);
  }

方法

ActiveDocument.Shapes.Item(Index).ConvertToInlineShape()

通过ConvertToInlineShape()方法，您可以将非嵌入式图形对象转换为嵌入式图形对象。

• 语法

  表达式.ActiveDocument.Shapes.Item(Index).ConvertToInlineShape()

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有非嵌入式图形对象
    const shapes = await app.ActiveDocument.Shapes;
  
    //获取第1个非嵌入式图形对象
    const shape = await shapes.Item(1);
  
    //将该非嵌入式图形转换为嵌入式图形
    await shape.ConvertToInlineShape();
  }

ActiveDocument.Shapes.Item(Index).Delete()

通过Delete()方法，您可以删除单个非嵌入式图形对象。

• 语法

  表达式.ActiveDocument.Shapes.Item(Index).Delete()

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有非嵌入式图形对象
    const shapes = await app.ActiveDocument.Shapes;
  
    //获取第1个非嵌入式图形对象
    const shape = await shapes.Item(1);
  
    //删除该非嵌入式图形对象
    await shape.Delete();
  }

ActiveDocument.Shapes.Item(Index).IncrementLeft()

通过IncrementLeft()方法，您可以将指定非嵌入式图形对象水平移动指定距离。

• 语法

  表达式.ActiveDocument.Shapes.Item(Index).IncrementLeft(Increment)

  表达式：文档类型应用对象

• 参数

  属性	数据类型	是否必填	描述
  Increment	Number	是	指定非嵌入式图形对象水平移动的距离，以磅为单位。取值范围如下： 正数：将非嵌入式图形对象右移。 负数：将非嵌入式图形对象左移。 0：不移动非嵌入式图形对象。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有非嵌入式图形对象
    const shapes = await app.ActiveDocument.Shapes;
  
    //获取第1个非嵌入式图形对象
    const shape = await shapes.Item(1);
  
    //将该非嵌入式图形对象往右移动30磅
    await shape.IncrementLeft(30);
  }

ActiveDocument.Shapes.Item(Index).IncrementTop()

通过IncrementTop()方法，您可以将指定非嵌入式图形对象垂直移动指定距离。

• 语法

  表达式.ActiveDocument.Shapes.Item(Index).IncrementLeft(Increment)

  表达式：文档类型应用对象

• 参数

  属性	数据类型	是否必填	描述
  Increment	Number	是	指定非嵌入式图形对象垂直移动的距离，以磅为单位。取值范围如下： 正数：将非嵌入式图形对象下移。 负数：将非嵌入式图形对象上移。 0：不移动非嵌入式图形对象。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有非嵌入式图形对象
    const shapes = await app.ActiveDocument.Shapes;
  
    //获取第1个非嵌入式图形对象
    const shape = await shapes.Item(1);
  
    //将该非嵌入式图形对象往下移动30磅
    await shape.IncrementTop(30);
  }

ActiveDocument.Shapes.Item(Index).Select()

通过Select()方法，您可以选中单个非嵌入式图形对象。

• 语法

  表达式.ActiveDocument.Shapes.Item(Index).Select()

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有非嵌入式图形对象
    const shapes = await app.ActiveDocument.Shapes;
  
    //获取第1个非嵌入式图形对象
    const shape = await shapes.Item(1);
  
    //选中该非嵌入式图形对象
    await shape.Select();
  }

ActiveDocument.Shapes.Item(Index).ZOrder()

通过ZOrder()方法，您可以将指定非嵌入式图形对象移动到相对于文字的z-index位置。

• 语法

  表达式.ActiveDocument.Shapes.Item(Index).ZOrder({ ZOrderCmd })

  表达式：文档类型应用对象

• 参数

  属性	数据类型	是否必填	描述
  ZOrderCmd	Enum	是	指定要将非嵌入式图形对象移动到的相对于文字的z-index位置。更多信息，请参见ZOrderCmd。

• 参数

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有非嵌入式图形对象
    const shapes = await app.ActiveDocument.Shapes;
  
    //获取第1个非嵌入式图形对象
    const shape = await shapes.Item(1);
  
    //指定要将该非嵌入式图形对象移动到的相对于文字的z-index位置
    shape.ZOrder(app.Enum.ZOrderCmd.bringInFrontOfText);
  }

属性

ActiveDocument.Shapes.Item(Index).Data

通过Data属性，您可以获取指定非嵌入式图形对象的Base64数据。

• 语法

  表达式.ActiveDocument.Shapes.Item(Index).Data

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有非嵌入式图形对象
    const shapes = await app.ActiveDocument.Shapes;
  
    //获取第1个非嵌入式图形对象
    const shape = await shapes.Item(1);
  
    //获取该非嵌入式图形对象的Base64数据
    const Data = await shape.Data;
    console.log(Data);;
  }

ActiveDocument.Shapes.Item(Index).Height

通过Height属性，您可以设置指定非嵌入式图形对象的高度。

• 语法

  表达式.ActiveDocument.Shapes.Item(Index).Height

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有非嵌入式图形对象
    const shapes = await app.ActiveDocument.Shapes;
  
    //获取第1个非嵌入式图形对象
    const shape = await shapes.Item(1);
  
    //设置该非嵌入式图形对象的高度
    shape.Height = 240;
  }

ActiveDocument.Shapes.Item(Index).Width

通过Width属性，您可以设置指定非嵌入式图形对象的宽度。

• 语法

  表达式.ActiveDocument.Shapes.Item(Index).Width

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有非嵌入式图形对象
    const shapes = await app.ActiveDocument.Shapes;
  
    //获取第1个非嵌入式图形对象
    const shape = await shapes.Item(1);
  
    //设置该非嵌入式图形对象的宽度
    shape.Width = 200;
  }

ActiveDocument.Shapes.Item(Index).WrapFormat

通过WrapFormat属性，您可以设置指定非嵌入式图形对象的文字环绕模式。

• 语法

  表达式.ActiveDocument.Shapes.Item(Index).WrapFormat = WdWrapType

  表达式：文档类型应用对象

• 参数

  属性	数据类型	是否必填	描述
  WdWrapType	Enum	是	指定如何在图形对象周围环绕文字。更多信息，请参见WdWrapType。

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有非嵌入式图形对象
    const shapes = await app.ActiveDocument.Shapes;
  
    //获取第1个非嵌入式图形对象
    const shape = await shapes.Item(1);
  
    //设置文字四周环绕
    shape.WrapFormat = app.Enum.WdWrapType.wdWrapSquare;
  }

ActiveDocument.Shapes.Item(Index).OriginData

通过OriginData属性，您可以获取单个非嵌入式图形对象的Base64数据。

• 语法

  表达式.ActiveDocument.Shapes.Item(Index).OriginData

  表达式：文档类型应用对象

• 示例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //获取所有非嵌入式图形对象
    const shapes = await app.ActiveDocument.Shapes;
  
    //获取第1个非嵌入式图形对象
    const shape = await shapes.Item(1);
  
    //异步返回该非嵌入式图形对象的宽度
    const OriginData = await shape.OriginData;
    console.log(OriginData);
  }

OLEFormat

ActiveDocument.Shapes.Item(Index).OLEFormat

获取OLE对象的OLE特性。

• 语法

  表达式.ActiveDocument.Shapes.Item(Index).OLEFormat

  或者表达式.ActiveDocument.InlineShapes.Item(Index).OLEFormat

  表达式：文档类型应用对象

• 示例

  • 通过Shape访问

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取所有非嵌入式图形对象
      const shapes = await app.ActiveDocument.Shapes;
    
      //获取第1个非嵌入式图形对象
      const shape = await shapes.Item(1);
    
      //获取该非嵌入式图形对象的OLE特征
      const OLEFormat = await shape.OLEFormat;
    }

  • 通过InlineShape访问

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取所有嵌入式图形对象
      const shapes = await app.ActiveDocument.InlineShapes;
    
      //获取第1个嵌入式图形对象
      const shape = await shapes.Item(1);  
    
      //获取该嵌入式图形对象的OLE特征
      const OLEFormat = await shape.OLEFormat;
    }

属性

ActiveDocument.Shapes.Item(Index).OLEFormat.ProgID

通过ProgID属性，您可以获取OLE对象的ProgID（编程标识符）。

• 语法

  表达式.ActiveDocument.Shapes.Item(Index).OLEFormat.ProgID

  或者表达式.ActiveDocument.InlineShapes.Item(Index).OLEFormat.ProgID

  表达式：文档类型应用对象

• 示例

  • 通过Shape访问

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取所有非嵌入式图形对象
      const shapes = await app.ActiveDocument.Shapes;
    
      //获取第1个非嵌入式图形对象
      const shape = await shapes.Item(1);
    
      //获取该非嵌入式图形对象的OLE特征
      const OLEFormat = await shape.OLEFormat;
    
      //获取该非嵌入式图形对象的ProgID
      const ProgID = OLEFormat.ProgID;
      console.log(ProgID);
    }

  • 通过InlineShape访问

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取所有嵌入式图形对象
      const shapes = await app.ActiveDocument.InlineShapes;
    
      //获取第1个嵌入式图形对象
      const shape = await shapes.Item(1);  
    
      //获取该嵌入式图形对象的OLE特征
      const OLEFormat = await shape.OLEFormat;
    
      //获取该嵌入式图形对象的ProgID
      const ProgID = OLEFormat.ProgID;
      console.log(ProgID);
    }