Допълнителни членове на API на библиотеката

Тази страница завършва справочника за публичните типове, които подпомагат основните API за работни книги, листове, рендиране, импортиране, диагностика и преглед, но не изискват отделно ръководство по конкретна задача

Филтриране и условно форматиране

TXLSCfValue, TXLSDataBarSpec, TXLSColorScaleSpec, TXLSIconSetSpec и TXLSDxfStyle приемат AttachWriteGuardOwner, свързвайки обекта на правилото със собствената му работна книга, така че редакциите автоматично придобиват защита при запис; притежателят имплементира TXLSCondFormatWriteGuardOwner, чийто единствен метод AcquireWriteGuard предава на правилото защитата при запис на работната книга. TXLSDxfStyle добавя FontColorIndex с FontColorIsIndexed, както и двойките FillFgColorIndex / FillFgColorIsIndexed и FillBgColorIndex / FillBgColorIsIndexed за цветове на правилата като индекси в палитрата, плюс презаписванията на шрифта в диференциалното форматиране FontName, FontSize и FontScheme (празен низ, размер в точки или слот за шрифт на темата като major / minor) редом до съществуващите членове за получер, курсив, подчертаване и цвят; всяко задаване придобива защитата при запис и маркира правилото като променено за повторно излъчване

TXLSConnections, TXLSDataTables и TXLSQueryTables разкриват OnAcquireWriteGuard (типове TXLSConnectionAcquireWriteGuard, TXLSDataTableAcquireWriteGuard и TXLSQueryTableAcquireWriteGuard) — куката, която пътищата им за редактиране използват, за да получат IXLSWorkbookWriteGuard на притежаващата работна книга преди мутация и да отместят генерацията на работната книга след нея; защитата записва StartGeneration, а Complete отбелязва записа като завършен, така че зависимите кешове да могат да се престроят

Запазените връзки с данни носят типизирано описание: TXLSConnectionKind (xlckUnknown, xlckOdbc, xlckDao, xlckFile, xlckWeb, xlckOleDb, xlckText, xlckAdo) класифицира връзката, TXLSConnectionCredentials (xlccIntegrated, xlccNone, xlccStored, xlccPrompt) записва нейния режим на автентикация, а всяка стойност на параметър на връзка е етикетирана с TXLSConnectionParameterValueKind (xlcpvNone, xlcpvBoolean, xlcpvDouble, xlcpvInteger, xlcpvString, xlcpvCell). Таблиците с данни „what-if“ докладват своя съхранен вид дефиниция чрез TXLSDataTableKind

Таблици с данни „what-if“ и групиране в обобщени таблици

Праговете на наборите от значки могат да се рендерират или валидират програмно: XLSCfIconSetCount докладва колко значки дефинира даден TXLSIconSetType, а XLSBuildCfIconGeometry запълва TXLSCfIconGeometry с примитивите (TXLSCfIconPrimitive, вид TXLSCfIconPrimitiveKind: cfipPolygon, cfipEllipse, cfipRect, cfipLine) и точките (TXLSCfIconPoint), които рисуват една значка, така че потребителските рендери да съвпадат с вградените форми на значки на Excel

Диагностика, проследяване на формули и валидация

Правила за запис на външни връзки

TXLSExternalLinkUpdateMode = (xluPromptUser, xluNever, xluAlways);

property IXLSWorkbook.SaveExternalLinkValues: Boolean;
property IXLSWorkbook.UpdateLinks: TXLSExternalLinkUpdateMode;
property TXLSXWorkbook.SaveExternalLinkValues: Boolean;
property TXLSXWorkbook.UpdateLinks: TXLSExternalLinkUpdateMode;
      

Одит на изчисленията и подсказки на работната книга

function TXLSWorkbook.RecalcAndVerify(MaxIssues: Integer = 10000): TXLSCalculationAuditReport;
function TXLSXWorkbook.RecalcAndVerify(MaxIssues: Integer = 10000): TXLSCalculationAuditReport;
function TXLSWorkbook.RecalcAndVerifyEx(const Options: TXLSRecalcAuditOptions): TXLSCalculationAuditReport;
function TXLSXWorkbook.RecalcAndVerifyEx(const Options: TXLSRecalcAuditOptions): TXLSCalculationAuditReport;
function TXLSWorkbook.RunCalculationAudit(const Options: TXLSRecalcAuditOptions): TXLSCalculationAuditReport;
function TXLSWorkbook.FormulaIsVolatile(Formula: WideString): Boolean;

function TXLSWorkbook.AuditOverlayHash(SheetIndex, Row, Col: Integer): Integer;
function TXLSWorkbook.AuditOverlayRead(SheetIndex, Row, Col: Integer; var Value: Variant): Boolean;
procedure TXLSWorkbook.AuditOverlayWrite(SheetIndex, Row, Col: Integer; const Value: Variant);
procedure TXLSWorkbook.AuditOverlayClear;

TXLSCalculationAuditIssueKind = (xlcaiCacheMismatch, xlcaiParseFailure,
  xlcaiMissingFunction, xlcaiMissingName, xlcaiUnsupportedArguments,
  xlcaiCircularReference, xlcaiExternalReferenceDenied,
  xlcaiExternalReferenceMissing, xlcaiDataTableSkipped, xlcaiCancelled,
  xlcaiInternalFailure);

TXLSCalculationAuditIssue = record
  Kind: TXLSCalculationAuditIssueKind;
  SheetIndex: Integer;
  SheetName: WideString;
  Row: Integer;
  Col: Integer;
  Formula: WideString;
  Symbol: WideString;
  Expected: Variant;
  Actual: Variant;
  ResultCode: Integer;
  Stack: WideString;
  ExternalTarget: WideString;
end;
TXLSCalculationAuditIssues = array of TXLSCalculationAuditIssue;

TXLSRecalcAuditProgress = procedure(ASender: TObject;
  ACurrent, ATotal: Integer; var ACancel: Boolean) of object;

property WorkbookCodeName: WideString;
property CalculationThreadMode: TXLSCalculationThreadMode;
property ForceFullCalculationState: TXLSOptionalBooleanState;
property RefreshAllOnLoadState: TXLSOptionalBooleanState;
      

Състояние на табличните формули и IME

property TXLSXTable.ColumnCalculatedFormulaArrayStates[Index: Integer]: TXLSTableFormulaArrayState;
property TXLSXTable.ColumnTotalsFormulaArrayStates[Index: Integer]: TXLSTableFormulaArrayState;
property TDataValidation.ImeMode: TXLSDataValidationImeMode;
property TXLSXDataValidation.ImeModeKind: TXLSDataValidationImeMode;
      

Инспекция и премахване на задачови панели от уеб добавки

function IXLSWorkbook.HasWebAddinTaskPanes: Boolean;
function IXLSWorkbook.WebAddinTaskPaneCount: Integer;
function IXLSWorkbook.RemoveWebAddinTaskPanes: Integer;
function TXLSXWorkbook.HasWebAddinTaskPanes: Boolean;
function TXLSXWorkbook.WebAddinTaskPaneCount: Integer;
function TXLSXWorkbook.RemoveWebAddinTaskPanes: Integer;
      

Правила за показване на обектите на работната книга

TXLSObjectDisplayMode = (xlsodmShowAll, xlsodmShowPlaceholders,
  xlsodmHideAll);

property IXLSWorkbook.ObjectDisplayMode: TXLSObjectDisplayMode;
property TXLSWorkbook.ObjectDisplayMode: TXLSObjectDisplayMode;
property TXLSXWorkbook.ObjectDisplayMode: TXLSObjectDisplayMode;
property TXLSPaginationModel.ExportObjectPlaceholders: Boolean;
property TXLSPDFExport.ExportObjectPlaceholders: Boolean;
property TXLSSvgExport.ExportObjectPlaceholders: Boolean;
property TXLSPageImageExporter.ExportObjectPlaceholders: Boolean;
property TXLSPrintDocument.ExportObjectPlaceholders: Boolean;
property TXLSXHtmlExportOptions.ExportObjectPlaceholders: Boolean;
      

Стойности за калибрация на рендирането и моментни снимки

TXLSRenderCalibration = record
  WidthCorrection: Double;
  HeightCorrection: Double;
  LineSpacing: Double;
  CellMarginFactor: Double;
  ScreenScaling: Integer;
  MeasurementDpi: Integer;
end;

function XLSDefaultRenderCalibration: TXLSRenderCalibration;
function XLSValidateRenderCalibration(const AValue: TXLSRenderCalibration;
  out AInvalidField: TXLSRenderCalibrationField): Boolean;
      

Геометрия на рендирането и измерване на шрифтове

TXLSRenderGeometryBackend = (xlsrgbAutoFit, xlsrgbPagination, xlsrgbPdf,
  xlsrgbSvg, xlsrgbBitmap, xlsrgbPrintPreview, xlsrgbViewer, xlsrgbHtml);

TXLSRenderFont = record
  Name: WideString;
  Size: Double;
  Styles: TXLSRenderFontStyles;
  Charset: Byte;
end;

function CreateXLSRenderGeometry(
  const ACalibration: TXLSRenderCalibration;
  AWorkbookGeneration: UInt64;
  ABackend: TXLSRenderGeometryBackend;
  ACacheCapacity: Integer = 4096): IXLSRenderGeometry;

property TXLSHTMLExport.RenderGeometry: IXLSRenderGeometry;
property TXLSXHtmlExportSession.RenderGeometry: IXLSRenderGeometry;
      

Импортиране, генериране на код, сравнение и наблюдение

Помощни средства за пакети и двоично съхранение

Добавки за рисунки и преглед на работни книги

Пагинация, изображения и печат

Класически Chart модели и Chart обекти на листа

Типизиран декодиран Chart модел

Декодираното състояние на диаграмата е изложено като обикновени записи и enum-и, така че инспектиращият код никога не се налага да обхожда сурови BIFF записи: TXLSChartInfo носи обобщената информация за декодираната диаграма с TXLSChartTypeFamily (cfBar, cfLine, cfPie, cfArea, cfScatter, cfRadar, cfDoughnut, cfSurface, cfBubble), всяка серия докладва TXLSChartSeriesType, а TXLSChart3DState и TXLSChart3DInfo описват тримерните изгледи. TXLSChartAxisType (catCategory, catValue, catSeries, catDate) и TXLSChartLegendPosition класифицират оси и легенди, докато моделът на дата-ос използва TXLSChartDateUnit (xcduDays, xcduMonths, xcduYears) и TXLSChartDateValues. TXLSCustomChart разкрива декодирания модел чрез TXLSChartInfo; анотациите за линии на тренда и ленти за грешки са типизирани обекти (TXLSChartTrendline, TXLSChartErrorBars), достъпни от всяка серия

Записи за създаване на диаграми

Създаването на диаграмни листове и builder код приема обикновени записи вместо обектни графи: TXLSChartTrendlineInfo, TXLSChartErrorBarsInfo, TXLSChartDataLabelsInfo и TXLSChartSeriesStyleInfo попълват записите за серията, подавани на TXLSWorksheets.AddChartSheet и споделения builder за диаграми, а TXLSPivotChartInfo описва рамковането на PivotChart, използвано при закачане на диаграма към обобщена таблица

PDF прикачени файлове, подписи и HTML експорт

Одит на изчисленията и контроли на работната книга

Съвместимост със старото PivotCache рамковане

StreamId се записва като запис SXStreamID ([MS-XLS] §2.4.303) и се повтаря като полето idstm в заглавката на SXDB, което трябва да съвпада с него; SourceDataType се записва като запис SXVS ([MS-XLS] §2.4.317: $0001 лист, $0002 външен, $0004 консолидация, $0010 сценарий) и се повтаря като полето vsType в заглавката на SXDB, което трябва да съвпада с него. Кешовете, изградени от диапазон на лист, стартират от типа лист, докато кешовете, прочетени от файл, запазват стойността, носена от техния подпоток, така че BIFF записващият никога не оставя поле SXDB, назоваващо запис, който не е излъчил; RawHasStorageStream маркира кеш, зареден от собствен поток за съхранение, чийто дескриптор, глобален за работната книга, предхожда кешираните записи

Интеграция с Clipboard и опции за поставяне

TXLSPasteOption = (xlpoValuesOnly, xlpoInsertRows, xlpoInsertCols);
TXLSPasteOptions = set of TXLSPasteOption;

function XLSGetClipboardText: WideString;
function XLSSetClipboardText(const Text: WideString): Boolean;
function XLSSetClipboardTextAndHtml(const Text: WideString;
  const Html: AnsiString): Boolean;
function XLSBuildHtmlClipboard(const Html: AnsiString): AnsiString;
function XLSEncodeClipboardField(const Text: WideString): WideString;
function XLSClipboardHasText: Boolean;
function XLSParseClipboardGrid(const ClipboardText: WideString;
  Loader: TXLSCSVLoader): Boolean;
function XLSClipboardHasXmlSpreadsheet: Boolean;
function XLSGetClipboardXmlSpreadsheet: WideString;
function XLSClipboardHasBiff8: Boolean;
      

Разрешаване на показвания текст на клетка

TXLSCellDisplayMode = (xcdmFormattedValue, xcdmFormulaText,
  xcdmSuppressedZero);

TXLSCellDisplayOptions = record
  ShowFormulas: Boolean;
  ShowZeros: Boolean;
  SheetProtected: Boolean;
  FormulaWidthFactor: Double;
  DateSerialZero: Double;
end;

TXLSCellDisplayInput = record
  HasFormula: Boolean;
  FormulaHidden: Boolean;
  IsNumericZero: Boolean;
  FormulaText: WideString;
  FormattedText: WideString;
end;

TXLSCellDisplayResult = record
  Mode: TXLSCellDisplayMode;
  Text: WideString;
  TreatAsText: Boolean;
  EffectiveWidthFactor: Double;
end;

function XLSDefaultCellDisplayOptions: TXLSCellDisplayOptions;
function XLSNormalizeFormulaDisplayText(const FormulaText: WideString): WideString;
function XLSResolveCellDisplay(const Options: TXLSCellDisplayOptions;
  const Input: TXLSCellDisplayInput): TXLSCellDisplayResult;
      

Обекти за валидация на данни в Classic XLS

TXLSDataValidationType = (xlsDvAny, xlsDvWhole, xlsDvDecimal, xlsDvList,
  xlsDvDate, xlsDvTime, xlsDvTextLength, xlsDvCustom);
TXLSDvErrorStyle = (xlsDvErrStop, xlsDvErrWarning, xlsDvErrInformation);

TDVRange = class;             { one validation rule over one or more ranges }
TDVRangeList = class;         { the per-sheet rule collection }
TDataValidator = class;       { engine that checks edits against the rules }
      

Сканиране и разрешаване на индексирани цветове

TXLSIndexedColorKind = (xickPalette, xickAutomatic, xickSystem, xickInvalid);
TXLSSystemColorRole = (xscrNone, xscrWindowText, xscrWindowBackground,
  xscrChartText, xscrChartBackground, xscrChartNeutral, xscrToolTipText);

TXLSIndexedColorResolution = record
  Kind: TXLSIndexedColorKind;
  RawIndex: Int64;
  PaletteSlot: Integer;
  SystemColorRole: TXLSSystemColorRole;
  ARGB: LongWord;
  HasResolvedColor: Boolean;
end;

TXLSNearestIndexedColorMatch = record
  InputARGB: LongWord;
  ColorIndex: Integer;
  PaletteSlot: Integer;
  ARGB: LongWord;
  DistanceSquared: Double;
  ExactMatch: Boolean;
end;

TXLSIndexedColorUsageKind = (xicukFont, xicukFillForeground,
  xicukFillBackground, xicukGradient, xicukBorder, xicukConditionalFormat,
  xicukChart, xicukShape, xicukComment, xicukWorksheet, xicukOther);
      

Помощни функции за A1 препратки

function XLSA1CellRef(ARow, ACol: Integer): WideString;
function XLSTryParseA1CellRef(const ARef: WideString;
  out ARow, ACol: Integer): Boolean;
function XLSTryParseA1RangeRef(const ARef: WideString;
  out ARow1, ACol1, ARow2, ACol2: Integer): Boolean;
      

Вижте също

• Допълнителни членове на класическия XLS API
• Разширени XLSX API членове
• Геометрия на разредения контур
• Проследяване и одит на формули
• Функция за преглед на работни книги