Returns the worksheet object whose name matches the supplied sheet name, or
nil when no worksheet has that name. The classic XLS facade
uses the same name matching as the existing Index[SheetName]
property
Syntax
function SheetByName(SheetName: WideString): TXLSWorksheet;
function TryGetSheetByName(SheetName: WideString; out Sheet: TXLSWorksheet): Boolean;
Parameters
| SheetName |
The worksheet name to locate |
| Sheet |
Receives the matching worksheet when TryGetSheetByName returns True; receives nil when no sheet matches |
Return value
The matching
TXLSWorksheet
instance, or
nil if the workbook does not contain a sheet with
that name.
TryGetSheetByName returns
True when a
match is found and
False otherwise
Example
var
Sheet: TXLSWorksheet;
begin
Sheet := Workbook.Worksheets.SheetByName('Summary');
if Sheet <> nil then
Sheet.Range['A1', 'A1'].Value := 'Ready';
if Workbook.Worksheets.TryGetSheetByName('Review', Sheet) then
Sheet.Range['A1', 'A1'].Value := 'Found';
end;
See also