---
title: "Линия - выноска (Интерфейс ksLeaderParam)"
type: interface
api: [api7]
tags: [interface, api7, ksleaderparam]
sources:
  - ksleaderparam.html
---

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


## Линия - выноска (Интерфейс ksLeaderParam)

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


## around - Признак наличия на линии-выноске знака обработки по контуру

Тип данных: short
Значения свойства:
| 0 | - знак отсутствует, |
| --- | --- |
| 1 | - знак присутствует. |
Синтаксис Automation:
```
around = iLeaderParam.around    Получить свойство (* )
iLeaderParam.around = around    Установить свойство (* )
around = iLeaderParam.GetAround()    Получить свойство (**)
iLeaderParam.SetAround( around )    Установить свойство (**)
```


## arrowType - Тип указателя линии-выноски

Тип данных: short
Значения свойства:
| 0 | - указатель отсутствует, |
| --- | --- |
| 1 | - точка, |
| 2 | - стрелка, |
| 3 | - верхняя половина стрелки, |
| 4 | - нижняя половина стрелки. |
Синтаксис Automation:
```
arrowType = iLeaderParam.arrowType    Получить свойство (* )
iLeaderParam.arrowType = arrowType    Установить свойство (* )
arrowType = iLeaderParam.GetArrowType()    Получить свойство (**)
iLeaderParam.SetArrowType(arrowType)    Установить свойство (**)
```


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

Тип данных: short
Синтаксис Automation:
```
cText0 = iLeaderParam.cText0    Получить свойство (* )
iLeaderParam.cText0 = cText0    Установить свойство (* )
cText0 = iLeaderParam.GetCText0()    Получить свойство (**)
iLeaderParam.SetCText0( cText0 )    Установить свойство (**)
```


## cText1 - Количество строк текста под полкой

Тип данных: short
Синтаксис Automation:
```
cText1 = iLeaderParam.cText1    Получить свойство (* )
iLeaderParam.cText1 = cText1    Установить свойство (* )
cText1 = iLeaderParam.GetcText1()    Получить свойство (**)
iLeaderParam.SetcText1( cText1 )    Установить свойство (**)
```


## cText2 - Количество строк текста над "ножкой" линии-выноски (не более одной строки)

Тип данных: short
Синтаксис Automation:
```
cText2 = iLeaderParam.cText2    Получить свойство (* )
iLeaderParam.cText2 = cText2    Установить свойство (* )
cText2 = iLeaderParam.GetcText2()    Получить свойство (**)
iLeaderParam.SetcText2( cText2 )    Установить свойство (**)
```


## cText3 - Количество строк текста под "ножкой" линии-выноски (не более одной строки)

Тип данных: short
Синтаксис Automation:
```
cText3 = iLeaderParam.cText3    Получить свойство (* )
iLeaderParam.cText3 = cText3    Установить свойство (* )
cText3 = iLeaderParam.GetcText3()    Получить свойство (**)
iLeaderParam.SetcText3(cText3)    Установить свойство (**)
```


## dirX - Направление полки линии-выноски

Тип данных: long
Значения свойства:
| 0 | - нет полки, |
| --- | --- |
| -1 | - полка влево, |
| 1 | - полка вправо, |
| 2 | - полка вверх, |
| 3 | - полка вниз. |
Синтаксис Automation:
```
dirX = iLeaderParam.dirX    Получить свойство (* )
iLeaderParam.dirX = dirX    Установить свойство (* )
dirX = iLeaderParam.GetDirX()    Получить свойство (**)
iLeaderParam.SetDirX( dirX )    Установить свойство (**)
```


## GetpPolyline - Получить указатель на интерфейс динамического массива ответвлений линии-выноски ksDynamicArray типа POLYLINE_ARR

Синтаксис Automation:
```
LPDISPATCH GetpPolyline();
Возвращаемое значение:
- указатель на интерфейс динамического массива ksDynamicArray типа POLYLINE_ARR.
```
Примечание:
В общем случае одно ответвление - это ломаная линия. Первый узел - базовая точка (ее в массив помещать не нужно, т.к. она общая для всех ответвлений), остальные узлы - изломы (могут отсутствовать), последний узел - конец ответвления (указывает на объект).
Смотрите также: ksMathPointParam


## GetpTextline - Получить указатель на интерфейс динамического массива текста линии-выноски ksDynamicArray типа TEXT_LINE_ARR

Синтаксис Automation:
```
LPDISPATCH GetpTextline();
Возвращаемое значение:
- указатель на интерфейс динамического массива ksDynamicArray типа POLYLINE_ARR.
```
Примечание:
Различают четыре разных текста для линии-выноски, их строки лежат в следующей последовательности:
•текст над полкой. Если свойство cText0 = 0, то этот текст отсутствует;
•текст под полкой. Если свойство cText1 = 0, то этот текст отсутствует;
•текст над ножкой. Если свойство cText2 = 0, то этот текст отсутствует;
•текст под ножкой. Если свойство cText3 = 0, то этот текст отсутствует.
Смотрите также: ksTextLineParam


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

Синтаксис Automation:
```
BOOL Init();
Возвращаемое значение:
TRUE    - в случае удачного завершения.
```
Примечания:
1. Метод обнуляет все параметры.
2. Создается динамический массив pTextline типа TEXT_LINE_ARR.
3. Создается динамический массив pPolytline типа POLYLINE_ARR.


## SetpPolyline - Установить указатель на интерфейс динамического массива ответвлений линии-выноски ksDynamicArray типа POLYLINE_ARR

Синтаксис Automation:
```
BOOL SetpPolyline (LPDISPATCH pPolyline);
Входной параметр:
pPolyline    - указатель на интерфейс динамического массива ksDynamicArray типа POLYLINE_ARR.
Возвращаемое значение:
TRUE    - в случае удачного завершения.
```
Примечание:
В общем случае одно ответвление - это ломаная линия. Первый узел - базовая точка (ее в массив помещать не нужно, т.к. она общая для всех ответвлений), остальные узлы - изломы (могут отсутствовать), последний узел - конец ответвления (указывает на объект).
Смотрите также: ksMathPointParam


## SetpTextline - Установить указатель на интерфейс динамического массива текста линии-выноски ksDynamicArray типа TEXT_LINE_ARR

Синтаксис Automation:
```
BOOL SetpTextline (LPDISPATCH pTextline);
Входной параметр:
pTextline    - указатель на интерфейс динамического массива ksDynamicArray типа POLYLINE_ARR.
Возвращаемое значение:
TRUE    - в случае удачного завершения.
```
Примечание:
Различают четыре разных текста для линии-выноски, их строки лежат в следующей последовательности:
•текст над полкой. Если свойство cText0 = 0, то этот текст отсутствует;
•текст под полкой. Если свойство cText1 = 0, то этот текст отсутствует;
•текст над ножкой. Если свойство cText2 = 0, то этот текст отсутствует;
•текст под ножкой. Если свойство cText3 = 0, то этот текст отсутствует.
Смотрите также: ksTextLineParam


## signType - Тип знака на "ножке" линии-выноски

Тип данных: short
Значения свойства:
| 0 | - знак отсутствует, |
| --- | --- |
| 1 | - знак склеивания, |
| 2 | - знак пайки, |
| 3 | - знак сшивания, |
| 4 | - знак соединения внахлестку металлическими скобами, |
| 5 | - знак углового соединения металлическими скобами, |
| 6 | - знак монтажного шва. |
Синтаксис Automation:
```
signType = iLeaderParam.signType    Получить свойство (* )
iLeaderParam.signType = signType    Установить свойство (* )
signType = iLeaderParam.GetSignType()    Получить свойство (**)
iLeaderParam.SetSignType( signType )    Установить свойство (**)
```


## x, y - Координаты базовой точки линии-выноски

Тип данных: double
Синтаксис Automation:
```
x = iLeaderParam.x    Получить свойство (* )
iLeaderParam.x = x    Установить свойство (* )
x = iLeaderParam.GetX()    Получить свойство (**)
iLeaderParam.SetX(x)    Установить свойство (**)
```
Примечание:
Базовая точка линии-выноски - начало полки, точка выхода из нее "ножки".
