Excel.RangeBorder class
Representa a borda de um objeto.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
color | Código de cor HTML que representa a cor da linha de borda, no formulário #RRGGBB (por exemplo, "FFA500" ou como uma cor HTML nomeada (por exemplo, "laranja"). |
context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
side |
Valor constante que indica o lado específico da borda. Confira |
style | Uma das constantes de estilo de linha especificando o estilo de linha da borda. Confira |
tint |
Especifica um duplo que clareia ou escure uma cor para a borda de intervalo, o valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um |
weight | Especifica o peso da borda em torno de um intervalo. Confira |
Métodos
load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
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 |
Detalhes da propriedade
color
Código de cor HTML que representa a cor da linha de borda, no formulário #RRGGBB (por exemplo, "FFA500" ou como uma cor HTML nomeada (por exemplo, "laranja").
color: string;
Valor da propriedade
string
Comentários
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
sideIndex
Valor constante que indica o lado específico da borda. Confira Excel.BorderIndex
detalhes.
readonly sideIndex: Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp";
Valor da propriedade
Excel.BorderIndex | "EdgeTop" | "EdgeBottom" | "EdgeLeft" | "EdgeRight" | "InsideVertical" | "InsideHorizontal" | "DiagonalDown" | "DiagonalUp"
Comentários
style
Uma das constantes de estilo de linha especificando o estilo de linha da borda. Confira Excel.BorderLineStyle
detalhes.
style: Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot";
Valor da propriedade
Excel.BorderLineStyle | "None" | "Continuous" | "Dash" | "DashDot" | "DashDotDot" | "Dot" | "Double" | "SlantDashDot"
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
// Add grid borders around the range.
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:F8";
const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
range.format.borders.getItem('InsideHorizontal').style = 'Continuous';
range.format.borders.getItem('InsideVertical').style = 'Continuous';
range.format.borders.getItem('EdgeBottom').style = 'Continuous';
range.format.borders.getItem('EdgeLeft').style = 'Continuous';
range.format.borders.getItem('EdgeRight').style = 'Continuous';
range.format.borders.getItem('EdgeTop').style = 'Continuous';
await context.sync();
});
tintAndShade
Especifica um duplo que clareia ou escure uma cor para a borda de intervalo, o valor é entre -1 (mais escuro) e 1 (mais brilhante), com 0 para a cor original. Um null
valor indica que a borda não tem uma configuração uniforme tintAndShade
.
tintAndShade: number;
Valor da propriedade
number
Comentários
weight
Especifica o peso da borda em torno de um intervalo. Confira Excel.BorderWeight
detalhes.
weight: Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick";
Valor da propriedade
Excel.BorderWeight | "Hairline" | "Thin" | "Medium" | "Thick"
Comentários
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.RangeBorderLoadOptions): Excel.RangeBorder;
Parâmetros
Fornece opções para quais propriedades do objeto 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[]): Excel.RangeBorder;
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
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.RangeBorder;
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
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.RangeBorderUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Excel.Interfaces.RangeBorderUpdateData
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.RangeBorder): void;
Parâmetros
- properties
- Excel.RangeBorder
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.stringify
por sua vez, chama o toJSON
método do objeto que é passado para ele.) Enquanto o objeto Excel.RangeBorder original é um objeto API, o toJSON
método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.RangeBorderData
) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.RangeBorderData;
Retornos
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de