--- title: "Интерфейс ISpecificationCommentObject" type: interface api: [api7] tags: [interface, api7, ispecificationcommentobject] sources: - ispecificationcommentobject.html --- *API интерфейсов. Версия 7 > Работа со спецификацией * ## Интерфейс ISpecificationCommentObject Интерфейс вспомогательного объекта спецификации. Иерархия: IKompasAPIObject ISpecificationObject ISpecificationCommentObject Описание: Интерфейс позволяет получить и изменить параметры вспомогательного объекта спецификации. В отличие от базового для вспомогательного объекта не предусмотрены сервисные функции, выполнение которых обеспечивает спецификация. Вспомогательные объекты не сортируются автоматически и т.д. Вспомогательные объекты рекомендуется использовать для выполнения таких приемов оформления спецификации, которые не могут быть обеспечены вводом базовых объектов. Например, при помощи вспомогательного объекта спецификации можно ввести произвольный текст (комментарий) в таблицу спецификации или создать пустую строку в середине раздела. Примечание: 1. После изменения параметров объекта спецификации требуется вызвать метод ISpecificationObject::Update. 2. Данный интерфейс можно получить у коллекции базовых объектов спецификации ISpecificationCommentObjects. ## BaseObject - Базовый объект спецификации, к которому прикреплен данный объект Тип данных: указатель на интерфейс базового объекта спецификации ISpecificationBaseObject Синтаксис Automation: ``` BaseObject = iObject.BaseObject Получить свойство (* ) BaseObject = iObject.GetBaseObject() Получить свойство (**) ``` Синтаксис COM: ``` iObject->get_BaseObject( &BaseObject ) Получить свойство ``` Примечание: Свойство доступно только для чтения. ## BlockNumber - Номер блока Тип данных: long Синтаксис Automation: ``` BlockNumber = iObject.BlockNumber Получить свойство (* ) iObject.BlockNumber = BlockNumber Установить свойство (* ) BlockNumber = iObject.GetBlockNumber() Получить свойство (**) iObject.SetBlockNumber( BlockNumber ) Установить свойство (**) ``` Синтаксис COM: ``` iObject->get_BlockNumber( &BlockNumber ) Получить свойство iObject->put_BlockNumber( BlockNumber ) Установить свойство ``` Примечание: Установить номер блока можно только для нового вспомогательного объекта спецификации. ## EditSourceObject - Передавать изменения в документ - владелец объекта Тип данных: BOOL Синтаксис Automation: ``` EditSourceObject = Object.EditSourceObject Получить свойство (* ) Object.EditSourceObject = EditSourceObject Установить свойство (* ) EditSourceObject = Object.GetEditSourceObject() Получить свойство (**) Object.SetEditSourceObject( EditSourceObject ) Установить свойство (**) ``` Синтаксис COM: ``` Object.get_EditSourceObject( &EditSourceObject ) Получить свойство Object.put_EditSourceObject( EditSourceObject ) Установить свойство ``` ## SetSection - Установить номер раздела Синтаксис Automation: ``` BOOL SetSection( long Val ); ``` Синтаксис COM: ``` HRESULT SetSection( long Val, BOOL * Result ); Возвращаемое значение: TRUE - в случае удачного завершения, FALSE - в случае неудачи. Входные параметры Val - номер раздела. ``` Примечание: Задаваемый номер раздела должен присутствовать в данной спецификации. Узнавать текущий номер раздела объекта надо у базового интерфейса ISpecificationObject.