Версия для печати


Excel ЧаВо часть II: Worksbooks и Worksheets
http://www.delphikingdom.com/asp/viewitem.asp?catalogID=1273

Александр Шабля
дата публикации 26-05-2006 03:55

В примерах используется раннее связывание (что это такое можно почитать здесь). Минимальная версия офиса — 2000 (9.0). Примеры для C# иногда не будут встречаться, когда есть примеры на MSDN http://msdn.microsoft.com/netframework/ или код на Delphi и C# практически одинаковый (не учитывая языковую специфику). Также в коде используются классы-наследники TOleServer: TExcelApplication, TExcelWorkbook и т.д. Константа lcid в примерах определена так:

const
  lcid = LOCALE_USER_DEFAULT;

WorkBooks, WorkSheets

Workbooks Collection

Workbook Object

Sheets Collection

Worksheet Object

Excel Workbook Object

Excel Worksheet Object

Как добавить новую книгу?

Добавить новую пустую книгу:

Delphi

XL.Workbooks.Add(EmptyParam, lcid);

C#

XL.Workbooks.Add(Type.Missing);

В первом параметре метода Add можно указать стандартный тип шаблона Excel. Если же в нем указать имя (с полным путем) подготовленного файла (шаблоном может быть и "обычный" файл XLS, а не только файл XLT), то можно открыть книгу на диске как шаблон.

Delphi

XL.Workbooks.Add('MyTemplate.xls', lcid);

Откроет файл "MyTemplate1.xls", т.е. точно как обычный шаблон "Книга1.xls", но свой со своим форматированием, что позволит ускорить процесс экспорта данных в Excel, т.к. не придется форматировать ячейки и вызывать другие настройки листа.

Add Method (Workbooks Collection)

How to: Create New Workbooks

Как задать количество листов в новой книге?

Задать количество листов в новой книге можно перед добавлением новой книги:

Delphi

XL.SheetsInNewWorkbook[lcid] := N; // N - новое количество листов (integer)
XL.Workbooks.Add(EmptyParam, lcid);

C#

XL.SheetsInNewWorkbook = N;

Где N = 1..255

SheetsInNewWorkbook Property

Как открыть книгу, имеющуюся на диске?

Если книга находится не в папке указанной в Excel.Application.DefaultFilePath, то нужно указывать полный путь к открываемому файлу .xls, даже если файл находится в текущей папке вашего приложения т.к. Excel ничего про него не знает.

Delphi

WB.ConnectTo(XL.Workbooks.Open(
      'МояКнига.xls', // Filename: WideString;
      2, // UpdateLinks: OleVariant; 2 - never update
      False, // ReadOnly: OleVariant;
      EmptyParam, // Format: OleVariant;
      EmptyParam, // Password: OleVariant;
      EmptyParam, // WriteResPassword: OleVariant;
      EmptyParam, // IgnoreReadOnlyRecommended: OleVariant;
      EmptyParam, // Origin: OleVariant;
      EmptyParam, // Delimiter: OleVariant;
      EmptyParam, // Editable: OleVariant;
      EmptyParam, // Notify: OleVariant;
      EmptyParam, // Converter: OleVariant;
      False, // AddToMru: OleVariant;
      EmptyParam, // Local: OleVariant;
      EmptyParam, // CorruptLoad: OleVariant;
      lcid));

C#

XL.Workbooks.Open(
"Книга1.xls", // FileName
	false, // UpdateLinks
	false, //  ReadOnly
	Type.Missing, // Format
	Type.Missing, // Password
	Type.Missing, // WriteResPassword
	Type.Missing, // IgnoreReadOnlyRecommended
	Type.Missing, // Origin
	Type.Missing, // Delimiter
	true, // Editable
	Type.Missing, //  Notify
	Type.Missing, // Converter
	false, // AddToMru
	Type.Missing, // Local
	Type.Missing // CorruptLoad
);

Open Method

How to: Open Workbooks

Как сохранить книгу?

Save Method

SaveAs Method

How to: Save Workbooks

Как закрыть книгу без вопросов о сохранении? Как закрыть все книги?

Delphi

// закрыть книгу без сохранения внесенных в нее изменений
oWorkBook.Close(0); // xlDontSaveChanges

// закрыть все книги без сохранения изменений
XL.DisplayAlerts[lcid] := False; // отключаем предупреждения
XL.Workbooks.Close(lcid); // закроем все книги

Close Method

How to: Close Workbooks

Как узнать имена всех открытых книг?

Узнать имена всех книг экземпляра Excel.Application можно в цикле, например, так:

Delphi

for i := 1 to XL.Workbooks.Count do
        XL.Assistant.DoAlert('Книга', XL.Workbooks[i].Name, msoAlertButtonOK,
          msoAlertIconInfo, msoAlertDefaultFirst, msoAlertCancelDefault,
          False);
      // а вот так имя книги с полным путем к ней (свойство FullName)
    for i := 1 to XL.Workbooks.Count do
      XL.Assistant.DoAlert('Книга', XL.Workbooks[i].FullName[lcid], msoAlertButtonOK,
        msoAlertIconInfo, msoAlertDefaultFirst, msoAlertCancelDefault,
        False);

C#

int R = 0;
foreach (Excel.Workbook WB in XL.Workbooks) {
oSheet.get_Range("A1", Type.Missing).get_Offset(R, 0).Formula = WB.FullName;
	R++;
}

Как найти определенную открытую книгу?

Точно так же как в предыдущем ответе — по имени в свойстве Name. Если вы хотите сделать найденную книгу активной, то вызовите метод Activate

Name Property

Activate Method

Как переименовать книгу?

Переименовать книгу ни как нельзя — только сохранить под другим именем методом SaveAs (смотрите "Как сохранить книгу").

Как спрятать книгу?

Delphi

// спрячем активную книгу
XL.ActiveWindow.Visible := False;

Windows Collection Object

Window Object

Как открыть текстовый файл в Excel'е?

Практически, так же как и обычную книгу, только внимательно указав дополнительные параметры в методе OpenText.

OpenText Method

How to: Open Text Files as Workbooks

Как узнать имена всех листов в книге и их количество?

Узнать количество листов в книге можно в цикле по коллекции Workbook.Sheets. Количество листов — свойство Sheets.Count. Имя листа — свойство Worksheet.Name.

Count Property

Name Property

How to: List All Worksheets in a Workbook

Как получить ссылку на активный лист в активной книге?

Обращаеясь к Excel.Application.ActiveSheet или WorkBook.ActiveSheet, вы получите ссылку на интерфейс IDispatch. Это происходит из-за того, что коллекция Excel.Application.Sheets может содержать объекты WorkSheet, Chart, Excel4MacroSheet (для поддержки Excel 4).

Delphi

// получить ссылку на активный лист, ASheet: TExcelWorksheet
ASheet.ConnectTo(XL.ActiveSheet as _Worksheet);

// получить ссылку на второй лист активной книги
ASheet.ConnectTo(XL.ActiveWorkbook.Sheet[2] as _Worksheet);

C#

Excel.Worksheet oSheet = (Excel.Worksheet) XL.ActiveSheet;
//
Excel.Worksheet oSheet = (Excel.Worksheet) XL.Sheets[1];

Определить тип листа можно, проверив свойство Worksheet.Type:

Delphi

if ASheet.type_[lcid] = xlWorksheet then { это Worksheet };

C#

if (oSheet.Type == Excel.XlSheetType.xlWorksheet) /* это Worksheet */ ;

ActiveWorkbook Property

ActiveSheet Property

Type Property

Как добавить новый лист в книгу? Как удалить лист?

При добавлении можно указать тип нового листа (WorkSheet, Chart, Excel4MacroSheet) и текущее положение. Добавленный лист будет активизирован автоматически (на него будет указывать свойство ActiveSheet)

// Добавим один новый лист после текущего
ASheet.ConnectTo(XL.ActiveWorkbook.Sheets.Add(EmptyParam, XL.ActiveSheet, 1, xlWorksheet, lcid));

// Удалить лист
XL.DisplayAlerts[lcid] := False; // отключим предуреждения
(XL.ActiveSheet as _Worksheet).Delete(lcid); // удаляем активный (можно любой) лист

Add Method

Delete Method

How to: Add New Worksheets to Workbooks

How to: Delete Worksheets from Workbooks

Нужно ли делать лист активным, чтоб записать в него данные?

Не нужно — переключение (активация) листов только замедлит экспорт данных. Получите ссылку на любой лист в книге (активной или нет) и работайте c ней, как с активной. Активизировать лист нужно только в случае необходимости, например, при вставке из буфера обмена, предварительном просмотре и др.

Как задать имя листу в книге?

// ASheet: ExcelWorksheet;
ASheet.ConnectTo(XL.ActiveSheet as _Worksheet);
ASheet.Name := 'Новое имя';

Name Property

Как выделить один или несколько листов в книге?

Delphi

// выделить один лист
(XL.Sheets[1] as _Worksheet).Select(True, lcid);

// выделим сразу несколько листов в цикле
    for i := 1 to 4 do begin
      (XL.Sheets[i] as _Worksheet).Select(False, lcid);
      Application.ProcessMessages;
    end;

// листы можно выделить не в цикле, указав список выделяемых
// листов (индексы или имена) как массив
(XL.ActiveWorkbook.Sheets[VarArrayOf([1, 2, 3, 4])] as Sheets).Select(False, lcid);

// Select - выделить, Activate - активировать без снятия выделения, 
// если активировать лист в выделенном диапозоне
(XL.Sheets[4] as _Worksheet).Activate(lcid);

// Если попробовать активировать 5 лист (не в выделенном диапозоне),
// то выделенным окажется только один лист
(XL.Sheets[5] as _Worksheet).Activate(lcid);

Select Method

Activate Method

How to: Select a Worksheet

Как скопировать/переместить лист в одной книге? В другую книгу?

Delphi

// скопировать лист в конец
ASheet.Copy(EmptyParam, XL.ActiveWorkbook.Sheets[XL.ActiveWorkbook.Sheets.Count]);
// переместим лист перед Лист4
ASheet.Move(XL.ActiveWorkbook.Sheets[4], EmptyParam);
// переместить лист в другую книгу в конец.
// Для копирования то же, только вместо Move вызвать метод Copy
ASheet.Move(EmptyParam, XL.Workbooks[2].Sheets[XL.Workbooks[2].Sheets.Count]);

Copy Method

Move Method

How to: Move Worksheets Within Workbooks

Как задать/убрать область печати? Как вызвать PrintPreview? Как напечатать лист?

Delphi

// Зададим область печати A1:D10 
ASheet.PageSetup.PrintArea := '$A$1:$D$10';
// Удаляем область печати, присвоив пустую строку
ASheet.PageSetup.PrintArea := '';
// Вызов PrintPreview
ASheet.PrintPreview;
// Печать на любой принтер (в примере на "PDFCreator")
// Если на активный принтер, то вместо имени принтера указать EmptyParam
    ASheet.DefaultInterface.PrintOut(
      EmptyParam, // From: OleVariant;
      EmptyParam,  // To_: OleVariant;
      1, //Copies: OleVariant;
      EmptyParam, // Preview: OleVariant;
      'PDFCreator', // ActivePrinter: OleVariant;
      EmptyParam, // PrintToFile: OleVariant;
      True, //Collate: OleVariant;
      EmptyParam, //PrToFileName: OleVariant;
      lcid
    );

PrintArea Property

PrintOut Method

PrintPreview Method

How to: Print Worksheets

Как установить параметры печати: отступы на листе, ориентацию листа и др.?

Установка параметров печати — довольно продолжительный процесс, поэтому советую настроить их в предварительно подготовленном шаблоне. Все параметры печати задаются в свойстве PageSetup объекта Worksheet. Но учтите, что текст в свойствах Footer или Header для Left, Right, Center суммарно не должен превышать 255 символов.

Для задания отступов в сантиметрах используйте функцию Excel.Application.CentimetersToPoints

Delphi

ASheet.Range['A1', EmptyParam].Formula :=
      'Любой текст, чтоб сработал PrintPreviw';
    ASheet.PageSetup.LeftMargin := 0;
    ASheet.PageSetup.TopMargin := 0;
    ASheet.PageSetup.RightMargin := 0;
    ASheet.PageSetup.BottomMargin := 0;
    ASheet.PageSetup.HeaderMargin := 0;
    ASheet.PageSetup.FooterMargin := 0;
    ASheet.PageSetup.FitToPagesWide := 1;
    ASheet.PageSetup.FitToPagesTall := 1;
    ASheet.PrintPreview(True, lcid);

Если вы выполните данный код, то заметьте как долго Excel настраивает все границы печати.

PageSetup Property

CentimetersToPoints Method

Как установить свои разрывы страниц (HPageBreaks) в области печати? Как узнать номер строки HpagePreak?

Для того чтобы "появились" автоматические разрывы страниц нужно перейти в режим разметки.

Delphi

// переходим в режим разметки, чтоб заполнить коллекцию HPageBreaks
XL.ActiveWindow.View := xlPageBreakPreview;

// вставим разрыв перед 4-й строкой
ASheet.HPageBreaks.Add(ASheet.Range['A4', EmptyParam]);

// Как узнать номер строки, перед которой вставлен первый (индекс 1) HPageBreak
FirstPageBreak := ASheet.HPageBreaks[1].Location.Row;

Также вы можете "переместить" разрыв, присвоив новое значение свойству Location объекта HPageBreak

Delphi

// переместим разрыв перед пятой строкой
ASheet.HPageBreaks[1].Location := Asheet.Range ['A5', EmptyParam];

View Property

HPageBreaks Collection Object

VPageBreaks Collection Object

Add Method

Как сделать так, чтобы на каждой странице повторялись заголовки колонок таблицы?

Нужно задать "сквозные" строки заголовка таблицы.

Delphi

// "сквозная" вторая строка
ASheet.PageSetup.PrintTitleRows := '2:2';

PageSetup Property

Как спрятать рабочий лист?

Delphi

ASheet.Visible[lcid] := xlSheetHidden;

Visible Property

How to: Hide Worksheets

Как установить пароль на существующий лист/книгу?

Protect Method

Unprotect Method

How to: Protect Workbooks

How to: Protect Worksheets

How to: Remove Protection from Worksheets

Как создать макрос из Delphi? Как выполнить макрос, имеющийся в книге?

Вам не удастся создать макрос программно, т.к. по умолчанию в Excel VBA Project отключен доступ к VBA из программ. Как включить эту возможность читайте "PRB: Programmatic Access to Office XP VBA Project Is Denied"

Пример создания макроса с параметром и вызов его из программы:

Delphi

try
      VBComp := WB.VBProject.VBComponents.Add(1); // vbext_ct_StdModule
      VBComp.Name := 'TestModule';
      // запишем туда наш макрос
      VBComp.CodeModule.AddFromString(
        'Public Sub Test(ByVal ADate As Date)'#10 +
        #9'MsgBox "Привет из VBA!" & Chr(13) & "Сегодня " & ADate, _'#10 +
        #9#9'vbInformation, "Test макроса"'#10 +
        'End Sub'
      );
    except
      ShowMessage('Нужно включить вручную в Excel''е "Доверять доступ к Visual Basic Project"');
    end;
    // выполним макрос
    XL.Run('Test', Date());

C#

Microsoft.Vbe.Interop.VBComponent VBComp = XL.ActiveWorkbook.VBProject.VBComponents.Add(
	Microsoft.Vbe.Interop.vbext_ComponentType.vbext_ct_StdModule);
VBComp.Name = "TestModule";
// запишем туда наш макрос
VBComp.CodeModule.AddFromString(
	"Public Sub Test(ByVal ADate As Date)\n" +
	"\tMsgBox \"Привет из VBA!\" & Chr(13) & \"Сегодня \" & ADate, _\n" +
	"\t\tvbInformation, \"Test макроса\"\n" +
"End Sub");
// и выполним его передав текущую дату
XL.Run("Test", DateTime.Today,
Type.Missing, Type.Missing, Type.Missing, Type.Missing, Type.Missing,
	Type.Missing, Type.Missing, Type.Missing, Type.Missing, Type.Missing,
	Type.Missing, Type.Missing, Type.Missing, Type.Missing, Type.Missing,
	Type.Missing, Type.Missing, Type.Missing, Type.Missing, Type.Missing,
	Type.Missing, Type.Missing, Type.Missing, Type.Missing, Type.Missing,
	Type.Missing, Type.Missing, Type.Missing, Type.Missing
);

Если все же вам очень нужно добавить макрос, не зависимо от настроек доступа к VBA Project, можно воспользоваться листом макросов xlExcel4MacroSheet. Макроязык представляет собой "команды".

Delphi

ASheet := WB.Sheets.Add(EmptyParam, WB.Sheets[WB.Sheets.Count], 1,
      xlExcel4MacroSheet, lcid) as _Worksheet;
    ASheet.Range['A1', EmptyParam].Formula := '=alert("Привет из Excel4 MacroSheet!")';
    ASheet.Range['A2', EmptyParam].Formula := '=return()';
    ASheet.Range['A1', EmptyParam].Run(
      EmptyParam, EmptyParam, EmptyParam, EmptyParam, EmptyParam, EmptyParam, EmptyParam,
      EmptyParam, EmptyParam, EmptyParam, EmptyParam, EmptyParam, EmptyParam, EmptyParam,
      EmptyParam, EmptyParam, EmptyParam, EmptyParam, EmptyParam, EmptyParam, EmptyParam,
      EmptyParam, EmptyParam, EmptyParam, EmptyParam, EmptyParam, EmptyParam, EmptyParam,
      EmptyParam, EmptyParam
    );

Turn on or off Trust access to Visual Basic Project

How To Create and Call an Excel Macro Programmatically from VB

Programming To The Visual Basic Editor

Run Method

Будет ли работать макрос при выставленной "Очень высокая безопасность макросов" в Excel'е пользователя?

Записанные макросы в книге, открытой вашей программой всегда будут работать, не зависимо от выставленного в Excel'е "Уровня безопасности" для макросов.

Почему не работает макрос, записанный в книге?

Записанный в книге макрос может не работать по причине установленного антивируса. Например, установленный "Kaspersky Office Guard", входящий в состав "Антивирус Касперского", начисто отключает все вызовы VBA.

Полезные ссылки

Microsoft Excel Object Model

Automating Excel Using the Excel Object Model

Office Development — Excel

Migrating Excel VBA Solutions to Visual Studio 2005 Tools for Office

Converting Microsoft Office VBA Macros to Visual Basic .NET and C#

Microsoft Excel 2003 Language Reference

Understanding the Excel Object Model from a .NET Developer's Perspective

Microsoft.Office.Interop.Excel Namespace

Excel Objects

Code Examples for Excel (C#)

Специально для Королевства Delphi