Compartilhar via

PowerPoint.ShapeFont class

Pacote:
powerpoint

Representa os atributos do tipo de letra, como o nome do tipo de letra, o tamanho do tipo de letra e a cor, para o objeto TextRange de uma forma.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

Exemplos

// 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}`);
});

Propriedades

bold

Especifica se o texto no TextRange está definido como negrito. Os valores possíveis são os seguintes:

  • true : todo o texto está a negrito.

  • false : nenhum dos textos está a negrito.

  • null : devolvido se algum, mas não todos, do texto estiver a negrito.
color

Especifica a representação do código de cores HTML da cor do texto (por exemplo, "#FF0000" representa vermelho). Devolve null se o TextRange contém fragmentos de texto com cores diferentes.
context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
italic

Especifica se o texto no TextRange está definido como itálico. Os valores possíveis são os seguintes:

  • true : todo o texto está em itálico.

  • false : nenhum dos textos está em itálico.

  • null : devolvido se algum, mas não todos, do texto estiver em itálico.
name

Especifica o nome do tipo de letra (por exemplo, "Calibri"). Se o texto for um Script Complexo ou um idioma asiático, este é o nome do tipo de letra correspondente; caso contrário, é o nome do tipo de letra latino. Devolve null se o TextRange contém fragmentos de texto com nomes de tipos de letra diferentes.
size

Especifica o tamanho do tipo de letra em pontos (por exemplo, 11). Devolve null se o TextRange contém fragmentos de texto com tamanhos de tipo de letra diferentes.
underline

Especifica o tipo de sublinhado aplicado ao tipo de letra. Devolve null se o TextRange contém fragmentos de texto com estilos de sublinhado diferentes. Consulte PowerPoint.ShapeFontUnderlineStyle para obter detalhes.

Métodos

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.ShapeFont é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.ShapeFontData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

bold

Especifica se o texto no TextRange está definido como negrito. Os valores possíveis são os seguintes:

  • true : todo o texto está a negrito.

  • false : nenhum dos textos está a negrito.

  • null : devolvido se algum, mas não todos, do texto estiver a negrito.

bold: boolean | null;

Valor da propriedade

boolean | null

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

color

Especifica a representação do código de cores HTML da cor do texto (por exemplo, "#FF0000" representa vermelho). Devolve null se o TextRange contém fragmentos de texto com cores diferentes.

color: string | null;

Valor da propriedade

string | null

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

Exemplos

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

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

PowerPoint.RequestContext

italic

Especifica se o texto no TextRange está definido como itálico. Os valores possíveis são os seguintes:

  • true : todo o texto está em itálico.

  • false : nenhum dos textos está em itálico.

  • null : devolvido se algum, mas não todos, do texto estiver em itálico.

italic: boolean | null;

Valor da propriedade

boolean | null

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

name

Especifica o nome do tipo de letra (por exemplo, "Calibri"). Se o texto for um Script Complexo ou um idioma asiático, este é o nome do tipo de letra correspondente; caso contrário, é o nome do tipo de letra latino. Devolve null se o TextRange contém fragmentos de texto com nomes de tipos de letra diferentes.

name: string | null;

Valor da propriedade

string | null

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

size

Especifica o tamanho do tipo de letra em pontos (por exemplo, 11). Devolve null se o TextRange contém fragmentos de texto com tamanhos de tipo de letra diferentes.

size: number | null;

Valor da propriedade

number | null

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

underline

Especifica o tipo de sublinhado aplicado ao tipo de letra. Devolve null se o TextRange contém fragmentos de texto com estilos de sublinhado diferentes. Consulte PowerPoint.ShapeFontUnderlineStyle para obter detalhes.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

Exemplos

// 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();
});

Detalhes do método

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

options
PowerPoint.Interfaces.ShapeFontLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

PowerPoint.ShapeFont

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

PowerPoint.ShapeFont

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

PowerPoint.ShapeFont

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.ShapeFont é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.ShapeFontData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): PowerPoint.Interfaces.ShapeFontData;

Retornos

PowerPoint.Interfaces.ShapeFontData