Объектная модель > Действия с репозиториями и сущностями > State (IsChanged, IsEnabled, IsCopied и т.д.) – состояние сущности > HighlightAreas – подсветка областей в контроле предпросмотра > Add

Метод используется для добавления области подсветки на контрол предпросмотра.

Перегрузки

Add(Color color, int page, double top, double left, double width, double height, double pageWidth, double pageHeight)	Добавить область подсветки
Add(int page, double top, double left, double width, double height, double pageWidth, double pageHeight)	Добавить область подсветки с навигацией

Добавить область подсветки

Синтаксис

public void Add(Color color, int page, double top, double left, double width, double height, double pageWidth, double pageHeight);

Параметры

color – цвет подсветки области, задается с помощью константы Colors.Common;

page – номер страницы;

top – координаты смещения от верхнего края страницы до области, в пикселях;

left – координаты смещения от левого края страницы до области, в пикселях;

width – ширина области, в пикселях;

height – высота области, в пикселях;

pageWidth – ширина страницы, в пикселях;

pageHeight – высота страницы, в пикселях.

Если для одной и той же области в предпросмотре метод Add() вызывается несколько раз, то отображается тот цвет, который был задан последним по времени.

Убрать подсветку области на контроле предпросмотра также можно с помощью метода Add(), указав в качестве первого параметра значение Colors.Empty.

Пример 1. Добавление зеленой подсветки в контрол предпросмотра Preview для указанной области

_obj.State.Controls.Preview.HighlightAreas.Add(Colors.Common.Green, 1, 105, 102, 46, 12, 210, 297);

Пример 2. Удаление подсветки области на контроле предпросмотра Preview с помощью метода Add()

_obj.State.Controls.Preview.HighlightAreas.Add(Colors.Empty, 1, 105, 156, 20, 100, 210, 297);

Добавить область подсветки с навигацией

Используется, чтобы связать свойство или ячейку свойства-коллекции с областью в контроле предпросмотра и настроить навигацию на эту область.

Синтаксис

public IPreviewHighlight Add(int page, double top, double left, double width, double height, double pageWidth, double pageHeight);

Параметры

page – номер страницы;

top – координаты смещения от верхнего края страницы до области, в пикселях;

left – координаты смещения от левого края страницы до области, в пикселях;

width – ширина области, в пикселях;

height – высота области, в пикселях;

pageWidth – ширина страницы, в пикселях;

pageHeight – высота страницы, в пикселях.

Возвращаемое значение

Область подсветки.

IPreviewHighlight – область подсветки

Методы

Имя	Описание
SetRelatedProperty()	Связать свойство с областью подсветки. Где: •propertyInfo – связываемое свойство
SetRelatedChildCollectionProperty()	Связать конкретную ячейку свойства-коллекции с областью подсветки. Где: •childEntity – ячейка свойства-коллекции; •childPropertyInfo – связываемое свойство-коллекция

Имя

Описание

SetRelatedProperty()

Связать свойство с областью подсветки. Где:

•propertyInfo – связываемое свойство

SetRelatedChildCollectionProperty()

Связать конкретную ячейку свойства-коллекции с областью подсветки. Где:

•childEntity – ячейка свойства-коллекции;

•childPropertyInfo – связываемое свойство-коллекция

Свойства

Имя	Тип	Описание
Style	IHighliteAreaStyle	Стиль подсветки, который по умолчанию применяется к области. Где: •Color – цвет области
ActivationStyle	IHighliteAreactivationStyle	Стиль подсветки, который применяется к области при нажатии на связанный контрол или ячейку. Где: •Color – цвет области; •BorderColor – цвет рамки выделенной области; •BorderWidth – толщина рамки в пикселях

Имя

Тип

Описание

Style

IHighliteAreaStyle

Стиль подсветки, который по умолчанию применяется к области. Где:

•Color – цвет области

ActivationStyle

IHighliteAreactivationStyle

Стиль подсветки, который применяется к области при нажатии на связанный контрол или ячейку. Где:

•Color – цвет области;

•BorderColor – цвет рамки выделенной области;

•BorderWidth – толщина рамки в пикселях

Пример 1. Навигация к области предпросмотра при клике на свойство

// Добавить область подсветки.
var area1 =_obj.State.Controls.Preview12.HighlightAreas.Add(10, 198, 103, 222, 90, 595, 842);
// Задать цвет области по умолчанию. Цвет отображается, когда не выделено
// поле карточки.
area1.Style.Color = Colors.Common.Green;
// Задать связь свойства и области. При клике на свойство изменяется
// подсветка области.
area1.SetRelatedProperty(_obj.Info.Properties.Created);
// Задать стиль подсветки. Стиль применяется при клике на свойство.
area1.ActivationStyle.BorderColor = Colors.Common.Red;
area1.ActivationStyle.BorderWidth = 3;
area1.ActivationStyle.Color = Colors.Common.DarkBlue;

Пример 2. Навигация к области предпросмотра при клике на ячейку таблицы

var first = _obj.CollectionProperty.FirstOrDefault();
// Добавить область подсветки.
var area2 = _obj.State.Controls.Preview12.HighlightAreas.Add(20, 218 , 103, 222, 90, 595, 842);
area2.Style.Color = Colors.Common.Yellow;
// Задать связь ячейки таблицы и области. При клике на ячейку изменяется подсветка
// области.
area2.SetRelatedChildCollectionProperty(first,
  first.Info.Properties.ChildProperty);
// Задать стиль подсветки. Стиль применяется при клике на ячейку.
area2.ActivationStyle.BorderColor = Colors.Common.Red;
area2.ActivationStyle.BorderWidth = 3;
area2.ActivationStyle.Color = Colors.Common.DarkBlue;