---
title: "Выносной элемент (Интерфейс ksRemoteElementParam)"
type: interface
api: [api7]
domain: [2d, drawing]
tags: [interface, api7, 2d, drawing, ksremoteelementparam]
sources:
  - ksremoteelementparam.html
---

*API интерфейсов. Версия 5 > Графический документ (Интерфейсы - ksDocument2D и IDocument2D)  > Интерфейсы параметров обозначений *


## Выносной элемент (Интерфейс ksRemoteElementParam)

Интерфейс параметров объекта "выносной элемент".
Аналог данных параметров при использовании API экспортных функций - RemoteElementParam.
Примечание:
Указатель на интерфейс можно получить при помощи метода KompasObject::GetParamStruct.


## GetPText - Получить указатель на интерфейс динамического массива строк текста

Синтаксис Automation:
```
LPDISPATCH GetPText();
Возвращаемое значение:
- указатель на интерфейс динамического массива ksDynamicArray.
```
Примечания:
1. Если style == INDICATIN_TEXT_LINE_ARR, то тип динамического массива будет TEXT_LINE_ARR.
2. Если style == 0, то тип динамического массива будет CHAR_STR_ARR.


## height - Высота выносного элемента (для прямоугольника и скругленного прямоугольника)

Тип данных: double
Синтаксис Automation:
```
height = iRemoteElementParam.height    Получить свойство (* )
iRemoteElementParam.height = height    Установить свойство (* )
height = iRemoteElementParam.GetHeight()    Получить свойство (**)
iRemoteElementParam.SetHeight(height)    Установить свойство (**)
```


## Init - Инициализировать параметры

Синтаксис Automation:
```
BOOL Init (long style);
Входной параметр:
(long) style    - стиль текста.
Возвращаемое значение:
TRUE    - в случае удачного завершения,
FALSE    - в случае неудачи.
```
Примечания:
1. Метод обнуляет поля структуры параметров RemoteElementParam, которую обслуживает.
2. Если style == INDICATIN_TEXT_LINE_ARR, то создается динамический массив строк текста TEXT_LINE_ARR. Его структура описывается TextLineParam.
3. Если style == 0, то создается динамический массив указателей на строки символов CHAR_STR_ARR.


## radius - Радиус окружности (для окружности)

Тип данных: double
Синтаксис Automation:
```
radius = iRemoteElementParam.radius    Получить свойство (* )
iRemoteElementParam.radius = radius    Установить свойство (* )
radius = iRemoteElementParam.GetRadius()    Получить свойство (**)
iRemoteElementParam.SetRadius(radius)    Установить свойство (**)
```


## SetPText - Установить динамический массив строк текста

Синтаксис Automation:
```
BOOL SetPText (LPDISPATCH strArr)
Входной параметр:
strArr    - указатель на интерфейс динамического массива ksDynamicArray.
Возвращаемое значение:
TRUE    - в случае удачного завершения,
FALSE    - в случае неудачи.
```
Примечания:
1. Если style == INDICATIN_TEXT_LINE_ARR, то тип динамического массива будет TEXT_LINE_ARR.
2. Если style == 0, то тип динамического массива будет CHAR_STR_ARR.


## shelfDir - Направление полки

Тип данных: short
Значения свойства:
| 1 | - вправо, |
| --- | --- |
| -1 | - влево, |
| 2 | - вверх, |
| 3 | - вниз. |
Синтаксис Automation:
```
shelfDir = iRemoteElementParam.shelfDir    Получить свойство (* )
iRemoteElementParam.shelfDir = shelfDir    Установить свойство (* )
shelfDir = iRemoteElementParam.GetShelfDir()    Получить свойство (**)
iRemoteElementParam.SetShelfDir(shelfDir)    Установить свойство (**)
```


## shelfX - Координата x начала полки

Тип данных: double
Синтаксис Automation:
```
shelfX = iRemoteElementParam.shelfX    Получить свойство (* )
iRemoteElementParam.shelfX = shelfX    Установить свойство (* )
shelfX = iRemoteElementParam.GetShelfX()    Получить свойство (**)
iRemoteElementParam.SetShelfX(shelfX)    Установить свойство (**)
```


## shelfY - Координата y начала полки

Тип данных: double
Синтаксис Automation:
```
shelfY = iRemoteElementParam.shelfY    Получить свойство (* )
iRemoteElementParam.shelfY = shelfY    Установить свойство (* )
shelfY = iRemoteElementParam.GetShelfY()    Получить свойство (**)
iRemoteElementParam.SetShelfY(shelfY)    Установить свойство (**)
```


## signType - Тип значка из LtRemoteElmSignType

Тип данных: long
Синтаксис Automation:
```
signType = iRemoteElementParam.signType    Получить свойство (* )
iRemoteElementParam.signType = signType    Установить свойство (* )
signType = iRemoteElementParam.GetSignType()    Получить свойство (**)
iRemoteElementParam.SetSignType(signType)    Установить свойство (**)
См. также LtRemoteElmSignType
```


## smooth - Радиус скругления (для прямоугольника)

Тип данных: double
Синтаксис Automation:
```
iRemoteElementParam.smooth    Получить свойство (* )
iRemoteElementParam.smooth = smooth    Установить свойство (* )
smooth = iRemoteElementParam.GetSmooth()    Получить свойство (**)
iRemoteElementParam.SetSmooth(smooth)    Установить свойство (**)
```


## style - Стиль текста

Тип данных: long
Синтаксис Automation:
```
style = iRemoteElementParam.style    Получить свойство (* )
iRemoteElementParam.style = style    Установить свойство (* )
style = iRemoteElementParam.GetStyle()    Получить свойство (**)
iRemoteElementParam.SetStyle( style )    Установить свойство (**)
```
Примечание:
Если style == INDICATIN_TEXT_LINE_ARR, создается динамический массив строк текста TEXT_LINE_ARR, структура которого описана в StructTextLineParam. В противном случае создается динамический массив указателей на строки символов CHAR_STR_ARR.


## width - Ширина выносного элемента (для прямоугольника и скругленного прямоугольника)

Тип данных: double
Синтаксис Automation:
```
width = iRemoteElementParam.width    Получить свойство (* )
iRemoteElementParam.width = width    Установить свойство (* )
width = iRemoteElementParam.GetWidth()    Получить свойство (**)
iRemoteElementParam.SetWidth(Width)    Установить свойство (**)
```


## x - Координата х центра выносного элемента

Тип данных: double
Синтаксис Automation:
```
x = iRemoteElementParam.x    Получить свойство (* )
iRemoteElementParam.x = x    Установить свойство (* )
x = iRemoteElementParam.GetX()    Получить свойство (**)
iRemoteElementParam.SetX(x)    Установить свойство (**)
```


## y - Координата y центра выносного элемента

Тип данных: double
Синтаксис Automation:
```
y = iRemoteElementParam.y    Получить свойство (* )
iRemoteElementParam.y = y    Установить свойство (* )
y = iRemoteElementParam.GetY()    Получить свойство (**)
iRemoteElementParam.SetY(y)    Установить свойство (**)
```
