mikhail
e1337e4016
docs/Kompas3D_SDK/ становится каноническим источником справки КОМПАС SDK и включается в репозиторий (2491 файл, ~14 МБ). HTML-зеркало docs/KOMPAS_SDK_ru-RU/ (~1.4 ГБ, © АСКОН) и генератор tools/build_kompas3d_sdk.py больше не нужны — регенерация не предполагается. - .gitignore: MD-база разблокирована; зеркало остаётся проигнорированным (safety-net на случай повторной локальной выгрузки). - CLAUDE.md / SKILL.md: убраны упоминания регенерации и зеркала. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
12 KiB
title, type, api, tags, sources
| title | type | api | tags | sources | |||||
|---|---|---|---|---|---|---|---|---|---|
| Текстовый документ (Интерфейс ksDocumentTxt) | interface |
|
|
|
API интерфейсов. Версия 5
Текстовый документ (Интерфейс ksDocumentTxt)
События... Интерфейс текстового документа.
| ksDocumentTxt | - интерфейс Automation |
|---|---|
| Примечание: | |
| Данный интерфейс в автоматизации может быть получен от интерфейса API Kompas KompasObject с помощью методов KompasObject::DocumentTxt, KompasObject::ActiveDocumentTxt; |
GetStamp - Получить указатель на интерфейс основной надписи
Синтаксис Automation:
LPDISPATCH GetStamp();
Возвращаемое значение:
- указатель на интерфейс основной надписи ksStamp.
GetStampEx - Получить указатель на интерфейс основной надписи чертежа
Синтаксис Automation:
LPDISPATCH GetStampEx (long sheetNumb);
Входные параметры:
sheetNumb - номер листа, начиная с 1.
Возвращаемое значение:
- указатель на интерфейс основной надписи ksStamp.
GetTxtDocumentPagesCount - Получить количество листов текстового документа
Аналог данного метода при использовании API экспортных функций - ksGetTxtDocumentPagesCount. Синтаксис Automation:
long ksGetTxtDocumentPagesCount();
Возвращаемое значение:
Количество листов
ksCloseDocument - Закрыть документ
Аналог данного метода при использовании API экспортных функций - CloseDocument. Синтаксис Automation:
BOOL ksCloseDocument();
Возвращаемое значение:
TRUE - в случае успешного завершения,
FALSE - в случае неудачи.
ksCreateDocument - Создать текстовый документ
Аналог данного метода при использовании API экспортных функций - CreateTextDocument. Синтаксис Automation:
BOOL ksCreateDocument (LPDISPATCH par);
Входные параметры:
par - указатель на интерфейс параметров текстового документа ksTextDocumentParam.
Возвращаемое значение:
TRUE - в случае успешного завершения,
FALSE - в случае неудачи.
Примечание: Созданный документ становится текущим.
ksGetDocumentPagesCount - Получить количество листов документа
Аналог данного метода при использовании API экспортных функций - ksGetDocumentPagesCount. ИС: оборванная ссылка. раздела "Получить количество листов" больше нет в разделе API экспортных - Функции работы с графическим - Оформление чертежа Синтаксис Automation:
long ksGetDocumentPagesCount();
Возвращаемое значение:
Количество листов документа.
ksGetObjParam - Получить параметры объекта
Аналог данного метода при использовании API экспортных функций - GetObjParam. Синтаксис Automation:
long ksGetObjParam (long reference, LPDISPATCH param, long paramType);
Входные параметры:
reference - указатель на объект,
paramType - тип параметров объекта.
Выходные параметры:
param - указатель на интерфейс параметров.
Типы объектов и интерфейсы...
Возвращаемое значение:
тип объекта - в случае успеха,
0 - в случае неудачи.
Примечания:
- Параметр paramType может принимать значения ALLPARAM, SHEET_ALLPARAM, DOCUMENT_STATE.
- Возвращаемым значением может быть TXT_DOCUMENT_OBJ.
- Перед применением метода указатель param должен быть задан, например, с помощью метода KompasObject::GetParamStruct.
- Вызов метода с нулевыми значениями параметров param и parType позволяет получить тип объекта по его reference.
ksOpenDocument - Открыть документ
Аналог данного метода при использовании API экспортных функций - OpenDocument. Синтаксис Automation:
BOOL ksOpenDocument (BSTR nameDoc, BOOL regim);
Входные параметры:
nameDoc - имя документа,
regim - режим работы с документом: 0 - видимый, 1 - невидимый ("слепой").
Возвращаемое значение:
TRUE - в случае успешного завершения,
FALSE - в случае неудачи.
Примечания:
- Невидимый режим применяется при пакетном (скрытом) формировании документа.
- Открытый документ автоматически становится текущим.
ksSaveDocument - Сохранить документ
Аналог данного метода при использовании API экспортных функций - SaveDocument. Синтаксис Automation:
BOOL ksSaveDocument (BSTR fileName);
Входные параметры:
fileName - полное имя файла.
Возвращаемое значение:
TRUE - в случае успешного завершения,
FALSE - в случае неудачи.
ksSaveDocumentEx - Сохранить документ в выбранной версии
Аналог данного метода при использовании API экспортных функций - SaveDocumentEx. Синтаксис Automation:
BOOL ksSaveDocumentEx (BSTR fileName, long saveMode);
Входные параметры:
fileName - полное имя файла,
saveMode - версия для сохранения: -1 - в предыдущую версию, 0 - в текущую версию, 1 - в версию 5.11.
Возвращаемое значение:
TRUE - в случае успешного завершения,
FALSE - в случае неудачи.
Примечания: Если fileName = NULL, то используется имя файла из документа. Если же и в документе отсутствует имя файла, то взводится ошибка.
ksSetObjParam - Установить параметры объекта
Аналог данного метода при использовании API экспортных функций - SetObjParam. Синтаксис Automation:
long ksSetObjParam (long reference, LPDISPATCH param, long paramType);
Входные параметры:
reference - указатель на объект,
paramType - тип параметров объекта,
param - указатель на интерфейс параметров.
Типы объектов и интерфейсы...
Возвращаемое значение:
1 - в случае успеха,
0 - в случае неудачи.
Примечания:
- Параметр paramType может принимать значения ALLPARAM, SHEET_ALLPARAM, DOCUMENT_STATE.
- Типом объекта может быть TXT_DOCUMENT_OBJ.
- Перед применением метода указатель param должен быть задан, например, с помощью метода KompasObject::GetParamStruct.
RasterFormatParam - Получить указатель на интерфейс параметров сохранения документа в растровом формате
Синтаксис Automation:
LPDISPATCH RasterFormatParam();
Синтаксис COM:
LPRASTERFORMATPARAM RasterFormatParam();
Возвращаемое значение:
указатель на интерфейс ksRasterFormatParam - в случае успеха,
NULL - в случае неудачи.
reference - Указатель на текстовый документ системы КОМПАС
Тип данных: long Синтаксис Automation:
ref = iDocumentTXT.reference Получить свойство (* )
iDocumentTXT.reference = ref Установить свойство (* )
ref = iDocumentTXT.GetReference() Получить свойство (**)
iDocumentTXT.SetReference(ref) Установить свойство (**)
SaveAsToRasterFormat - Сохранить документ в растровом формате
Аналог данного метода при использовании API экспортных функций - ksSaveAsToRasterFormat. Синтаксис Automation:
BOOL SaveAsToRasterFormat (BSTR fileName, LPDISPATCH rasterPar);
Входные параметры:
fileName - полное имя файла документа,
rasterPar - указатель на интерфейс ksRasterFormatParam, определяющий параметры записи в растровый формат.
Возвращаемое значение:
TRUE - в случае успешного завершения,
FALSE - в случае неудачи.
Примечания: Метод позволяет сохранить присланный документ в растровом формате (BMP, GIF, JPG, PNG, TIF, TGA, PCX, EMF и WMF) с заданными свойствами. Сохранение в WMF формат не поддерживается. При сохранении в WMF формате файл записывается в формате EMF.
SaveAsToUncompressedRasterFormat - Сохранить документ в растровый формат без сжатия
Аналог данного метода при использовании API экспортных функций - ksSaveAsToUncompressedRasterFormat. Синтаксис Automation:
BOOL SaveAsToUncompressedRasterFormat (BSTR fileName, LPDISPATCH rasterPar);
Входные параметры:
fileName - полное имя файла документа,
rasterPar - Указатель на интерфейс ksRasterFormatParam, определяющий параметры записи в растровый формат.
Возвращаемое значение:
TRUE - в случае успеха,
FALSE - в случае неудачи.
Примечания: Метод позволяет сохранить присланный документ в растровом формате (BMP, GIF, JPG, PNG, TIF, TGA, PCX, EMF и WMF) с заданными свойствами. Сохранение в WMF формат не поддерживается. При сохранении в WMF формате файл записывается в формате EMF.