PowerPoint.ShapeFont class

Пакет:
powerpoint

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

Extends
OfficeExtension.ClientObject

Комментарии

Набор API: PowerPointApi 1.4

Используется

Примеры

// 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");

  const parentTextFrame: PowerPoint.TextFrame = textRange.getParentTextFrame();
  const parentShape: PowerPoint.Shape = parentTextFrame.getParentShape();
  const parentSlide: PowerPoint.Slide = parentShape.getParentSlide();
  parentShape.load("id");
  parentSlide.load("id");
  await context.sync();

  console.log(`Selected text range found in parent shape with ID ${parentShape.id} on parentSlide with ID ${parentSlide.id}`);

  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 : весь текст имеет атрибут "Все прописными буквами ".

  • false : у текста нет атрибута "Все прописные".

  • null : возвращается, если некоторый (но не весь текст) имеет атрибут "Все прописными буквами ".
bold

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

  • true : весь текст выделен полужирным шрифтом.

  • false : текст не полужирный.

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

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

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

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

  • true : весь текст имеет атрибут Double strikethrough .

  • false : у текста нет атрибута Double strikethrough .

  • null : возвращается, если часть (но не весь текст) имеет атрибут Double strikethrough .
italic

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

  • true : весь текст выделяется курсивом.

  • false : текст не выделен курсивом.

  • null : возвращается, если часть текста выделена курсивом, но не весь текст.
name

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

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

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

  • true : весь текст имеет атрибут малых прописных .

  • false : у текста нет атрибута малых прописных .

  • null : возвращается, если некоторый (но не весь текст) имеет атрибут малых прописных .
strikethrough

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

  • true : весь текст имеет атрибут Strikethrough .

  • false : у текста нет атрибута зачеркивания .

  • null : возвращается, если некоторый (но не весь текст) имеет атрибут Strikethrough .
subscript

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

  • true : весь текст имеет атрибут Subscript .

  • false : у текста нет атрибута Subscript .

  • null : возвращается, если часть текста (но не весь текст) имеет атрибут Subscript .
superscript

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

  • true : весь текст имеет атрибут надстрочного начертания.

  • false : у текста нет атрибута надстрочного .

  • null : возвращается, если часть текста (но не весь текст имеет атрибут надстрочный ).
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

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

  • true : весь текст имеет атрибут "Все прописными буквами ".

  • false : у текста нет атрибута "Все прописные".

  • null : возвращается, если некоторый (но не весь текст) имеет атрибут "Все прописными буквами ".

allCaps: boolean | null;

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

boolean | null

Комментарии

Набор API: PowerPointApi 1.8

bold

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

  • true : весь текст выделен полужирным шрифтом.

  • false : текст не полужирный.

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

bold: boolean | null;

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

boolean | null

Комментарии

Набор API: PowerPointApi 1.4

color

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

color: string | null;

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

string | null

Комментарии

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

context

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

context: RequestContext;

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

PowerPoint.RequestContext

doubleStrikethrough

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

  • true : весь текст имеет атрибут Double strikethrough .

  • false : у текста нет атрибута Double strikethrough .

  • null : возвращается, если часть (но не весь текст) имеет атрибут Double strikethrough .

doubleStrikethrough: boolean | null;

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

boolean | null

Комментарии

Набор API: PowerPointApi 1.8

italic

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

  • true : весь текст выделяется курсивом.

  • false : текст не выделен курсивом.

  • null : возвращается, если часть текста выделена курсивом, но не весь текст.

italic: boolean | null;

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

boolean | null

Комментарии

Набор API: PowerPointApi 1.4

name

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

name: string | null;

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

string | null

Комментарии

Набор API: PowerPointApi 1.4

size

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

size: number | null;

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

number | null

Комментарии

Набор API: PowerPointApi 1.4

smallCaps

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

  • true : весь текст имеет атрибут малых прописных .

  • false : у текста нет атрибута малых прописных .

  • null : возвращается, если некоторый (но не весь текст) имеет атрибут малых прописных .

smallCaps: boolean | null;

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

boolean | null

Комментарии

Набор API: PowerPointApi 1.8

strikethrough

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

  • true : весь текст имеет атрибут Strikethrough .

  • false : у текста нет атрибута зачеркивания .

  • null : возвращается, если некоторый (но не весь текст) имеет атрибут Strikethrough .

strikethrough: boolean | null;

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

boolean | null

Комментарии

Набор API: PowerPointApi 1.8

subscript

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

  • true : весь текст имеет атрибут Subscript .

  • false : у текста нет атрибута Subscript .

  • null : возвращается, если часть текста (но не весь текст) имеет атрибут Subscript .

subscript: boolean | null;

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

boolean | null

Комментарии

Набор API: PowerPointApi 1.8

superscript

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

  • true : весь текст имеет атрибут надстрочного начертания.

  • false : у текста нет атрибута надстрочного .

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

superscript: boolean | null;

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

boolean | null

Комментарии

Набор API: PowerPointApi 1.8

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;

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

PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null

Комментарии

Набор API: PowerPointApi 1.4

Примеры

// 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)

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

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

Параметры

propertyNames

string | string[]

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

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

PowerPoint.ShapeFont

load(propertyNamesAndPaths)

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

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