Intelligent Media Management:ActiveSheet

ActiveSheet

ActiveWorkbook.ActiveSheet

アクティブなワークブック内のアクティブなシートを取得します。

• 構文

  expression.ActiveWorkbook.ActiveSheet

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // アクティブなワークブックを取得します。
    const activeWorkbook = await app.ActiveWorkbook;
  
    // アクティブなワークブック内のアクティブなワークシートを取得します。
    const activeSheet = await activeWorkbook.ActiveSheet;
  }

メソッド

ActiveWorkbook.ActiveSheet.Delete()

Delete() メソッドを使用して、アクティブなワークシートを削除できます。

• 構文

  expression.ActiveWorkbook.ActiveSheet.Delete()

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• 例

  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 を取得できます。

• 構文

  expression.ActiveWorkbook.ActiveSheet.ExportAsFixedFormat({ Type })

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• パラメータ

  プロパティ	タイプ	必須	説明
  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() メソッドを使用して、アクティブなワークシートを保護して変更できないようにすることができます。

• 構文

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

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• パラメータ

  プロパティ	タイプ	必須	説明
  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() メソッドを使用して、アクティブなワークシートから保護を解除できます。アクティブなワークブックが保護されていない場合、このメソッドは何の効果もありません。

• 構文

  expression.ActiveWorkbook.ActiveSheet.Unprotect({ Password })

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• パラメータ

  プロパティ	タイプ	必須	説明
  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() メソッドを使用して、アクティブなワークブックを移動できます。

• 構文

  expression.ActiveWorkbook.ActiveSheet.Move({ Before, After })

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• パラメータ

  プロパティ	タイプ	必須	説明
  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() メソッドを使用して、コピーしたセルの周囲のマーチングアントを削除できます。

• 構文

  expression.ActiveWorkbook.ResetClipBoard({ Range })

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• 例

  //@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 プロパティを使用して、アクティブなワークシート内のすべてのセルを取得できます。

• 構文

  expression.ActiveWorkbook.ActiveSheet.Cells

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• 例

  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 プロパティを使用して、アクティブなワークシート内のすべての列を取得できます。

• 構文

  expression.ActiveWorkbook.ActiveSheet.Columns

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• 例

  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 プロパティを使用して、アクティブなワークシートのインデックス番号を取得できます。

• 構文

  expression.ActiveWorkbook.ActiveSheet.Index

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• 例

  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 プロパティを使用して、アクティブなワークシートの名前を取得できます。

• 構文

  expression.ActiveWorkbook.ActiveSheet.Name

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• 例

  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 プロパティを使用して、アクティブなワークシートのすべてのワークシート固有の名前を取得できます。

• 構文

  expression.ActiveWorkbook.ActiveSheet.Names

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• 例

  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 プロパティを使用して、アクティブなワークシート内のセル、行、列、または 1 つ以上の連続したセルの範囲を取得できます。

• 構文

  expression.ActiveWorkbook.ActiveSheet.Range

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• 例

  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 プロパティを使用して、アクティブなワークシート内のすべての行を取得できます。

• 構文

  expression.ActiveWorkbook.ActiveSheet.Rows

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• 例

  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 プロパティを使用して、アクティブなワークシート内のすべての Shape オブジェクトを取得できます。

• 構文

  expression.ActiveWorkbook.ActiveSheet.Shapes

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• 例

  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 プロパティを使用して、アクティブなワークシートが表示されるかどうかを指定できます。

• 構文

  expression.ActiveWorkbook.ActiveSheet.Visible

  expression: ドキュメント タイプ アプリケーション オブジェクト。

  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 プロパティを使用して、アクティブなワークシートで使用されている範囲を取得できます。

• 構文

  expression.ActiveWorkbook.ActiveSheet.UsedRange

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• 例

  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（ダッシュボード）の 3 つのタイプがあります。

• 構文

  expression.ActiveWorkbook.ActiveSheet.Type

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• 例

  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 プロパティを使用して、アクティブなワークシートの ID を取得できます。

• 構文

  expression.ActiveWorkbook.ActiveSheet.Id

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // アクティブなワークブック内のアクティブなワークシートを取得します。
    const activeSheet = await app.ActiveWorkbook.ActiveSheet;
  
    // アクティブなワークシートの ID を取得します。
    const id = await activeSheet.Id;
    console.log(id);
  }

ActiveWorkbook.ActiveSheet.ChartObjects

ChartObjects プロパティを使用して、ワークシート内のすべてのチャートを取得できます。

• 構文

  expression.ActiveWorkbook.ActiveSheet.ChartObjects

  expression: ドキュメント タイプ アプリケーション オブジェクト。

• 例

  //@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

  アクティブなワークブックのアクティブなワークシート内の、編集が許可された範囲を取得します。

  • 構文

    expression.ActiveWorkbook.ActiveSheet.AllowEditRanges

    expression: ドキュメント タイプ アプリケーション オブジェクト。

  • 例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      // アクティブなワークブック内のアクティブなワークシートを取得します。
      const activeSheet = await app.ActiveWorkbook.ActiveSheet;
    
      // アクティブなワークシート内の、編集が許可された範囲を取得します。
      const allowEditRanges = await activeSheet.AllowEditRanges;
    }