Excel.RangeFont class
Этот объект представляет атрибуты шрифта (имя, размер, цвет и т. д.) для объекта.
- Extends
Комментарии
Свойства
| bold | Представляет состояние шрифта полужирным шрифтом. |
| color | Представление цветового кода HTML для цвета текста (например, #FF0000 представляет красный цвет). |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| italic | Указывает курсивное состояние шрифта. |
| name | Имя шрифта (например, "Calibri"). Длина имени не должна превышать 31 символ. |
| size | размер шрифта |
| strikethrough | Указывает состояние зачеркиния шрифта. Значение |
| subscript | Указывает состояние подстрочного индекса шрифта. Возвращает значение |
| superscript | Указывает надстрочный индекс шрифта. Возвращает значение |
| tint |
Указывает двойник, который осветляет или затемняет цвет шрифта диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. Значение |
| underline | Тип подчеркивания, применяемый для шрифта. Дополнительные сведения см. в этой |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
bold
Представляет состояние шрифта полужирным шрифтом.
bold: boolean;Значение свойства
boolean
Комментарии
color
Представление цветового кода HTML для цвета текста (например, #FF0000 представляет красный цвет).
color: string;Значение свойства
string
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
italic
Указывает курсивное состояние шрифта.
italic: boolean;Значение свойства
boolean
Комментарии
name
Имя шрифта (например, "Calibri"). Длина имени не должна превышать 31 символ.
name: string;Значение свойства
string
Комментарии
Примеры
// 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
strikethrough
Указывает состояние зачеркиния шрифта. Значение null указывает, что для всего диапазона не задано однородное зачеркивное значение.
strikethrough: boolean;Значение свойства
boolean
Комментарии
subscript
Указывает состояние подстрочного индекса шрифта. Возвращает значение true , если все шрифты диапазона являются подстрочными. Возвращает значение false , если все шрифты диапазона являются надстрочными или обычными (ни надстрочными, ни подстрочными). В противном случае возвращает значение null .
subscript: boolean;Значение свойства
boolean
Комментарии
superscript
Указывает надстрочный индекс шрифта. Возвращает значение true , если все шрифты диапазона являются надстрочными. Возвращает значение false , если все шрифты диапазона являются подстрочными или обычными (ни надстрочными, ни подстрочными). В противном случае возвращает значение null .
superscript: boolean;Значение свойства
boolean
Комментарии
tintAndShade
Указывает двойник, который осветляет или затемняет цвет шрифта диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий) с 0 для исходного цвета. Значение null указывает, что для всего диапазона не задано однородное значение шрифта tintAndShade .
tintAndShade: number;Значение свойства
number
Комментарии
underline
Тип подчеркивания, применяемый для шрифта. Дополнительные сведения см. в этой Excel.RangeUnderlineStyle статье.
underline: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant";Значение свойства
Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.RangeFontLoadOptions): Excel.RangeFont;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.RangeFont;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
Примеры
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 строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
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;Возвращаемое значение
Office Add-ins