Compartilhar via


PowerPoint.ShapeFont class

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

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

Propriedades

allCaps

Especifica se o texto no TextRange está definido para utilizar o atributo Todas as Maiúsculas , o que faz com que as letras minúsculas apareçam como letras maiúsculas. Os valores possíveis são os seguintes:

  • true : todo o texto tem o atributo Todas as Maiúsculas .

  • false : nenhum dos textos tem o atributo Todas as Maiúsculas .

  • null : devolvido se algum, mas não todos, do texto tiver o atributo Todas as Maiúsculas .

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.

doubleStrikethrough

Especifica se o texto no TextRange está definido para utilizar o atributo Rasurado duplo . Os valores possíveis são os seguintes:

  • true : todo o texto tem o atributo Rasurado duplo .

  • false : nenhum dos textos tem o atributo Rasurado duplo .

  • null : devolvido se algum, mas não todos, do texto tiver o atributo Rasurado duplo .

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.

smallCaps

Especifica se o texto no TextRange está definido para utilizar o atributo Maiúsculas Pequenas , o que faz com que as letras minúsculas apareçam como letras maiúsculas pequenas. Os valores possíveis são os seguintes:

  • true : todo o texto tem o atributo Maiúsculas Pequenas .

  • false : nenhum dos textos tem o atributo Maiúsculas Pequenas .

  • null : devolvido se algum, mas não todos, do texto tiver o atributo Maiúsculas Pequenas .

strikethrough

Especifica se o texto no TextRange está definido para utilizar o atributo Rasurado . Os valores possíveis são os seguintes:

  • true : todo o texto tem o atributo Rasurado .

  • false : nenhum dos textos tem o atributo Rasurado .

  • null : devolvido se algum, mas não todos, do texto tiver o atributo Rasurado .

subscript

Especifica se o texto no TextRange está definido para utilizar o atributo Inferior à Linha . Os valores possíveis são os seguintes:

  • true : todo o texto tem o atributo Inferior à Linha .

  • false : nenhum dos textos tem o atributo Inferior à Linha .

  • null : devolvido se algum, mas não todos, do texto tiver o atributo Inferior à Linha .

superscript

Especifica se o texto no TextRange está definido para utilizar o atributo Superior à Linha . Os valores possíveis são os seguintes:

  • true : todo o texto tem o atributo Superior à Linha .

  • false : nenhum dos textos tem o atributo Superior à Linha .

  • null : devolvido se algum, mas não todos, do texto tiver o atributo Superior à Linha .

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

allCaps

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica se o texto no TextRange está definido para utilizar o atributo Todas as Maiúsculas , o que faz com que as letras minúsculas apareçam como letras maiúsculas. Os valores possíveis são os seguintes:

  • true : todo o texto tem o atributo Todas as Maiúsculas .

  • false : nenhum dos textos tem o atributo Todas as Maiúsculas .

  • null : devolvido se algum, mas não todos, do texto tiver o atributo Todas as Maiúsculas .

allCaps: boolean | null;

Valor da propriedade

boolean | null

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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

doubleStrikethrough

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica se o texto no TextRange está definido para utilizar o atributo Rasurado duplo . Os valores possíveis são os seguintes:

  • true : todo o texto tem o atributo Rasurado duplo .

  • false : nenhum dos textos tem o atributo Rasurado duplo .

  • null : devolvido se algum, mas não todos, do texto tiver o atributo Rasurado duplo .

doubleStrikethrough: boolean | null;

Valor da propriedade

boolean | null

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 ]

smallCaps

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica se o texto no TextRange está definido para utilizar o atributo Maiúsculas Pequenas , o que faz com que as letras minúsculas apareçam como letras maiúsculas pequenas. Os valores possíveis são os seguintes:

  • true : todo o texto tem o atributo Maiúsculas Pequenas .

  • false : nenhum dos textos tem o atributo Maiúsculas Pequenas .

  • null : devolvido se algum, mas não todos, do texto tiver o atributo Maiúsculas Pequenas .

smallCaps: boolean | null;

Valor da propriedade

boolean | null

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

strikethrough

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica se o texto no TextRange está definido para utilizar o atributo Rasurado . Os valores possíveis são os seguintes:

  • true : todo o texto tem o atributo Rasurado .

  • false : nenhum dos textos tem o atributo Rasurado .

  • null : devolvido se algum, mas não todos, do texto tiver o atributo Rasurado .

strikethrough: boolean | null;

Valor da propriedade

boolean | null

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

subscript

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica se o texto no TextRange está definido para utilizar o atributo Inferior à Linha . Os valores possíveis são os seguintes:

  • true : todo o texto tem o atributo Inferior à Linha .

  • false : nenhum dos textos tem o atributo Inferior à Linha .

  • null : devolvido se algum, mas não todos, do texto tiver o atributo Inferior à Linha .

subscript: boolean | null;

Valor da propriedade

boolean | null

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

superscript

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica se o texto no TextRange está definido para utilizar o atributo Superior à Linha . Os valores possíveis são os seguintes:

  • true : todo o texto tem o atributo Superior à Linha .

  • false : nenhum dos textos tem o atributo Superior à Linha .

  • null : devolvido se algum, mas não todos, do texto tiver o atributo Superior à Linha .

superscript: boolean | null;

Valor da propriedade

boolean | null

Comentários

[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 ]

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

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

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

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