Compartilhar via

Excel.ShapeFont class

  • Referência
Pacote:
excel

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 de TextRange uma forma.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Propriedades

bold

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

Representação do código de cores HTML da cor do texto (por exemplo, "#FF0000" representa vermelho). Devolve null se o TextRange incluir 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

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

Representa 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.
size

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

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

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
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 Excel.ShapeFont original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ShapeFontData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

bold

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

bold: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

color

Representação do código de cores HTML da cor do texto (por exemplo, "#FF0000" representa vermelho). Devolve 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 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

Excel.RequestContext

italic

Representa o status da fonte em itálico. Devolve 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 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.

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

size

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

size: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

underline

Tipo de sublinhado aplicado à fonte. Devolve null se incluir TextRange fragmentos de texto com estilos de sublinhado diferentes. Veja Excel.ShapeFontUnderlineStyle para obter 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 as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

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

Excel.ShapeFont

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas 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 que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num 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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto Excel.ShapeFont original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.ShapeFontData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.ShapeFontData;

Retornos

Excel.Interfaces.ShapeFontData