ExcelScript.NamedItem interface
Representa um nome definido para um intervalo de células ou um valor. Os nomes podem ser objetos chamados primitivos (como visto no tipo abaixo), objeto range ou uma referência a um intervalo. Use esse objeto para obter um objeto de intervalo associado aos nomes.
Comentários
Exemplos
/**
* This script creates a named formula and uses it in another part of the workbook.
*/
function main(workbook: ExcelScript.Workbook) {
// Create a named item for a formula.
// This formula is the sum of the cells F2:F21 on Sheet1.
const namedItem: ExcelScript.NamedItem = workbook.addNamedItem(
"GrandTotal",
"=SUM(Sheet1!$F$2:$F$21)",
"The sum of table sums."
);
// Add this named formula to a new sheet in the workbook.
const otherSheet = workbook.addWorksheet();
otherSheet.getRange("A1").setFormula(namedItem.getFormula());
// Switch to the new worksheet.
otherSheet.activate();
}
Métodos
delete() | Exclui o nome fornecido. |
get |
Retorna um objeto que contém valores e tipos do item nomeado. |
get |
Especifica o comentário associado a esse nome. |
get |
A fórmula do item nomeado. As fórmulas sempre começam com um sinal igual ("="). |
get |
O nome do objeto. |
get |
Retorna o objeto Range associado ao nome. Se o tipo do item nomeado não for um intervalo, esse método retornará |
get |
Especifica se o nome está no escopo da pasta de trabalho ou de uma planilha específica. Os valores possíveis são: Planilha, Pasta de Trabalho. |
get |
Especifica o tipo do valor retornado pela fórmula do nome. Confira |
get |
Representa o valor calculado pela fórmula do nome. Para um intervalo nomeado, ele retornará o endereço de intervalo. Essa API retorna o #VALUE! erro na interface do usuário do Excel se ele se refere a uma função definida pelo usuário. |
get |
Especifica se o objeto está visível. |
get |
Retorna a planilha à qual o item nomeado está no escopo. Se o item estiver no escopo da pasta de trabalho, esse método retornará |
set |
Especifica o comentário associado a esse nome. |
set |
A fórmula do item nomeado. As fórmulas sempre começam com um sinal igual ("="). |
set |
Especifica se o objeto está visível. |
Detalhes do método
delete()
Exclui o nome fornecido.
delete(): void;
Retornos
void
getArrayValues()
Retorna um objeto que contém valores e tipos do item nomeado.
getArrayValues(): NamedItemArrayValues;
Retornos
getComment()
Especifica o comentário associado a esse nome.
getComment(): string;
Retornos
string
getFormula()
A fórmula do item nomeado. As fórmulas sempre começam com um sinal igual ("=").
getFormula(): string;
Retornos
string
getName()
O nome do objeto.
getName(): string;
Retornos
string
getRange()
Retorna o objeto Range associado ao nome. Se o tipo do item nomeado não for um intervalo, esse método retornará undefined
.
getRange(): Range;
Retornos
getScope()
Especifica se o nome está no escopo da pasta de trabalho ou de uma planilha específica. Os valores possíveis são: Planilha, Pasta de Trabalho.
getScope(): NamedItemScope;
Retornos
getType()
Especifica o tipo do valor retornado pela fórmula do nome. Confira ExcelScript.NamedItemType
detalhes.
getType(): NamedItemType;
Retornos
Exemplos
/**
* This script looks for every named range with "Review" in the name
* and marks the range with a yellow fill.
*/
function main(workbook: ExcelScript.Workbook) {
// Look at every named item in the workbook.
workbook.getNames().forEach((namedItem) => {
// Find names containing "Review".
if (namedItem.getName().includes("Review")) {
// Only change the fill color if the named item is a range (not a formula).
let itemType: ExcelScript.NamedItemType = namedItem.getType();
if (itemType === ExcelScript.NamedItemType.range) {
// Set the range's fill color to yellow.
namedItem.getRange().getFormat().getFill().setColor("yellow");
}
}
});
}
getValue()
Representa o valor calculado pela fórmula do nome. Para um intervalo nomeado, ele retornará o endereço de intervalo. Essa API retorna o #VALUE! erro na interface do usuário do Excel se ele se refere a uma função definida pelo usuário.
getValue(): string | number;
Retornos
string | number
getVisible()
Especifica se o objeto está visível.
getVisible(): boolean;
Retornos
boolean
getWorksheet()
Retorna a planilha à qual o item nomeado está no escopo. Se o item estiver no escopo da pasta de trabalho, esse método retornará undefined
.
getWorksheet(): Worksheet | undefined;
Retornos
ExcelScript.Worksheet | undefined
setComment(comment)
Especifica o comentário associado a esse nome.
setComment(comment: string): void;
Parâmetros
- comment
-
string
Retornos
void
setFormula(formula)
A fórmula do item nomeado. As fórmulas sempre começam com um sinal igual ("=").
setFormula(formula: string): void;
Parâmetros
- formula
-
string
Retornos
void
setVisible(visible)
Especifica se o objeto está visível.
setVisible(visible: boolean): void;
Parâmetros
- visible
-
boolean
Retornos
void