Files
kompas3d-mcp/docs/Kompas3D_SDK/interfaces/kssheetoptions.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

88 lines
4.1 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.
---
title: "Оформление (Интерфейс ksSheetOptions)"
type: interface
api: [api7]
domain: [2d, drawing]
tags: [interface, api7, 2d, drawing, kssheetoptions]
sources:
- kssheetoptions.html
---
*API интерфейсов. Версия 5 > Графический документ (Интерфейсы - ksDocument2D и IDocument2D)  > Интерфейсы параметров формата и компоновки чертежа *
## Оформление (Интерфейс ksSheetOptions)
Интерфейс параметров оформления листа документа.
Аналог данных параметров при использовании API экспортных функций - SheetOptions.
Примечание:
1. Указатель на интерфейс можно получить при помощи метода KompasObject::GetParamStruct.
2. Данный интерфейс используется при передаче данных методом ksGetDocOptions.
## GetSheetParam - Получить указатель на интерфейс параметров листа документа
Синтаксис Automation:
```
LPDISPATCH GetSheetParam (BOOL type);
Входной параметр:
type - признак формата листа: FALSE - стандартный лист, TRUE - пользовательский формат.
Возвращаемое значение:
- указатель на интерфейс параметров листа ksStandartSheet или ksSheetSize.
```
Примечание:
При вызове метода необходимо учитывать свойство sheetType. Его значение должно соответствовать значению входного параметра type. Осталась для совместимости со старыми библиотеками.
## Init - Инициализировать параметры
Синтаксис Automation:
```
BOOL Init();
Возвращаемое значение:
TRUE - в случае удачного завершения.
```
Примечание:
Метод обнуляет все параметры.
## layoutName - Имя библиотеки оформления
Тип данных:строка.
Синтаксис Automation:
```
layoutName = iSheetOptions.layoutName Получить свойство (* )
iSheetOptions.layoutName = layoutName Установить свойство (* )
layoutName = iSheetOptions.GetLayoutName() Получить свойство (**)
iSheetOptions.SetLayoutName( layoutName ) Установить свойство (**)
```
## sheetType - Тип листа
Тип данных:BOOL.
Синтаксис Automation:
```
sheetType = iSheetOptions.sheetType Получить свойство (* )
iSheetOptions.sheetType = sheetType Установить свойство (* )
sheetType = iSheetOptions.GetSheetType() Получить свойство (**)
iSheetOptions.SetSheetType (sheetType) Установить свойство (**)
Значения свойства:
TRUE - пользовательский формат,
FALSE - стандартный лист.
```
Примечание:
Свойство необходимо учитывать при вызове метода GetSheetParam. Значение свойства должно соответствовать значению входного параметра type. Осталась для совместимости со старыми библиотеками.
## shtType - Для чертежа - тип основной надписи, для спецификации - имя библиотеки стилей спецификации
Тип данных:short.
Синтаксис Automation:
```
shtType = iSheetOptions.shtType Получить свойство (* )
iSheetOptions.shtType = shtType Установить свойство (* )
shtType = iSheetOptions.GetShtType() Получить свойство (**)
iSheetOptions.SetShtType(shtType) Установить свойство (**)
```