Методы

Документация по методам

На этой странице вы можете ознакомиться со списком доступных на данный момент методов CraftTechAPI.

Три кита [большинства] макросов

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

openFile(): fileHandler

Открывает внешний файл, добавляет его в базу данных.

saveFile(): boolean

Сохраняет файл (и изменения в нём) в базу данных.

closeFile(): boolean

Закрывает внешний файл, удаляет его из базы данных.

Архитектура CraftTechPE

deleteTempDirForce(): void

Принудительно удаляет папку temp, в которой хранятся временные файлы, открытые через CraftTechPE, во время выполнения макроса.

Работа с путями

Методы для получения, обработки и работы с путями к файлам и папкам.

getBaseDir(): string

Позволяет получить путь до папки, внутри которой находится активный файл.

getCurrentFilePath(): string

Позволяет получить путь до активного файла.

Управление папками

Методы для создания, копирования и работы с папками.

createDir(): boolean

Создаёт папку по указанному пути и добавляет её в систему.

existDir(): boolean

Проверяет существование папки по указанному пути.

copyDir(): boolean

Копирует папку со всеми файлами внутри в указанное место.

Управление файлами

Методы для работы с файлами: открытие, сохранение, удаление и копирование.

createXlsx(): fileHandler | boolean

Создаёт xlsx-файл по указанному пути с заданным названием листа. Если название не передано, то лист будет назван по умолчанию «Лист1».

isFileOpen(): boolean

Проверяет, открыт ли файл физически в данный момент времени (другим пользователем или этим же пользователем в Excel/Р7-Офис).

renameFile(): boolean

Переименовывает файл.

existFile(): boolean

Проверяет существование файла по указанному пути.

copyFile(): boolean

Копирует файл в указанное место.

deleteFile(): boolean

Удаляет файл по указанному пути.

Текстовые файлы

Методы для чтения, записи и обработки текстовых файлов.

editTxtFile(): boolean

Вносит изменения в текстовый файл и сохраняет его под новым названием.

Обновление данных

recalcAllFormulas(): boolean

Пересчитывает все формулы во внешнем документе.

autoRecalcFormula(): boolean

Запускает автоматический пересчёт формул при каждом открытии документа.

reRenderSheet(): void

Обновляет данные на текущем листе файла, из которого запущен текущий макрос.

updateActiveFilePivotTable(): boolean

Обновляет сводную таблицу в активном файле.

Листы книги

Методы для управления листами книги (файла .xlsx).

createSheet(): boolean

Создаёт новый лист в книге.

renameSheet(): boolean

Переименовывает лист в книге.

isSheetExist(): boolean

Проверяет наличие листа в книге по его названию.

copySheet(): boolean

Копирует лист книги.

moveSheetName(): boolean

Перемещает лист в книге на другую позицию.

getSheetsNames(): string[]

Возвращает список листов книги.

getSheetArray(): (string | number | null)[][]

Позволяет получить все строковые и числовые данные ячеек указанного листа книги.

editSheetTabColor(): boolean

Изменяет цвет вкладки листа в документе.

getActiveSheetName(): string

Возвращает активный лист переданного файла.

deleteSheet(): boolean

Удаляет указанный лист в книге.

copyCurrentWorksheet(): void

Копирует лист в активном файле, из которого запущен текущий макрос.

editSheetPrintOptions(): boolean

Изменяет параметры печати листа.

editSheetVisibility(): boolean

Изменяет видимость листа.

Диапазоны и значения

Методы для работы с диапазонами и данными в них.

Получение данных

getCellValue(): string | number | null

Возвращает значение ячейки.

getCellRange(): object[][]

Возвращает значения диапазона ячеек.

findCellsByValue(): string[],object[]

Находит все ячейки листа, соответствующие указанному значению.

findCellsBySubString(): string[],object[]

Находит все ячейки листа, или диапазона содержащие подстроку в своём значении.

getUsedRange(): object

Возвращает информацию о полном диапазоне ячеек, в которых есть значения во всем листе.

getFileData(): object

Возвращает все текстовые и числовые данные в документе.

Изменение данных

editCellValue(): boolean

Вносит изменения в значение ячейки.

editCellsValue(): boolean

Вносит изменения в значения нескольких ячеек.

editCellRange(): boolean

Вносит изменения в значения диапазона ячеек.

editCells(): boolean

Изменяет значение ячейки и применяет форматирование к ней.

pasteDataFromBuffer(): boolean

Копирует данные из буфера (текст/изображение) в указанную ячейку.

Копирование данных

copyCellRange(): boolean

Копирует диапазон листа книги.

Сохранение данных

saveActiveFile(): void

Принудительно сохраняет активный файл, из которого запущен текущий макрос.

applyActiveFileChanges(): void

Применяет изменения, внесенные в активный файл при помощи методов Crafttech PE

Строки и столбцы

getFieldLength(): number

Находит длину переданного ряда или столбца.

getColumnIndex(): number

Возвращает номер колонки, в которой находится ячейка на активном листе.

showColumns(): boolean

Раскрывает скрытые столбцы.

showRows(): boolean

Раскрывает скрытые строки.

insertRowFile(): boolean

Вставляет пустую строку на указанную позицию со смещением вниз.

hideColumns(): boolean

Скрывает столбцы.

hideRows(): boolean

Скрывает строки.

deleteRowFile(): boolean

Очищает данные всего ряда на листе.

clearCellRange(): boolean

Очищает данные диапазона на листе.

dropRowFile(): boolean

Удаляет данные всего ряда на листе со смещением вверх.

freezeField(): boolean

Закрепляет липкие строки и столбцы.

unfreezeField(): boolean

Открепляет липкие строки и столбцы.

Сортировка и фильтрация

resetFilters(): boolean

Сбрасывает фильтрацию с указанного листа.

setAutofilterActive(): void

Устанавливает фильтрацию в активном файле, из которого запущен текущий макрос.

resetAutofilterActive(): void

Сбрасывает фильтрацию в активном файле, из которого запущен текущий макрос.

removeAutoFilter(): void

Сбрасывает фильтрацию на листе.

createAutoFilter(): void

Устанавливает фильтрацию по диапазону значений.

sortActiveSheet(): void

Устанавливает сортировку в активном файле, из которого запущен текущий макрос.

Объединение ячеек

isMergedCell(): object

Предоставляет данные об объединенных ячейках по адресу.

mergeCells(): boolean

Объединяет ячейки в диапазоне.

unmergeCells(): boolean

Разъединяет ячейки в диапазоне.

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

copyStyleCell(): void

Копирует стили одной ячейки и вставляет их в другую в активном файле, из которого запущен текущий макрос.

copySizeCell(): void

Копирует размер (ширину и высоту) одной ячейки и вставляет его в другую в активном файле, из которого запущен текущий макрос.

clearCurrentCells(): void

Очищает значение ячейки.

setAutoFitCell(): boolean

setCellSize(): boolean

Изменяет размеры ячейки (высоту строки и ширину столбца).

Группировка

groupActive(): void

Группирует диапазон ячеек в активном файле, из которого запущен текущий макрос.

ungroupActive(): void

Разгруппировывает диапазон ячеек в активном файле, из которого запущен текущий макрос.

showLevels(): boolean

Отображает указанное количество уровней строк и (или) столбцов структуры.

Форматированные таблицы

createStyledTable(): boolean

Создаёт стилизованную таблицу на листе.

updateStyledTable(): boolean

Обновляет стилизованную таблицу на листе.

resizeActiveFileStyledTable(): boolean

Изменяет размер стилизованной таблицы в активном файле.

Папки и файлы

Методы для получения информации о файлах, папках и их подпапках.

getFilesInDir(): string[][]

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

infoFile(): object

Используется для получения информации о файле по его абсолютному пути; также возвращаемый объект хранит текущую дату и время.

getPageCount(): number

Фигуры и графики

Методы для добавления, редактирования и удаления графических элементов и диаграмм в файле (листе).

deleteDrawings(): boolean

Удаляет фигуры с листа.

deleteActiveFileDrawings(): boolean

Удаляет рисунки (фигуры, графики, картинки) с листа активной книги.

getAllCharts(): object[]

Возвращает все графики переданного файла.

getAllChartsBySheet(): object[]

Возвращает все графики указанного листа переданного файла.

Защита файла

Методы для защиты файлов: установка пароля или шифрования на документ.

protectSheet(): boolean

unProtectSheet(): boolean

isSheetProtected(): boolean

Проверяет, защищён ли указанный лист переданного файла.

encryptFile(): boolean

Шифрует файл. Файл станет недоступен для просмотра, и при попытке его открыть потребуется ввод пароля пользователем.

decryptFile(): boolean

Снимает шифрование с файла. Файл вновь станет доступен для просмотра.

isFileEncrypted(): boolean

Проверяет, установлен ли пароль в файле.

protectBookActive(): void

Устанавливает защиту от редактирования на активный файл, из которого запущен текущий макрос.

protectSheetActive(): void

Устанавливает защиту от редактирования на листа из активного файла, из которого запущен текущий макрос.

protectRangeActive(): void

Устанавливает защиту от редактирования на диапазон данных листа из активного файла, из которого запущен текущий макрос.

unprotectRangeActive(): void

Снимает защиту от редактирования на диапазон данных листа из активного файла, из которого запущен текущий макрос.

Конвертация в другой формат

Методы для преобразования файлов в другие форматы.

convertToPdf(): boolean

convertPdfToBase64(): string

Конвертирует PDF-файл в строку формата Base64.

Система

Методы для взаимодействия с системой.

openExplorer(): boolean

Используется для нативного открытия файла (или папки) в системе. При помощи данного метода можно открывать файлы и папки с открытием окон.

runFile(): boolean

Запускает исполняемую программу.

getUserName(): string

Возвращает имя пользователя в системе.

Управление макросами

Методы для создания, редактирования, удаления и выполнения макросов.

addMacros(): boolean

Добавляет новый макрос в список макросов в Р7-Офис.

executeMacros(): boolean

Запускает макрос внешнего файла.

Преобразование данных

convertDate(): object

Преобразовывает дату из формата Р7-Офис в читаемый формат.

convertTime(): object

Преобразовывает время из формата Р7-Офис в читаемый формат.

numberFormat(): boolean

Устанавливает формат ячейки (или диапазона ячеек) по переданному шаблону. Содержимое ячейки должно быть числом.

conditionalFormatting(): boolean

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

goalSeek(): boolean

Вычисляет значения, необходимые для достижения определенной цели. Аналог метода в VBA.

Работа с почтовым клиентом

Методы для отправки писем и/или взаимодействия с почтовыми клиентами.

sendMail(): boolean

Отправляет письмо с вложенными файлами на электронную почту через SMTP-сервер.

sendByMail(): boolean

Отправляет письмо с вложенными файлами на электронную почту через вызов Р7-Органайзера.

Интерактив с пользователем

Методы для вызова окон, с которыми будет работать пользовать для дальнейшей работы макроса.

getPathsByDialog(): string[]

Открывает диалоговое окно в Проводнике и возвращает абсолютные пути до файлов, выбранных пользователем в этом окне.

getDirPathsByDialog(): string

Открывает диалоговое окно в Проводнике и возвращает абсолютный путь до папки, выбранной пользователем в этом окне.

showInputBox(): string

Выводит на экран окно с полем ввода для указания в нём данных пользователем.

selectRangeDialog(): string

Выводит на экран окно с полем ввода, которое содержит диапазон данных, выбранный пользователем.

inputForm(): string[]

Выводит на экран окно с полями ввода, лейблами и кнопками с возможностью кастомизации; при нажатии на выбранную кнопку запускает функцию или макрос.

macroStatus(): macroStatusType

Выводит на экран окно с прогресс-баром (индикатором выполнения) во время выполнения макроса.

spinner(): SimpleSpinnerType

Отображает окно с индикатором выполнения (спиннером) и может показывать сообщения об успехе или ошибке в зависимости от условий.

Элементы управления

Методы для работы с элементами управления, не реализованными в Р7-Офис.

convertCellToCheckbox(): void

Формирует чекбоксы (флажки) на место указанных ячеек в активном файле, из которого запущен текущий макрос.

convertCellToRadiobox(): void

Формирует радиобоксы (радиокнопки) на место указанных ячеек в активном файле, из которого запущен текущий макрос.

convertCellsToBoxes(): void

Формирует чекбоксы и радиобоксы (радиокнопки) на место указанных ячеек в активном файле, из которого запущен текущий макрос.

getDefaultCheckboxValues(): void

Возвращает символы чекбоксов.

getDefaultRadioboxValues(): void

Возвращает символы радиобоксов.

createListBox(): void

Формирует поле списка на листе на основе переданного диапазона.

getListBox(): object

Возвращает данные, выбранные пользователем из поля списка.

createDropdownCell(): boolean

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

XML-файлы

XML: class

Возвращает классы XML и XMLTag, экземпляры которых позволяют создавать разметку для XML-файла.

Электронные документы (docx)

getDocTables(): object[]

Возвращает содержимое из таблиц электронного документа.

DOM

getHtml(): string

Возвращает HTML-разметку переданного URL-адреса.

Математика (WorksheetFunction и др.)

mathFunction(): string

Возвращает результат расчета математической функции, переданной первым аргументом.

mathFunctionMany(): string

Позволяет выполнить неоднократное вычисление функций в зависимости от количества переданных аргументов-массивов

mathRand(): array

Позволяет сгенерировать псевдослучайные числа с запоминанием последовательности с помощью семечка

Политика конфиденциальности

Обратная связь: support@crafttech.ru