---
title: "Листы и оформление"
type: interface
api: [api7]
domain: [2d]
tags: [interface, api7, 2d, bb2345331]
sources:
  - bb2345331.html
  - ilayoutsheets.html
  - ilayoutsheet.html
  - isheetformat.html
  - ispecrough.html
  - istamp.html
  - itechnicaldemand.html
---

*API интерфейсов. Версия 7 > Документ 2D *




## Интерфейс ILayoutSheets

Интерфейс коллекции листов оформления.
Иерархия:
IKompasAPIObject
IKompasCollection
ILayoutSheets
Описание:
Управляет массивом интерфейсов листов оформления ILayoutSheet.
Примечание:
1. После вызова метода Add лист оформления будет добавлен с умолчательными параметрами (заданными в настройках). Для изменения параметров листа нужно изменить их у полученного объекта и вызывать ILayoutSheet::Update.
2. Данный интерфейс может быть получен от интерфейса документа IKompasDocument с помощью свойства IKompasDocument::LayoutSheets.


## Add - Создать лист оформления (добавляет лист оформления в коллекцию)

Синтаксис Automation:
```
LPDISPATCH Add();
```
Синтаксис COM:
```
HRESULT Add ([out, retval] ILayoutSheet ** Result);
Возвращаемое значение:
- Указатель на интерфейс листа оформления ILayoutSheet.
```
Примечание:
Лист оформления будет добавлен с умолчательными параметрами (заданными в настройках). Для изменения параметров листа в документе нужно задать его параметры и вызвать метод ILayoutSheet::Update.


## Item - Лист оформления, заданный по индексу

Тип данных: указатель на интерфейс ILayoutSheet листа оформления
Синтаксис Automation:
```
Sheet = iObject.Item (Index)    Получить свойство(* )
Sheet = iObject.GetItem (Index)    Получить свойство (**)
```
Синтаксис COM:
```
iObject->get_Item (Index, &Sheet)    Получить свойство
```
Примечание:
Свойство доступно только для чтения.


## ItemByNumber - Лист оформления, заданный по номеру

Тип данных: указатель на интерфейс ILayoutSheet листа оформления
Синтаксис Automation:
```
Sheet = iObject.ItemByNumber (Number)    Получить свойство(* )
Sheet = iObject.GetItemByNumber (Number)    Получить свойство (**)
```
Синтаксис COM:
```
iObject->get_ItemByNumber (Number, &Sheet)    Получить свойство
Входные параметры:
Number    - номер листа, отображается в основной надписи.
```
Примечание:
Свойство доступно только для чтения.


## Интерфейс ILayoutSheet

Интерфейс параметров листа оформления.
Иерархия:
IKompasAPIObject
ILayoutSheet
Описание:
В чертежно-графическом редакторе КОМПАС-График при работе с документами используется понятие оформления. Оформление включает основную надпись, а также внешнюю и внутреннюю рамки. Данный интерфейс позволяет выбрать оформление, которое будет использоваться для листов документа. Оформления документов хранятся в специальных системных библиотеках - файлах с расширением lyt.
Примечание:
Данный интерфейс можно получить у коллекции листов оформления ILayoutSheets с помощью свойства ILayoutSheets::Item, ILayoutSheets::ItemByNumber, метода ILayoutSheets::Add.


## Delete - Удалить лист

Синтаксис Automation:
```
BOOL Delete();
```
Синтаксис COM:
```
HRESULT Delete ([out, retval] VARIANT_BOOL* pVal);
Возвращаемое значение:
TRUE    - в случае успеха,
FALSE    - в случае неудачи.
```
Примечание:
Удаляет лист оформления из документа.


## Format - Формат листа

Тип данных: указатель на интерфейс ISheetFormat формата листа оформления
Синтаксис Automation:
```
Format = iObject.Format    Получить свойство(* )
Format = iObject.GetFormat()    Получить свойство (**)
```
Синтаксис COM:
```
iObject->get_Format (&Format)    Получить свойство
```
Примечание:
1. Данное свойство определяет формат листа оформления. После изменения значений свойств формата листа оформления, для того чтобы изменения вступили в силу, надо вызвать метод Update.
2. Свойство доступно только для чтения.


## GetPlaceInsideFrames - Выдать свободное место внутри рамок

Синтаксис Automation:
```
BOOL GetPlaceInsideFrames( double* Left, double* Top, double* Right, double* Bottom);
```
Синтаксис COM:
```
HRESULT GetPlaceInsideFrames([out] double* Left, [out] double* Top, [out] double* Right, [out] double* Bottom, [out, retval] VARIANT_BOOL * Val);
Возвращаемое значение:
TRUE    - в случае успеха,
FALSE    - в случае неудачи.
Выходные параметры:
Left, Top    - координата верхней левой точки,
Right, Bottom    - координата нижней правой точки.
```


## LayoutLibraryFileName - Имя файла библиотеки стилей оформления

Тип данных: BSTR (строка)
Синтаксис Automation:
```
LayoutLibraryFileName = iObject.LayoutLibraryFileName    Получить свойство(* )
iObject.LayoutLibraryFileName = LayoutLibraryFileName    Установить свойство (* )
LayoutLibraryFileName = iObject.GetLayoutLibraryFileName()    Получить свойство (**)
iObject.SetLayoutLibraryFileName (LayoutLibraryFileName)    Установить свойство (**)
```
Синтаксис COM:
```
iObject->get_LayoutLibraryFileName (&LayoutLibraryFileName)    Получить свойство
iObject->put_LayoutLibraryFileName (LayoutLibraryFileName)    Установить свойство
```
Примечание:
Данное свойство позволяет получить/изменить полное имя файла библиотеки стилей оформлений, из которой взят данный стиль. После изменения значений свойств формата листа оформления, для того чтобы изменения вступили в силу, надо вызвать метод Update.


## LayoutStyleNumber - Номер стиля оформления

Тип данных: double
Синтаксис Automation:
```
LayoutStyleNumber = iObject.LayoutStyleNumber    Получить свойство(* )
iObject.LayoutStyleNumber = LayoutStyleNumber    Установить свойство (* )
LayoutStyleNumber = iObject.GetLayoutStyleNumber()    Получить свойство (**)
iObject.SetLayoutStyleNumber (LayoutStyleNumber)    Установить свойство (**)
```
Синтаксис COM:
```
iObject->get_LayoutStyleNumber (&LayoutStyleNumber)    Получить свойство
iObject->put_LayoutStyleNumber (LayoutStyleNumber)    Установить свойство
```
Примечание:
Данное свойство позволяет получить\изменить номер используемого стиля в библиотеке стилей оформлений (см. LayoutLibraryFileName). После изменения значений свойств формата листа оформления, для того чтобы изменения вступили в силу, надо вызвать метод Update.


## SheetType - Тип листа

Тип данных: из перечисления ksSheetTypeEnum
Синтаксис Automation:
```
SheetType = iObject.SheetType    Получить свойство(* )
iObject.SheetType = SheetType    Установить свойство (* )
SheetType = iObject.GetSheetType()    Получить свойство (**)
iObject.SetSheetType (SheetType)    Установить свойство (**)
```
Синтаксис COM:
```
iObject->get_SheetType (&SheetType)    Получить свойство
iObject->put_SheetType (SheetType)    Установить свойство
```


## Stamp - Основная надпись листа

Тип данных: указатель на интерфейс IStamp
Синтаксис Automation:
```
Stamp = Object.Stamp    Получить свойство(* )
Stamp = Object.GetStamp()    Получить свойство (**)
```
Синтаксис COM:
```
Object.get_Stamp( &Stamp )    Получить свойство
```
Примечание:
1. Свойство позволяет получать интерфейс основной надписи.
2. Свойство доступно только для чтения.


## Update - Обновить данные

Синтаксис Automation:
```
BOOL Update();
```
Синтаксис COM:
```
HRESULT Update ([out, retval] VARIANT_BOOL* pVal);
Возвращаемое значение:
TRUE    - обновление прошло успешно,
FALSE    - обновить настройки не удалось.
```
Примечание:
Все изменения, сделанные в данном интерфейсе и интерфейсе формата листа, вступят в силу только после вызова этого метода.


## Интерфейс ISheetFormat

Интерфейс формата листа.
Иерархия:
IKompasAPIObject
ISheetFormat
Примечание:
1. Данный интерфейс позволяет получить и изменить текущий формат листа для документа.
2. Данный интерфейс может быть получен следующими способами:
•от интерфейса стиля спецификации ISpecificationStyle с помощью свойства ISpecificationStyle::Format,
•от интерфейса параметров листа оформления ILayoutSheet с помощью свойства ILayoutSheet::Format.


## Format - Формат листа

Тип данных: из перечисления ksDocumentFormatEnum
Синтаксис Automation:
```
Format = iObject.Format    Получить свойство(* )
iObject.Format = Format    Установить свойство (* )
Format = iObject.GetFormat()    Получить свойство (**)
iObject.SetFormat (Format)    Установить свойство (**)
```
Синтаксис COM:
```
iObject->get_Format (&Format)    Получить свойство
iObject->put_Format (Format)    Установить свойство
```


## FormatHeight - Высота пользовательского формата

Тип данных: long
Синтаксис Automation:
```
FormatHeight = iObject.FormatHeight    Получить свойство(* )
iObject.FormatHeight = FormatHeight    Установить свойство (* )
FormatHeight = iObject.GetFormatHeight()    Получить свойство (**)
iObject.SetFormatHeight (FormatHeight)    Установить свойство (**)
```
Синтаксис COM:
```
iObject->get_FormatHeight (&FormatHeight)    Получить свойство
iObject->put_FormatHeight (FormatHeight)    Установить свойство
```
Примечание:
Свойство используется только для пользовательских форматов листа (см. ISheetFormat::Format).


## FormatMultiplicity - Кратность формата листа

Тип данных: long
Синтаксис Automation:
```
FormatMultiplicity = iObject.FormatMultiplicity    Получить свойство(* )
iObject.FormatMultiplicity = FormatMultiplicity    Установить свойство (* )
FormatMultiplicity = iObject.GetFormatMultiplicity()    Получить свойство (**)
iObject.SetFormatMultiplicity (FormatMultiplicity)    Установить свойство (**)
```
Синтаксис COM:
```
iObject->get_FormatMultiplicity (&FormatMultiplicity)    Получить свойство
iObject->put_FormatMultiplicity (FormatMultiplicity)    Установить свойство
```
Примечание:
1. Свойство используется только для стандартных форматов листа (см. ISheetFormat::Format).
2. Свойство не используется для текстовых документов.


## FormatWidth - Ширина пользовательского формата

Тип данных: long
Синтаксис Automation:
```
FormatWidth = iObject.FormatWidth    Получить свойство(* )
iObject.FormatWidth = FormatWidth    Установить свойство (* )
FormatWidth = iObject.GetFormatWidth()    Получить свойство (**)
iObject.SetFormatWidth (FormatWidth)    Установить свойство (**)
```
Синтаксис COM:
```
iObject->get_FormatWidth (&FormatWidth)    Получить свойство
iObject->put_FormatWidth (FormatWidth)    Установить свойство
```
Примечание:
Свойство используется только для пользовательских форматов листа (см. ISheetFormat::Format).


## VerticalOrientation - Вертикальная ориентация формата листа

Тип данных: long
Синтаксис Automation:
```
VerticalOrientation = iObject.VerticalOrientation    Получить свойство(* )
iObject.VerticalOrientation = VerticalOrientation    Установить свойство (* )
VerticalOrientation = iObject.GetVerticalOrientation()    Получить свойство (**)
iObject.SetVerticalOrientation (VerticalOrientation)    Установить свойство (**)
```
Синтаксис COM:
```
iObject->get_VerticalOrientation (&VerticalOrientation)    Получить свойство
iObject->put_VerticalOrientation (VerticalOrientation)    Установить свойство
```
Примечание:
Свойство используется только для стандартных форматов листа (см. ISheetFormat::Format).


## Интерфейс ISpecRough

Неуказанная шероховатость.
Иерархия:
IDispatch
IKompasAPIObject
ISpecRough
Описание:
Интерфейс позволяет задавать и получать параметры неуказанной шероховатости.
Примечание:
Интерфейс можно получить у интерфейса чертежа с помощью свойства IDrawingDocument::SpecRough.


## AddSign - Добавить знак в скобках

Тип данных: BOOL
Синтаксис Automation:
```
AddSign = Object.AddSign    Получить свойство(* )
Object.AddSign = AddSign    Установить свойство (* )
AddSign = Object.GetAddSign()    Получить свойство (**)
Object.SetAddSign( AddSign )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_AddSign( &AddSign )    Получить свойство
Object.put_AddSign( AddSign )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать признак знака в скобках.


## AutoPlacement - Авторазмещение

Тип данных: BOOL
Синтаксис Automation:
```
AutoPlacement = Object.AutoPlacement    Получить свойство(* )
Object.AutoPlacement = AutoPlacement    Установить свойство (* )
AutoPlacement = Object.GetAutoPlacement()    Получить свойство (**)
Object.SetAutoPlacement( AutoPlacement )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_AutoPlacement( &AutoPlacement )    Получить свойство
Object.put_AutoPlacement( AutoPlacement )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать признак авторазмещения неуказанной шероховатости.


## Crossed - Признак необходимости перестроения неуказанной шероховатости

Тип данных: BOOL
Синтаксис Automation:
```
Crossed = Object.Crossed    Получить свойство(* )
Crossed = Object.GetCrossed()    Получить свойство (**)
```
Синтаксис COM:
```
Object.get_Crossed( &Crossed )    Получить свойство
```
Примечание:
Свойство доступно только для чтения.
Версия Компас v18.1


## Delete - Удалить объект

Синтаксис Automation:
```
BOOL Delete();
```
Синтаксис COM:
```
HRESULT Delete( BOOL * Result );
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
```
Примечание:
Метод позволяет удалить неуказанную шероховатость.


## Distance - Расстояние до знака

Тип данных: double
Синтаксис Automation:
```
Distance = Object.Distance    Получить свойство(* )
Object.Distance = Distance    Установить свойство (* )
Distance = Object.GetDistance()    Получить свойство (**)
Object.SetDistance( Distance )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_Distance( &Distance )    Получить свойство
Object.put_Distance( Distance )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать расстояние до знака неуказанной шероховатости.


## IsCreated - Признак отображения в документе

Тип данных: BOOL
Синтаксис Automation:
```
IsCreated = Object.IsCreated    Получить свойство(* )
IsCreated = Object.GetIsCreated()    Получить свойство (**)
```
Синтаксис COM:
```
Object.get_IsCreated( &IsCreated )    Получить свойство
```
Примечание:
1. Свойство позволяет получать признак отображения неуказанной шероховатости в документе.
2. Свойство доступно только для чтения.


## SignType - Тип значка

Тип данных: из перечисления ksRoughSignEnum
Синтаксис Automation:
```
SignType = Object.SignType    Получить свойство(* )
Object.SignType = SignType    Установить свойство (* )
SignType = Object.GetSignType()    Получить свойство (**)
Object.SetSignType( SignType )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_SignType( &SignType )    Получить свойство
Object.put_SignType( SignType )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать тип значка неуказанной шероховатости.


## Text - Текст

Тип данных: BSTR
Синтаксис Automation:
```
Text = Object.Text    Получить свойство(* )
Object.Text = Text    Установить свойство (* )
Text = Object.GetText()    Получить свойство (**)
Object.SetText( Text )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_Text( &Text )    Получить свойство
Object.put_Text( Text )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать текст неуказанной шероховатости.


## Update - Обновить данные

Синтаксис Automation:
```
BOOL Update();
```
Синтаксис COM:
```
HRESULT Update( BOOL * Result );
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
```
Примечание:
Метод позволяет применить заданные параметры неуказанной шероховатости.


## X - Координата начала выносной линии или положение знака по оси Х

Тип данных: double
Синтаксис Automation:
```
X = Object.X    Получить свойство(* )
Object.X = X    Установить свойство (* )
X = Object.GetX()    Получить свойство (**)
Object.SetX( X )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_X( &X )    Получить свойство
Object.put_X( X )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать координату Х положения знака неуказанной шероховатости.


## Y - Координата начала выносной линии или положение знака по оси Y

Тип данных: double
Синтаксис Automation:
```
Y = Object.Y    Получить свойство(* )
Object.Y = Y    Установить свойство (* )
Y = Object.GetY()    Получить свойство (**)
Object.SetY( Y )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_Y( &Y )    Получить свойство
Object.put_Y( Y )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать координату Y положения знака неуказанной шероховатости.


## Интерфейс IStamp

Интерфейс основной надписи (штампа).
Иерархия:
IDispatch
IKompasAPIObject
IStamp
Описание:
Интерфейс позволяет задавать и получать параметры штампа.
Примечание:
Интерфейс можно получить у интерфейса параметров листа оформления с помощью свойства ILayoutSheet::Stamp.


## Clear - Очистить штамп

Синтаксис Automation:
```
BOOL Clear();
```
Синтаксис COM:
```
HRESULT Clear( BOOL * Result );
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
```
Примечание:
Метод позволяет очистить штамп.


## Crossed - Признак необходимости перестроения штампа

Тип данных: BOOL
Синтаксис Automation:
```
Crossed = Object.Crossed    Получить свойство(* )
Crossed = Object.GetCrossed()    Получить свойство (**)
```
Синтаксис COM:
```
Object.get_Crossed( &Crossed )    Получить свойство
```
Примечание:
Свойство доступно только для чтения.


## GetNextColumnId - Получить идентификатор следующей непустой ячейки штампа

Синтаксис Automation:
```
long GetNextColumnId( long Id );
```
Синтаксис COM:
```
HRESULT GetNextColumnId( long Id,
long * Result );
Входные параметры:
Id    - идентификатор ячейки штампа.
Возвращаемое значение:
- Идентификатор следующей не пустой ячейки штампа.
```
Примечание:
Метод позволяет получить идентификатор следующей непустой ячейки штампа.


## Text - Текст

Тип данных: указатель на интерфейс текста IText
Синтаксис Automation:
```
Text = Object.Text( Id )    Получить свойство(* )
Text = Object.GetText( Id )    Получить свойство (**)
```
Синтаксис COM:
```
Object.get_Text( Id, &Text )    Получить свойство
Входные параметры:
Id (long)    - идентификатор ячейки.
```
Примечание:
1. Свойство позволяет получать интерфейс текста ячейки штампа.
2. Свойство доступно только для чтения.


## Update - Обновить данные

Синтаксис Automation:
```
BOOL Update();
```
Синтаксис COM:
```
HRESULT Update( BOOL * Result );
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
```
Примечание:
Метод позволяет применить заданные параметры штампа.


## Интерфейс ITechnicalDemand

Интерфейс технических требований.
Иерархия:
IDispatch
IKompasAPIObject
ITechnicalDemand
Описание:
Интерфейс позволяет задавать и получать параметры технических требований.
Примечание:
Интерфейс можно получить у интерфейса чертежа с помощью свойства IDrawingDocument::TechnicalDemand.


## AutoPlacement - Авторазмещение

Тип данных: BOOL
Синтаксис Automation:
```
AutoPlacement = Object.AutoPlacement    Получить свойство(* )
Object.AutoPlacement = AutoPlacement    Установить свойство (* )
AutoPlacement = Object.GetAutoPlacement()    Получить свойство (**)
Object.SetAutoPlacement( AutoPlacement )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_AutoPlacement( &AutoPlacement )    Получить свойство
Object.put_AutoPlacement( AutoPlacementX1 )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать признак авторазмещения технических требований.


## BlocksGabarits - Габариты

Тип данных: VARIANT типа VT_ARRAY | VT_R8
Синтаксис Automation:
```
BlocksGabarits = Object.BlocksGabarits    Получить свойство(* )
Object.BlocksGabarits = BlocksGabarits    Установить свойство (* )
BlocksGabarits = Object.GetBlocksGabarits()    Получить свойство (**)
Object.SetBlocksGabarits( BlocksGabarits )    Установить свойство (**)
```
Синтаксис COM:
```
Object.get_BlocksGabarits( &BlocksGabarits )    Получить свойство
Object.put_BlocksGabarits( BlocksGabarits )    Установить свойство
```
Примечание:
Свойство позволяет устанавливать и получать габариты технических требований.


## BlocksStartLineNumbers - Получить список номеров строк в начале блоков

Тип данных: VARIANT типа VT_ARRAY | VT_I4
Синтаксис Automation:
```
BlocksStartLineNumbers = Object.BlocksStartLineNumbers    Получить свойство(* )
BlocksStartLineNumbers = Object.GetBlocksStartLineNumbers()    Получить свойство (**)
```
Синтаксис COM:
```
Object.get_BlocksStartLineNumbers( &BlocksStartLineNumbers )    Получить свойство
```
Примечание:
1. Свойство позволяет получать список номеров строк в начале блоков технических требований.
2. Свойство доступно только для чтения.


## Delete - Удалить объект

Синтаксис Automation:
```
BOOL Delete();
```
Синтаксис COM:
```
HRESULT Delete( BOOL * Result );
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
```
Примечание:
Метод позволяет удалить технические требования.


## IsCreated - Признак отображения в документе

Тип данных: BOOL
Синтаксис Automation:
```
IsCreated = Object.IsCreated    Получить свойство(* )
IsCreated = Object.GetIsCreated()    Получить свойство (**)
```
Синтаксис COM:
```
Object.get_IsCreated( &IsCreated )    Получить свойство
```
Примечание:
1. Свойство позволяет получать признак отображения технических требований в документе.
2. Свойство доступно только для чтения.


## Synchronize - Синхронизация

Синтаксис Automation:
```
BOOL Synchronize();
```
Синтаксис COM:
```
HRESULT Synchronize( BOOL * Result );
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
Метод позволяет при создании ассоциативного вида синхронизировать технические требования чертежа с техническими требованиями документа 3D, с которого создается вид.
```


## Text - Текст

Тип данных: указатель на интерфейс текста IText
Синтаксис Automation:
```
Text = Object.Text    Получить свойство(* )
Text = Object.GetText()    Получить свойство (**)
```
Синтаксис COM:
```
Object.get_Text( &Text )    Получить свойство
```
Примечание:
1. Свойство позволяет получать интерфейс текста технических требований.
2. Свойство доступно только для чтения.


## Update - Обновить данные

Синтаксис Automation:
```
BOOL Update();
```
Синтаксис COM:
```
HRESULT Update( BOOL * Result );
Возвращаемое значение:
TRUE    - в случае успешного завершения,
FALSE    - в случае неудачи.
```
Примечание:
Метод позволяет применить заданные параметры технических требований.
