Excel.Style class

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

autoIndent: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.8

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

readonly borders: Excel.RangeBorderCollection;

プロパティ値

注釈

API セット: ExcelApi 1.7

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

readonly builtIn: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.7

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

context: RequestContext;

プロパティ値

スタイルの塗りつぶし。

readonly fill: Excel.RangeFill;

プロパティ値

注釈

API セット: ExcelApi 1.7

スタイルのフォントを表す 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: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.7

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

horizontalAlignment: 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: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.7

スタイルにカラー、カラー インデックス、線のスタイル、および太さの罫線プロパティを含めるかどうかを指定します。

includeBorder: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.7

スタイルに background、bold、color、color index、font style、italic、name、size、strikethrough、subscript、upscript、underline font プロパティを含めるかどうかを指定します。

includeFont: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.7

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

includeNumber: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.7

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

includePatterns: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.7

隠し保護プロパティとロック保護プロパティの数式がスタイルに含まれるかどうかを指定します。

includeProtection: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.7

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

indentLevel: number;

プロパティ値

注釈

API セット: ExcelApi 1.7

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

locked: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.7

スタイルの名前。

readonly name: string;

プロパティ値

注釈

API セット: ExcelApi 1.7

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

numberFormat: string;

プロパティ値

注釈

API セット: ExcelApi 1.7

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

numberFormatLocal: string;

プロパティ値

注釈

API セット: ExcelApi 1.7

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

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

プロパティ値

注釈

API セット: ExcelApi 1.7

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

shrinkToFit: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.7

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

textOrientation: number;

プロパティ値

注釈

API セット: ExcelApi 1.8

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

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

プロパティ値

注釈

API セット: ExcelApi 1.7

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

wrapText: boolean;

プロパティ値

注釈

API セット: ExcelApi 1.7

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

delete(): 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.");
});

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

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

パラメーター

返品

例

// 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);
});

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

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

set(properties: Excel.Style): void;

パラメーター

返品

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

toJSON(): Excel.Interfaces.StyleData;

返品