Intelligent Media Management：ActiveSheet

ActiveSheet

ActiveWorkbook.ActiveSheet

擷取活動活頁簿中的使用中工作表。

• 文法

  運算式.ActiveWorkbook.ActiveSheet

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

• 樣本

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

方法

ActiveWorkbook.ActiveSheet.Delete()

通過Delete()方法，您可以刪除使用中工作表。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.Delete()

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

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //刪除該使用中工作表
    await activeSheet.Delete();
  }

ActiveWorkbook.ActiveSheet.ExportAsFixedFormat()

通過ExportAsFixedFormat()方法，您可以將當前使用中工作表匯出為對應的PDF或IMG圖片，並擷取匯出檔案的URL。

• 文法

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

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

• 參數

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

• 傳回值

  返回匯出檔案的URL。

• 樣本

  • 匯出為PDF

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

  • 匯出為圖片

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

ActiveWorkbook.ActiveSheet.Protect()

通過Protect()方法，您可以設定保護使用中工作表使其不被修改。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.Protect({ Password, DrawingObjects, Scenarios, AllowFormattingCells, AllowFormattingColumns, AllowFormattingRows, AllowInsertingColumns, AllowInsertingRows, AllowInsertingHyperlinks, AllowDeletingColumns, AllowDeletingRows, AllowSorting, AllowFiltering, AllowUsingPivotTables })

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

• 參數

  屬性	資料類型	是否必填	描述
  Password	String	否	指定使用中工作表的密碼。該密碼字串區分大小寫。 省略此參數，可以不使用密碼解除對使用中工作表的保護。 使用此參數，則必須使用指定密碼才能解除對使用中工作表的保護。 重要 請務必牢記設定的密碼，如果忘記密碼，則無法解除對使用中工作表的保護。
  DrawingObjects	Boolean	否	是否保護使用中工作表形狀。取值範圍如下： false（預設）：否。 true：是。
  Scenarios	Boolean	否	是否保護使用中工作表方案。取值範圍如下： true（預設）：是。 false：否。
  AllowFormattingCells	Boolean	否	是否允許使用者格式化受保護使用中工作表上的任何儲存格。取值範圍如下： false（預設）：否。 true：是。
  AllowFormattingColumns	Boolean	否	是否允許使用者格式化受保護使用中工作表上的任何列。取值範圍如下： false（預設）：否。 true：是。
  AllowFormattingRows	Boolean	否	是否允許使用者格式化受保護的使用中工作表上的任何行。取值範圍如下： false（預設）：否。 true：是。
  AllowInsertingColumns	Boolean	否	是否允許使用者在受保護使用中工作表上插入列。取值範圍如下： false（預設）：否。 true：是。
  AllowInsertingRows	Boolean	否	是否允許使用者在受保護使用中工作表上插入行。取值範圍如下： false（預設）：否。 true：是。
  AllowInsertingHyperlinks	Boolean	否	是否允許使用者在受保護的使用中工作表上插入超連結。取值範圍如下： false（預設）：否。 true：是。
  AllowDeletingColumns	Boolean	否	是否允許使用者在受保護的使用中工作表上刪除列。取值範圍如下： false（預設）：否。 true：是。要刪除的列中的每個儲存格都必須處於解鎖狀態。
  AllowDeletingRows	Boolean	否	是否允許使用者在受保護的使用中工作表上刪除行。取值範圍如下： false（預設）：否。 true：是。要刪除的行中的每個儲存格都必須處於解鎖狀態。
  AllowSorting	Boolean	否	是否允許使用者對受保護的使用中工作表進行排序。取值範圍如下： false（預設）：否。 true：是。排序範圍內的每個儲存格都必須處於解鎖或不受保護的狀態。
  AllowFiltering	Boolean	否	是否允許使用者在受保護的使用中工作表上設定篩選。取值範圍如下： false（預設）：否。 true：是。使用者可以在現有自動篩選上設定篩選或更改篩選條件，但無法啟用或禁用自動篩選。
  AllowUsingPivotTables	Boolean	否	是否允許使用者在受保護的使用中工作表上使用樞紐分析表。取值範圍如下： false（預設）：否。 true：是。

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //設定密碼
    activeSheet.Protect('123456');
  }

ActiveWorkbook.ActiveSheet.Unprotect()

通過Unprotect()方法，您可以解除使用中工作表中的保護，如果使用中工作表未受保護，則此方法無效。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.Unprotect({ Password })

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

• 參數

  屬性	資料類型	是否必填	描述
  Password	String	否	設定的密碼。

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //解除保護
    activeSheet.Unprotect('123456');
  }

ActiveWorkbook.ActiveSheet.Move()

通過Move()方法，您可以移動使用中工作表。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.Move({ Before, After })

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

• 參數

  屬性	資料類型	是否必填	描述
  Before	number	否	指定的使用中工作表ID。將目標使用中工作表移動到該使用中工作表之前。如果指定Before，則不能指定After。
  After	number	否	指定的使用中工作表ID。將目標使用中工作表移動到該使用中工作表之後。如果指定After，則不能指定Before。

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //將目標使用中工作表移動到該使用中工作表之後
    await app.ActiveWorkbook.Sheets(1).Move({
      Before: null,
      After: await app.ActiveWorkbook.Sheets(2).Id,
  }

ActiveWorkbook.ResetClipBoard()

通過ResetClipBoard()方法，您可以清除複製螞蟻線。

• 文法

  運算式.ActiveWorkbook.ResetClipBoard({ Range })

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

• 樣本

  //@file=base.xlsx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    const range = await app.Selection;
    //清除複製螞蟻線
    await app.ActiveWorkbook.ResetClipBoard()
  }

屬性

ActiveWorkbook.ActiveSheet.Cells

通過Cells屬性，您可以擷取使用中工作表中的所有儲存格。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.Cells

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

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //擷取使用中工作表中的所有儲存格
    const cells = await activeSheet.Cells;
  }

ActiveWorkbook.ActiveSheet.Columns

通過Columns屬性，您可以擷取使用中工作表中的所有列。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.Columns

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

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //擷取使用中工作表中的所有列
    const chartObjects = await activeSheet.Columns;
  }

ActiveWorkbook.ActiveSheet.Index

通過Index屬性，您可以擷取使用中工作表對應的索引號。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.Index

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

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //擷取使用中工作表對應的索引號
    const index = await activeSheet.Index;
    console.log(index);
  }

ActiveWorkbook.ActiveSheet.Name

通過Name屬性，您可以擷取使用中工作表對應的名稱。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.Name

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

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //擷取使用中工作表對應的名稱
    const name = await app.ActiveWorkbook.ActiveSheet.Name;
    console.log(name);
  }

ActiveWorkbook.ActiveSheet.Names

通過Names屬性，您可以擷取使用中工作表的所有特定名稱。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.Names

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

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //擷取使用中工作表的所有特定名稱
    const names = await activeSheet.Names;
  }

ActiveWorkbook.ActiveSheet.Range

通過Range屬性，您可以擷取使用中工作表中的一個儲存格、一行、一列、一個包含單個或若干連續儲存格範圍的選定儲存格範圍。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.Range

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

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //擷取使用中工作表中的一個儲存格範圍
    const range = await app.Range('A1');
  }

ActiveWorkbook.ActiveSheet.Rows

通過Rows屬性，您可以擷取使用中工作表中的所有行。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.Rows

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

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //擷取使用中工作表中的所有行
    const chartObjects = await activeSheet.Rows;
  }

ActiveWorkbook.ActiveSheet.Shapes

通過Shapes屬性，您可以擷取使用中工作表中的所有繪圖物件。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.Shapes

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

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //擷取使用中工作表中的所有繪圖物件
    const shapes = await activeSheet.Shapes;
  }

ActiveWorkbook.ActiveSheet.Visible

通過Visible屬性，您可以設定使用中工作表是否可見。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.Visible

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

  Visible取值為true時，表示使用中工作表可見，取值為false時，表示使用中工作表不可見。

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //設定使用中工作表不可見
    activeSheet.Visible = false;
  }

ActiveWorkbook.ActiveSheet.UsedRange

通過UsedRange屬性，您可以擷取使用中工作表中的所用地區。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.UsedRange

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

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //擷取使用中工作表的所用地區
    const UsedRange = await activeSheet.UsedRange;
  }

ActiveWorkbook.ActiveSheet.Type

通過Type屬性，您可以擷取使用中工作表的類型。使用中工作表包含xlWorksheet（普通工作表）、xlEtDataBaseSheet（空白資料表）和xlEtDashBoardSheet（儀表板）三種類型。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.Type

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

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //擷取使用中工作表的類型
    const type = await activeSheet.Type;
    console.log(type);
  }

ActiveWorkbook.ActiveSheet.Id

通過Id屬性，您可以擷取使用中工作表的編號。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.Id

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

• 樣本

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //擷取活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //擷取使用中工作表的編號
    const id = await activeSheet.Id;
    console.log(id);
  }

ActiveWorkbook.ActiveSheet.ChartObjects

通過ChartObjects屬性，您可以擷取工作表上的所有圖表。

• 文法

  運算式.ActiveWorkbook.ActiveSheet.ChartObjects

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

• 樣本

  //@file=base.xlsx
  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    //活動活頁簿中的使用中工作表
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    //工作表上的所有圖表
    const chartObjects = await activeSheet.ChartObjects;
  }

  ActiveWorkbook.ActiveSheet.AllowEditRanges

  擷取活動活頁簿中的使用中工作表的可編輯區域。

  • 文法

    運算式.ActiveWorkbook.ActiveSheet.AllowEditRanges

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

  • 樣本

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //擷取活動活頁簿中的使用中工作表
      const activeSheet = await app.ActiveWorkbook.ActiveSheet;
    
      //擷取使用中工作表的可編輯區域
      const allowEditRanges = await activeSheet.AllowEditRanges;
    }