---
title: "Параметры цвета фона (Интерфейс ksViewColorParam)"
type: interface
api: [api7]
tags: [interface, api7, ksviewcolorparam]
sources:
  - ksviewcolorparam.html
---

*API интерфейсов. Версия 5*


## Параметры цвета фона (Интерфейс ksViewColorParam)

Интерфейс параметров цвета фона.
| ksViewColorParam | - интерфейс Automation |
| --- | --- |
Аналог данных параметров при использовании API экспортных функций - ViewColorParam.
Примечание:
Данный интерфейс может быть получен с использованием метода интерфейса KompasObject::ksGetSysOptions. Значение параметра optionsType = VIEWCOLOR_OPTIONS.


## BottomColor - Нижний цвет перехода

Тип данных: long
Синтаксис Automation:
```
bottomColor = iViewColorParam.bottomColor    Получить свойство (* )
iViewColorParam.bottomColor = bottomColor    Установить свойство (* )
bottomColor = iViewColorParam.GetBottomColor()    Получить свойство (**)
iViewColorParam.SetBottomColor (bottomColor)    Установить свойство (**)
```
Примечание:
Свойство доступно только для документов-моделей.


## Color - Цвет фона

Тип данных: long
Синтаксис Automation:
```
color = iViewColorParam.color    Получить свойство (* )
iViewColorParam.color = color    Установить свойство (* )
color = iViewColorParam.GetСolor()    Получить свойство (**)
iViewColorParam.SetСolor(color)    Установить свойство (**)
Значения свойства:
Цвет фона
-1    - если используется цвет окна, установленный в Windows.
```


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

Синтаксис Automation:
```
BOOL Init();
Возвращаемое значение:
TRUE    - в случае удачного завершения,
FALSE    - в случае неудачи.
```


## TopColor - Верхний цвет перехода

Тип данных: long
Синтаксис Automation:
```
topColor = iViewColorParam.topColor    Получить свойство (* )
iViewColorParam.topColor = topColor    Установить свойство (* )
topColor = iViewColorParam.GetTopColor()    Получить свойство (**)
iViewColorParam.SetTopColor (topColor)    Установить свойство (**)
```
Примечание:
Свойство доступно только для документов-моделей.


## UseGradient - Использовать градиентный переход при полутоновом отображении

Тип данных: BOOL
Синтаксис Automation:
```
useGradient = iViewColorParam.useGradient    Получить свойство (* )
iViewColorParam.useGradient = useGradient    Установить свойство (* )
useGradient = iViewColorParam.GetUseGradient()    Получить свойство (**)
iViewColorParam.SetUseGradient(useGradient)    Установить свойство (**)
Значения свойства:
TRUE    - использовать градиентный переход,
FALSE    - не использовать.
```
Примечание:
Свойство доступно только для документов-моделей.
