---
title: "Линия-выноска для обозначения позиции (Интерфейс ksPosLeaderParam)"
type: interface
api: [api7]
tags: [interface, api7, ksposleaderparam]
sources:
  - ksposleaderparam.html
---

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


## Линия-выноска для обозначения позиции (Интерфейс ksPosLeaderParam)

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


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

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


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

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


## dirY - Направление полки линии-выноски относительно оси OY

Тип данных: long
Значения свойства:
| 1 | - вверх (по оси OY), |
| --- | --- |
| -1 | - вниз (против оси OY). |
Синтаксис Automation:
```
dirY = iPosLeaderParam.dirY    Получить свойство (* )
iPosLeaderParam.dirY = dirY    Установить свойство (* )
dirY = iPosLeaderParam.GetDirY()    Получить свойство (**)
iPosLeaderParam.SetDirY( dirY )    Установить свойство (**)
```


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

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


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

Синтаксис Automation:
```
LPDISPATCH GetpTextline();
Возвращаемое значение:
- указатель на интерфейс динамического массива ksDynamicArray типа POLYLINE_ARR.
```
Примечания:
1. Если свойство ksPosLeaderParam::style = INDICATIN_TEXT_LINE_ARR, то динамический массив - типа TEXT_LINE_ARR (динамический массив строк текста), в остальных случаях - типа CHAR_STR_ARR (динамический массив строк обозначения позиции).
2. Каждая строка соответствует одному номеру позиции.
Смотрите также:
ksTextLineParam
ksChar255


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

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


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

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


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

Синтаксис Automation:
```
BOOL SetpTextline (LPDISPATCH pTextline);
Входной параметр:
pTextline    - указатель на интерфейс динамического массива ksDynamicArray типа POLYLINE_ARR.
Возвращаемое значение:
TRUE    - в случае удачного завершения.
```
Примечания:
1. Если свойство ksPosLeaderParam::style = INDICATIN_TEXT_LINE_ARR, то динамический массив - типа TEXT_LINE_ARR (динамический массив строк текста), в остальных случаях - типа CHAR_STR_ARR (динамический массив строк обозначения позиции).
2. Каждая строка соответствует одному номеру позиции.
Смотрите также:
ksTextLineParam
ksChar255


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

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


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

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