Intelligent Media Management：Workbook

Workbook

Workbook

擷取使用中視窗中的活動活頁簿。

• 文法

  運算式.ActiveWorkbook

  運算式：文件類型應用對象

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿
    const activeWorkbook = await app.ActiveWorkbook;
  }

方法

ActiveWorkbook.CopySheetFromBook()

通過CopySheetFromBook()方法，您可以將指定活動活頁簿中的使用中工作表複製到當前活動活頁簿。

• 文法

  運算式.ActiveWorkbook.CopySheetFromBook({ FromBookFileId, FromBookFileName, FromeSheetName, DestSheetName })

  運算式：文件類型應用對象

• 參數

  屬性	資料類型	是否必填	描述
  FromBookFileId	String	是	目標活動活頁簿的ID
  FromBookFileName	String	否	目標活動活頁簿的名稱。
  FromeSheetName	String	否	目標活動活頁簿中使用中工作表名稱。
  DestSheetName	String	否	需要複製到當前活動活頁簿的使用中工作表名稱。

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿
    const activeWorkbook = await app.ActiveWorkbook;
  
    //將ID為“100161090439”，名稱為“活頁簿”的活動活頁簿中名稱為“Sheet”的使用中工作表複製到當前活活頁簿中名稱為“Sheet6”的使用中工作表
    const result = await activeWorkbook.CopySheetFromBook('100161090439', '活頁簿', 'Sheet1', 'Sheet6');
    console.log(result);
  }

ActiveWorkbook.ExportAsFixedFormat()

通過ExportAsFixedFormat()方法，您可以將當前活動活頁簿匯出為對應的PDF或IMG圖片，並擷取匯出檔案的URL。

• 文法

  運算式.ActiveWorkbook.ExportAsFixedFormat({ Type })

  運算式：文件類型應用對象

• 參數

  屬性	資料類型	是否必填	描述
  Type	Enum	否	匯出的檔案類型，目前僅支援匯出圖片和PDF。更多資訊，請參見XlFixedFormatType。

• 傳回值

  屬性	資料類型	描述
  url	String	匯出檔案的URL。

• 樣本

  • 匯出為PDF

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //匯出為PDF，並擷取匯出檔案的URL
      const workbookPdfUrl = await app.ActiveWorkbook.ExportAsFixedFormat();
      console.log(workbookPdfUrl);
    }
    

  • 匯出為圖片

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //匯出為圖片，並擷取匯出檔案的URL
      const workbookImgUrl = await app.ActiveWorkbook.ExportAsFixedFormat({
        Type: app.Enum.XlFixedFormatType.xlTypeIMG,
      });
      console.log(workbookImgUrl);
    }

ActiveWorkbook.GetOperatorsInfo()

通過GetOperatorsInfo()方法，您可以擷取當前登入操作者的資訊。

• 文法

  運算式.ActiveWorkbook.GetOperatorsInfo()

  運算式：文件類型應用對象

• 傳回值

  • Object object

    屬性	資料類型	描述
    type	String	請求類型。
    response	Object	使用者資訊列表。

  • response結構

    屬性	資料類型	描述
    id	String	使用者ID。
    avatar_url	String	帳戶圖片。
    logined	String	使用者登入狀態。
    name	String	使用者姓名。

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取當前登入操作者資訊
    const operatorsInfo = await app.ActiveWorkbook.GetOperatorsInfo();
    console.log(operatorsInfo);
  }

ActiveWorkbook.SetFilterShared()

通過SetFilterShared()方法，您可以開啟或關閉多人同步篩選。

• 文法

  運算式.ActiveWorkbook.SetFilterShared({ Checked })

  運算式：文件類型應用對象

• 參數

  屬性	資料類型	是否必填	描述
  Checked	Boolean	是	是否開啟多人同步篩選。取值範圍如下： true：開啟。 false：關閉。

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿
    const activeWorkbook = await app.ActiveWorkbook;
  
    //開啟多人同步篩選
    const result = await activeWorkbook.SetFilterShared(true);
  }

ActiveWorkbook.Save()

通過Save()方法，您可以儲存活動活頁簿的改動。

• 文法

  運算式.ActiveWorkbook.Save()

  運算式：文件類型應用對象

• 傳回值

  屬性	資料類型	描述
  result	String	儲存狀態。取值範圍如下： ok：儲存成功，可在歷史版本中查看。 nochange：文檔無更新，無需儲存版本。 SavedEmptyFile：儲存空檔案，暫不支援。 觸發情境：核心儲存完後檔案為空白。 SpaceFull：空間已滿。 QueneFull：儲存中請勿頻繁操作。 觸發情境：服務端處理儲存隊列已滿，正在排隊。 fail：儲存失敗。
  size	Number	檔案大小，單位為位元組。
  version	Number	版本。

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //儲存活動活頁簿的改動
    const saveResult = await app.ActiveWorkbook.Save();
    console.log(saveResult);
  }

ActiveWorkbook.SwitchCardView()

通過SwitchCardView()方法，您可以開啟或關閉卡片視圖面板。

• 文法

  運算式.ActiveWorkbook.SwitchCardView()

  運算式：文件類型應用對象

• 參數

  屬性	資料類型	是否必填	描述
  Status	Boolean	是	開啟或關閉卡片視圖面板。取值範圍如下： true：開啟。 false：關閉，暫不支援。

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //開啟卡片視圖面板
    await app.ActiveWorkbook.SwitchCardView(true);
  }

ActiveWorkbook.QuitCellEdit()

通過QuitCellEdit()方法，您可以退出編輯。

• 文法

  運算式.ActiveWorkbook.QuitCellEdit()

  運算式：文件類型應用對象

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //退出編輯
    await app.ActiveWorkbook.QuitCellEdit();
  }

ActiveWorkbook.CloseDropdownPanels()

通過CloseDropdownPanels()方法，您可以關閉所有開啟的下拉麵板。

• 文法

  運算式.ActiveWorkbook.CloseDropdownPanels()

  運算式：文件類型應用對象

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //關閉所有開啟的下拉麵板
    await app.ActiveWorkbook.CloseDropdownPanels();
  }

ActiveWorkbook.CloseHyperLink()

通過CloseHyperLink()方法，您可以關閉超連結。

• 文法

  運算式.ActiveWorkbook.CloseHyperLink()

  運算式：文件類型應用對象

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //關閉超連結
    await app.ActiveWorkbook.CloseHyperLink();
  }

ActiveWorkbook.CloseFilterTips()

通過CloseFilterTips()方法，您可以關閉篩選hover提示。

• 文法

  運算式.ActiveWorkbook.CloseFilterTips()

  運算式：文件類型應用對象

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //關閉篩選hover提示
    await app.ActiveWorkbook.CloseFilterTips();
  }

ActiveWorkbook.SetCalcOptions()

通過SetCalcOptions()方法，您可以配置迭代計算。

• 文法

  運算式.ActiveWorkbook.SetCalcOptions()

  運算式：文件類型應用對象

• 參數

  屬性	資料類型	是否必填	描述
  EnableIterate	Boolean	否	是否啟用迭代計算。取值範圍如下： true：是。 false（預設）：否。
  IterateCount	Number	否	最多迭代次數。取值範圍為1~32767，預設值為100。
  IterateDelta	Number	否	最大誤差。取值範圍為大於等於0。預設值為0.001。
  FullPrecision	Boolean	否	計算是否以顯示精度為準。取值範圍如下： true：是。 false（預設）：否。
  CalcMode	Enum	否	迭代計算模式。更多資訊，請參見XlCalcModeType。
  Callback	Function	否	回呼函數。

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //配置迭代計算
    await app.ActiveWorkbook.SetCalcOptions({
      EnableIterate: false, 
      IterateCount: 300,
      IterateDelta: 0.1, 
      FullPrecision: false, 
      CalcMode: 'automatic',
      Callback:(res)=>console.error('回呼函數',res)
    })
  }

ActiveWorkbook.ClearTransactions()

通過ClearTransactions()方法，您可以清除撤銷記錄。

• 文法

  運算式.ActiveWorkbook.ClearTransactions()

  運算式：文件類型應用對象

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //清除撤銷記錄
    await app.ActiveWorkbook.ClearTransactions()
  }

ActiveWorkbook.HasTransactions()

通過HasTransactions()方法，您可以判斷是否含有撤銷記錄。

• 文法

  運算式.ActiveWorkbook.HasTransactions()

  運算式：文件類型應用對象

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //判斷是否含有撤銷記錄
    await app.ActiveWorkbook.HasTransactions()
  }

ActiveWorkbook.GetComments()

通過GetComments()方法，您可以擷取整個活動活頁簿的評論。

• 文法

  運算式.ActiveWorkbook.GetComments()

  運算式：文件類型應用對象

• 傳回值

  屬性	資料類型	描述
  CellComments	Array<Object>	評論資訊集合。
  PosInfo	String	儲存格資訊。
  SheetName	String	工作表名稱。
  UserIds	Array<String>	使用者ID集合。

• 評論資訊集合

  屬性	資料類型	描述
  DateTime	String	時間戳記。
  Text	String	評論文本。
  Time	String	轉換後的時間。
  UserId	String	使用者ID。

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取整個活動活頁簿的評論
    const comments = await app.ActiveWorkbook.GetComments();
    console.log(comments);
  }

ActiveWorkbook.SkipAtCell()

通過SkipAtCell()方法，您可以跳轉到@所在的儲存格。

• 文法

  運算式.ActiveWorkbook.SkipAtCell()

  運算式：文件類型應用對象

• 參數

  屬性	資料類型	是否必填	描述
  AtId	String	是	@的ID。

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //跳轉到@所在儲存格
    await app.ActiveWorkbook.SkipAtCell(AtId)
  }

ActiveWorkbook.SetWatermark()

通過SetWatermark()方法，您可以設定浮水印。

• 文法

  運算式.ActiveWorkbook.SetWatermark()

  運算式：文件類型應用對象

• 參數

  屬性	資料類型	是否必填	描述
  Type	Number	是	是否有浮水印。取值範圍如下： 1：有。 0：無。
  Value	String	是	浮水印文字。
  FillStyle	String	是	填充樣式。
  Font	String	是	浮水印字型。
  Rotate	Number	是	旋轉度。
  Horizontal	Number	是	水平間距。
  Vertical	Number	是	垂直間距。

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //設定浮水印
    await app.ActiveWorkbook.SetWatermark({
      Type: 1,
      Value: "測試浮水印",
      FillStyle: 'rgba(192, 192, 192, 0.6)',
      Font: "bold 20px Serif",
      Rotate: -45 * Math.PI / 180,
      Horizontal: 50,
      Vertical: 100,
    });
  }

ActiveWorkbook.GetWatermark()

通過GetWatermark()方法，您可以擷取浮水印。

• 文法

  運算式.ActiveWorkbook.GetWatermark()

  運算式：文件類型應用對象

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //擷取浮水印
    await app.ActiveWorkbook.GetWatermark();
  }

ActiveWorkbook.BuiltinDocumentProperties()

通過BuiltinDocumentProperties()方法，您可以擷取活動活頁簿的內建屬性。

• 文法

  運算式.ActiveWorkbook.BuiltinDocumentProperties({ Name })

  運算式：文件類型應用對象

• 參數

  屬性	資料類型	是否必填	描述
  Name	String	是	內建屬性，包含如下選項： Title：標題。 Security：安全值。 Size：大小。 Author：作者。 CorpId：企業編號。 Guid：安全文檔編號。

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //擷取活動活頁簿的內建屬性
    const title = await app.ActiveWorkbook.BuiltinDocumentProperties('Title').Value;
    console.log('title: ', title);
  }

ActiveWorkbook.CustomDocumentProperties()

通過CustomDocumentProperties()屬性，您可以擷取活動活頁簿的自訂文件屬性。

• 文法

  運算式.ActiveWorkbook.CustomDocumentProperties({ Name })

  運算式：文件類型應用對象

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //擷取活動活頁簿的自訂文件屬性
    const txt = await app.ActiveWorkbook.CustomDocumentProperties('AT_txt').Value;
    console.log('txt: ', txt);
  }

屬性

ActiveWorkbook.ActiveSheet

通過ActiveSheet屬性，您可以擷取活動活頁簿中的使用中工作表，使用方法可參考ActiveSheet，

• 文法

  運算式.ActiveWorkbook.ActiveSheet

  運算式：文件類型應用對象

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // 活動活頁簿
    const activeWorkbook = await app.ActiveWorkbook;
  
    // 使用中工作表
    const activeSheet = await activeWorkbook.ActiveSheet;
  }

ActiveWorkbook.Names

通過Names屬性，您可以擷取活動活頁簿名稱的集合。

• 文法

  運算式.ActiveWorkbook.Names

  運算式：文件類型應用對象

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿
    const activeWorkbook = await app.ActiveWorkbook;
  
    //擷取活頁簿名稱集合
    const names = await activeWorkbook.Names;
  }

ActiveWorkbook.Sheets

通過Sheets方法，您可以擷取活動活頁簿中的所有工作表。

• 文法

  運算式.ActiveWorkbook.Sheets

  運算式：文件類型應用對象

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取所有工作表
    const sheets = await app.ActiveWorkbook.Sheets;
  }

ActiveWorkbook.ReadOnly

通過ReadOnly屬性，您可以查看活動活頁簿是否唯讀。

• 文法

  運算式.ActiveWorkbook.ReadOnly

  運算式：文件類型應用對象

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //查看活動活頁簿是否唯讀
    const ReadOnly = await app.ActiveWorkbook.ReadOnly;
  }

ActiveWorkbook.ReadOnlyComment

通過ReadOnlyComment屬性，您可以查看活動活頁簿是否唯讀可評論。

• 文法

  運算式.ActiveWorkbook.ReadOnlyComment

  運算式：文件類型應用對象

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //查看活動活頁簿是否唯讀可評論
    const ReadOnlyComment = await app.ActiveWorkbook.ReadOnlyComment;
  }

ActiveWorkbook.SupportReadOnlyComment

通過SupportReadOnlyComment屬性，您可以查看活動活頁簿是否支援唯讀可評論，此屬性為唯讀屬性。

• 文法

  運算式.ActiveWorkbook.SupportReadOnlyComment

  運算式：文件類型應用對象

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    //查看活動活頁簿是否支援唯讀可評論
    const SupportReadOnlyComment = await app.ActiveWorkbook.SupportReadOnlyComment;
  }