Excel.Style class

Ссылка

Пакет:: excel

Объект, инкапсулирующий формат стиля и другие свойства.

Extends: OfficeExtension.ClientObject

Свойства

autoIndent	Указывает, будет ли текст автоматически отступен, если выравнивание текста в ячейке установлено на равное распределение.
borders	Коллекция из четырех объектов границ, представляющих стиль четырех границ.
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()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Excel.Style` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `Excel.Interfaces.StyleData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

autoIndent

Указывает, будет ли текст автоматически отступен, если выравнивание текста в ячейке установлено на равное распределение.

autoIndent: boolean;

Значение свойства

boolean

borders

Коллекция из четырех объектов границ, представляющих стиль четырех границ.

readonly borders: Excel.RangeBorderCollection;

Значение свойства

Excel.RangeBorderCollection

builtIn

Указывает, является ли стиль встроенным.

readonly builtIn: boolean;

Значение свойства

boolean

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

fill

Заливка стиля.

readonly fill: Excel.RangeFill;

Значение свойства

Excel.RangeFill

font

Объект Font , представляющий шрифт стиля.

readonly font: Excel.RangeFont;

Значение свойства

Excel.RangeFont

Примеры

// 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

horizontalAlignment

Представляет горизонтальное выравнивание для стиля. Дополнительные сведения см. в этой Excel.HorizontalAlignment статье.

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

Значение свойства

Примеры

// 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

includeBorder

Указывает, включает ли стиль цвет, индекс цвета, стиль линии и свойства границы веса.

includeBorder: boolean;

Значение свойства

boolean

includeFont

Указывает, включает ли стиль фон, полужирный шрифт, цвет, индекс цвета, стиль шрифта, курсив, имя, размер, зачеркивку, подстрочный, надстрочный и подчеркивающий шрифт.

includeFont: boolean;

Значение свойства

boolean

includeNumber

Указывает, включает ли стиль свойство числового формата.

includeNumber: boolean;

Значение свойства

boolean

includePatterns

Указывает, включает ли стиль цвет, индекс цвета, инвертировать , если отрицательный, шаблон, цвет узора и внутренние свойства индекса цвета узора.

includePatterns: boolean;

Значение свойства

boolean

includeProtection

Указывает, включает ли стиль скрытые и заблокированные свойства защиты формулы.

includeProtection: boolean;

Значение свойства

boolean

indentLevel

Целое число от 0 до 250, указывающее уровень отступа для стиля.

indentLevel: number;

Значение свойства

number

locked

Указывает, заблокирован ли объект при защите листа.

locked: boolean;

Значение свойства

boolean

name

Имя стиля.

readonly name: string;

Значение свойства

string

numberFormat

Код числового формата для стиля.

numberFormat: string;

Значение свойства

string

numberFormatLocal

Локализованный код числового формата для стиля.

numberFormatLocal: string;

Значение свойства

string

readingOrder

Направление чтения для стиля.

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

Значение свойства

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

shrinkToFit

Указывает, будет ли текст автоматически сжиматься в соответствии с доступной шириной столбца.

shrinkToFit: boolean;

Значение свойства

boolean

textOrientation

Ориентация текста для стиля.

textOrientation: number;

Значение свойства

number

verticalAlignment

Задает вертикальное выравнивание стиля. Дополнительные сведения см. в этой Excel.VerticalAlignment статье.

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

Значение свойства

wrapText

Указывает, будет ли Excel переносить текст в объект .

wrapText: boolean;

Значение свойства

boolean

Сведения о методе

delete()

Удаляет этот стиль.

delete(): void;

Возвращаемое значение

void

Примеры

// 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

Предоставляет параметры свойств объекта для загрузки.

Возвращаемое значение

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

load(propertyNames)

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

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Excel.Style

load(propertyNamesAndPaths)

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

Параметры

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Excel.Style

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

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

Параметры

properties: Excel.Interfaces.StyleUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.Style): void;

Параметры

properties: Excel.Style

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.Style объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.StyleData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.StyleData;

Возвращаемое значение

Excel.Interfaces.StyleData

Поделиться через

Excel.Style class

Комментарии

Свойства

Методы

Сведения о свойстве

autoIndent

Значение свойства

Комментарии

borders

Значение свойства

Комментарии

builtIn

Значение свойства

Комментарии

context

Значение свойства

fill

Значение свойства

Комментарии

font

Значение свойства

Комментарии

Примеры

formulaHidden

Значение свойства

Комментарии

horizontalAlignment

Значение свойства

Комментарии

Примеры

includeAlignment

Значение свойства

Комментарии

includeBorder

Значение свойства

Комментарии

includeFont

Значение свойства

Комментарии

includeNumber

Значение свойства

Комментарии

includePatterns

Значение свойства

Комментарии

includeProtection

Значение свойства

Комментарии

indentLevel

Значение свойства

Комментарии

locked

Значение свойства

Комментарии

name

Значение свойства

Комментарии

numberFormat

Значение свойства

Комментарии

numberFormatLocal

Значение свойства

Комментарии

readingOrder

Значение свойства

Комментарии

shrinkToFit

Значение свойства

Комментарии

textOrientation

Значение свойства

Комментарии

verticalAlignment

Значение свойства

Комментарии

wrapText

Значение свойства

Комментарии

Сведения о методе