TExportNamedCells

Description

TExportNamedCells stores information about defined names of the workbook (named cells and named ranges).

Properties

NameTypeDescription
Items[const aName: OWideString]TExportRange Get range of a defined name aName. An error is raised if the defined name was not found.
ItemsByIndex[const aIndex: Integer]TExportRange Get range of a defined name by index.
Names[const aIndex: Integer]OWideString Get defined name by index.
CountIntegerCount of defined names in the list.

Functions & procedures

procedure AddCell(const aName: OWideString; const aCell: TExportCell); overload;
procedure AddCell(const aName: OWideString; const aWorkSheet: TExportWorkSheet;
const aColIndex, aRowIndex: Integer); overload;
Adds a named cell.
procedure AddCellRange(const aName: OWideString; const aWorkSheet: TExportWorkSheet;
  const aLeftCol, aTopRow, aRightCol, aBottomRow: Integer);
procedure AddCellRangeSpan(const aName: OWideString; const aWorkSheet: TExportWorkSheet;
  const aColIndex, aRowIndex, aColSpan, aRowSpan: Integer);
Adds a named cell range.
class function ValidName(const aName: OWideString): Boolean;
Detects if the name aName is a valid range name.
function Defined(const aName: OWideString): Boolean;
Detects if a defined name aName exists.
function Remove(const aName: OWideString): Boolean;
Removes a defined name aName. Returns True if the defined name existed.
procedure Remove(const aIndex: Integer);
Removes a defined name by index.
function Find(const aName: OWideString; out outRange: TExportRange): Boolean;
Returns True if the defined name aName exists. The export range object is returned in the outRange parameter.
function FindFromCell(const aCell: TExportCell;
      out outName: OWideString): Boolean;
Returns True if the cell has a defined name. The defined name of the cell is returned in the outName parameter.
function FindFromRangeSpan(const aWorkSheet: TExportWorkSheet;
const aColIndex, aRowIndex, aColSpan, aRowSpan: Integer;
out outName: OWideString): Boolean;
Returns True if the cell range has a defined name. The defined name of the cell range is returned in the outName parameter.
Categories