ExcelScript.RangeBorder interface
Representa a borda de um objeto.
Métodos
get |
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"). |
get |
Valor constante que indica o lado específico da borda. Confira |
get |
Uma das constantes de estilo de linha especificando o estilo de linha da borda. Confira |
get |
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 |
get |
Especifica o peso da borda em torno de um intervalo. Confira |
set |
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"). |
set |
Uma das constantes de estilo de linha especificando o estilo de linha da borda. Confira |
set |
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 |
set |
Especifica o peso da borda em torno de um intervalo. Confira |
Detalhes do método
getColor()
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").
getColor(): string;
Retornos
string
getSideIndex()
Valor constante que indica o lado específico da borda. Confira ExcelScript.BorderIndex
detalhes.
getSideIndex(): BorderIndex;
Retornos
getStyle()
Uma das constantes de estilo de linha especificando o estilo de linha da borda. Confira ExcelScript.BorderLineStyle
detalhes.
getStyle(): BorderLineStyle;
Retornos
getTintAndShade()
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
.
getTintAndShade(): number;
Retornos
number
getWeight()
Especifica o peso da borda em torno de um intervalo. Confira ExcelScript.BorderWeight
detalhes.
getWeight(): BorderWeight;
Retornos
setColor(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").
setColor(color: string): void;
Parâmetros
- color
-
string
Retornos
void
setStyle(style)
Uma das constantes de estilo de linha especificando o estilo de linha da borda. Confira ExcelScript.BorderLineStyle
detalhes.
setStyle(style: BorderLineStyle): void;
Parâmetros
Retornos
void
Exemplos
/**
* This script adds a border around the outside of a range.
*/
function main(workbook: ExcelScript.Workbook) {
// Get a range from the current worksheet.
let range = workbook.getActiveWorksheet().getRange("B2:E15");
// Add a border around the whole bounding range.
let format = range.getFormat();
format.getRangeBorder(ExcelScript.BorderIndex.edgeTop).setStyle(ExcelScript.BorderLineStyle.continuous); // Top border
format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom).setStyle(ExcelScript.BorderLineStyle.continuous); // Bottom border
format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft).setStyle(ExcelScript.BorderLineStyle.continuous); // Left border
format.getRangeBorder(ExcelScript.BorderIndex.edgeRight).setStyle(ExcelScript.BorderLineStyle.continuous); // Right border
}
setTintAndShade(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
.
setTintAndShade(tintAndShade: number): void;
Parâmetros
- tintAndShade
-
number
Retornos
void
setWeight(weight)
Especifica o peso da borda em torno de um intervalo. Confira ExcelScript.BorderWeight
detalhes.
setWeight(weight: BorderWeight): void;
Parâmetros
- weight
- ExcelScript.BorderWeight
Retornos
void
Exemplos
/**
* This script creates a border around a range.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the RangeFormat object for the range "B2:G10".
const currentSheet = workbook.getActiveWorksheet();
const rangeForBorder = currentSheet.getRange("B2:G10");
const format = rangeForBorder.getFormat();
// Get a RangeBorder object for each edge of the range and set the border properties.
let edgeTop = format.getRangeBorder(ExcelScript.BorderIndex.edgeTop);
edgeTop.setStyle(ExcelScript.BorderLineStyle.dashDot);
edgeTop.setWeight(ExcelScript.BorderWeight.thick);
let edgeBottom = format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom);
edgeBottom.setStyle(ExcelScript.BorderLineStyle.dashDot);
edgeBottom.setWeight(ExcelScript.BorderWeight.thick);
let edgeLeft = format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft);
edgeLeft.setStyle(ExcelScript.BorderLineStyle.dashDot);
edgeLeft.setWeight(ExcelScript.BorderWeight.thick);
let edgeRight = format.getRangeBorder(ExcelScript.BorderIndex.edgeRight);
edgeRight.setStyle(ExcelScript.BorderLineStyle.dashDot);
edgeRight.setWeight(ExcelScript.BorderWeight.thick);
}
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: ao longo de 2024, vamos eliminar problemas do GitHub como o mecanismo de comentários para conteúdo e substituí-lo por um novo sistema de comentários. Para obter mais informações, consulte:Enviar e exibir comentários de