Сообщений 0    Оценка 130        Оценить  
Система Orphus

Автоматизация OpenOffice.org Calc при помощи Borland C++ Builder 6.0

Автор: Oleg Koleskin
Источник: RSDN Magazine #6-2004
Опубликовано: 12.07.2005
Версия текста: 1.0
Введение
История и краткая характеристика OpenOffice.org
Работа с OpenOffice.org
Создание экземпляра OpenOffice.org
Создание или открытие документа
Вставка новой таблицы
Запись данных в ячейку
Чтение данных из ячейки
Установка ширины столбца
Форматирование ячеек
Печать
Сохранение документа.
Закрытие документа
Закрытие офиса
Аналог ScreenUpdating от Excel.
Заключение
Пример работы с OpenOffice.org Calc.
Источники информации

Демонстрационный проект

Введение

Очень часто программист сталкивается с необходимостью экспорта данных в MS Excel. В сети очень много материалов на данную тему, и решение данной проблемы не вызывает никакого затруднения.

Однако жизнь меняется. И на рынке офисных пакетов, где ещё недавно безраздельно властвовал Microsoft Office, появился новый игрок. В этой статье я попытаюсь хотя бы частично восполнить недостаток материала по автоматизации OpenOffice.org Calc.

История и краткая характеристика OpenOffice.org

Проект OpenOffice.org начался 13 октября 2000 года, когда были открыты исходные тексты StarOffice. Версия 1.0 вышла летом 2002 года. С тех пор началась экспансия OpenOffice.org. Особенно бурно развивается проект в последнее время, буквально один за другим выходят версии 1.1.1, 1.1.2, 1.1.3, только что вышла версия 1.1.4.

Складывается впечатление, что развитие ветки 1.1 остановлено, в версии 1.1.4 не добавлено новой функциональности, она посвящена исправлению ошибок.

Все силы разработчиков направлены на версию 2.0, которая, возможно, выйдет в начале 2005 года.

На основе одного исходного кода, разрабатываемого сообществом OpenOffice.org, выпускается два продукта: StarOffice, в который добавляются компоненты под проприетарной лицензией, и свободный OpenOffice.org. В настоящее время в OpenOffice.org большинство проприетарных компонентов, присутствующих в StarOffice, заменено их свободными аналогами.

На данный момент пакет работает в среде Linux, Solaris и некоторых других Unix-клонах, а также Windows.

В состав пакета входит:

Функционально пакет покрывает все потребности обычного пользователя. Кроме того, он хорошо работает с форматами Microsoft Office.

ПРИМЕЧАНИЕ

Следует отметить, что файловые форматы Microsoft Office являются закрытыми стандартами Microsoft. Поэтому хорошая совместимость данных форматов с OpenOffice.org – большое достижение разработчиков OpenOffice.org.

Сам же OpenOffice.org для своих приложений использует открытые и хорошо специфицированные форматы на основе XML. Благодаря сжатию (файлы OpenOffice представляют собой zip-архивы) файлы получаются очень компактными.

Работа с OpenOffice.org

Я постараюсь показать основные приёмы работы с OpenOffice.org. Не забудьте скачать пример к статье, в котором показана работа с OpenOffice.org более подробно, чем в статье.

Хочу обратить внимание, на то, что мне не удалось импортировать Type Library из файла soffice.exe, или какого либо другого файла, возможно, что просто плохо искал.

Скорее всего, дело в том, что OpenOffice.org не поддерживает автоматизацию напрямую. Что в принципе не удивительно, если принять во внимание, что OpenOffice.org всё же межплатформенный продукт, а технология COM, частью которой является автоматизация, всё же технология для Windows.

OpenOffice.org базируется на компонентной модели UNO (Universal Network Objects). Для поддержки автоматизации используется Automation Bridge, который преобразует вызовы COM в вызов функций UNO, а возвращаемые UNO-объекты – в объекты автоматизации.

Создание экземпляра OpenOffice.org

try
{
  ServiceManager = CreateOleObject("com.sun.star.ServiceManager");
}
catch (...)
{
  return false;
}
if (VarType(ServiceManager) == varDispatch)
  Desktop = ServiceManager.OleFunction("createInstance",
    "com.sun.star.frame.Desktop");

Как следует из данного примера кода, стартовая точка для любого контроллера автоматизации – это ServiceManager. Для создания экземпляра ServiceManager вызывается функция CreateOleObject, содержащаяся в модуле ComObj библиотеки VCL. В качестве параметра функции передаётся имя объекта, экземпляр которого нужно создать. Функция возвращает ссылку на интерфейс, который может быть использован для связи с объектом. Тип данного интерфейса – IDispatch. Результат присваивается переменной типа вариант.

Как показывает практика, в системе может быть создан только один экземпляр ServiceManager, то есть использование GetActiveOleObject при уже созданном экземпляре ServiceManager даст тот же самый результат, что и при использовании CreateOleObject.

При помощи строки VarType(ServiceManager) == varDispatch проверяется, что именно лежит в данной переменной. Я в примере к статье не использую данную проверку исключительно с целью улучшения читабельности кода. Однако при написании реального приложения, наверное, надо использовать данную проверку при каждом использовании вариантной переменной, которая должна хранить ссылку на интерфейс IDispatch, например, при вызове OleFunction или OlePropertySet / OlePropertyGet.

Затем создаётся экземпляр Desktop, который используется для открытия существующих или создания новых документов.

Итак, иерархия объектов такова: ServiceManager > Desktop > Document.

Создание или открытие документа

Document = Desktop.OleFunction("LoadComponentFromURL",
  FilePath, "_blank", 0, VariantArray );
if (VarType(Document) == varDispatch)  
  Sheets = Document.OleFunction("getSheets");

Для данных целей используется функция LoadComponentFromURL.

Если переменная FilePath будет равна "private:factory/scalc", то будет создан новый документ OpenOffice.org Calc. Для других приложений OpenOffice.org значение scalc заменяется соответственно на swriter, simpress, sdraw.

Если в данной переменной содержиться URL файла, то произойдёт открытие файла. URL получается из пути файла при помощи функции convertToURL, реализованной в примере.

Параметр “_blank” указывает, что файл должен открыться в новом окне.

В вариантном массиве содержатся опции открытия документа, в виде пар название опции – значение опции. Например, если не нужно показывать окно OpenOffice.org, можно передать данной функции массив, содержащий пару: Hidden (название опции) – true(значение опции).

Получив ссылку на Document, можно сразу получить ссылку на коллекцию листов Sheets, всё равно впоследствии она пригодится.

Вставка новой таблицы

Sheets.OleFunction("insertNewByName", NewSheetName, i);

В данном случае NewSheetName – имя, а i – индекс новой таблицы. Для вставки в самое начало используется 0, для того, чтобы новая таблица стала последней, в качестве параметра передаётся количество листов Sheets.OleFunction("getCount").

Перед вставкой полезно убедиться, что таблицы с данным именем пока не существует Sheets.OleFunction("hasByName", sheetName).

После вставки таблицы её можно показать пользователю:

Sheets = Document.OleFunction("getSheets");
Sheet = Sheets.OleFunction("getByName", sheetName);
View = Document.OleFunction("getCurrentController");
View.OleFunction("setActiveSheet", Sheet);

Запись данных в ячейку

Перед записью данных в ячейку, необходимо получить ссылку на ячейку:

Cell = Sheet.OleFunction("getCellByPosition", col, row);

Итак, схема взаимодействия такова:

ServiceManager > Desktop > Document > Sheets > Sheet > Cell

Другими словами, чтобы добраться до ячейки, необходимо последовательно получить ссылки на все эти объекты:

ServiceManager = СreateOleObject("com.sun.star.ServiceManager");
Desktop = ServiceManager.OleFunction("createInstance",
"com.sun.star.frame.Desktop");
Document = Desktop.OleFunction("LoadComponentFromURL",
"private:factory/scalc", "_blank", 0, VariantArray );
Sheets = Document.OleFunction("getSheets");
Sheet = Sheets.OleFunction("getByName", “Sheet1”);
Cell = Sheet.OleFunction("getCellByPosition", 0, 0);

ServiceManager = СreateOleObject("com.sun.star.ServiceManager");
Cell = ServiceManager.OleFunction("createInstance",
"com.sun.star.frame.Desktop").OleFunction
("LoadComponentFromURL", "private:factory/scalc", 
"_blank", 0, VariantArray ).OleFunction("getSheets").
OleFunction("getByName", “Sheet1”).
OleFunction("getCellByPosition", 0, 0);

У ячейки есть три метода для записи данных. Названия говорят сами за себя: setString, setValue, setFormula.

Дату я записывал в ячейку просто как строку. Можно также записывать дату в ячейку при помощи формулы: ”=DATE(2004;12;31)”. При этом форма представления даты будет зависеть от установки OpenOffice.org Locale setting.

Понятно, что при больших объёмах данных, где речь идёт хотя бы о нескольких тысячах ячеек, вызывать OLE-метод для каждой ячейки нерационально. Вместо этого можно воспользоваться Range.OleFunction("setDataArray", VariantArray);

Чтение данных из ячейки

Чтение данных можно разделить на два этапа.

1. Получение типа содержимого ячейки:

Cell.OleFunction("getType")

Возвращаемые данной функцией значения:

2. Использование одного из следующих методов (в зависимости от полученного на первом этапе значения):

switch (contentType)
{
  case 1 :
    return Cell.OleFunction("getValue");
  case 2 :
    return Cell.OleFunction("getString");
  case 3 :
    return Cell.OleFunction("getFormula");
  default :
    return "";
}

Установка ширины столбца

Column.OlePropertySet("width", 1000); //1000 = 1см
или
Column.OlePropertySet("optimalWidth", true); //Excel AutoFit

Форматирование ячеек

Установка параметров шрифта для ячейки или диапазона ячеек

Переменная font типа TFont.

При передаче цвета необходимо преобразовать TColor в RGB-представление цвета.

Cell.OlePropertySet("charColor",
  (TColor)RGB(GetBValue(font->Color),GetGValue(font->Color),
  GetRValue(font->Color)));
Cell.OlePropertySet("charHeight", font->Size);
Cell.OlePropertySet("charFontName", (WideString)font->Name);
Cell.OlePropertySet("charWeight", 150*font->Style.Contains(fsBold));
Cell.OlePropertySet("charUnderline", font->Style.Contains(fsUnderline));
Cell.OlePropertySet("charPosture", font->Style.Contains(fsItalic));
Cell.OlePropertySet("charStrikeout", font->Style.Contains(fsStrikeOut));
Cell.OlePropertySet("charFontCharSet", font->Charset);

Установка фона для ячейки или диапазона ячеек

Cell.OlePropertySet("cellBackColor",
  (TColor)RGB(GetBValue(color),GetGValue(color),GetRValue(color)));

Рисование рамок для ячейки или диапазона ячеек

MyStruct = ServiceManager.OleFunction
("Bridge_GetStruct","com.sun.star.table.BorderLine");
MyStruct.OlePropertySet("color", ColorToRGB(clBlack));
MyStruct.OlePropertySet("lineDistance", 0);
MyStruct.OlePropertySet("innerLineWidth", 0);
MyStruct.OlePropertySet("outerLineWidth", 1);
Cell.OlePropertySet("leftBorder", MyStruct);
Cell.OlePropertySet("rightBorder", MyStruct);
Cell.OlePropertySet("topBorder", MyStruct);
Cell.OlePropertySet("bottomBorder", MyStruct);

Печать

int Bounds[2] = {0,-1};
Document.OleFunction("print", VarArrayCreate(Bounds, 1, varVariant));

Данный код производит печать на принтер по умолчанию.

StyleFamilies = Document.OleFunction("getStyleFamilies");
PageFamilies = StyleFamilies.OleFunction("getByName","PageStyles");
PageStyleName = Sheet.OlePropertyGet("PageStyle");
PageStyle = PageFamilies.OleFunction("getByName",PageStyleName);
PageStyle.OlePropertySet("headerIsOn",true);
PageStyle.OlePropertySet("headerIsShared",true);
HeaderLeft = PageStyle.OlePropertyGet("leftPageHeaderContent");
HeaderText = HeaderLeft.OleFunction("getCenterText");
HeaderText.OlePropertySet("string","My test header");
PageStyle.OlePropertySet("leftPageHeaderContent",HeaderLeft);

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

Аналогичные функции существуют и для footer: “footerIsOn”, “footerIsShared”.

Сохранение документа.

Для сохранения в формате OpenOffice.org:

Document.OleFunction ("storeAsURL", convertToURL(fileName), VariantArray);

Для сохранения в другом формате, например формате Microsoft Excel, надо заполнить массив с опциями сохранения документа. Обратите внимание, что используется функция “storeToURL”, а не “storeAsURL” как в предыдущем примере:

Variant VariantArray;
int Bounds[2];
Bounds[0] = 0;
Bounds[1] = 0;
Variant MyStruct = ServiceManager.OleFunction("Bridge_GetStruct",
"com.sun.star.beans.PropertyValue");
MyStruct.OlePropertySet("name","FilterName");
MyStruct.OlePropertySet("value","MS Excel 97");
VariantArray = VarArrayCreate(Bounds, 1, varVariant);
VariantArray.PutElement(MyStruct, 0);
Document.OleFunction ("storeToURL", convertToURL(fileName), VariantArray);

Закрытие документа

Document.OleFunction("close", true);
Document = Unassigned();

Закрытие офиса

Desktop.OleFunction("terminate"); //не закроет QuickStarter
Desktop = Unassigned();

Аналог ScreenUpdating от Excel.

У Excel существует функция отключения вывода на экран, что позволяет повысить скорость работы при выводе больших объемов данных.

Аналог данной функции для OpenOffice.org:

Отключение вывода

Document.OleFunction("lockControllers");
Document.OleFunction("addActionLock");

Включение вывода

Document.OleFunction("unLockControllers");
Document.OleFunction("removeActionLock");

Заключение

Надеюсь, что данная статья, несмотря на её краткость, окажется полезной для тех, кто делает первые шаги в автоматизации OpenOffice.org Calc.

Я не пытался в данной статье охватить все аспекты работы с OpenOffice.org, в принципе это и невозможно в рамках одной статьи. Однако я надеюсь, что основные приёмы работы освещены достаточно подробно.

Пример работы с OpenOffice.org Calc.

Данный пример был протестирован на следующих конфигурациях:

Во всех случаях использовалась английская версия OpenOffice.org с отключенным Quickstarter.

Пример не тестировался на системах Windows 95/98. Есть предположение, что для корректной работы потребуется запущенный Quickstarter.

На всех системах в установках OpenOffice.org было установлено Locale setting – English (USA).

Для компиляции использовался Borland C++ Builder 6 Enterprise.

Источники информации

  1. OpenOffice.org: Home Page – http://www.openoffice.org. Рекомендуется скачать SDK - http://www.openoffice.org/dev_docs/source/sdk/#about
  2. OpenOffice.org для русскоговорящих пользователей http://ru.openoffice.org.
  3. OpenOffice.ru - http://www.openoffice.ru/
  4. OpenOffice.org Forum at OooForum.org – http://www.oooforum.org


Эта статья опубликована в журнале RSDN Magazine #6-2004. Информацию о журнале можно найти здесь
    Сообщений 0    Оценка 130        Оценить