Excel.ConditionalRangeFont class

Этот объект представляет атрибуты шрифта (начертание шрифта, цвет и т. д.) объекта.

Extends

Комментарии

Набор API: ExcelApi 1.6

Используется

Свойства

bold

Указывает, является ли шрифт полужирным.

color

Цветовой код текста в формате HTML (например, #FF0000 представляет красный).

context

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

italic

Указывает, является ли шрифт курсивом.

strikethrough

Указывает состояние зачеркивания шрифта.

underline

Тип подчеркивания, примененного к шрифту. См. Excel.ConditionalRangeFontUnderlineStyle дополнительные сведения.

Методы

clear()

Удаляет форматирование шрифтов.

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.ConditionalRangeFont объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ConditionalRangeFontData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

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

bold

Указывает, является ли шрифт полужирным.

bold: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.6

color

Цветовой код текста в формате HTML (например, #FF0000 представляет красный).

color: string;

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

string

Комментарии

Набор API: ExcelApi 1.6

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B8:E13");
    const conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.custom);
    conditionalFormat.custom.rule.formula = '=IF(B8>INDIRECT("RC[-1]",0),TRUE)';
    conditionalFormat.custom.format.font.color = "green";

    await context.sync();
});

context

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

context: RequestContext;

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

italic

Указывает, является ли шрифт курсивом.

italic: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.6

strikethrough

Указывает состояние зачеркивания шрифта.

strikethrough: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.6

underline

Тип подчеркивания, примененного к шрифту. См. Excel.ConditionalRangeFontUnderlineStyle дополнительные сведения.

underline: Excel.ConditionalRangeFontUnderlineStyle | "None" | "Single" | "Double";

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

Excel.ConditionalRangeFontUnderlineStyle | "None" | "Single" | "Double"

Комментарии

Набор API: ExcelApi 1.6

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

clear()

Удаляет форматирование шрифтов.

clear(): void;

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

void

Комментарии

Набор API: ExcelApi 1.6

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.ConditionalRangeFontLoadOptions): Excel.ConditionalRangeFont;

Параметры

options
Excel.Interfaces.ConditionalRangeFontLoadOptions

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

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

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames

string | string[]

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

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

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths

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

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

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

set(properties, options)

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

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

Параметры

properties
Excel.Interfaces.ConditionalRangeFontUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.ConditionalRangeFont): void;

Параметры

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

void

toJSON()

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

toJSON(): Excel.Interfaces.ConditionalRangeFontData;

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