Excel.RangeFont class

Пакет:

excel

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

bold	Представляет состояние шрифта полужирным шрифтом.
color	Представление цветового кода HTML для цвета текста (например, #FF0000 представляет красный цвет).
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
italic	Указывает курсивное состояние шрифта.
name	Имя шрифта (например, "Calibri"). Длина имени не должна превышать 31 символ.
size	размер шрифта
underline	Тип подчеркивания, применяемый для шрифта. Дополнительные сведения см. в этой Excel.RangeUnderlineStyle статье.

Методы

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

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

bold

Представляет состояние шрифта полужирным шрифтом.

bold: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

color

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

color: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.1 ]

context

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

context: RequestContext;

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

Excel.RequestContext

italic

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

italic: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.1 ]

name

Имя шрифта (например, "Calibri"). Длина имени не должна превышать 31 символ.

name: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.1 ]

Примеры

// Change the font of the selected range to "Impact".
await Excel.run(async (context) => {
  const selection = context.workbook.getSelectedRange();
  selection.format.font.name = "Impact";
  await context.sync();
});

size

размер шрифта

size: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.1 ]

underline

Тип подчеркивания, применяемый для шрифта. Дополнительные сведения см. в этой Excel.RangeUnderlineStyle статье.

underline: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant";

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

Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"

Комментарии

[ Набор API: ExcelApi 1.1 ]

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

load(options)

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

load(options?: Excel.Interfaces.RangeFontLoadOptions): Excel.RangeFont;

Параметры

options

Excel.Interfaces.RangeFontLoadOptions

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

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

Excel.RangeFont

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.RangeFont

Примеры

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFont = range.format.font;
    rangeFont.load('name');
    await context.sync();
    console.log(rangeFont.name);
});

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.RangeFont

set(properties, options)

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

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

Параметры

properties

Excel.Interfaces.RangeFontUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Excel.RangeFont): void;

Параметры

properties

Excel.RangeFont

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

void

toJSON()

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

toJSON(): Excel.Interfaces.RangeFontData;

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

Excel.Interfaces.RangeFontData