Compartilhar via

Excel.ShapeFont class

  • Referência
Pacote:
excel

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

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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). Retornará null se o TextRange incluir fragmentos de texto com diferentes tamanhos de fonte.
underline

Tipo de sublinhado aplicado à fonte. Retornará null se o TextRange incluir fragmentos de texto com diferentes estilos de sublinhado. Confira Excel.ShapeFontUnderlineStyle 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.
set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
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 Excel.ShapeFont original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ShapeFontData) que contém cópias rasas de quaisquer propriedades filho carregadas 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: ExcelApi 1.9 ]

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: ExcelApi 1.9 ]

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

Excel.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: ExcelApi 1.9 ]

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: ExcelApi 1.9 ]

size

Representa o tamanho da fonte em pontos (por exemplo, 11). Retornará null se o TextRange incluir fragmentos de texto com diferentes tamanhos de fonte.

size: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

underline

Tipo de sublinhado aplicado à fonte. Retornará null se o TextRange incluir fragmentos de texto com diferentes estilos de sublinhado. Confira Excel.ShapeFontUnderlineStyle detalhes.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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?: Excel.Interfaces.ShapeFontLoadOptions): Excel.ShapeFont;

Parâmetros

options
Excel.Interfaces.ShapeFontLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.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[]): Excel.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

Excel.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;
        }): Excel.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

Excel.ShapeFont

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.ShapeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.ShapeFontUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Excel.ShapeFont): void;

Parâmetros

properties
Excel.ShapeFont

Retornos

void

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 Excel.ShapeFont original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ShapeFontData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.ShapeFontData;

Retornos

Excel.Interfaces.ShapeFontData