PowerPoint.ShapeFont class

Пакет:: powerpoint

Представляет атрибуты шрифта, такие как имя шрифта, размер шрифта и цвет, для объекта TextRange фигуры.

Extends: OfficeExtension.ClientObject

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml

// Gets navigational (complex) properties of the selected text range.
await PowerPoint.run(async (context) => {
  const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
  textRange.load("font,paragraphFormat/bulletFormat,paragraphFormat/horizontalAlignment");
  await context.sync();

  console.log("Font properties of selected text range:");
  console.log(`\tallCaps: ${textRange.font.allCaps}`);
  console.log(`\tbold: ${textRange.font.bold}`);
  console.log(`\tcolor: ${textRange.font.color}`);
  console.log(`\tdoubleStrikethrough: ${textRange.font.doubleStrikethrough}`);
  console.log(`\titalic: ${textRange.font.italic}`);
  console.log(`\tname: ${textRange.font.name}`);
  console.log(`\tsize: ${textRange.font.size}`);
  console.log(`\tsmallCaps: ${textRange.font.smallCaps}`);
  console.log(`\tstrikethrough: ${textRange.font.strikethrough}`);
  console.log(`\tsubscript: ${textRange.font.subscript}`);
  console.log(`\tsuperscript: ${textRange.font.superscript}`);
  console.log(`\tunderline: ${textRange.font.underline}`);

  console.log("Paragraph format properties of selected text range:");
  console.log(`\tbulletFormat.visible: ${textRange.paragraphFormat.bulletFormat.visible}`);
  console.log(`\thorizontalAlignment: ${textRange.paragraphFormat.horizontalAlignment}`);
});

Свойства

allCaps	Указывает, задано ли в тексте значение атрибута `TextRange`All Caps , в котором строчные буквы отображаются как прописные буквы. Возможны следующие значения. `true` : весь текст имеет атрибут All Caps . `false` : ни один из текста не имеет атрибута All Caps . `null` : возвращается, если некоторые (но не все) текста имеют атрибут All Caps .
bold	Указывает, имеет ли текст в полужирном `TextRange` шрифте. Возможны следующие значения. `true` : весь текст выделен полужирным шрифтом. `false` : текст не выделен полужирным шрифтом. `null` : возвращается, если некоторые( но не все) текста выделены полужирным шрифтом.
color	Задает представление цвета текста в коде HTML (например, "#FF0000" представляет красный цвет). Возвращает значение `null` , `TextRange` если содержит фрагменты текста с разными цветами.
context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
doubleStrikethrough	Указывает, задано ли для текста в `TextRange` атрибуте Double strikethrough . Возможны следующие значения. `true` : весь текст имеет атрибут Double strikethrough . `false` : ни один из текста не имеет атрибута Double strikethrough . `null` : возвращается, если некоторые (но не все) текста имеют атрибут Double strikethrough .
italic	Указывает, задано ли для текста в `TextRange` курсиве. Возможны следующие значения. `true` : весь текст курсивом. `false` : ни один текст не курсивирован. `null` : возвращается, если некоторые( но не все) текста курсивом.
name	Указывает имя шрифта (например, "Calibri"). Если текст является сложным или восточноазиатским языком, это соответствующее имя шрифта; В противном случае это латинское имя шрифта. Возвращает значение `null` , `TextRange` если содержит фрагменты текста с разными именами шрифтов.
size	Задает размер шрифта в точках (например, 11). Возвращает значение `null` , `TextRange` если объект содержит фрагменты текста с разными размерами шрифта.
smallCaps	Указывает, задано ли в тексте значение атрибута `TextRange`Small Caps , в котором строчные буквы отображаются как небольшие прописные буквы. Возможны следующие значения. `true` : весь текст имеет атрибут Small Caps . `false` : ни в одном тексте нет атрибута Small Caps . `null` : возвращается, если некоторые ( но не все) текста имеют атрибут Small Caps .
strikethrough	Указывает, задано ли для текста в объекте `TextRange` использование атрибута Strikethrough . Возможны следующие значения. `true` : весь текст содержит атрибут Strikethrough . `false` : ни в одном тексте нет атрибута Strikethrough . `null` : возвращается, если некоторые ( но не все) текста имеют атрибут Strikethrough .
subscript	Указывает, задано ли для текста в `TextRange` атрибуте Subscript . Возможны следующие значения. `true` : весь текст содержит атрибут Subscript . `false` : ни в одном тексте нет атрибута Subscript . `null` : возвращается, если некоторые ( но не все) текста имеют атрибут Subscript .
superscript	Указывает, задано ли для текста в `TextRange` атрибуте Superscript . Возможны следующие значения. `true` : весь текст содержит атрибут Superscript . `false` : ни в одном тексте нет атрибута Надстрочного индекса. `null` : возвращается, если некоторые (но не все) текста имеют атрибут Superscript .
underline	Указывает тип подчеркивания, примененного к шрифту. Возвращает значение `null` , `TextRange` если объект содержит фрагменты текста с разными стилями подчеркивания. Дополнительные сведения см. в разделе PowerPoint.ShapeFontUnderlineStyle .

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`в свою очередь вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `PowerPoint.ShapeFont` объект является объектом API, `toJSON` метод возвращает обычный объект JavaScript (типизированный как `PowerPoint.Interfaces.ShapeFontData`), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

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

allCaps

Указывает, задано ли в тексте значение атрибута TextRangeAll Caps , в котором строчные буквы отображаются как прописные буквы. Возможны следующие значения.

true : весь текст имеет атрибут All Caps .
false : ни один из текста не имеет атрибута All Caps .
null : возвращается, если некоторые (но не все) текста имеют атрибут All Caps .

allCaps: boolean | null;

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

boolean | null

bold

Указывает, имеет ли текст в полужирном TextRange шрифте. Возможны следующие значения.

true : весь текст выделен полужирным шрифтом.
false : текст не выделен полужирным шрифтом.
null : возвращается, если некоторые( но не все) текста выделены полужирным шрифтом.

bold: boolean | null;

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

boolean | null

color

Задает представление цвета текста в коде HTML (например, "#FF0000" представляет красный цвет). Возвращает значение null , TextRange если содержит фрагменты текста с разными цветами.

color: string | null;

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

string | null

Примеры

// 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: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
  textRange.font.color = "green";
  await context.sync();
});

context

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

context: RequestContext;

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

PowerPoint.RequestContext

doubleStrikethrough

Указывает, задано ли для текста в TextRange атрибуте Double strikethrough . Возможны следующие значения.

true : весь текст имеет атрибут Double strikethrough .
false : ни один из текста не имеет атрибута Double strikethrough .
null : возвращается, если некоторые (но не все) текста имеют атрибут Double strikethrough .

doubleStrikethrough: boolean | null;

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

boolean | null

italic

Указывает, задано ли для текста в TextRange курсиве. Возможны следующие значения.

true : весь текст курсивом.
false : ни один текст не курсивирован.
null : возвращается, если некоторые( но не все) текста курсивом.

italic: boolean | null;

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

boolean | null

name

Указывает имя шрифта (например, "Calibri"). Если текст является сложным или восточноазиатским языком, это соответствующее имя шрифта; В противном случае это латинское имя шрифта. Возвращает значение null , TextRange если содержит фрагменты текста с разными именами шрифтов.

name: string | null;

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

string | null

size

Задает размер шрифта в точках (например, 11). Возвращает значение null , TextRange если объект содержит фрагменты текста с разными размерами шрифта.

size: number | null;

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

number | null

smallCaps

Указывает, задано ли в тексте значение атрибута TextRangeSmall Caps , в котором строчные буквы отображаются как небольшие прописные буквы. Возможны следующие значения.

true : весь текст имеет атрибут Small Caps .
false : ни в одном тексте нет атрибута Small Caps .
null : возвращается, если некоторые ( но не все) текста имеют атрибут Small Caps .

smallCaps: boolean | null;

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

boolean | null

strikethrough

Указывает, задано ли для текста в объекте TextRange использование атрибута Strikethrough . Возможны следующие значения.

true : весь текст содержит атрибут Strikethrough .
false : ни в одном тексте нет атрибута Strikethrough .
null : возвращается, если некоторые ( но не все) текста имеют атрибут Strikethrough .

strikethrough: boolean | null;

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

boolean | null

subscript

Указывает, задано ли для текста в TextRange атрибуте Subscript . Возможны следующие значения.

true : весь текст содержит атрибут Subscript .
false : ни в одном тексте нет атрибута Subscript .
null : возвращается, если некоторые ( но не все) текста имеют атрибут Subscript .

subscript: boolean | null;

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

boolean | null

superscript

Указывает, задано ли для текста в TextRange атрибуте Superscript . Возможны следующие значения.

true : весь текст содержит атрибут Superscript .
false : ни в одном тексте нет атрибута Надстрочного индекса.
null : возвращается, если некоторые (но не все) текста имеют атрибут Superscript .

superscript: boolean | null;

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

boolean | null

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" | null;

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

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/shapes.yaml

// This function gets the collection of shapes on the first slide,
// and adds a brace pair, {}, to the collection, while specifying its
// location and size. Then it names the shape, sets its text and font
// color, and centers it inside the braces.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
  const braces: PowerPoint.Shape = shapes.addGeometricShape(PowerPoint.GeometricShapeType.bracePair, {
    left: 100,
    top: 400,
    height: 50,
    width: 150,
  });
  braces.name = "Braces";
  braces.textFrame.textRange.text = "Shape text";
  braces.textFrame.textRange.font.color = "purple";
  braces.textFrame.textRange.font.underline = PowerPoint.ShapeFontUnderlineStyle.heavy;
  braces.textFrame.verticalAlignment = PowerPoint.TextVerticalAlignment.middleCentered;
  braces.textFrame.autoSizeSetting = PowerPoint.ShapeAutoSize.autoSizeShapeToFitText;

  return context.sync();
});

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

load(options)

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

load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;

Параметры

options: PowerPoint.Interfaces.ShapeFontLoadOptions

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

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

PowerPoint.ShapeFont

load(propertyNames)

load(propertyNames?: string | string[]): PowerPoint.ShapeFont;

Параметры

propertyNames: string | string[]

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

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

PowerPoint.ShapeFont

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.ShapeFont;

Параметры

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

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

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

PowerPoint.ShapeFont

toJSON()

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

toJSON(): PowerPoint.Interfaces.ShapeFontData;

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

PowerPoint.Interfaces.ShapeFontData

Обратная связь

Была ли эта страница полезна?

Поделиться через

PowerPoint.ShapeFont class

Комментарии

Примеры

Свойства

Методы

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

allCaps

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

Комментарии

bold

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

Комментарии

color

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

Комментарии

Примеры

context

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

doubleStrikethrough

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

Комментарии

italic

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

Комментарии

name

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

Комментарии

size

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

Комментарии

smallCaps

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

Комментарии

strikethrough

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

Комментарии

subscript

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

Комментарии

superscript

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

Комментарии

underline

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

Комментарии

Примеры

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

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

toJSON()

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

Обратная связь