PowerPoint.ShapeFont class

  • Referência
Pacote:
powerpoint

Representa os atributos de fonte, como nome da fonte, tamanho da fonte e cor, para o objeto TextRange de uma forma.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

Propriedades

bold

Representa o status da fonte em negrito. Retornará null se o TextRange incluir fragmentos de texto em negrito e não negrito.
color

Representação de código de cor HTML da cor do texto (por exemplo, "#FF0000" representa vermelho). Retornará null se o TextRange incluir fragmentos de texto com cores diferentes.
context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
italic

Representa o status da fonte em itálico. Retornará 'null' se o 'TextRange' incluir fragmentos de texto itálico e não itálico.
name

Representa o nome da fonte (por exemplo, "Calibri"). Se o texto for um script complexo ou uma linguagem do Leste Asiático, este será o nome da fonte correspondente; caso contrário, é o nome da fonte latina.
size

Representa o tamanho da fonte em pontos (por exemplo, 11). Retorna nulo se o TextRange incluir fragmentos de texto com tamanhos de fontes diferentes.
underline

Tipo de sublinhado aplicado à fonte. Retornará null se o TextRange incluir fragmentos de texto com diferentes estilos de sublinhado. 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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto PowerPoint.ShapeFont original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.ShapeFontData) que contém cópias rasas de qualquer propriedade filho carregada do objeto original.

Detalhes da propriedade

bold

Representa o status da fonte em negrito. Retornará null se o TextRange incluir fragmentos de texto em negrito e não negrito.

bold: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

color

Representação de código de cor HTML da cor do texto (por exemplo, "#FF0000" representa vermelho). Retornará null se o TextRange incluir fragmentos de texto com cores diferentes.

color: string;

Valor da propriedade

string

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

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

PowerPoint.RequestContext

italic

Representa o status da fonte em itálico. Retornará 'null' se o 'TextRange' incluir fragmentos de texto itálico e não itálico.

italic: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

name

Representa o nome da fonte (por exemplo, "Calibri"). Se o texto for um script complexo ou uma linguagem do Leste Asiático, este será o nome da fonte correspondente; caso contrário, é o nome da fonte latina.

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

size

Representa o tamanho da fonte em pontos (por exemplo, 11). Retorna nulo se o TextRange incluir fragmentos de texto com tamanhos de fontes diferentes.

size: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

underline

Tipo de sublinhado aplicado à fonte. Retornará null se o TextRange incluir fragmentos de texto com diferentes estilos de sublinhado. 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";

Valor da propriedade

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

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 quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

PowerPoint.ShapeFont

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto PowerPoint.ShapeFont original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.ShapeFontData) que contém cópias rasas de qualquer propriedade filho carregada do objeto original.

toJSON(): PowerPoint.Interfaces.ShapeFontData;

Retornos

PowerPoint.Interfaces.ShapeFontData