สมาชิก API เพิ่มเติมของไลบรารี

หน้านี้สมบูรณ์ข้อมูลอ้างอิงของชนิดสาธารณะที่สนับสนุน API หลักของสมุดงาน เวิร์กชีต การเรนเดอร์ การนำเข้า การวินิจฉัย และตัวแสดง แต่ไม่จำเป็นต้องมีคู่มือเฉพาะงานแยกต่างหาก

การกรองข้อมูลและการจัดรูปแบบตามเงื่อนไข

TXLSCfValue, TXLSDataBarSpec, TXLSColorScaleSpec, TXLSIconSetSpec และ TXLSDxfStyle รับ AttachWriteGuardOwner โดยเชื่อมออบเจกต์กฎเข้ากับสมุดงานเจ้าของ เพื่อให้การแก้ไขได้รับการพยุงการเขียนโดยอัตโนมัติ เจ้าของต้อง implement TXLSCondFormatWriteGuardOwner ซึ่งมีเมธอด AcquireWriteGuard เมธอดเดียวที่ส่งการพยุงการเขียนของสมุดงานให้กฎ TXLSDxfStyle เพิ่ม FontColorIndex พร้อม FontColorIsIndexed และคู่ FillFgColorIndex / FillFgColorIsIndexed กับ FillBgColorIndex / FillBgColorIsIndexed สำหรับสีกฎตามดัชนีพาเลต บวก override ฟอนต์แบบ differential FontName, FontSize และ FontScheme (สตริงว่าง ขนาดหน่วย point หรือ slot ฟอนต์ของธีมอย่าง major / minor) เพิ่มจากสมาชิก bold, italic, underline และสีที่มีอยู่เดิม โดยการกำหนดค่าแต่ละครั้งจะได้รับการพยุงการเขียน และ mark กฎเป็น dirty เพื่อให้ถูก emit ใหม่

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 ด้วย primitive (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;
      

การนำเข้า การสร้างโค้ด การเปรียบเทียบ และการตรวจตรา

ตัวช่วยแพ็กเกจและการจัดเก็บแบบไบนารี

ส่วนเพิ่มเติมของการวาดรูปและตัวแสดงสมุดงาน

การแบ่งหน้า เอาต์พุตภาพ และการพิมพ์

โมเดลแผนภูมิแบบคลาสสิกและออบเจกต์แผนภูมิของเวิร์กชีต

โมเดลการถอดรหัสแผนภูมิแบบมีชนิด

สถานะแผนภูมิที่ถอดรหัสแล้วถูกเปิดเผยเป็นเรกคอร์ดและ 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 คำอธิบายประกอบ trendline และ error bar เป็นออบเจกต์แบบมีชนิด (TXLSChartTrendline, TXLSChartErrorBars) ที่ไปถึงได้จากชุดข้อมูลแต่ละชุด

เรกคอร์ดการสร้างแผนภูมิ

การสร้าง chart sheet และการสร้างผ่าน builder ยอมรับเรกคอร์ดธรรมดาแทนกราฟออบเจกต์: TXLSChartTrendlineInfo, TXLSChartErrorBarsInfo, TXLSChartDataLabelsInfo และ TXLSChartSeriesStyleInfo เติมรายการชุดข้อมูลที่ส่งให้ TXLSWorksheets.AddChartSheet และตัวสร้างแผนภูมิที่ใช้ร่วมกัน ส่วน TXLSPivotChartInfo อธิบายการจัดกรอบ pivot chart ที่ใช้เมื่อแผนภูมิถูกผูกกับตาราง pivot

ไฟล์แนบ PDF ลายเซ็น และการส่งออก HTML

การตรวจสอบการคำนวณและตัวควบคุมสมุดงาน

ความเข้ากันได้ของ framing PivotCache แบบเดิม

StreamId ถูกเขียนเป็นเรกคอร์ด SXStreamID ([MS-XLS] §2.4.303) และซ้ำอีกครั้งเป็นฟิลด์ idstm ในหัวเรกคอร์ด SXDB ซึ่งต้องมีค่าเท่ากัน SourceDataType ถูกเขียนเป็นเรกคอร์ด SXVS ([MS-XLS] §2.4.317: $0001 เวิร์กชีต, $0002 external, $0004 consolidation, $0010 scenario) และซ้ำเป็นฟิลด์ vsType ในหัวเรกคอร์ด SXDB ซึ่งต้องเท่ากันเช่นกัน แคชที่สร้างจากช่วงเวิร์กชีตจะเริ่มที่ชนิดเวิร์กชีต ขณะที่แคชที่อ่านกลับจากไฟล์คงค่าที่ substream ของมันถือไว้ ตัวเขียน BIFF จึงไม่มีวันทิ้งฟิลด์ SXDB ที่อ้างถึงเรกคอร์ดที่ตัวเองไม่ได้เขียน RawHasStorageStream ระบุแคชที่โหลดจากสตรีม storage ของตัวเองซึ่งตัวอธิบายระดับสมุดงานมาอยู่ก่อนเรกคอร์ดแคช

การทำงานร่วมกับคลิปบอร์ดและตัวเลือกการวาง

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;
      

การ resolve ข้อความแสดงผลของเซลล์

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
• เรขาคณิตโครงร่างแบบสแปร์ส
• การติดตามและตรวจสอบสูตร
• ตัวแสดงสมุดงาน