---
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)    Установить свойство (**)
```
