Compartilhar via


Excel.Interfaces.WorksheetData interface

Uma interface que descreve os dados retornados chamando worksheet.toJSON().

Propriedades

autoFilter

Representa o AutoFilter objeto da planilha.

charts

Retorna uma coleção de gráficos que fazem parte da planilha.

comments

Retorna um conjunto de todos os objetos Comments na planilha.

customProperties

Obtém uma coleção de propriedades personalizadas no nível da planilha.

enableCalculation

Determina se o Excel deve recalcular a planilha quando necessário. True se o Excel recalcular a planilha quando necessário. False se o Excel não recalcular a planilha.

horizontalPageBreaks

Obtém a coleção de quebra de página horizontal da planilha. Esta coleção contém apenas quebras de página manuais.

id

Retorna um valor que identifica de forma exclusiva a planilha em uma determinada pasta de trabalho. O valor do identificador permanece o mesmo, ainda que a planilha seja renomeada ou movida.

name

O nome de exibição da planilha.

names

Coleção de nomes com escopo para a planilha atual.

pageLayout

Obtém o PageLayout objeto da planilha.

pivotTables

Coleção de Tabelas Dinâmicas que fazem parte da planilha.

position

A posição baseada em zero da planilha na pasta de trabalho.

protection

Retorna o objeto de proteção de planilha para uma planilha.

shapes

Retorna a coleção de todos os objetos Shape na planilha.

showGridlines

Especifica se as linhas de grade estão visíveis para o usuário.

showHeadings

Especifica se os títulos estão visíveis para o usuário.

slicers

Retorna uma coleção de segmentações que fazem parte da planilha.

standardHeight

Retorna a altura padrão de todas as linhas na planilha, em pontos.

standardWidth

Especifica a largura padrão (padrão) de todas as colunas na planilha. Uma unidade de largura de coluna equivale à largura de um caractere no estilo Normal. Para fontes proporcionais, será usada a largura do caractere 0 (zero).

tabColor

A cor da guia da planilha. Ao recuperar a cor da guia, se a planilha estiver invisível, o valor será null. Se a planilha estiver visível, mas a cor da guia estiver definida como automática, uma cadeia de caracteres vazia será retornada. Caso contrário, a propriedade será definida como uma cor, no formulário #RRGGBB (por exemplo, "FFA500"). Ao definir a cor, use uma cadeia de caracteres vazia para definir uma cor "automática" ou uma cor real caso contrário.

tabId

Retorna um valor que representa essa planilha que pode ser lido pelo Open Office XML. Esse é um valor inteiro, que é diferente de worksheet.id (que retorna um identificador globalmente exclusivo) e worksheet.name (que retorna um valor como "Sheet1").

tables

Coleção de tabelas que fazem parte da planilha.

verticalPageBreaks

Obtém a coleção de quebra de página vertical da planilha. Esta coleção contém apenas quebras de página manuais.

visibility

A visibilidade da planilha.

Detalhes da propriedade

autoFilter

Representa o AutoFilter objeto da planilha.

autoFilter?: Excel.Interfaces.AutoFilterData;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

charts

Retorna uma coleção de gráficos que fazem parte da planilha.

charts?: Excel.Interfaces.ChartData[];

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

comments

Retorna um conjunto de todos os objetos Comments na planilha.

comments?: Excel.Interfaces.CommentData[];

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

customProperties

Obtém uma coleção de propriedades personalizadas no nível da planilha.

customProperties?: Excel.Interfaces.WorksheetCustomPropertyData[];

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

enableCalculation

Determina se o Excel deve recalcular a planilha quando necessário. True se o Excel recalcular a planilha quando necessário. False se o Excel não recalcular a planilha.

enableCalculation?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

horizontalPageBreaks

Obtém a coleção de quebra de página horizontal da planilha. Esta coleção contém apenas quebras de página manuais.

horizontalPageBreaks?: Excel.Interfaces.PageBreakData[];

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

id

Retorna um valor que identifica de forma exclusiva a planilha em uma determinada pasta de trabalho. O valor do identificador permanece o mesmo, ainda que a planilha seja renomeada ou movida.

id?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

name

O nome de exibição da planilha.

name?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

names

Coleção de nomes com escopo para a planilha atual.

names?: Excel.Interfaces.NamedItemData[];

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

pageLayout

Obtém o PageLayout objeto da planilha.

pageLayout?: Excel.Interfaces.PageLayoutData;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

pivotTables

Coleção de Tabelas Dinâmicas que fazem parte da planilha.

pivotTables?: Excel.Interfaces.PivotTableData[];

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

position

A posição baseada em zero da planilha na pasta de trabalho.

position?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

protection

Retorna o objeto de proteção de planilha para uma planilha.

protection?: Excel.Interfaces.WorksheetProtectionData;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

shapes

Retorna a coleção de todos os objetos Shape na planilha.

shapes?: Excel.Interfaces.ShapeData[];

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

showGridlines

Especifica se as linhas de grade estão visíveis para o usuário.

showGridlines?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

showHeadings

Especifica se os títulos estão visíveis para o usuário.

showHeadings?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

slicers

Retorna uma coleção de segmentações que fazem parte da planilha.

slicers?: Excel.Interfaces.SlicerData[];

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

standardHeight

Retorna a altura padrão de todas as linhas na planilha, em pontos.

standardHeight?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

standardWidth

Especifica a largura padrão (padrão) de todas as colunas na planilha. Uma unidade de largura de coluna equivale à largura de um caractere no estilo Normal. Para fontes proporcionais, será usada a largura do caractere 0 (zero).

standardWidth?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

tabColor

A cor da guia da planilha. Ao recuperar a cor da guia, se a planilha estiver invisível, o valor será null. Se a planilha estiver visível, mas a cor da guia estiver definida como automática, uma cadeia de caracteres vazia será retornada. Caso contrário, a propriedade será definida como uma cor, no formulário #RRGGBB (por exemplo, "FFA500"). Ao definir a cor, use uma cadeia de caracteres vazia para definir uma cor "automática" ou uma cor real caso contrário.

tabColor?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

tabId

Retorna um valor que representa essa planilha que pode ser lido pelo Open Office XML. Esse é um valor inteiro, que é diferente de worksheet.id (que retorna um identificador globalmente exclusivo) e worksheet.name (que retorna um valor como "Sheet1").

tabId?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.14 ]

tables

Coleção de tabelas que fazem parte da planilha.

tables?: Excel.Interfaces.TableData[];

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

verticalPageBreaks

Obtém a coleção de quebra de página vertical da planilha. Esta coleção contém apenas quebras de página manuais.

verticalPageBreaks?: Excel.Interfaces.PageBreakData[];

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

visibility

A visibilidade da planilha.

visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

Valor da propriedade

Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"

Comentários

[ Conjunto de API: ExcelApi 1.1 para visibilidade de leitura; 1.2 para defini-la. ]