---
title: "Основная надпись (Интерфейс ksStamp)"
type: interface
api: [api7]
domain: [2d]
tags: [interface, api7, 2d, ksstamp]
sources:
  - ksstamp.html
---

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


## Основная надпись (Интерфейс ksStamp)

Интерфейс основной надписи.
Примечание:
Указатель на интерфейс можно получить при помощи методов ksDocument2D::GetStamp, ksDocument2D::GetStampEx, ksSpcDocument::GetStamp, ksSpcDocument::GetStampEx, ksDocumentTxt::GetStamp, ksDocumentTxt::GetStampEx.


## GetSheetNumb - Получить номер листа

Синтаксис Automation:
```
long GetSheetNumb ();
Возвращаемое значение:
номер листа
```


## ksClearStamp - Очистить основную надпись

Аналог данного метода при использовании API экспортных функций - ClearStamp.
Синтаксис Automation:
```
long ksClearStamp (long numb);
Входной параметр:
numb    - номер очищаемой ячейки основной надписи (0 - очищается вся основная надпись).
Возвращаемое значение:
1    - в случае успешного завершения,
0    - в случае неудачи.
```
Примечание:
Метод действителен для чертежа и спецификации.


## ksCloseStamp - Закрыть основную надпись

Аналог данного метода при использовании API экспортных функций - CloseStamp.
Синтаксис Automation:
```
long ksCloseStamp();
Возвращаемое значение:
1    - в случае успешного завершения,
0    - в случае неудачи.
```
Примечание:
Метод действителен для чертежа и спецификации.


## ksColumnNumber - Определить номер ячейки основной надписи

Аналог данного метода при использовании API экспортных функций - ColumnNumber.
Синтаксис Automation:
```
long ksColumnNumber (long numb);
Входной параметр:
numb    - номер ячейки основной надписи.
Возвращаемое значение:
1    - в случае успешного завершения,
0    - в случае неудачи.
```
Примечание:
Метод используется в режиме редактирования основной надписи.


## ksGetStampColumnText - Получить текст ячейки основной надписи

Аналог данного метода при использовании API экспортных функций - GetStampColumnText.
Синтаксис Automation:
```
LPDISPATCH ksGetStampColumnText (long* numb);
Выходной параметр:
numb    - номер ячейки основной надписи.
Возвращаемое значение:
- указатель на интерфейс динамического массива ksDynamicArray строк текста типа TEXT_LINE_ARR или NULL, если все ячейки пройдены.
Смотрите также: ksTextLineParam
```
Примечание:
После выполнения метод смещается на следующую ячейку.
Если номер графы не определен с помощью функции ksColumnNumber, метод начинает работу с первой графы.
После использования полученный массив желательно удалить.
Если numb != NULL, метод возвращает номер графы.
Функция используется в режиме редактирования штампа.


## ksOpenStamp - Открыть основную надпись

Аналог данного метода при использовании API экспортных функций - OpenStamp.
Синтаксис Automation:
```
long ksOpenStamp();
Возвращаемое значение:
1    - в случае успешного завершения,
0    - в случае неудачи.
```
Примечание:
Метод действителен для чертежа и спецификации.
Операторы ksStamp::ksColumnNumber и ksStamp::ksTextLin, вводимые между операторами ksStamp::ksOpenStamp и ksStamp::ksCloseStamp, принадлежат основной надписи.
ksStamp::ksColumnNumber определяет номер ячейки, куда помещать текcт.
Номера определены в соответствии с ГОСТом на данную основную надпись.
ksStamp::ksCloseStamp возвращает указатель на штамп.


## ksSetStampColumnText - Задать текст в ячейке

Аналог данного метода при использовании API экспортных функций - SetStampColumnText.
Синтаксис Automation:
```
long ksSetStampColumnText (long numb,
LPDISPATCH textArr);
Входные параметры:
numb    - номер ячейки основной надписи,
textArr    - указатель на интерфейс динамического массива ksDynamicArray строк текста типа TEXT_LINE_ARR.
Возвращаемое значение:
1    - в случае успешного завершения,
0    - в случае неудачи.
```
Примечание:
Метод используется в режиме редактирования штампа.


## ksSetTextLineAlign - Установить выравнивание текста

Аналог данного метода при использовании API экспортных функций - ksSetTextLineAlign.
Синтаксис Automation:
```
long ksSetTextLineAlign (short align);
Входной параметр:
align    - признак выравнивания: 0 - по левому краю, 1 - по центру, 2 - по правому краю, 3 - по ширине.
Возвращаемое значение:
предыдущий признак    - в случае успешного завершения,
-1    - в случае неудачи.
```


## ksTextLine - Задать компоненту строки текста или строку текста полностью

Аналог данного метода при использовании API экспортных функций - TextLine.
Синтаксис Automation:
```
ksTextLine(LPDISPATCH textItem);
Входной параметр:
textItem    - указатель на интерфейс ksTextItemParam для компоненты текста или указатель на интерфейс ksTextLineParam для всей строки.
Возвращаемое значение:
1    - в случае успешного завершения,
0    - в случае неудачи.
```
Примечание:
Данная функция предназначена для задания сложно-структурированного текста, отдельные компоненты которого имеют различные параметры.


## reference - Указатель на основную надпись

Тип данных:long.
Синтаксис Automation:
```
ref = iStamp.reference    Получить свойство (* )
iStamp.reference = ref    Установить свойство (* )
ref = iStamp.GetReference()    Получить свойство (**)
iStamp.SetReference (ref)    Установить свойство (**)
```
