Documentação HotXLS

Exibições de pasta de trabalho, conexões e XML Maps

Esta referência cobre metadados editáveis da pasta de trabalho que ficam fora da grade de células e devem permanecer consistentes quando planilhas, intervalos, filtros e partes do pacote mudam

Exibições personalizadas clássicas

TXLSWorksheet.CustomViews retorna TXLSCustomViews, cujos membros Count, Items, Invalidatee SyncToRaw preservam registros de exibições personalizadas tipados e desconhecidos

TXLSCustomView exposes ViewId, Zoom, GridColorIndex, ActivePane, ShowPageBreaks, ShowFormulas, ShowGridLines, ShowHeadings, ShowOutlineSymbols, ShowZeroValues, CenterHorizontally, CenterVertically, PrintHeadingsexpõe PrintGridLines, FitToPage, FilterMode, AutoFilterVisible, FrozenPanes, FrozenNoSplit, SplitVertically, SplitHorizontally, TopLeftRow, TopLeftColumn, SplitX, SplitY, RightPaneColumn, BottomPaneRow, SelectionCount, Selections, HorizontalPageBreaks, VerticalPageBreaks, HasPageSetup, PaperSize, PrintScale, FirstPageNumber, FitToPagesWide, FitToPagesTall, PageSetupFlags, HorizontalResolution, VerticalResolution, HeaderMargin, FooterMargin, Copies, FilterFieldCount, FilterActive, FilterCriteria1, FilterCriteria2, FilterOperators, ClearFilterCriteria, RawRecordCount, RawRecordIdse RawRecordData

TXLSCustomViewCellRange, TXLSCustomViewCellRanges, TXLSCustomViewSelectionInfo, TXLSCustomViewPageBreake TXLSCustomViewPageBreaks transportam as cargas de seleção e de quebra de página de propriedade de uma exibição

Janelas de pasta de trabalho XLSX

TXLSXWorkbook.WorkbookViews possui entradas ordenadas de TXLSXWorkbookView configuradas por TXLSXWorkbookViewVisibility

TXLSXWorkbookViewAssign, ActiveTab, FirstSheet, Visibility, Minimized, ShowHorizontalScroll, ShowVerticalScroll, ShowSheetTabs, XWindow, YWindow, WindowWidth, WindowHeight, TabRatio, AutoFilterDateGroupinge UnknownAttributes, and Extensions
TXLSXWorkbookViewsAdd, Insert, Delete, Move, Clear, Counte Items

A inserção, a exclusão e o movimento de planilhas remapeiam a guia ativa e a primeira guia visível de cada janela, preservando geometria e configurações de exibição independentes

Seleções por painel

TXLSXWorksheet.Selections retorna TXLSXSelections; TXLSXSelectionPane identifica o painel de destino e cada TXLSXSelection armazena Pane, ActiveCell, ActiveCellIde Sqref

TXLSXSelection.Assign copia uma seleção, enquanto TXLSXSelections.Add, AddSelection, Assign, Clear, Delete, IndexOfPane, Counte Items mantêm a coleção ordenada de exibições de planilha

Submodelos de conexão

TXLSConnection preserva metadados de banco de dados, web, texto e OLAP. Seu modelo web usa WebParsePre, WebHtmlTablese WebTables; seu modelo de texto fixo usa TextSourceFile e TextFields; seu modelo OLAP usa HasOlapProperties, OlapLocal, OlapLocalConnection, OlapLocalRefresh, OlapSendLocale, OlapRowDrillCount, OlapServerFill, OlapServerNumberFormat, OlapServerFont, OlapServerFontColor, OlapExtraAttributesXmle OlapChildrenXml

SourceFile armazena a origem da conexão de nível superior, enquanto TextSourceFile armazena a origem de importação textPr independente; um TextSourceFile vazio usa SourceFile como fallback por compatibilidade

TXLSWebTableSelectorKind configura TXLSWebTableSelector, cujos membros Kind, Name, Index, ExtraAttributesXml, ChildrenXml, Assigne Validate preservam seletores nomeados, indexados e de tabela completa

TXLSWebTableSelectors fornece Add, AddExisting, Assign, Validate, Delete, Clear, Count, Items, ExtraAttributesXmle UnknownChildrenXml

TXLSTextImportFieldType configura TXLSTextImportField, cujos membros FieldType, Position, ExtraAttributesXml, ChildrenXmle Assigndefinem um campo de texto fixo Validate members define one fixed-text field

TXLSTextImportFields fornece Add, AddExisting, Assign, Validate, Delete, Clear, Count, Items, ExtraAttributesXmle UnknownChildrenXml

Membros completos de conexão

TXLSConnection são Id, TypeCode, SourceFile, OdcFile, SingleSignOnId, KeepAlive, Interval, BackgroundRefresh, RefreshOnLoad, SaveData, SavePassword, NewConnection, Deleted, OnlyUseConnectionFile, ReconnectionMethod, RefreshedVersion, MinRefreshableVersion, ConnectionString, CommandText, ServerCommandText, CommandType, Parameterse ExtensionXml

As propriedades web são WebUrl, WebPost, WebEditPage, WebHtmlFormat, WebXml, WebSourceData, WebConsecutive, WebFirstRow, WebXl97, WebTextDates, WebXl2000, WebExtraAttributesXmle WebChildrenXml

As propriedades de texto são TextSourceFile, TextPrompt, TextDelimited, TextCodePage, TextFirstRow, TextCharacterSet, TextQualifier, TextFileType, TextDecimal, TextThousands, TextTab, TextSpace, TextComma, TextSemicolon, TextConsecutive, TextDelimiter, TextExtraAttributesXmle TextChildrenXml; a preservação de banco de dados usa DbExtraAttributesXml e DbChildrenXml

TXLSConnections.Assign copia uma coleção, IndexOfId encontra um identificador de conexão estável e RootAttributesXml mais UnknownChildrenXml preservam conteúdo raiz não suportado

Parâmetros de conexão

TXLSConnectionParameter usa Name, ParameterType, SqlType, RefreshOnChange, Prompt, CellReference, IntegerValue, DoubleValue, BooleanValue, StringValue, ValueKind, ExtraAttributesXmle Assign

TXLSConnectionParameters fornece Add, AddExisting, Assign, Delete, Clear, Counte Items

Tabelas de consulta e campos

TXLSQueryTable usa Assign, ConnectionId, ResultTableName, ResultRange, RowNumbers, DisableRefresh, BackgroundRefresh, FirstBackgroundRefresh, RefreshOnLoad, GrowShrinkType, FillFormulas, RemoveDataOnSave, DisableEdit, PreserveFormatting, Intermediate, AutoFormatId, ApplyNumberFormats, ApplyBorderFormats, ApplyFontFormats, ApplyPatternFormats, ApplyAlignmentFormats, ApplyWidthHeightFormats, PreserveSortFilterLayout, FieldIdWrapped, AdjustColumnWidth, HeadersInLastRefresh, MinimumVersion, UnboundColumnsLeft, UnboundColumnsRight, DeletedFields, SortStateXml, ExtensionXml, RefreshExtensionXmle UnknownChildrenXml, ExtraAttributesXml, RefreshExtraAttributesXml, and RefreshUnknownChildrenXml

TXLSQueryTableField uses Idusa Name, TableColumnId, DataBound, RowNumbers, FillFormulas, Clipped, ExtraAttributesXml, Assigne Validate

TXLSQueryTableFields fornece Add, AddExisting, Assign, FindById, FindByTableColumnId, NextId, Validate, Deletee Clear; Countcopia a coleção de tabelas de consulta da planilha Items; TXLSQueryTables.Assign copia a coleção de query tables da planilha

Atualização explícita de tabelas de consulta

Veja provedores de consulta automáticos para atualização explícita sem um provider do chamador, registro, vínculos nativos e limites de operações externas

TXLSXWorksheet.RefreshQueryTable seleciona uma tabela de consulta existente pelo nome ou pelo índice de base zero de sua coleção e aceita um TXLSQueryTableProvider de propriedade do chamador, um limite positivo AMaxRows que tem como padrão 1.000.000 de linhas de dados, e um callback TXLSQueryRefreshProgress opcional

Implemente TXLSQueryTableProvider.Fetch(Connection, Query, MaxRows, out Data, var Abort) para retornar um record TXLSQueryResultData com ColumnCount e Rows retangulares de valores escalares Variant; TXLSQueryResultRow é um array de variants e TXLSQueryResultRows é um array dessas linhas; as linhas excluem os cabeçalhos existentes e devem corresponder à largura do alvo, valores numéricos, datas, booleanos, strings, erros, valores vazios e nulls retêm seus tipos, e strings que começam com = permanecem valores literais

O provider recebe snapshots destacados de metadados de conexão e de consulta, válidos apenas durante a chamada, e deve respeitar o limite de linhas; a biblioteca rejeita linhas em excesso, matrizes irregulares, tipos de valor sem suporte, larguras inválidas e resultados fora da grade de planilha de 1.048.576 linhas por 16.384 colunas, sem truncamento

A atualização preserva os cabeçalhos existentes e a formatação das células, limpa a antiga cauda de dados de um resultado que encolhe, redimensiona uma tabela Excel anexada e intervalos de filtro ou de ordenação suportados, atualiza os metadados da tabela de consulta e invalida os cálculos dependentes; fórmulas e estilos fora da área de resultado permanecem inalterados

Uma consulta desabilitada, uma conexão excluída, células mescladas ou fórmulas de matriz sobrepostas, outra tabela ou resultado de consulta, células de expansão ocupadas, colunas calculadas de tabela, linhas de totais, colunas de números de linha, comportamento de preenchimento de fórmulas ou colunas não vinculadas impedem a atualização antes que as células de resultado mudem

O progresso é informado antes da busca, antes de aplicar os resultados e após cada linha aplicada ou limpa; defina Abort no provider ou no callback de progresso para cancelar, e um valor de retorno de 1 indica sucesso, 0 cancelamento e -1 falha, com os códigos de diagnóstico 1401 e 1400 identificando cancelamento e falha sob xlsOperationRefresh

Cancelamento ou exceções de provider, de validação ou de callback restauram as células de resultado e os metadados de consulta ou de tabela, incluindo os handles de células existentes; providers explícitos do chamador são responsáveis pelo próprio acesso externo; a seleção automática para consultas Text, ADO, ODBC e Web do Windows com suporte está disponível por meio do dispatcher da pasta de trabalho, e abrir uma pasta de trabalho ou preservar metadados RefreshOnLoad não invoca nenhum dos dois caminhos de provider

XML Maps e XML personalizado

TXLSXWorkbook.XmlMaps retorna TXLSXXmlMaps, e TXLSXWorksheet.XmlCellBindings retorna a coleção de associações da planilha

TXLSXXmlDataBindingArmazena o identificador de relacionamento e os metadados de atualização que conectam um mapa a uma parte XML personalizada Enabled, DataBindingName, FileBinding, FileBindingName, ConnectionId, DataBindingLoadMode, and ExtensionXml mirror the OOXML dataBinding attributes
TXLSXXmlSchemaArmazena um identificador de esquema, um namespace e o XML de esquema preservado Id, SchemaRef, NamespaceUri, Language, and Xml round-trip the schema part
TXLSXXmlMapArmazena a identidade do mapa, o elemento raiz e o namespace, e seu DataBinding; import behaviour is configured by RootElement, SchemaId, ShowImportExportValidationErrors, AutoFit, Append, PreserveSortAFLayoutArmazena a identidade do mapa, o elemento raiz e o namespace, e seu PreserveFormat
TXLSXXmlMapsAddSchema, AddMap, FindSchema, FindMap, DeleteSchema, DeleteMap, Clear, Validate, SelectionNamespacese SchemaCountTXLSXXmlCellBinding SchemasMapeia um intervalo de planilha para um XPath e um identificador de mapa XML MapCount
TXLSXXmlCellBindingSobrecargas de CellReference, XPath, XmlDataType, MapId, XmlCellPropertyIde ConnectionId, and UniqueName preserve the full OOXML binding
TXLSXXmlCellBindingsAdd overloads, Delete, Clear, Validate, Count, and Items
TXLSXCustomXmlPartAddSchemaRef associa um item XML personalizado a uma referência de esquema; Xml holds the item payload, ItemId the data-store item identifier, and SchemaRefs associa um item XML personalizado a uma referência de esquema

Membros avançados de clonagem, HTML e imagem

TXLSXRangeClonePart, TXLSXRangeClonePartse TXLSXRangeCloneSourceCounts definem a clonagem de intervalo ciente de dependências. TXLSXWorksheet.CaptureRangeCloneSourceCounts, AuthorizeRepeatedDisjointRangeClones, ResizeTableRowse TileRangeAxisMetadata são ganchos avançados de edição estrutural usados pela expansão de relatórios compilados e por participantes personalizados

TXLSXHtmlExportSessionState descreve TXLSXHtmlExportSession; use BeginExport, ExportNextSheete Resete, em seguida, inspecione State, Active, ExportedSheetCounte TotalSheetCount. Defina TXLSXHtmlExportOptions.IncludeDrawings para renderizar objetos suportados da planilha na sessão HTML

TXLSXImage expõe Gamma, ShadowColor, ShadowOpacity, ShadowBlur, ShadowOffsetXe ShadowOffsetY para renderização compartilhada de PDF, SVG, HTML, bitmap e metarquivo

Veja também