Documentação HotXLS

Membros avançados da API XLSX

Estes membros cobrem superfícies de edição XLSX públicas porém menos comuns, que complementam as principais páginas de referência de pasta de trabalho, planilha, intervalo, estilo, filtro e gráfico

Painéis, exibição e plano de fundo da planilha

TXLSXWorksheet.SplitPanes e RemoveSplit editam o estado dos painéis divididos; SplitRow, SplitCol, PaneStateKind e ScrollCol expõem as coordenadas armazenadas da exibição

DisplayRowColHeaders controla os títulos de linhas e colunas, GridLinesSet distingue uma escolha explícita de linhas de grade do padrão, e DefaultFormat mais StyleOverlays expõem o estado de estilo no nível da planilha

BackgroundImageData e BackgroundImageFormat expõem a imagem de plano de fundo da planilha, BackgroundImageResource fornece um payload e uma descrição de formato somente leitura independentes de backend, e ClearBackgroundImage a remove

Seleções de painel e rolagem

GetSelectedAreas e o overload de SelectAreas com painel à frente usam o tipo compartilhado TXLSPanePosition, preservam áreas A1 ordenadas e sobrepostas e retornam snapshots de propriedade do chamador com o índice da área ativa

Edições estruturais de linha ou coluna inteira remapeiam cada seleção de painel, preservam a ordem sobrevivente e a identidade da área ativa, e usam fallbacks determinísticos de sucessora, antecessora ou célula de contorno quando a área ativa é removida

Normalização de seleção, remapeamento estrutural e construção de snapshots usam builders de uma única passada e crescimento geométrico de capacidade para processar grandes áreas em tempo amortizado-linear

TryGetWindowScroll e ScrollWindow usam os mesmos painéis lógicos e coordenadas de base 1, mantendo de forma independente as posições de rolagem gerais do sheetView e dos pane inferior ou direito

Painéis ausentes e atualizações inválidas deixam a planilha inalterada; veja Seleções de painel e rolagem da planilha

Intervalos keep-together de paginação

KeepRowsTogether, ClearKeepRowsTogether, KeepColumnsTogether, ClearKeepColumnsTogether e KeepTogetherCount definem blocos que devem permanecer em uma única página quando a geometria permitir

BreakSplitsKeepBlock, ColBreakSplitsKeepBlock, KeepBlockBreakRow e KeepColBlockBreakCol inspecionam como as quebras de página propostas interagem com esses blocos

Auxiliares de edição da planilha

AddImagePair grava uma imagem primária mais um acompanhante de Fallback, como SVG e PNG, AddChartFromRanges cria um gráfico a partir de intervalos tipados de categorias e valores, e CheckDataValidations retorna toda célula em violação

CheckDataValidation testa um valor candidato contra cada regra de validação que cobre uma célula, retorna -1 quando válido ou o índice (base 1) da primeira regra que falha, e opcionalmente só confirma um candidato válido

GetCellVisibleFormat resolve a formatação efetiva de planilha, linha, coluna, overlay de intervalo e célula explícita sem criar uma célula vazia; Subtotal agrupa um intervalo ordenado pelas mudanças em uma coluna e insere fórmulas de subtotal, fórmulas de total geral opcionais, formatação herdada e níveis de contorno

SortRangeInternal é o ponto de entrada avançado de ordenação estável usado pelas operações de intervalo e de relatório; os chamadores normalmente devem preferir SortRange ou TXLSXRange.Sort

ClearColWidth e ClearRowHeight removem a dimensão explícita de uma coluna ou linha para que ela volte ao padrão da planilha, complementando as sondagens HasColWidth / HasRowHeight

Controle de nós de contorno

TryGetOutlineNode retorna o nó de resumo com detecção de direção, o intervalo de detalhe, o nível de contorno, o estado oculto e o marcador de recolhimento explícito para um índice de linha ou coluna com base 1

SetOutlineNodeCollapsed recolhe ou expande um nó de resumo de forma idempotente, enquanto SetOutlineDisplayLevel aplica o nível de botão de contorno (base 1) em todos os grupos materializados; ambos aceitam o tratamento de filhos xocPreserve, xocCollapse ou xocExpand

ToggleRowGrouped e ToggleColGrouped continuam sendo wrappers de compatibilidade que aceitam o índice da primeira linha/coluna de detalhe e resolvem o nó de resumo real a partir de SummaryBelow ou SummaryRight

Grupos nativos de linhas e colunas do OpenDocument mapeiam por meio de table:display, sobrevivem a edições diretas de metadados e estruturais, e convertem para marcadores de nó de resumo XLSX sem reter flags de recolhimento no nível de membro; veja Geometria esparsa de contorno

Estilos nomeados e resolução de estilo de tabela

TXLSXRange.ApplyNamedStyle vincula um intervalo a um estilo de célula nomeado; TXLSXLinkedStyle.AutomaticChoose deriva as partes de formato afetadas a partir do estilo, enquanto LinkedParts seleciona fonte, preenchimento, borda, formato numérico, alinhamento ou proteção explicitamente

Editar TXLSXNamedStyle.Style atualiza as partes vinculadas sem descartar overrides locais, e GetCellVisibleFormat resolve o resultado junto com os overlays da planilha e os estilos de tabela sem materializar células em branco

TXLSXNamedStyles.FindByName localiza uma entrada de estilo nomeado pelo seu nome de exibição sem varrer a coleção manualmente

Os 60 nomes de estilo de tabela internos light, medium e dark resolvem para formatos de seção completos baseados em tema, compartilhados pela saída de HTML, PDF, imagem, preview e viewer

Conversão de fórmulas

TXLSXCell.ConvertFormulaToValue substitui uma fórmula pelo seu valor em cache e TXLSXCells.ConvertFormulasToValues aplica a mesma operação à coleção de células armazenada

Validação de entrada de fórmulas

TXLSXWorkbook.FormulaEntryPolicy e TXLSXWorksheet.ValidateFormulaEntry expõem o contrato compartilhado de entrada de fórmulas sem mutação, distinguem texto vazio, funções desconhecidas, nomes desconhecidos, falhas de sintaxe e destinos inválidos, e reconhecem funções de usuário registradas sem invocá-las; veja Política de validação de entrada de fórmulas

Diagnósticos de armazenamento de células

TXLSXCells.PackedStorageEnabled controla o backend RLE compactado usado por gravações em lote tipadas compatíveis com ordem linha a linha, e PackedCellCount informa as células retidas ali antes que o acesso no nível de objeto materialize handles estáveis de célula

GetStorageStatistics informa blocos de linha, linhas populadas e contagens de bytes de objetos, texto, fórmulas, rich text, compactado estimado, compactado ativo, alocado, usado e strings compactadas para decisões de memória mensuráveis; as contagens de payload de estilo e os bytes de payload de blanks estilizados evitados expõem diretamente o compartilhamento copy-on-write

Detalhes do AutoFiltro

TXLSXAutoFilterColumn.ClearValueFilters limpa filtros de valor e de grupo de data mantendo a entrada da coluna

HasCriteria2 e AndConnector descrevem filtros personalizados de duas condições; filtros de cor usam HasColorFilter, HasColorFilter_CellColor e HasColorFilter_DxfId; filtros de ícone usam HasIconFilter, HasIconFilter_Set e HasIconFilter_Id

Filtros dinâmicos usam HasDynamicFilter, HasDynamicFilter_Type, HasDynamicFilter_Val, HasDynamicFilter_ValSet, HasDynamicFilter_MaxVal e HasDynamicFilter_MaxValSet; RawXml preserva a carga de filtro não suportada

Preenchimentos de gradiente

TXLSXFill.AddGradientStop anexa uma parada de cor. GradientKind, GradientDegree, GradientLeft, GradientTop, GradientRight, GradientBottom, GradientStopCount e GradientStops expõem a geometria linear ou de caminho

BackgroundColorTheme, BackgroundColorIndex e BackgroundTintAndShade preservam cores de plano de fundo não RGB, e TXLSXFills.AddLinearGradient cria e registra um gradiente linear completo

TXLSXFill.ForegroundColorTheme, ForegroundColorIndex e ForegroundTintAndShade são as contrapartes de primeiro plano, preservando cores de primeiro plano de tema, índice de paleta e tint-and-shade junto ao valor RGB

Gráficos

TXLSXChart expõe PlotGroupCount, ChartStyle, DispBlanksAs, PlotVisibleOnly e a facade de compatibilidade DataLabelsRange, cujo setter propaga para as séries atuais e pré-configura as séries futuras, enquanto o getter retorna apenas uma fórmula comum por série

TXLSXChartPlotGroup.Assign copia um grupo de plotagem; ZOrder, BarGrouping, GapWidth e Overlap controlam sua ordenação e a geometria das barras

TXLSXChartSeries expõe SolidFillHex, SolidFillSet, MarkerSymbol, MarkerSize, MarkerSet, LabelNumFmt, LabelNumFmtSet, LabelPos e LabelPosSet

Rótulos por série originados de células usam DataLabelsRange, DataLabelsCache, ShowDataLabelsRange e ShowDataLabelsRangeSet; SetPointShowDataLabelsRange e TryGetPointShowDataLabelsRange mantêm overrides esparsos de visibilidade com base 0, enquanto ResolveDataLabelsRange atualiza o texto acessível da planilha uma vez por geração da pasta de trabalho e retém caches externos sem abrir uma fonte de dados

TXLSXChartSeries.CategoriesMultiLevel emite categorias c:multiLvlStrRef para rótulos de eixo hierárquicos, enquanto o padrão mantém a emissão plana c:strRef / c:numRef

TXLSXChartTrendline expõe Intercept, InterceptSet, Forward e Backward como períodos de previsão, enquanto TXLSXChartAxis.ShowDispUnitsLabel controla o rótulo de unidades de exibição

Formatos condicionais e validações

TXLSXConditionalFormat.ContainsCellFast executa verificações indexadas de associação, HasStyle informa um estilo diferencial, e StdDev, EqualAverage e IsPivot expõem flags avançadas de regra

TXLSXConditionalFormat.AcquireWriteGuard retorna o IXLSWorkbookWriteGuard da pasta de trabalho para que edições de regras em lote avancem a geração da pasta de trabalho uma única vez ao concluir

TXLSXDataValidation.ContainsCellFast executa a verificação indexada equivalente de associação ao intervalo de validação

Tabelas, planilhas, links, comentários e desenhos

TXLSXTable.TableType, ConnectionId, ColumnQueryTableFieldIds e HasHeaderRow preservam metadados de tabela com suporte de consulta e sem cabeçalho

TXLSXTable.FindFirst e FindNext varrem uma planilha informada pelo chamador em busca de linhas cuja coluna nomeada seja igual a um valor, retornando uma linha (base 1) ou 0, com comparações de string, numéricas e booleanas sem diferenciar maiúsculas

TXLSXSheets.AddCopy duplica uma planilha com objetos dependentes e ByPos acessa a coleção pela posição atual da guia

TXLSXExternalLink.AddDefinedName e DefinedNameCount mantêm nomes externos em cache e FindDefinedName localiza uma entrada pelo nome; as propriedades somente leitura RelationshipId, SourceSlot e LinkKind expõem o id de relationship da parte de link externo, o slot [N] (base 1) usado por fórmulas externas e a classificação do link (pasta de trabalho, DDE, OLE ou desconhecido); TXLSXHyperlink.TargetFrame preserva o contexto de navegação de destino

TXLSXDefinedName.UnknownAttributes preserva atributos não reconhecidos em um nome definido para que extensões não suportadas sobrevivam a Round trips

TXLSXComment.AutoSizeFromText dimensiona a forma do comentário conforme seu texto e ClearFont remove runs de fonte de rich text explícitos

TXLSXImage.SvgData armazena o acompanhante SVG e CameraRange identifica um intervalo de origem de imagem vinculada; TXLSXTextBox.PrstToken preserva o token de geometria predefinida do DrawingML

Imagens compartilham payloads sem copiar bytes: atribuir TXLSXImage.Blob (a interface IXLSXImageBlob com Data, SvgData, CacheKey, ContentDigest, SvgContentDigest e ByteSize) é o caminho zero-copy para imagens de relatório repetidas, os digests são calculados uma vez para o interning de mídia no salvamento, e o TXLSXImage.CacheKey e o ContentDigest somente leitura informam a identidade atribuída; o cache de relatório rejeita uma cache key reutilizada com bytes ou formatos diferentes

DrawingObjectCount e DrawingObject expõem uma única ordem mista estável entre imagens, gráficos, caixas de texto, âncoras brutos preservados e grupos; cada TXLSXDrawingObject expõe Kind, Parent, ChildCount e TextBox, e pode ser reordenado com BringToFront, SendToBack, BringForward e SendBackward

GroupDrawingObjects cria um grupo DrawingML com suporte a transformação a partir dos objetos selecionados e UngroupDrawingObject restaura seus filhos em ordem, inclusive grupos carregados de um pacote existente

Contrapartes clássicas de planilha

TXLSWorksheet.SetBackgroundImage, ClearBackgroundImage e BackgroundImageResource criam, removem e inspecionam planos de fundo de planilha BIFF8; dados de bitmap são expostos como um BMP padrão, formatos nativos ou desconhecidos retêm seu payload bruto e código de formato, e planos de fundo conhecidos convertem em qualquer direção entre os motores clássico e XLSX

TXLSWorksheet.ConvertFormulasToValues substitui fórmulas por resultados em cache, os overloads de OpenRTF importam uma tabela RTF no destino padrão ou selecionado pelo chamador, WriteAutoValue seleciona um tipo de célula a partir de um variant, e DefaultFormat expõe o XF padrão da planilha

Veja também