Files
kompas3d-mcp/docs/Kompas3D_SDK/interfaces/kstextdocumentparam.md
T
mikhail e1337e4016 feat(sdk-docs): MD-база знаний SDK — в репозиторий; генератор и зеркало убраны
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>
2026-05-26 20:00:05 +03:00

113 lines
4.4 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: "Параметры текстового документа (Интерфейс ksTextDocumentParam)"
type: interface
api: [api7]
tags: [interface, api7, kstextdocumentparam]
sources:
- kstextdocumentparam.html
---
*API интерфейсов. Версия 5 > Текстовый документ (Интерфейс ksDocumentTxt)  > ksDocumentTxt - методы *
## Параметры текстового документа (Интерфейс ksTextDocumentParam)
Интерфейс параметров текстового документа.
Аналог данных параметров при использовании API экспортных функций - TextDocumentParam.
Примечание:
Указатель на интерфейс можно получить при помощи метода ompasObject::GetParamStruct.
## author - Имя автора документа
Тип данных: BSTR
Синтаксис Automation:
```
author = iTextDocumentParam.author Получить свойство (* )
iTextDocumentParam.author = author Установить свойство (* )
author = iTextDocumentParam.GetAuthor() Получить свойство (**)
iTextDocumentParam.SetAuthor(author) Установить свойство (**)
```
## comment - Комментарий документа
Тип данных: BSTR
Синтаксис Automation:
```
comment = iTextDocumentParam.comment Получить свойство (* )
iTextDocumentParam.comment = comment Установить свойство (* )
comment = iTextDocumentParam.GetСomment() Получить свойство (**)
iTextDocumentParam.SetСomment(comment) Установить свойство (**)
```
## fileName - Полный путь к файлу с растровым изображением
Тип данных: BSTR
Синтаксис Automation:
```
fileName = iTextDocumentParam.fileName Получить свойство (* )
iTextDocumentParam.fileName = fileName Установить свойство (* )
fileName = iTextDocumentParam.GetFileName() Получить свойство (**)
iTextDocumentParam.SetFileName( fileName ) Установить свойство (**)
```
## GetArrTailSheet - Получить указатель на интерфейс массива оформлений листов заключительной части
Синтаксис Automation:
```
LPDISPATCH GetArrTailSheet();
Возвращаемое значение:
- указатель на интерфейс ksDynamicArray. Тип массива - LIBRARY_STYLE_ARR.
```
## GetArrTitleSheet - Получить указатель на интерфейс массива оформлений титульных листов
Синтаксис Automation:
```
LPDISPATCH GetArrTitleSheet();
Возвращаемое значение:
- указатель на интерфейс ksDynamicArray. Тип массива - LIBRARY_STYLE_ARR.
```
## GetSheetParam - Получить указатель на интерфейс параметров пользовательского или стандартного листа
Синтаксис Automation:
```
GetSheetParam()
Возвращаемое значение:
- возвращаемое значение: указатель на интерфейс ksSheetSize параметров пользовательского или ksStandartSheet стандартного листа.
```
## regime - Режим редактирования документа
Тип данных: short
Значения свойства:
| 0 | - видимый, |
| --- | --- |
| 1 | - "слепой". |
Синтаксис Automation:
```
regime = iTextDocumentParam.regime Получить свойство (* )
iTextDocumentParam.regime = regime Установить свойство (* )
regime = iTextDocumentParam.GetRegime() Получить свойство (**)
iTextDocumentParam.SetRegime(regime) Установить свойство (**)
```
## type - Тип документа
Тип данных: short
Синтаксис Automation:
```
type = iTextDocumentParam.type Получить свойство (* )
iTextDocumentParam.type = type Установить свойство (* )
type = iTextDocumentParam.GetType() Получить свойство (**)
iTextDocumentParam.SetType(type) Установить свойство (**)
```