workbookRange resource type
Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Representa um conjunto de uma ou mais células contíguas num livro, como uma célula, uma linha, uma coluna ou um bloco de células.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| Get | workbookRange | Leia as propriedades e relações de um objeto de intervalo. |
| Atualizar | workbookRange | Atualizar um objeto de intervalo. |
| Delete | Nenhum | Elimine as células associadas ao intervalo. |
| Clear | Nenhum | Limpar valores de intervalo, formato, preenchimento ou limite. |
| Obter delimitação delimitadora | workbookRange | Obtenha o objeto de intervalo mais pequeno que abrange os intervalos especificados. Por exemplo, GetBoundingRect de "B2:C5" e "D10:E15" é "B2:E16". |
| Obter célula | workbookRange | Obtenha o objeto de intervalo que contém a única célula com base nos números de linha e coluna. A célula pode estar fora dos limites do respetivo intervalo principal, desde que permaneça na grelha da folha de cálculo. A localização da célula retornada está relacionada à célula superior esquerda do intervalo. |
| Obter coluna | workbookRange | Obter uma coluna contida no intervalo. |
| Obter colunas depois | workbookRangeView | Obtenha algumas colunas à direita do intervalo especificado. |
| Obter colunas antes | workbookRangeView | Obtenha algumas colunas à esquerda do intervalo especificado. |
| Obter coluna inteira | workbookRange | Obtenha um objeto que represente toda a coluna do intervalo. |
| Obter linha inteira | workbookRange | Obtenha um objeto que represente toda a linha do intervalo. |
| Obter interseção | workbookRange | Obtenha o objeto de intervalo que representa a interseção retangular dos intervalos especificados. |
| Obter última célula | workbookRange | Obtenha a última célula dentro do intervalo. Por exemplo, a última célula de "B2:D5" é "D5". |
| Obter a última coluna | workbookRange | Obtenha a última coluna dentro do intervalo. Por exemplo, a última coluna de "B2:D5" é "D2:D5". |
| Obter última linha | workbookRange | Obtém a última linha dentro do intervalo. Por exemplo, a última linha de "B2:D5" é "B5:D5". |
| Obter intervalo de deslocamento | workbookRange | Obtenha um objeto que represente um intervalo que seja desfasado do intervalo especificado. A dimensão do intervalo devolvido corresponde a este intervalo. Quando o intervalo resultante é imposto fora dos limites da grade da planilha, o sistema gera uma exceção. |
| Obter intervalo redimensionado | workbookRangeView | Obtenha um objeto de intervalo semelhante ao objeto de intervalo atual, mas com o canto inferior direito expandido (ou contratado) por alguns números de linhas e colunas. |
| Obter linha | workbookRange | Obter uma linha contida no intervalo. |
| Obter linhas acima | workbookRangeView | Obtenha algumas linhas acima de um determinado intervalo. |
| Obter linhas abaixo | workbookRangeView | Obtenha algumas linhas abaixo de um determinado intervalo. |
| Obter intervalo usado | workbookRange | Devolver o intervalo utilizado do determinado objeto de intervalo. |
| Obter vista visível | workbookRangeView | Obtenha o intervalo visível de um intervalo filtrado. |
| Inserir intervalo | workbookRange | Insira uma célula ou um intervalo de células na folha de cálculo em vez deste intervalo e desloca as outras células para libertar espaço. Retorna um novo objeto Range no espaço em branco atual. |
| Merge | Nenhum | Mescla as células do intervalo em uma região da planilha. |
| Unmerge | Nenhum | Desfaz a mesclagem das células do intervalo em células separadas. |
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| address | cadeia de caracteres | Representa a referência do intervalo no estilo A1. O valor de endereço contém a Referência da folha (por exemplo, Folha1! A1:B4). Somente leitura. |
| addressLocal | string | Representa a referência de intervalo para o intervalo especificado no idioma do usuário. Somente leitura. |
| cellCount | int | Número de células no intervalo. Somente leitura. |
| columnCount | int | Representa o número total de colunas no intervalo. Somente leitura. |
| columnHidden | Booliano | Indica se todas as colunas do intervalo atual estão ocultas. |
| columnIndex | int | Representa o número de colunas da primeira célula no intervalo. Indexados com zero. Somente leitura. |
| formulas | Json | Representa a fórmula em notação A1. |
| formulasLocal | Json | Representa a fórmula em notação A1, na formatação de número da localidade e no idioma do usuário. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. |
| formulasR1C1 | Json | Representa a fórmula em notação no estilo L1C1. |
| hidden | Booliano | Representa se todas as células do intervalo atual estão ocultas. Somente leitura. |
| numberFormat | Json | Representa o código de formato de número do Excel para determinada célula. |
| rowCount | int | Retorna o número total de linhas no intervalo. Somente leitura. |
| rowHidden | Booliano | Indica se todas as linhas do intervalo atual estão ocultas. |
| rowIndex | int | Representa o número de linhas da primeira célula no intervalo. Indexados com zero. Somente leitura. |
| text | Json | Valores de texto do intervalo especificado. O valor do texto não depende da largura da célula. A substituição de sinal # que ocorre na IU do Excel não afeta o valor de texto devolvido pela API. Somente leitura. |
| valueTypes | string | Representa o tipo de dados de cada célula. Os valores possíveis são: Unknown, Empty, String, Integer, Double, Boolean e Error. Somente leitura. |
| values | Json | Representa os valores brutos do intervalo especificado. Os dados devolvidos podem ser do tipo cadeia, número ou booleano. A célula que contém um erro devolve a cadeia de erro. |
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| formato | WorkbookRangeFormat | Retorna um objeto de formato que encapsula a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades do intervalo. Somente leitura. |
| sort | WorkbookRangeSort | A planilha que contém o intervalo atual. Somente leitura. |
| planilha | WorkbookWorksheet | A planilha que contém o intervalo atual. Somente leitura. |
Representação JSON
A representação JSON seguinte mostra o tipo de recurso.
{
"id": "string",
"address": "string",
"addressLocal": "string",
"cellCount": 1024,
"columnCount": 1024,
"columnHidden": true,
"columnIndex": 1024,
"formulas": "Json",
"formulasLocal": "Json",
"formulasR1C1": "Json",
"hidden": true,
"numberFormat": "Json",
"rowCount": 1024,
"rowHidden": true,
"rowIndex": 1024,
"text": "Json",
"valueTypes": "string",
"values": "json"
}