Workbook класс

Workbook класс

Представляет корневой объект для создания электронной таблицы Excel.

Тип Workbook предоставляет следующие элементы:

Конструкторы

КонструкторОписание
__init__(self)Инициализирует новый экземпляр класса Workbook.
__init__(self, file_format_type)Инициализирует новый экземпляр класса Workbook.
__init__(self, file)Инициализирует новый экземпляр класса Workbook и открывает файл.
__init__(self, stream)Инициализирует новый экземпляр класса Workbook и открывает поток.
__init__(self, file, load_options)Инициализирует новый экземпляр класса Workbook и открывает файл.
__init__(self, stream, load_options)Инициализирует новый экземпляр класса Workbook и открывает поток.

Характеристики

СвойствоОписание
settingsПредставляет параметры книги.
worksheetsПолучает коллекцию WorksheetCollection в электронной таблице.
is_licensedУказывает, установлена ли лицензия.
colorsВозвращает цвета в палитре электронной таблицы.
count_of_styles_in_poolВозвращает количество стилей в пуле стилей.
default_styleВозвращает или задает объект Style по умолчанию для рабочей книги.
is_digitally_signedУказывает, имеет ли данная электронная таблица цифровую подпись.
is_workbook_protected_with_passwordУказывает, защищена ли структура или окно паролем.
vba_projectПолучает Workbook.vba_project в электронной таблице.
has_macroУказывает, содержит ли эта электронная таблица макрос/VBA.
has_revisionsПроверяет, есть ли в книге отслеживаемые изменения.
file_nameПолучает и задает текущее имя файла.
cells_data_table_factoryПолучает фабрику для построения ICellsDataTable из пользовательских объектов.
data_sorterПолучает объект DataSorter для сортировки данных.
themeПолучает имя темы.
built_in_document_propertiesВозвращает коллекцию DocumentProperty, которая представляет все встроенные свойства документа электронной таблицы.
custom_document_propertiesВозвращает коллекцию DocumentProperty, которая представляет все пользовательские свойства документа электронной таблицы.
file_formatПолучает и задает формат файла.
has_custom_functionОпределяет, используется ли в этой книге пользовательская функция,
например, в формуле ячейки, в определенных именах…
content_type_propertiesПолучает список из ContentTypeProperty объектов в рабочей книге.
custom_xml_partsПредставляет собой часть хранилища пользовательских XML-данных (пользовательские XML-данные в пакете).
data_mashupПолучает данные мэшапа.
ribbon_xmlПолучает и задает XML-файл, определяющий пользовательский интерфейс Ribbon.
absolute_pathПолучает и задает абсолютный путь к файлу.
data_connectionsПолучает коллекцию ExternalConnection.
data_modelПолучает модель данных в рабочей книге.

Методы

МетодОписание
save(self, file_name, save_format)Сохраняет книгу на диск.
save(self, file_name)Сохраните книгу на диске.
save(self, file_name, save_options)Сохраняет книгу на диск.
save(self, stream, save_format)Сохраняет книгу в потоке.
save(self, stream, save_options)Сохраняет книгу в потоке.
create_style(self)Создаёт новый стиль.
create_style(self, clone_default_style)Создаёт новый стиль.
replace(self, place_holder, new_value)Заменяет значение ячейки новой строкой.
replace(self, place_holder, new_value)Заменяет значение ячейки новым целым числом.
replace(self, place_holder, new_value)Заменяет значение ячейки новым числом двойной точности.
replace(self, place_holder, new_values, is_vertical)Заменяет значение ячейки новым строковым массивом.
replace(self, place_holder, new_values, is_vertical)Заменяет значения ячеек целочисленным массивом.
replace(self, place_holder, new_values, is_vertical)Заменяет значения ячеек двойным массивом.
replace(self, bool_value, new_value)Заменяет значения ячеек новыми данными.
replace(self, int_value, new_value)Заменяет значения ячеек новыми данными.
replace(self, place_holder, new_value, options)Заменяет значение ячейки новой строкой.
copy(self, source, copy_options)Копирует другой объект Workbook.
copy(self, source)Копирует данные из исходного объекта Workbook.
calculate_formula(self)Вычисляет результат формул.
calculate_formula(self, ignore_error)Вычисляет результат формул.
calculate_formula(self, options)Расчетные формулы в этой рабочей тетради.
refresh_dynamic_array_formulas(self, calculate)Обновляет динамические формулы массива (переносит в новый диапазон соседних ячеек в соответствии с текущими данными)
Другие формулы в рабочей книге не будут вычисляться рекурсивно, даже если они использовались в формулах динамического массива.
refresh_dynamic_array_formulas(self, calculate, copts)Обновляет динамические формулы массива (переносит в новый диапазон соседних ячеек в соответствии с текущими данными)
import_xml(self, url, sheet_name, row, col)Импортирует/обновляет XML-файл данных в рабочую книгу.
import_xml(self, stream, sheet_name, row, col)Импортирует/обновляет XML-файл данных в рабочую книгу.
export_xml(self, map_name, path)Экспорт XML-данных, связанных с указанной XML-картой.
export_xml(self, map_name, stream)Экспорт XML-данных.
parse_formulas(self, ignore_error)Анализирует все формулы, которые не были проанализированы при загрузке из файла шаблона или установке в ячейку.
start_access_cache(self, opts)Запускает сеанс, использующий кэши для доступа к данным.
close_access_cache(self, opts)Закрывает сеанс, использующий кэши для доступа к данным.
remove_unused_styles(self)Удалите все неиспользуемые стили.
create_builtin_style(self, type)Создает встроенный стиль по заданному типу.
create_cells_color(self)Создает объект CellsColor.
combine(self, second_workbook)Объединяет другой объект Workbook.
get_style_in_pool(self, index)Получает стиль из пула стилей.
Все стили в рабочей книге будут объединены в пул.
В ячейках имеется только простой справочный индекс.
get_fonts(self)Получает все шрифты в пуле стилей.
get_named_style(self, name)Получает именованный стиль в пуле стилей.
merge_named_styles(self, source)Объединяет именованные стили из другого файла Excel.
change_palette(self, color, index)Изменяет палитру для электронной таблицы в указанном индексе.
is_color_in_palette(self, color)Проверяет, присутствует ли цвет в палитре электронной таблицы.
get_matching_color(self, raw_color)Найдите наиболее подходящий цвет в текущей палитре.
set_encryption_options(self, encryption_type, key_length)Установите параметры шифрования.
protect(self, protection_type, password)Защищает рабочую книгу.
protect_shared_workbook(self, password)Защищает общую книгу.
unprotect(self, password)Снимает защиту с книги.
unprotect_shared_workbook(self, password)Снимает защиту с общей книги.
remove_macro(self)Удаляет VBA/макрос из этой электронной таблицы.
remove_digital_signature(self)Удаляет цифровую подпись из этой электронной таблицы.
accept_all_revisions(self)Принимает все отслеживаемые изменения в рабочей книге.
remove_external_links(self)Удаляет все внешние ссылки в книге.
get_theme_color(self, type)Получает цвет темы.
set_theme_color(self, type, color)Устанавливает цвет темы
custom_theme(self, theme_name, colors)Таможня тема.
copy_theme(self, source)Копирует тему из другой рабочей книги.
has_exernal_links(self)Указывает, содержит ли эта книга внешние ссылки на другие источники данных.
update_custom_function_definition(self, definition)Обновляет определение пользовательских функций.
update_linked_data_source(self, external_workbooks)Если эта рабочая книга содержит внешние ссылки на другие источники данных,
Aspose.Cells попытается получить последние данные из указанных источников.
set_digital_signature(self, digital_signature_collection)Устанавливает цифровую подпись для файла электронной таблицы (Excel2007 и более поздние версии).
add_digital_signature(self, digital_signature_collection)Добавляет цифровую подпись в файл электронной таблицы OOXML (Excel2007 и более поздние версии).
get_digital_signature(self)Получает цифровую подпись из файла.
remove_personal_information(self)Удаляет персональные данные.
close(self)Dispose() пропускается оболочкой с протокола Python

Примечания

Класс Workbook обозначает электронную таблицу Excel. Каждая таблица может содержать несколько рабочих листов. Основная функция класса — открытие и сохранение собственных файлов Excel. Класс обладает некоторыми расширенными функциями, такими как копирование данных из других рабочих книг, объединение двух рабочих книг, преобразование Excel в PDF, преобразование Excel в изображение и защита электронной таблицы Excel.

Пример

В следующем примере загружается Workbook из файла Excel с именем designer.xls и делаются невидимыми горизонтальные и вертикальные полосы прокрутки. Затем он заменяет два строковых значения целочисленным значением и строковым значением соответственно в электронной таблице и, наконец, сохраняет книгу как файл Excel xlsx.

from aspose.cells import Workbook

# Open a designer file
designerFile = "designer.xls"
workbook = Workbook(designerFile)
# Set scroll bars
workbook.settings.is_h_scroll_bar_visible = False
workbook.settings.is_v_scroll_bar_visible = False
# Replace the placeholder string with new values
newInt = 100
workbook.replace("OldInt", newInt)
newString = "Hello!"
workbook.replace("OldString", newString)
workbook.save("result.xlsx")

Смотрите также