Excel.Interfaces.WorksheetData interface
Uma interface que descreve os dados retornados chamando worksheet.toJSON()
.
Propriedades
auto |
Representa o |
charts | Retorna uma coleção de gráficos que fazem parte da planilha. |
comments | Retorna um conjunto de todos os objetos Comments na planilha. |
custom |
Obtém uma coleção de propriedades personalizadas no nível da planilha. |
enable |
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. |
horizontal |
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. |
page |
Obtém o |
pivot |
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. |
show |
Especifica se as linhas de grade estão visíveis para o usuário. |
show |
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. |
standard |
Retorna a altura padrão de todas as linhas na planilha, em pontos. |
standard |
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). |
tab |
A cor da guia da planilha. Ao recuperar a cor da guia, se a planilha estiver invisível, o valor será |
tab |
Retorna um valor que representa essa planilha que pode ser lido pelo Open Office XML. Esse é um valor inteiro, que é diferente de |
tables | Coleção de tabelas que fazem parte da planilha. |
vertical |
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
charts
Retorna uma coleção de gráficos que fazem parte da planilha.
charts?: Excel.Interfaces.ChartData[];
Valor da propriedade
Comentários
comments
Retorna um conjunto de todos os objetos Comments na planilha.
comments?: Excel.Interfaces.CommentData[];
Valor da propriedade
Comentários
customProperties
Obtém uma coleção de propriedades personalizadas no nível da planilha.
customProperties?: Excel.Interfaces.WorksheetCustomPropertyData[];
Valor da propriedade
Comentários
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
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
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
name
O nome de exibição da planilha.
name?: string;
Valor da propriedade
string
Comentários
names
Coleção de nomes com escopo para a planilha atual.
names?: Excel.Interfaces.NamedItemData[];
Valor da propriedade
Comentários
pageLayout
Obtém o PageLayout
objeto da planilha.
pageLayout?: Excel.Interfaces.PageLayoutData;
Valor da propriedade
Comentários
pivotTables
Coleção de Tabelas Dinâmicas que fazem parte da planilha.
pivotTables?: Excel.Interfaces.PivotTableData[];
Valor da propriedade
Comentários
position
A posição baseada em zero da planilha na pasta de trabalho.
position?: number;
Valor da propriedade
number
Comentários
protection
Retorna o objeto de proteção de planilha para uma planilha.
protection?: Excel.Interfaces.WorksheetProtectionData;
Valor da propriedade
Comentários
shapes
Retorna a coleção de todos os objetos Shape na planilha.
shapes?: Excel.Interfaces.ShapeData[];
Valor da propriedade
Comentários
showGridlines
Especifica se as linhas de grade estão visíveis para o usuário.
showGridlines?: boolean;
Valor da propriedade
boolean
Comentários
showHeadings
Especifica se os títulos estão visíveis para o usuário.
showHeadings?: boolean;
Valor da propriedade
boolean
Comentários
slicers
Retorna uma coleção de segmentações que fazem parte da planilha.
slicers?: Excel.Interfaces.SlicerData[];
Valor da propriedade
Comentários
standardHeight
Retorna a altura padrão de todas as linhas na planilha, em pontos.
standardHeight?: number;
Valor da propriedade
number
Comentários
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
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
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
tables
Coleção de tabelas que fazem parte da planilha.
tables?: Excel.Interfaces.TableData[];
Valor da propriedade
Comentários
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
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. ]
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