Excel.Interfaces.WorksheetLoadOptions interface

Excel のワークシートは、セルのグリッドです。 データ、テーブル、グラフなどを含めることができます。ワークシート オブジェクト モデルの詳細については、「 Excel JavaScript API を使用してワークシートを操作する」を参照してください。

注釈

[ API セット: ExcelApi 1.1 ]

プロパティ

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.addressなど) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

autoFilter

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

charts

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

enableCalculation

Excel が必要に応じてワークシートを再計算するかどうかを決定します。 True を指定すると、必要に応じてワークシートが再計算されます。 False を指定すると、Excel でシートが再計算されません。

id

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

name

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

pageLayout

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

position

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

protection

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

showGridlines

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

showHeadings

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

standardHeight

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

standardWidth

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

tabColor

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

tabId

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

tables

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

visibility

ワークシートの可視性。

プロパティの詳細

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.addressなど) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

$all?: boolean;

プロパティ値

boolean

autoFilter

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

autoFilter?: Excel.Interfaces.AutoFilterLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

charts

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

charts?: Excel.Interfaces.ChartCollectionLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

enableCalculation

Excel が必要に応じてワークシートを再計算するかどうかを決定します。 True を指定すると、必要に応じてワークシートが再計算されます。 False を指定すると、Excel でシートが再計算されません。

enableCalculation?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.9 ]

id

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

id?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

name

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

name?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

pageLayout

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

pageLayout?: Excel.Interfaces.PageLayoutLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.9 ]

position

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

position?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.1 ]

protection

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

protection?: Excel.Interfaces.WorksheetProtectionLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.2 ]

showGridlines

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

showGridlines?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.8 ]

showHeadings

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

showHeadings?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.8 ]

standardHeight

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

standardHeight?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

standardWidth

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

standardWidth?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

tabColor

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

tabColor?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

tabId

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

tabId?: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.14 ]

tables

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

tables?: Excel.Interfaces.TableCollectionLoadOptions;

プロパティ値

注釈

[ API セット: ExcelApi 1.1 ]

visibility

ワークシートの可視性。

visibility?: boolean;

プロパティ値

boolean

注釈

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