Excel.Worksheet class

ワークシートの AutoFilter オブジェクトを表します。

readonly autoFilter: Excel.AutoFilter;

プロパティ値

注釈

[API セット: ExcelApi 1.9]

ワークシートの一部であるグラフのコレクションを返します。

readonly charts: Excel.ChartCollection;

プロパティ値

注釈

[API セット: ExcelApi 1.1]

ワークシート上のすべての Comments オブジェクトの集まりを返します。

readonly comments: Excel.CommentCollection;

プロパティ値

注釈

[API セット: ExcelApi 1.10]

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

ワークシート レベルのカスタム プロパティのコレクションを取得します。

readonly customProperties: Excel.WorksheetCustomPropertyCollection;

プロパティ値

注釈

[API セット: ExcelApi 1.12]

必要に応じてワークシートを再計算するかどうかを決定します。 必要に応じてワークシートを再計算する場合は true。 Excel がシートを再計算しない場合は false。

enableCalculation: boolean;

プロパティ値

注釈

[API セット: ExcelApi 1.9]

ワークシート上のフリーズしたウィンドウの操作に使用できるオブジェクトを取得します。

readonly freezePanes: Excel.WorksheetFreezePanes;

プロパティ値

注釈

[API セット: ExcelApi 1.7]

ワークシートの水平改ページをまとめて取得します。 このコレクションには、手動の改ページのみが含まれます。

readonly horizontalPageBreaks: Excel.PageBreakCollection;

プロパティ値

注釈

[API セット: ExcelApi 1.9]

指定されたブックのワークシートを一意に識別する値を返します。 この識別子の値は、ワークシートの名前を変更したり移動したりしても同じままです。

readonly id: string;

プロパティ値

注釈

[API セット: ExcelApi 1.1]

ワークシートの表示名。 名前は 32 文字未満にする必要があります。

name: string;

プロパティ値

注釈

[API セット: ExcelApi 1.1]

現在のワークシートにスコープされている名前のコレクション。

readonly names: Excel.NamedItemCollection;

プロパティ値

注釈

[API セット: ExcelApi 1.4]

ワークシート内のすべてのノート オブジェクトのコレクションを返します。

readonly notes: Excel.NoteCollection;

プロパティ値

注釈

[API セット: ExcelApi 1.18]

ワークシートの PageLayout オブジェクトを取得します。

readonly pageLayout: Excel.PageLayout;

プロパティ値

注釈

[API セット: ExcelApi 1.9]

ワークシートの一部になっているピボットテーブルのコレクション。

readonly pivotTables: Excel.PivotTableCollection;

プロパティ値

注釈

[API セット: ExcelApi 1.3]

0 を起点とした、ブック内のワークシートの位置。

position: number;

プロパティ値

注釈

[API セット: ExcelApi 1.1]

ワークシートのシート保護オブジェクトを返します。

readonly protection: Excel.WorksheetProtection;

プロパティ値

注釈

[API セット: ExcelApi 1.2]

ワークシート上のすべての Shape オブジェクトをまとめて返します。

readonly shapes: Excel.ShapeCollection;

プロパティ値

注釈

[API セット: ExcelApi 1.9]

ワークシートにデータ型アイコンを表示するかどうかを指定します。 既定では、データ型アイコンが表示されます。

showDataTypeIcons: boolean;

プロパティ値

注釈

[API セット: ExcelApi 1.19]

グリッド線をユーザーに表示するかどうかを指定します。

showGridlines: boolean;

プロパティ値

注釈

[API セット: ExcelApi 1.8]

見出しをユーザーに表示するかどうかを指定します。

showHeadings: boolean;

プロパティ値

注釈

[API セット: ExcelApi 1.8]

ワークシートの一部であるスライサーのコレクションを返します。

readonly slicers: Excel.SlicerCollection;

プロパティ値

注釈

[API セット: ExcelApi 1.10]

ワークシート内のすべての行の標準 (既定) の高さ (ポイント数) を返します。

readonly standardHeight: number;

プロパティ値

注釈

[API セット: ExcelApi 1.7]

ワークシートのすべての列の標準 (既定) 幅を指定します。 列幅の単位は、標準スタイルの 1 文字分の幅に相当します。 プロポーショナル フォントでは、数字の 0 の幅が列幅の単位になります。

standardWidth: number;

プロパティ値

注釈

[API セット: ExcelApi 1.7]

ワークシートのタブの色。 タブ カラーを取得するときに、ワークシートが表示されない場合、値は nullになります。 ワークシートが表示されていてもタブの色が自動に設定されている場合は、空の文字列が返されます。 それ以外の場合は、プロパティは色 (#RRGGBB の形式 (例: "FFA500") に設定されます。 色を設定するときは、空の文字列を使用して "自動" 色を設定します。それ以外の場合は実際の色を設定します。

tabColor: string;

プロパティ値

注釈

[API セット: ExcelApi 1.7]

Open Office XML で読み取り可能な、このワークシートを表す値を返します。 これは整数値で、 worksheet.id (グローバル一意識別子を返す) や worksheet.name ("Sheet1" などの値を返す) とは異なります。

readonly tabId: number;

プロパティ値

注釈

[API セット: ExcelApi 1.14]

ワークシートの一部になっているグラフのコレクション。

readonly tables: Excel.TableCollection;

プロパティ値

注釈

[API セット: ExcelApi 1.1]

ワークシートの垂直改ページをまとめて取得します。 このコレクションには、手動の改ページのみが含まれます。

readonly verticalPageBreaks: Excel.PageBreakCollection;

プロパティ値

注釈

[API セット: ExcelApi 1.9]

ワークシートの可視性。

visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

プロパティ値

注釈

[API セット: 可視性の読み取り用 ExcelApi 1.1、設定用 1.2。]

Excel UI でワークシートをアクティブにします。

activate(): void;

返品

注釈

[API セット: ExcelApi 1.1]

ワークシート上のすべてのセルを計算します。

calculate(markAllDirty: boolean): void;

パラメーター

返品

注釈

[API セット: ExcelApi 1.6]

ワークシートをコピーし、指定した位置に配置します。

copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet): Excel.Worksheet;

パラメーター

返品

新しく作成されたワークシート。

注釈

[API セット: ExcelApi 1.7]

ワークシートをコピーし、指定した位置に配置します。

copy(positionType?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Excel.Worksheet): Excel.Worksheet;

パラメーター

返品

新しく作成されたワークシート。

注釈

[API セット: ExcelApi 1.7]

ブックからワークシートを削除します。 ワークシートの表示設定が "VeryHidden" に設定されている場合、削除操作は InvalidOperation 例外で失敗することに注意してください。 削除する前に、まず可視性を非表示または表示に変更する必要があります。

delete(): void;

返品

注釈

[API セット: ExcelApi 1.1]

指定された抽出条件に基づいて指定した文字列を検索し、1 つ以上の四角形の範囲からなる RangeAreas オブジェクトとして返します。 非表示のワークシート内のコンテンツは返されません。

findAll(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

パラメーター

返品

検索条件に一致する 1 つ以上の四角形の範囲で構成される RangeAreas オブジェクト。 この条件を満たすセルがない場合は、 ItemNotFound エラーがスローされます。

注釈

[API セット: ExcelApi 1.9]

指定された抽出条件に基づいて指定した文字列を検索し、1 つ以上の四角形の範囲からなる RangeAreas オブジェクトとして返します。 非表示のワークシート内のコンテンツは返されません。

findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

パラメーター

返品

検索条件に一致する 1 つ以上の四角形の範囲で構成される RangeAreas オブジェクト。 一致するものがない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

注釈

[API セット: ExcelApi 1.9]

行番号と列番号に基づいて、1 つのセルを含む Range オブジェクトを取得します。 ワークシート グリッド内にある限り、セルは親範囲の境界外に置かれてかまいません。

getCell(row: number, column: number): Excel.Range;

パラメーター

返品

注釈

[API セット: ExcelApi 1.1]

このワークシートの後に続くワークシートを取得します。 このワークシートの後にワークシートがない場合、このメソッドはエラーをスローします。

getNext(visibleOnly?: boolean): Excel.Worksheet;

パラメーター

返品

注釈

[API セット: ExcelApi 1.5]

このワークシートの後に続くワークシートを取得します。 このワークシートの後にワークシートがない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

getNextOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

パラメーター

返品

注釈

[API セット: ExcelApi 1.5]

このワークシートの前にあるワークシートを取得します。 以前のワークシートがない場合、このメソッドはエラーをスローします。

getPrevious(visibleOnly?: boolean): Excel.Worksheet;

パラメーター

返品

注釈

[API セット: ExcelApi 1.5]

このワークシートの前にあるワークシートを取得します。 以前のワークシートがない場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

getPreviousOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

パラメーター

返品

注釈

[API セット: ExcelApi 1.5]

アドレスまたは名前で指定された、セルの単一の長方形ブロックを表す Range オブジェクトを取得します。

getRange(address?: string): Excel.Range;

パラメーター

返品

注釈

[API セット: ExcelApi 1.1]

特定の行インデックスと列インデックスから始まり、特定の行と列数にまたがる Range オブジェクトを取得します。

getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number): Excel.Range;

パラメーター

返品

注釈

[API セット: ExcelApi 1.7]

アドレスまたは名前で指定された四角形範囲の 1 つ以上のブロックを表す RangeAreas オブジェクトを取得します。

getRanges(address?: string): Excel.RangeAreas;

パラメーター

返品

注釈

[API セット: ExcelApi 1.9]

使用範囲とは、値または書式設定が割り当たっているすべてのセルを包含する最小の範囲です。 ワークシート全体が空白の場合、この関数は左上のセルを返します (つまり、エラーはスロー されません )。

getUsedRange(valuesOnly?: boolean): Excel.Range;

パラメーター

返品

注釈

[API セット: ExcelApi 1.1]

使用範囲とは、値または書式設定が割り当たっているすべてのセルを包含する最小の範囲です。 ワークシート全体が空白の場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

パラメーター

返品

注釈

[API セット: ExcelApi 1.4]

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.WorksheetLoadOptions): Excel.Worksheet;

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Excel.Worksheet;

パラメーター

返品

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Worksheet;

パラメーター

返品

現在のワークシート内で、指定された条件に基づき、指定された文字列を検索し、置換します。

replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

パラメーター

返品

実行された置換の数。

注釈

[API セット: ExcelApi 1.9]

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.WorksheetUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

返品

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.Worksheet): void;

パラメーター

返品

行または列のグループをアウトライン レベルで表示します。 アウトライン、グループ、およびワークシート内のデータのリストを要約します。 rowLevels パラメーターと columnLevels パラメーターは、表示するアウトラインのレベル数を指定します。 許容される引数の範囲は 0 から 8 です。 値が 0 の場合、現在の表示は変更されません。 現在のレベル数より大きい値を指定すると、すべてのレベルが表示されます。

showOutlineLevels(rowLevels: number, columnLevels: number): void;

パラメーター

返品

注釈

[API セット: ExcelApi 1.10]

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Excel.Worksheet オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Excel.Interfaces.WorksheetData と型指定) を返します。

toJSON(): Excel.Interfaces.WorksheetData;

返品

ワークシートがアクティブ化されたときに発生します。

readonly onActivated: OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.7]

ワークシートの計算時に発生します。

readonly onCalculated: OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.8]

特定のワークシート内のデータが変更されたときに発生します。

readonly onChanged: OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.7]

1 つ以上の列を並べ替えたときに発生します。 これは、左から右への並べ替え操作の結果として発生します。

readonly onColumnSorted: OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.10]

ワークシートが非アクティブ化されると発生します。

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.7]

フォーマットが特定のワークシートで変更されたときに発生します。

readonly onFormatChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.9]

このワークシートで 1 つ以上の数式が変更されたときに発生します。 このイベントは、数式の計算の結果のデータ値ではなく、数式自体が変更されたときに発生します。

このイベントは、セルに既に数式が含まれている場合にのみトリガーされます。 新しいセル値に数式を含めることはできません。 このイベントは、数式が含まれていなかったセルに数式が入力されたときにはトリガーされません。

readonly onFormulaChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.13]

ワークシート名が変更されたときに発生します。

readonly onNameChanged: OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.17]

ワークシートの保護状態が変更されたときに発生します。

readonly onProtectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.14]

特定のワークシートで 1 つ以上の行の非表示状態が変更されたときに発生します。

readonly onRowHiddenChanged: OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.11]

1 つ以上の行を並べ替えたときに発生します。 これは、上から下に並べ替えを実行したときに発生します。

readonly onRowSorted: OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.10]

特定のワークシートで選択範囲が変更されたときに発生します。

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.7]

ワークシート内で左クリック/タップ操作が行われたときに発生します。 以下の場合、クリックすると、このイベントは発生しません。

• ユーザーがマウスをドラッグして複数選択する場合。

• 数式参照のセル引数が選択されている場合、ユーザーはモードのセルを選択します。

readonly onSingleClicked: OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.10]

ワークシートの表示が変更されたときに発生します。

readonly onVisibilityChanged: OfficeExtension.EventHandlers<Excel.WorksheetVisibilityChangedEventArgs>;

イベントの種類

注釈

[API セット: ExcelApi 1.17]