Intelligent Media Management:シート

シート

ActiveWorkbook.Sheets

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

• 構文

  expression.ActiveWorkbook.Sheets

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // ワークブック内のすべてのワークシートを取得します。
    const sheets = await app.ActiveWorkbook.Sheets;
  }

メソッド

ActiveWorkbook.Sheets.Add()

新しいワークシートを追加します。

• 構文

  expression.ActiveWorkbook.Sheets.Add({ Before, After, Count, Type, Name })

  expression: アプリケーションオブジェクト。

• パラメーター

  パラメーター	型	必須	説明
  Before	String/Number	はい	新しいワークシートを追加する前に配置するワークシートを指定するオブジェクト。
  After	String/Number	いいえ	新しいワークシートを追加した後に配置するワークシートを指定するオブジェクト。
  Count	Number	いいえ	追加するワークシートの数。デフォルト値：1。
  Type	Enum	いいえ	新しいワークシートのタイプ。詳細については、「XlSheetType」をご参照ください。
  Name	Name	いいえ	新しいワークシートの名前。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // ワークブック内のすべてのワークシートを取得します。
    const sheets = await app.ActiveWorkbook.Sheets;
  
    // ワークシートを追加します。
    await worksheets.Add(null, null, 1, app.Enum.XlSheetType.xlWorksheet, 'new worksheet');
  }

プロパティ

ActiveWorkbook.Sheets.Count

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

• 構文

  expression.ActiveWorkbook.Sheets.Count

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // ワークブック内のすべてのワークシートを取得します。
    const sheets = await app.ActiveWorkbook.Sheets;
  
    // ワークシートの数を取得します。
    const count = await sheets.Count;
    console.log(count);
  }

シート

ActiveWorkbook.Sheets.Item(Index)

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

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Item

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    // ワークブック内のすべてのワークシートを取得します。
    const sheet = await app.ActiveWorkbook.Sheets.Item(1)
  }

メソッド

ActiveWorkbook.Sheets.Item(Index).Delete()

アクティブなワークブックからワークシートを削除します。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Delete()

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    const activeSheet = await app.ActiveWorkbook.Sheets.Item(1);
  
    await activeSheet.Delete();
  } 

ActiveWorkbook.Sheets.Item(Index).ExportAsFixedFormat()

指定されたワークシートを PDF または IMG ファイルとしてエクスポートし、エクスポートされたファイルの URL を返します。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).ExportAsFixedFormat({ Type })

  expression: アプリケーションオブジェクト。

• パラメーター

  パラメーター	型	必須	説明
  Type	Enum	いいえ	エクスポートするファイル形式のタイプ。詳細については、「XlFixedFormatType」をご参照ください。 説明 IMG ファイルと PDF ファイルのみがサポートされています。

• 戻り値

  パラメーター	型	説明
  url	string	エクスポートされたファイルの URL。

• 例

  • ワークシートを PDF としてエクスポートする

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      // ワークシート全体をエクスポートします。
      const workbookPdfUrl = await app.ActiveWorkbook.Sheets.Item(1).ExportAsFixedFormat();
      console.log(workbookPdfUrl);
    }

  • ワークシートをイメージとしてエクスポートする

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      // ワークシート全体をエクスポートします。
      const workbookPdfUrl = await app.ActiveWorkbook.Sheets.Item(1).ExportAsFixedFormat();
      console.log(workbookPdfUrl);
    }

ActiveWorkbook.Sheets.Item(Index).Protect()

指定されたワークシートを修正から保護します。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Protect({ Password, DrawingObjects, Scenarios, AllowSelLockedCells, AllowSelUnlockedCells, AllowFormattingCells, AllowFormattingColumns, AllowFormattingRows, AllowInsertingColumns, AllowInsertingRows, AllowInsertingHyperlinks, AllowDeletingColumns, AllowDeletingRows, AllowSorting, AllowFiltering, AllowUsingPivotTables })

  expression: アプリケーションオブジェクト。

• パラメーター

  パラメーター	型	デフォルト値	必須	備考
  Password	String		いいえ	ワークシートまたはワークブックの大文字と小文字を区別するパスワードを指定する文字列。このパラメーターを省略した場合、パスワードを使用せずにワークシートまたはワークブックから保護を解除できます。それ以外の場合は、ワークシートまたはワークブックから保護を解除するためにパスワードを指定する必要があります。パスワードを忘れた場合は、ワークシートまたはワークブックから保護を解除できません。
  DrawingObjects	Boolean	false	いいえ	このパラメーターを true に設定すると、図形が保護されます。
  Scenarios	Boolean	true	いいえ	このパラメーターを true に設定すると、シナリオが保護されます。このパラメーターはワークシートにのみ適用されます。
  AllowSelLockedCells	Boolean	true	いいえ
  AllowSelUnLockedCells	Boolean	true	いいえ
  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.Sheets.Item(1);
  
    activeSheet.Protect('123456');
  }

ActiveWorkbook.Sheets.Item(Index).Unprotect()

ワークシートから保護を解除します。ワークシートが保護されていない場合、このメソッドは効果がありません。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Unprotect({ Password })

  expression: アプリケーションオブジェクト。

• パラメーター

  パラメーター	型	必須	説明
  Password	String	いいえ	ワークシートの保護に使用されるパスワード。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    const activeSheet = await app.ActiveWorkbook.Sheets.Item(1);
  
    activeSheet.Unprotect('123456');
  }

ActiveWorkbook.Sheets.Item(Index).Activate()

指定されたワークシートをアクティブなワークシートにします。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Activate()

  または expression.Sheets(Index).Activate()

  expression: アプリケーションオブジェクト。

• パラメーター

  パラメーター	型	必須	説明
  Index	Number	はい	ワークシートのインデックス番号。

• 例

  • 例 1

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      // 指定されたワークシートをアクティブなワークシートにします。
      const worksheetIndex = 2; // ワークシートのインデックス番号。番号は 1 から始まります。
      app.ActiveWorkbook.Sheets.Item(sheetIndex).Activate();
    }

  • 例 2

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      // 指定されたワークシートをアクティブなワークシートにします。
      const worksheetIndex = 2; // ワークシートのインデックス番号。番号は 1 から始まります。
      app.Sheets(sheetIndex).Activate();
    }

ActiveWorkbook.Sheets.Item(Index).Move()

ワークシートをワークブック内の別の場所に移動します。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Move({ Before, After })

  expression: アプリケーションオブジェクト。

• パラメーター

  パラメーター	型	必須	説明
  Before	number	いいえ	移動されたワークシートを配置する前のワークシートの ID。After を指定する場合は、Before を指定できません。
  After	number	いいえ	移動されたワークシートを配置する後のワークシートの ID。Before を指定する場合は、After を指定できません。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    await app.ActiveWorkbook.Sheets(1).Move({
      Before: null,
      After: await app.ActiveWorkbook.Sheets(2).Id,
    })
  }

プロパティ

ActiveWorkbook.Sheets.Item(Index).Type

指定されたワークシートのタイプを返します。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Type

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // ワークブック内のすべてのワークシートを取得します。
    const worksheetIndex = 2; // ワークシートのインデックス番号。番号は 1 から始まります。
    const sheet = await app.ActiveWorkbook.Sheets.Item(worksheetIndex)
  
    // ワークシートのタイプを取得します。
    const Type = await sheet.Type;
    console.log(Type);
  }

ActiveWorkbook.Sheets.Item(Index).Columns

指定されたワークシートのすべての列を返します。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Columns

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    const activeSheet = await app.ActiveWorkbook.Sheets.Item(1);
  
    const chartObjects = await activeSheet.Columns;
  }

ActiveWorkbook.Sheets.Item(Index).Range

セルまたはセルの範囲を返します。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Range

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // ワークブック内のすべてのワークシートを取得します。
    const Sheet = await app.ActiveWorkbook.Sheets.Item(1);
  
    // ワークシート内のセルまたはセルの範囲を取得します。
    const Range = await Sheet.Range;
  
    // セルを指定します。
    const range = await Range.Item("D2");
    // range=await Range("D2") を使用してセルを指定することもできます。
  
    // セル D2 を選択します。
    await range.Select();
  }

ActiveWorkbook.Sheets.Item(Index).Cells

指定されたワークシートのすべてのセルを返します。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Cells

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // ワークブック内のすべてのワークシートを取得します。
    const Sheet = await app.ActiveWorkbook.Sheets.Item(1);
  
    // セルオブジェクトを取得します。
    const cells = await Sheet.Cells;
  
    // セルを指定します。
    const cell = await cells.Item(1);
    // あるいは、cell = await cells(1) を使用します。
  
    // 最初のセルを選択します。
    await cell.Select();
  }

ActiveWorkbook.Sheets.Item(Index).Name

指定されたワークシートの名前を返します。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Name

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
    
    const name = await app.ActiveWorkbook.Sheets.Item(1).Name;
    console.log(name);
  }

ActiveWorkbook.Sheets.Item(Index).Names

すべてのワークシート固有の名前を返します。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Names

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    const activeSheet = await app.ActiveWorkbook.Sheets.Item(1);
  
    const names = await activeSheet.Names;
  }

ActiveWorkbook.Sheets.Item(Index).Rows

指定されたワークシートのすべての行を返します。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Rows

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // ワークブック内のすべてのワークシートを取得します。
    const Sheet = await app.ActiveWorkbook.Sheets.Item(1);
  
    // 行を取得します。
    const Rows = await Sheet.Rows;
  
    // 行を指定します。
    const row = await Rows.Item(1);
    // あるいは、row = await Rows(1) を使用します
  
    // 最初の行を選択します。
    await row.Select();
  }

ActiveWorkbook.Sheets.Item(Index).UsedRange

指定されたワークシートで使用されている範囲を返します。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).UsedRange

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    // ワークブック内のすべてのワークシートを取得します。
    const Sheet = await app.ActiveWorkbook.Sheets.Item(1);
  
    // ワークシートで使用されている範囲を取得します。
    const UsedRange = await Sheet.UsedRange;
  
    // 使用されている範囲を選択します。
    UsedRange.Select();
  }

ActiveWorkbook.Sheets.Item(Index).Index

指定されたワークシートのインデックス番号を返します。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Index

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    const index = await app.ActiveWorkbook.Sheets.Item(1).Index;
    console.log(index);
  }

ActiveWorkbook.Sheets.Item(Index).Shapes

指定されたワークシートのすべての図形を返します。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Shapes

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    const activeSheet = await app.ActiveWorkbook.Sheets.Item(1);
  
    const shapes = await activeSheet.Shapes;
  }

ActiveWorkbook.Sheets.Item(Index).Visible

Visible プロパティを使用すると、ワークシートが表示されるかどうかを指定および取得できます。

• 構文

  expression.ActiveWorkbook.Sheets.Item(Index).Visible = Boolean

  expression: アプリケーションオブジェクト。

  Boolean に true を指定すると、ワークシートが表示されます。false を指定すると、ワークシートは非表示になります。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    const visible = await app.ActiveWorkbook.Sheets.Item(1).Visible;
    console.log(visible);
  
    app.ActiveWorkbook.Sheets.Item(1).Visible = false;
  }

ActiveWorkbook.Sheets.Item(Index).Id

指定されたワークシートの ID を返します。

• 構文

  expression.ActiveWorkbook.ActiveSheet.Shapes.Item(Index).ID

  expression: アプリケーションオブジェクト。

• 例

  async function example() {
    await instance.ready();
  
    const app = instance.Application;
  
    const id = await app.ActiveWorkbook.Sheets.Item(1).Id;
    console.log(id);
  }