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
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-auto-fill.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();
const sumRange = sheet.getRange("F4");
sumRange.formulas = [["=SUM(B4:E4)"]];
sumRange.format.fill.color = "LightBlue";
sumRange.format.font.bold = true;
sheet.getRanges("K4,P4").copyFrom("F4", Excel.RangeCopyType.all);
sheet.getRanges("F4,K4,P4").format.autofitColumns();
await context.sync();
});
color
Цветовой код текста в формате HTML (например, #FF0000 представляет красный).
color: string;Значение свойства
string
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/formatting.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B2:E2");
range.format.fill.color = "#4472C4";;
range.format.font.color = "white";
await context.sync();
});
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
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
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;