ObjectItem

<< Click to Display Table of Contents >>

Navigation:  Интерфейс редактора проекта > Операции в редакторе проекта > Скрипт C# > Объектная модель, классы, их свойства и методы >

ObjectItem

Тип ObjectItem соответствует элементу Объект.

Унаследован от класса ObjectOrTagItem.

Общие свойства для всех элементов (класса Item) смотрите в соответствующем разделе.

Свойства и методы, характерные для ObjectItem, представлены в таблице:

Название

Значение свойства / Тип возвращаемого значения метода

Описание

Пример использования

Свойства (Properties)

 

Ancestor

ObjectItem

Предок объекта (тип объекта, от которого наследуется элемент).

Методы доступа: get

var objItem = (ObjectItem)RootItemModel.GetChildByNamePath("Объекты.Объект 1.Объект 1");
WriteConsole(objItem?.Ancestor?.FullName);

ControllerRef

Узел. Соответствует свойству Узел в Панели свойств в категории Настройки.

Методы доступа: get/set

newObject.ControllerRef = newARM;

DataArchiveRef

Архив данных. Соответствует свойству Архив данных в Панели свойств в категории Настройки.

Методы доступа: get/set

newObject.DataArchiveRef = newArchive;

DisableExecution

Отключить исполнение. Соответствует свойству Отключить исполнение в Панели свойств в категории Общие.

Методы доступа: get/set

newObject.DisableExecution = true;

 

EventsArchiveRef

Архив сообщений. Соответствует свойству Архив сообщений в Панели свойств в категории Настройки.

Методы доступа: get/set

newObject.EventsArchiveRef = newEventsArchive;

ExecutePlace

ExecutePlaces

Место исполнения. Соответствует свойству Место исполнения в Панели свойств в категории Задача. Возможные значения свойства (ExecutePlaces):

ObjectTask - в задаче родительского объекта;

ControllerTask - в основной задаче узла;

ScreenTask - в задаче экрана.

Методы доступа: get/set

newObject.ExecutePlace = ExecutePlaces.ScreenTask;

TaskRef

Задача. Соответствует свойству Задача в Панели свойств в категории Настройки.

Методы доступа: get/set

newObject.TaskRef = newTask;

WindowRef

Ссылка на окно для сообщений. Соответствует свойству Ссылка на окно для сообщений в Панели свойств в категории Настройки.

Методы доступа: get/set

var okno = (ViewDeclarationInObjectsItem)newObject.AddWindow("");        object1.WindowRef = okno;

Методы (Methods)

 

AddFolder(string?)

ObjectFolder (Папка)

Добавление Папки. В качестве аргумента задается Имя Папки (Display Name)

newObject.AddFolder();

AddObject(string?)

ObjectItem (Объект)

Добавление вложенного Объекта. В качестве аргумента задается Имя Объекта (Display Name)

newObject.AddObject();

AddTagBase(string?)

Добавление Базового тега. В качестве аргумента задается имя Базового тега (Display Name)

newObject.AddTagBase("Базовый тег");

AddTagInteger(string?)

TagInstanceItem (Целый тег)

Добавление Целого тега как экземпляра. В качестве аргумента задается имя Целого тега (Display Name)

newObject.AddTagInteger("Тег типа INT");

AddTagIntegerInheritance(string?)

Добавление Целого тега как наследника. В качестве аргумента задается имя Целого тега (Display Name)

newObject.AddTagIntegerInheritance("Тег-наследник типа INT");

AddTagLogical(string?)

TagInstanceItem (Логический тег)

Добавление Логического тега как экземпляра. В качестве аргумента задается имя Логического тега (Display Name)

newObject.AddTagLogical("Тег типа BOOL");

AddTagLogicalInheritance(string?)

Добавление Логического тега как наследника. В качестве аргумента задается имя Логического тега (Display Name)

newObject.AddTagLogicalInheritance("Тег-наследник типа BOOL");

AddTagReal(string?)

TagInstanceItem (Вещественный тег)

Добавление Вещественного тега как экземпляра. В качестве аргумента задается имя Вещественного тега (Display Name)

newObject.AddTagReal("Тег типа REAL");

AddTagRealInheritance(string?)

Добавление Вещественного тега как наследника. В качестве аргумента задается имя Вещественного тега (Display Name)

newObject.AddTagRealInheritance("Тег-наследник типа REAL");

CopyTo(ObjectItem)

ObjectItem (скопированный объект)

Копирование Объекта. В качестве аргумента задается объект, куда будет вставлена копия объекта

var objInst = (ObjectItem)RootItemModel.GetChildByNamePath("Объекты.Объект 2.Объект_90");        

var objInst1 = (ObjectItem)RootItemModel.GetChildByNamePath("Объекты.Объект 1");

var objInst2 = objInst.CopyTo(objInst1);

 

FindTag (string)

Поиск Тега по имени. Возвращает первый найденный тег в дереве, соответствующий указанному имени. В качестве аргумента метода задается Имя Тега (DisplayName)

var tag = object.FindTag("Тег");

FindTagInstance(string)

TagInstanceItem (экземпляр тега)

Поиск Экземпляра тега по имени. Возвращает первый найденный экземпляр тега в дереве, соответствующий указанному имени. В качестве аргумента метода задается Имя Экземпляра тега (DisplayName)

var tag = object.FindTagInstance("Экземпляр тега");

FindObject(string)

ObjectItem (найденный объект)

 

Поиск Объекта по имени. Возвращает первый найденный объект в дереве объектов, соответствующий указанному имени. В качестве аргумента метода задается Имя Объекта (DisplayName)

var obj = object.FindObject("Объект 4");

InsertInheritorTo(ObjectItem)

ObjectItem (вставленный наследник)

Вставка наследника в объект. В качестве аргумента метода задается объект, куда будет вставлен наследник

Добавление объекта в качестве наследника типа:

var objInst1 = (ObjectItem)RootItemModel.GetChildByNamePath("Объекты.Объект 1");

var objLibInst = (ObjectItem)RootItemModel.GetItemByFullName("Моя_библиотека.Объекты.Объект_из_библиотеки");

var objInst = objLibInst.InsertInheritorTo(objInst1);

 

InsertInstanceTo(ObjectItem)

ObjectInstanceItem (экземпляр объекта)

Вставка экземпляра в объект. В качестве аргумента метода задается объект, куда будет вставлен экземпляр

Добавление объекта в качестве наследника типа:

var objInst1 = (ObjectItem)RootItemModel.GetChildByNamePath("Объекты.Объект 1");

var objLibInst = (ObjectItem)RootItemModel.GetItemByFullName("Моя_библиотека.Объекты.Объект_из_библиотеки");

var objInst = objLibInst.InsertInstanceTo(objInst1);