Excel.ShapeFont class
Представляет атрибуты шрифта, такие как имя шрифта, размер и цвет шрифта, для объекта фигуры TextRange .
- Extends
Свойства
| bold | Указывает, является ли шрифт полужирным. Возвращается |
| color | Цветовой код текста в HTML (например, "#FF0000" представляет красный). Возвращает |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| italic | Указывает, применяется ли курсив. Возвращается |
| name | Представляет название шрифта (например, "Calibri"). Если текст представляет собой сложный шрифт или восточноазиатский язык, это соответствующее название шрифта; в противном случае это латинское название шрифта. |
| size | Представляет размер шрифта в точках (например, 11). Возвращает |
| strikethrough | Указывает состояние зачеркивания шрифта. Значение |
| subscript | Определяет состояние подстрочного текста шрифта. Возвращает |
| superscript | Определяет надстрочный статус шрифта. Возвращает |
| tint |
Указывает двойное значение, которое осветляет или затемняет цвет шрифта диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий), где 0 для исходного цвета. Значение |
| underline | Тип подчеркивания, применяемый для шрифта. Возвращает |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
bold
Указывает, является ли шрифт полужирным. Возвращается null , если текст TextRange содержит как полужирный, так и неполужирный фрагмент текста.
bold: boolean;Значение свойства
boolean
Комментарии
color
Цветовой код текста в HTML (например, "#FF0000" представляет красный). Возвращает null значение при TextRange наличии фрагментов текста разных цветов.
color: string;Значение свойства
string
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
italic
Указывает, применяется ли курсив. Возвращается null , если поле содержит как курсивные TextRange , так и другие фрагменты текста.
italic: boolean;Значение свойства
boolean
Комментарии
name
Представляет название шрифта (например, "Calibri"). Если текст представляет собой сложный шрифт или восточноазиатский язык, это соответствующее название шрифта; в противном случае это латинское название шрифта.
name: string;Значение свойства
string
Комментарии
size
Представляет размер шрифта в точках (например, 11). Возвращает null , если включает TextRange фрагменты текста с разным размером шрифта.
size: number;Значение свойства
number
Комментарии
strikethrough
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Указывает состояние зачеркивания шрифта. Значение null указывает, что для всего диапазона не задано единое зачеркивание.
strikethrough: boolean;Значение свойства
boolean
Комментарии
subscript
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Определяет состояние подстрочного текста шрифта. Возвращает true , если все шрифты диапазона являются подстрочными Возвращает false , если все шрифты в диапазоне являются надстрочными или обычными (без надстрочного или подстрочного начертания). В противном случае возвращает обратное значение null .
subscript: boolean;Значение свойства
boolean
Комментарии
superscript
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Определяет надстрочный статус шрифта. Возвращает true , если все шрифты диапазона являются надстрочными Возвращает false , если все шрифты диапазона являются подстрочными или обычными (ни надстрочными, ни подстрочными вариантами). В противном случае возвращает обратное значение null .
superscript: boolean;Значение свойства
boolean
Комментарии
tintAndShade
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Указывает двойное значение, которое осветляет или затемняет цвет шрифта диапазона. Значение находится в диапазоне от -1 (самый темный) до 1 (самый яркий), где 0 для исходного цвета. Значение null указывает на то, что для всего диапазона не используется единый шрифт tintAndShade .
tintAndShade: number;Значение свойства
number
Комментарии
underline
Тип подчеркивания, применяемый для шрифта. Возвращает null , если включает TextRange текстовые фрагменты с различными стилями подчеркивания. См. Excel.ShapeFontUnderlineStyle дополнительные сведения.
underline: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";Значение свойства
Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Excel.Interfaces.ShapeFontLoadOptions): Excel.ShapeFont;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.ShapeFont;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ShapeFont;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.ShapeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.ShapeFontUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
void
set(properties)
Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
set(properties: Excel.ShapeFont): void;Параметры
- properties
- Excel.ShapeFont
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Excel.ShapeFont объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Excel.Interfaces.ShapeFontData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
toJSON(): Excel.Interfaces.ShapeFontData;