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>
112 lines
3.9 KiB
Markdown
112 lines
3.9 KiB
Markdown
---
|
||
title: "Параметры графического документа (Интерфейс ksDocumentParam)"
|
||
type: interface
|
||
api: [api7]
|
||
domain: [2d]
|
||
tags: [interface, api7, 2d, ksdocumentparam]
|
||
sources:
|
||
- ksdocumentparam.html
|
||
---
|
||
|
||
*API интерфейсов. Версия 5 > Графический документ (Интерфейсы - ksDocument2D и IDocument2D) *
|
||
|
||
|
||
## Параметры графического документа (Интерфейс ksDocumentParam)
|
||
|
||
Интерфейс параметров документа.
|
||
Аналог интерфейса при использовании API экспортных функций структура параметров DocumentParam.
|
||
| ksDocumentParam | - интерфейс Automation |
|
||
| --- | --- |
|
||
Примечание:
|
||
Указатель на интерфейс можно получить при помощи метода KompasObject::GetParamStruct.
|
||
Смотрите также: KompasObject
|
||
|
||
|
||
## author - Автор
|
||
|
||
Тип данных:BSTR.
|
||
Синтаксис Automation:
|
||
```
|
||
author = iDocumentParam.author Получить свойство (* )
|
||
iDocumentParam.author = author Установить свойство (* )
|
||
author = iDocumentParam.GetAuthor() Получить свойство (**)
|
||
iDocumentParam.SetAuthor(author) Установить свойство (**)
|
||
```
|
||
|
||
|
||
## comment - Комментарий
|
||
|
||
Тип данных:BSTR.
|
||
Синтаксис Automation:
|
||
```
|
||
comment = iDocumentParam.comment Получить свойство (* )
|
||
iDocumentParam.comment = comment Установить свойство (* )
|
||
comment = iDocumentParam.GetComment() Получить свойство (**)
|
||
iDocumentParam.SetComment(comment) Установить свойство (**)
|
||
```
|
||
|
||
|
||
## filfeName - Имя файла
|
||
|
||
Тип данных:BSTR.
|
||
Синтаксис Automation:
|
||
```
|
||
regime = iDocumentParam.regime Получить свойство (* )
|
||
iDocumentParam.regime = regime Установить свойство (* )
|
||
regime = iDocumentParam.GetRegime() Получить свойство (**)
|
||
iDocumentParam.SetRegime(regime) Установить свойство (**)
|
||
```
|
||
|
||
|
||
## GetLayoutParam - Получить указатель на интерфейс параметров оформления документа
|
||
|
||
Синтаксис Automation:
|
||
```
|
||
LPDISPATCH GetLayoutParam();
|
||
Возвращаемое значение:
|
||
- указатель на интерфейс параметров оформления документа ksSheetPar.
|
||
```
|
||
|
||
|
||
## Init - Инициализировать параметры
|
||
|
||
Синтаксис Automation:
|
||
```
|
||
BOOL Init();
|
||
Возвращаемое значение:
|
||
TRUE - в случае удачного завершения.
|
||
```
|
||
Примечание:
|
||
Метод обнуляет все параметры чертежа или фрагмента.
|
||
|
||
|
||
## regime - Режим редактирования
|
||
|
||
Тип данных:short.
|
||
Значения свойства:
|
||
| 0 | - видимый, |
|
||
| --- | --- |
|
||
| 1 | - "слепой". |
|
||
Синтаксис Automation:
|
||
```
|
||
fileName = iDocumentParam.fileName Получить свойство (* )
|
||
iDocumentParam.fileName = fileName Установить свойство (* )
|
||
fileName = iDocumentParam.GetFileName() Получить свойство (**)
|
||
iDocumentParam.SetFileName( fileName ) Установить свойство (**)
|
||
```
|
||
|
||
|
||
## type - Тип документа
|
||
|
||
Тип данных:short.
|
||
Значения свойства:
|
||
| Из перечисления DocType. | |
|
||
| --- | --- |
|
||
Синтаксис Automation:
|
||
```
|
||
type = iDocumentParam.type Получить свойство (* )
|
||
iDocumentParam.type = type Установить свойство (* )
|
||
type = iDocumentParam.GetType() Получить свойство (**)
|
||
iDocumentParam.SetType(type) Установить свойство (**)
|
||
```
|