PowerPoint.ShapeFont class
Представляет атрибуты шрифта, такие как имя шрифта, размер шрифта и цвет, для объекта TextRange фигуры.
- Extends
Комментарии
[ Набор API: PowerPointApi 1.4 ]
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
const textRange = context.presentation.getSelectedTextRange();
textRange.font.color = "green";
await context.sync();
});
Свойства
| bold | Указывает, является ли шрифт полужирным. Возвращает значение |
| color | Представление цветового кода HTML для цвета текста (например, "#FF0000" представляет красный цвет). Возвращает значение |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| italic | Указывает, применяется ли курсив. Возвращает значение null, если TextRange содержит фрагменты текста курсивным и не курсивным курсивом. |
| name | Представляет имя шрифта (например, "Calibri"). Если текст является сложным или восточноазиатским языком, это соответствующее имя шрифта; в противном случае это латинское имя шрифта. |
| size | Представляет размер шрифта в пунктах (например, 11). Возвращает значение null, если объект TextRange включает фрагменты текста с разными размерами шрифта. |
| underline | Тип подчеркивания, применяемый для шрифта. Возвращает значение |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
bold
Указывает, является ли шрифт полужирным. Возвращает значение null , если содержит TextRange как полужирные, так и не полужирные фрагменты текста.
bold: boolean;Значение свойства
boolean
Комментарии
color
Представление цветового кода HTML для цвета текста (например, "#FF0000" представляет красный цвет). Возвращает значение null , если объект TextRange содержит фрагменты текста с разными цветами.
color: string;Значение свойства
string
Комментарии
[ Набор API: PowerPointApi 1.4 ]
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
const textRange = context.presentation.getSelectedTextRange();
textRange.font.color = "green";
await context.sync();
});
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
italic
Указывает, применяется ли курсив. Возвращает значение null, если TextRange содержит фрагменты текста курсивным и не курсивным курсивом.
italic: boolean;Значение свойства
boolean
Комментарии
name
Представляет имя шрифта (например, "Calibri"). Если текст является сложным или восточноазиатским языком, это соответствующее имя шрифта; в противном случае это латинское имя шрифта.
name: string;Значение свойства
string
Комментарии
size
Представляет размер шрифта в пунктах (например, 11). Возвращает значение null, если объект TextRange включает фрагменты текста с разными размерами шрифта.
size: number;Значение свойства
number
Комментарии
underline
Тип подчеркивания, применяемый для шрифта. Возвращает значение null , если объект TextRange содержит фрагменты текста с разными стилями подчеркивания. Дополнительные сведения см. в разделе PowerPoint.ShapeFontUnderlineStyle .
underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";Значение свойства
PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): PowerPoint.ShapeFont;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.ShapeFont;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.ShapeFont объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.ShapeFontData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): PowerPoint.Interfaces.ShapeFontData;Возвращаемое значение
Office Add-ins