اعضای تکمیلی API کتابخانه

این صفحه مرجع نوع‌های عمومی را تکمیل می‌کند؛ نوع‌هایی که APIهای اصلی کتاب کار، کاربرگ، رندر، درون‌ریزی، تشخیص خطا و نمایشگر را پشتیبانی می‌کنند اما نیازمند راهنمای مستقل و وظیفه‌محور نیستند

پالایش و قالب‌بندی شرطی

TXLSCfValue، TXLSDataBarSpec، TXLSColorScaleSpec، TXLSIconSetSpec و TXLSDxfStyle مقدار AttachWriteGuardOwner را می‌پذیرند و شیء قاعده را به کتاب کار مالک آن پیوند می‌زنند تا ویرایش‌ها به‌طور خودکار نگهبان نوشتن بگیرند؛ مالک، TXLSCondFormatWriteGuardOwner را پیاده‌سازی می‌کند که تنها متدش یعنی AcquireWriteGuard نگهبان نوشتن کتاب کار را به قاعده می‌دهد. TXLSDxfStyle علاوه بر آن FontColorIndex با FontColorIsIndexed و زوج‌های FillFgColorIndex / FillFgColorIsIndexed و FillBgColorIndex / FillBgColorIsIndexed را برای رنگ‌های قاعده با اندیس پالت می‌افزاید، به‌علاوه overrideهای فونت تمایزی یعنی FontName، FontSize و FontScheme (رشته خالی، یک اندازه point، یا اسلات فونت تم مانند major / minor) در کنار اعضای موجود bold، italic، underline و رنگ؛ هر تخصیص نگهبان نوشتن را می‌گیرد و قاعده را برای انتشار مجدد dirty علامت می‌زند

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;
      

درون‌ریزی، تولید کد، مقایسه و پایش

کمک‌کننده‌های بسته و ذخیره‌سازی باینری

افزوده‌های رسم و نمایشگر کتاب کار

صفحه‌بندی، خروجی تصویر و چاپ

مدل‌های نمودار کلاسیک و اشیای نمودار کاربرگ

مدل رمزگشایی نوع‌دار نمودار

وضعیت رمزگشایی‌شده نمودار به‌شکل رکوردها و نوع‌های شمارشی ساده در معرض قرار می‌گیرد تا کد بازرسی هرگز مجبور به پیمایش رکوردهای خام 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) که از هر سری در دسترس‌اند

رکوردهای ساخت نمودار

تألیف برگ نمودار و سازنده، به‌جای گراف اشیا رکوردهای ساده می‌پذیرد: TXLSChartTrendlineInfo، TXLSChartErrorBarsInfo، TXLSChartDataLabelsInfo و TXLSChartSeriesStyleInfo مدخل‌های سری‌ای را که به TXLSWorksheets.AddChartSheet و سازنده نمودار مشترک داده می‌شوند پُر می‌کنند و TXLSPivotChartInfo قاب‌بندی نمودار محوری را توصیف می‌کند که هنگام اتصال نمودار به یک جدول محوری به کار می‌رود

پیوست‌های 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 حافظه پنهان بارگذاری‌شده از جریان ذخیره‌سازی خودش را نشان می‌گذارد که توصیفگر سراسری کتاب کارش پیش از رکوردهای حافظه پنهان قرار دارد

یکپارچگی کلیپ‌بورد و گزینه‌های چسباندن

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;
      

اشیای اعتبارسنجی داده کلاسیک

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;
      

همچنین ببینید

• اعضای تکمیلی API برای Classic XLS
• اعضای پیشرفته API برای XLSX
• هندسه طرح‌واره خلوت
• ردگیری و ممیزی فرمول
• نمایشگر کتاب کار