Средства разработки приложений


Компонент ExcelDDEConnection. - часть 2


Дескриптор раздела TopicDescriptor.

Экземпляр класса описывает раздел данных. Каждый раздел содержит в себе коллекцию элементов данных типа ItemDescriptor, описывающих ячейки. При добавлении ячейки происходит отправка Excel транзакции на подписку на эту ячейку, при удалении – транзакция на завершение работы с ячейкой.

Название Описание

TopicDescriptor(string book, string sheet)

Конструктор. В качестве параметров получает название книги и страницы.

Result Add(ItemDescriptor descriptor)

Добавить дескриптор ячейки в список подписанных ячеек. В качестве параметров получает дескриптор ячейки . При добавлении происходит отправка транзакции Excel на подписку на эту ячейку. В случае успешного выполнения метод вернет код возврата Result.OK, а дескриптор будет добавлен в коллекцию. Если такой дескриптор уже существовал, или произошла ошибка при подписке, то дескриптор не будет добавлен в коллекцию. В первом случае метод вернет код возврата Result. AlreadyExists, а во втором – Result.SubscribeError.

Result Add(int row, int col)

Добавить дескриптор ячейки в список подписанных ячеек. В качестве параметров метод получает номер строки row и номер столбца col. При добавлении происходит отправка транзакции Excel на подписку на эту ячейку. В случае успешного выполнения метод вернет код возврата Result.OK, а дескриптор будет добавлен в коллекцию. Если такой дескриптор уже существовал, или произошла ошибка при подписке, то дескриптор не будет добавлен в коллекцию. В первом случае метод вернет код возврата Result. AlreadyExists, а во втором – Result.SubscribeError.

Result Remove(ItemDescriptor descriptor)

Удалить ячейку из списка подписанных ячеек. В качестве параметров принимает дескриптор ячейки. При удалении происходит отправка транзакции Excel на отписку от данной ячейки. Если при выполнении функции не произошло никаких ошибок, то метод вернет код возврата Result.OK. Если ячейка не существовала или при удалении произошли ошибки, то метод вернет в первом случае код Result.NonExistingItem, а во втором – Result.UnsubscribeError, при этом ячейка будет удалена из списка подписанных ячеек.

Result Remove(int row, int col)

Удалить ячейку из списка подписанных ячеек. В качестве параметров принимает номер строки row и номер столбца col. При удалении происходит отправка транзакции Excel на отписку от данной ячейки. Если при выполнении функции не произошло никаких ошибок, то метод вернет код возврата Result.OK. Если ячейка не существовала или при удалении произошли ошибки, то метод вернет в первом случае код Result.NonExistingItem, а во втором – Result.UnsubscribeError, при этом ячейка будет удалена из списка подписанных ячеек.

void Clear()

Метод отменяет подписку на все ячейки из списка  подписанных ячеек и очищает список.

void Dispose()

Метод отменяет подписку на все ячейки из списка  подписанных ячеек и очищает список.

int Count

Свойство возвращает количество дескрипторов ячеек в списке.

string Book

Свойство возвращает название книги раздела, который описывает данный дескриптор.

string Sheet

Свойство возвращает название страницы раздела, который описывает данный дескриптор.

string Topic

Свойство возвращает название раздела в формате Excel, который описывает данный дескриптор.

ItemDescriptor this[int index]

Получить дескриптор ячейки по его порядковому номеру в списке подписанных ячеек.

ItemDescriptor this[int row, int col]

Получить дескриптор ячейки по номеру строки row и столбца col ячейки.

ItemDescriptor this[string item]

Получить дескриптор ячейки по названию в формате Excel.




Начало  Назад  Вперед



Книжный магазин