次の方法で共有


Excel.Style class

スタイルの形式とその他のプロパティをカプセル化するオブジェクト。

Extends

注釈

[ API セット: ExcelApi 1.7 ]

プロパティ

autoIndent

セル内のテキストの配置が等しい分布に設定されている場合に、テキストを自動的にインデントするかどうかを指定します。

borders

4 つの罫線のスタイルを表す 4 つの罫線オブジェクトのコレクション。

builtIn

スタイルが組み込みスタイルかどうかを指定します。

context

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

fill

スタイルの塗りつぶし。

font

スタイルのフォントを表す Font オブジェクト。

formulaHidden

ワークシートが保護されているときに数式を非表示にするかどうかを指定します。

horizontalAlignment

スタイルでの水平方向の配置を表します。 詳細は「Excel.HorizontalAlignment」をご覧ください。

includeAlignment

スタイルに自動インデント、水平方向の配置、垂直方向の配置、テキストの折り返し、インデント レベル、およびテキストの向きのプロパティが含まれるかどうかを指定します。

includeBorder

スタイルに色、色のインデックス、線のスタイル、太さの罫線のプロパティが含まれるかどうかを指定します。

includeFont

スタイルに背景、太字、色、色インデックス、フォント スタイル、斜体、名前、サイズ、取り消し線、添字、上付き文字、下線の各フォント プロパティが含まれるかどうかを指定します。

includeNumber

スタイルに数値書式プロパティを含めるかどうかを指定します。

includePatterns

スタイルに色、色のインデックス、負の場合は反転、パターン、パターンの色、およびパターンの色インデックスの内部プロパティを含めるかどうかを指定します。

includeProtection

スタイルに非表示の数式とロックされた保護プロパティを含めるかどうかを指定します。

indentLevel

スタイルのインデント レベルを示す 0 から 250 の範囲内の整数。

locked

ワークシートが保護されているときにオブジェクトがロックされているかどうかを指定します。

name

スタイルの名前。

numberFormat

スタイルで適用される数値形式の表示形式コード。

numberFormatLocal

スタイルで適用される数値形式のローカライズされた表示形式コード。

readingOrder

スタイルで適用される読み上げ順序。

shrinkToFit

使用可能な列幅に合わせてテキストを自動的に縮小するかどうかを指定します。

textOrientation

スタイルで適用されるテキストの向き。

verticalAlignment

スタイルの垂直方向の配置を指定します。 詳細は「Excel.VerticalAlignment」をご覧ください。

wrapText

Excel がオブジェクト内のテキストを折り返すかどうかを指定します。

メソッド

delete()

このスタイルを削除します。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

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

set(properties)

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

toJSON()

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

プロパティの詳細

autoIndent

セル内のテキストの配置が等しい分布に設定されている場合に、テキストを自動的にインデントするかどうかを指定します。

autoIndent: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.8 ]

borders

4 つの罫線のスタイルを表す 4 つの罫線オブジェクトのコレクション。

readonly borders: Excel.RangeBorderCollection;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

builtIn

スタイルが組み込みスタイルかどうかを指定します。

readonly builtIn: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

context

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

context: RequestContext;

プロパティ値

fill

スタイルの塗りつぶし。

readonly fill: Excel.RangeFill;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

font

スタイルのフォントを表す Font オブジェクト。

readonly font: Excel.RangeFont;

プロパティ値

注釈

[ API セット: ExcelApi 1.7 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml

await Excel.run(async (context) => {
    let style = context.workbook.styles.getItem("Normal");
    style.font.load("bold, color, italic, name, size");
    style.fill.load("color");

    await context.sync();

    console.log("Bold: " + style.font.bold);
    console.log("Font color: " + style.font.color);
    console.log("Italic: " + style.font.italic);
    console.log("Name: " + style.font.name);
    console.log("Size: " + style.font.size);
    console.log("Fill color: " + style.fill.color);
});

formulaHidden

ワークシートが保護されているときに数式を非表示にするかどうかを指定します。

formulaHidden: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

horizontalAlignment

スタイルでの水平方向の配置を表します。 詳細は「Excel.HorizontalAlignment」をご覧ください。

horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";

プロパティ値

Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"

注釈

[ API セット: ExcelApi 1.7 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml

await Excel.run(async (context) => {
    let worksheet = context.workbook.worksheets.getItem("Sample");
    let range = worksheet.getRange("A1:E1");

    // Apply built-in style. 
    // Styles are in the Home tab ribbon.
    range.style = Excel.BuiltInStyle.neutral;
    range.format.horizontalAlignment = "Right";

    await context.sync();
});

includeAlignment

スタイルに自動インデント、水平方向の配置、垂直方向の配置、テキストの折り返し、インデント レベル、およびテキストの向きのプロパティが含まれるかどうかを指定します。

includeAlignment: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

includeBorder

スタイルに色、色のインデックス、線のスタイル、太さの罫線のプロパティが含まれるかどうかを指定します。

includeBorder: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

includeFont

スタイルに背景、太字、色、色インデックス、フォント スタイル、斜体、名前、サイズ、取り消し線、添字、上付き文字、下線の各フォント プロパティが含まれるかどうかを指定します。

includeFont: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

includeNumber

スタイルに数値書式プロパティを含めるかどうかを指定します。

includeNumber: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

includePatterns

スタイルに色、色のインデックス、負の場合は反転、パターン、パターンの色、およびパターンの色インデックスの内部プロパティを含めるかどうかを指定します。

includePatterns: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

includeProtection

スタイルに非表示の数式とロックされた保護プロパティを含めるかどうかを指定します。

includeProtection: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

indentLevel

スタイルのインデント レベルを示す 0 から 250 の範囲内の整数。

indentLevel: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.7 ]

locked

ワークシートが保護されているときにオブジェクトがロックされているかどうかを指定します。

locked: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

name

スタイルの名前。

readonly name: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.7 ]

numberFormat

スタイルで適用される数値形式の表示形式コード。

numberFormat: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.7 ]

numberFormatLocal

スタイルで適用される数値形式のローカライズされた表示形式コード。

numberFormatLocal: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.7 ]

readingOrder

スタイルで適用される読み上げ順序。

readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";

プロパティ値

Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"

注釈

[ API セット: ExcelApi 1.7 ]

shrinkToFit

使用可能な列幅に合わせてテキストを自動的に縮小するかどうかを指定します。

shrinkToFit: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

textOrientation

スタイルで適用されるテキストの向き。

textOrientation: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.8 ]

verticalAlignment

スタイルの垂直方向の配置を指定します。 詳細は「Excel.VerticalAlignment」をご覧ください。

verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";

プロパティ値

Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"

注釈

[ API セット: ExcelApi 1.7 ]

wrapText

Excel がオブジェクト内のテキストを折り返すかどうかを指定します。

wrapText: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.7 ]

メソッドの詳細

delete()

このスタイルを削除します。

delete(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.7 ]

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml

await Excel.run(async (context) => {
    let style = context.workbook.styles.getItem("Diagonal Orientation Style");

    // Delete the diagonal orientation style from the style collection.
    // Styles are in the Home tab ribbon.
    style.delete();

    await context.sync();

    console.log("Successfully deleted the diagonal orientation style from the Home tab ribbon.");
});

load(options)

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

load(options?: Excel.Interfaces.StyleLoadOptions): Excel.Style;

パラメーター

options
Excel.Interfaces.StyleLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml

await Excel.run(async (context) => {
    let style = context.workbook.styles.getItem("Diagonal Orientation Style");            
    style.load("textOrientation, horizontalAlignment, autoIndent, readingOrder, wrapText, includeProtection, shrinkToFit, locked");

    await context.sync();

    console.log("Orientation: " + style.textOrientation);
    console.log("Horizontal alignment: " + style.horizontalAlignment);
    console.log("Add indent: " + style.autoIndent);
    console.log("Reading order: " + style.readingOrder);
    console.log("Wrap text: " + style.wrapText);
    console.log("Include protection: " + style.includeProtection);
    console.log("Shrink to fit: " + style.shrinkToFit);
    console.log("Style locked: " + style.locked);
});

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。

戻り値

set(properties, options)

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

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

パラメーター

properties
Excel.Interfaces.StyleUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

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

set(properties: Excel.Style): void;

パラメーター

properties
Excel.Style

戻り値

void

toJSON()

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

toJSON(): Excel.Interfaces.StyleData;

戻り値