--- title: "Интерфейс ISpecificationTuningSection" type: interface api: [api7] tags: [interface, api7, ispecificationtuningsection] sources: - ispecificationtuningsection.html --- *API интерфейсов. Версия 7 > Работа со спецификацией * ## Интерфейс ISpecificationTuningSection Настройка раздела спецификации. Иерархия: IKompasAPIObject ISpecificationTuningSection Описание: Данный интерфейс позволяет получить доступ к настройкам раздела спецификации. Если настройки взяты у стиля спецификации, то они являются умолчательными для данного стиля и изменять их нельзя. В этом случае данный интерфейс отражает содержимое настроек стиля в библиотеке стилей на момент получения и в дальнейшем не отслеживает изменений в библиотеке стилей. Если настройки взяты у описания спецификации, то они отображают и отслеживают текущее состояние описания спецификации. Эти настройки можно изменять и они могут отличаться от умолчательных настроек стиля спецификации, по которому создано данное описание спецификации. После изменения настроек для того, чтобы эти изменения реально отобразились в документе, необходимо вызвать метод ISpecificationTuning::Update. Примечание: Данный интерфейс можно получить у коллекции ISpecificationTuningSections. ## AdditionalBlocks - Блоки вложенных разделов Тип данных: указатель на интерфейс IAdditionalBlockTunings коллекции настроек блоков вложенных разделов спецификации Синтаксис Automation: ``` AdditionalBlocks = iObject.AdditionalBlocks Получить свойство (* ) AdditionalBlocks = iObject.GetAdditionalBlocks() Получить свойство (**) ``` Синтаксис COM: ``` iObject->get_AdditionalBlocks (&AdditionalBlocks) Получить свойство ``` Примечание: 1. Позволяет получить параметры настроек блоков вложенных разделов спецификации. 2. Свойство доступно только для чтения. ## AddSortColumn - Добавить колонку в список сортируемых Синтаксис Automation: ``` BOOL AddSortColumn( ksSpecificationColumnTypeEnum ColumnType, long ColumnTypeNumber, ksSortTypeEnum SortType ); ``` Синтаксис COM: ``` HRESULT AddSortColumn( ksSpecificationColumnTypeEnum ColumnType, long ColumnTypeNumber, ksSortTypeEnum SortType, BOOL * Result ); Возвращаемое значение: TRUE - обновление прошло успешно, FALSE - обновить настройки не удалось. Входные параметры: ColumnType - тип колонки из перечисления ksSpecificationColumnTypeEnum, ColumnTypeNumber - номер колонки, SortType - тип сортировки. КOMPAS v24 ``` ## AttachGeometry - Подключать геометрию Тип данных: BOOL Синтаксис Automation: ``` AttachGeometry = iObject.AttachGeometry Получить свойство (* ) iObject.AttachGeometry = AttachGeometry Установить свойство (* ) AttachGeometry = iObject.GetAttachGeometry() Получить свойство (**) iObject.SetAttachGeometry (AttachGeometry) Установить свойство (**) ``` Синтаксис COM: ``` iObject->get_AttachGeometry (&AttachGeometry) Получить свойство iObject->put_AttachGeometry (AttachGeometry) Установить свойство Значения свойства: TRUE - объектам раздела можно поставить в соответствие геометрические объекты графического документа, FALSE - объектам раздела нельзя поставить в соответствие геометрические объекты графического документа. ``` Примечание: Позволяет включать и отключать подключение геометрии к объектам раздела. ## ClearSortColumns - Очистить список сортируемых колонок Синтаксис Automation: ``` BOOL ClearSortColumns(); ``` Синтаксис COM: ``` HRESULT ClearSortColumns( BOOL * Result ); Возвращаемое значение: TRUE - обновление прошло успешно, FALSE - обновить настройки не удалось. КOMPAS v24 ``` ## DeleteSortColumn - Удалить колонку из списка сортируемых Синтаксис Automation: ``` BOOL DeleteSortColumn( long Level ); ``` Синтаксис COM: ``` HRESULT DeleteSortColumn( long Level, BOOL * Result ); Возвращаемое значение: TRUE - обновление прошло успешно, FALSE - обновить настройки не удалось. Входные параметры: Level - уровень сортировки. КOMPAS v24 ``` ## FirstOnSheet - Размещать на новом листе Тип данных: BOOL Синтаксис Automation: ``` FirstOnSheet = iObject.FirstOnSheet Получить свойство (* ) FirstOnSheet = iObject.FirstOnSheet Установить свойство (* ) FirstOnSheet = iObject.GetFirstOnSheet() Получить свойство (**) iObject.SetFirstOnSheet (FirstOnSheet) Установить свойство (**) ``` Синтаксис COM: ``` iObject->get_FirstOnSheet (&FirstOnSheet) Получить свойство iObject->put_FirstOnSheet (FirstOnSheet) Установить свойство Значения свойства: TRUE - располагать раздел на новой странице, FALSE - располагать раздел сразу за предыдущим. ``` Примечание: Позволяет включать и отключать размещение раздела на новом листе спецификации. ## GetSortParameters - Параметры сортировки Синтаксис Automation: ``` BOOL GetSortParameters( long Level, ksSpecificationColumnTypeEnum * ColumnType, long * ColumnTypeNumber, ksSortTypeEnum * SortType ); ``` Синтаксис COM: ``` HRESULT GetSortParameters( long Level, ksSpecificationColumnTypeEnum * ColumnType, long * ColumnTypeNumber, ksSortTypeEnum * SortType, BOOL * Result ); Возвращаемое значение: TRUE - обновление прошло успешно, FALSE - обновить настройки не удалось. Входные параметры: Level - уровень сортировки. Выходные параметры: ColumnType - тип колонки из перечисления ksSpecificationColumnTypeEnum, ColumnTypeNumber - номер колонки, SortType - тип сортировки из перечисления ksSortTypeEnum. КOMPAS v24 ``` ## IndependentPosition - Независимая нумерация позиций Тип данных: BOOL Синтаксис Automation: ``` IndependentPosition = Object.IndependentPosition Получить свойство (* ) Object.IndependentPosition = IndependentPosition Установить свойство (* ) IndependentPosition = Object.GetIndependentPosition() Получить свойство (**) Object.SetIndependentPosition( IndependentPosition ) Установить свойство (**) ``` Синтаксис COM: ``` Object.get_IndependentPosition( &IndependentPosition ) Получить свойство Object.put_IndependentPosition( IndependentPosition ) Установить свойство ``` ## Mark - Марка. Текст префикса Тип данных: BSTR Синтаксис Automation: ``` Mark = Object.Mark Получить свойство (* ) Object.Mark = Mark Установить свойство (* ) Mark = Object.GetMark() Получить свойство (**) Object.SetMark( Mark ) Установить свойство (**) ``` Синтаксис COM: ``` Object.get_Mark( &Mark ) Получить свойство Object.put_Mark( Mark ) Установить свойство ``` ## MarkOn - Марка. Включена простановка позиций c префиксом Тип данных: BOOL Синтаксис Automation: ``` MarkOn = Object.MarkOn Получить свойство (* ) Object.MarkOn = MarkOn Установить свойство (* ) MarkOn = Object.GetMarkOn() Получить свойство (**) Object.SetMarkOn( MarkOn ) Установить свойство (**) ``` Синтаксис COM: ``` Object.get_MarkOn( &MarkOn ) Получить свойство Object.put_MarkOn( MarkOn ) Установить свойство ``` ## Number - Номер раздела Тип данных: long Синтаксис Automation: ``` Number = iObject.Number Получить свойство (* ) Number = iObject.GetNumber() Получить свойство (**) ``` Синтаксис COM: ``` iObject->get_Number (&Number) Получить свойство ``` Примечание: 1. Данное свойство определяет уникальный номер раздела в данном стиле спецификации. 2. Свойство доступно только для чтения. ## PutPosition - Проставлять позиции Тип данных: BOOL Синтаксис Automation: ``` PutPosition = iObject.PutPosition Получить свойство (* ) iObject.PutPosition = PutPosition Установить свойство (* ) PutPosition = iObject.GetPutPosition() Получить свойство (**) iObject.SetPutPosition (PutPosition) Установить свойство (**) ``` Синтаксис COM: ``` iObject->get_PutPosition (&PutPosition) Получить свойство iObject->put_PutPosition (PutPosition) Установить свойство Значения свойства: TRUE - в разделе возможен автоматический расчет номеров позиций, FALSE - в разделе невозможен автоматический расчет номеров позиций. ``` Примечание: Позволяет включать и отключать простановку позиций в разделе. Следует понимать, что отключение простановки позиций отличается от запрета ввода данных в колонку "Позиция". Если в разделе включена простановка позиций, но запрещен ввод данных в колонку "Позиция", то объектам этого раздела при автоматической простановке позиций будут присвоены номера позиций. И хотя эти номера не будут видны в таблице (из-за запрета на ввод данных в колонку "Позиция"), нумерация объектов в следующем разделе будет производиться с их учетом. Если в разделе отключена простановка позиций и разрешен ввод данных в колонку "Позиция", то после автоматической простановки позиций номера позиций в этом разделе не изменятся, а номера позиций в следующем разделе не будут учитывать введенные вручную номера позиций в данном разделе. Обычно запрет ввода данных в колонку "Позиция" какого-либо раздела сочетают с отключением простановки позиций в этом разделе (пример такого раздела — Документация). И наоборот, если данные в колонку "Позиция" раздела вводить можно, то в этом разделе включают автоматическую простановку позиций. ## ReserveStringCount - Число резервных строк и позиций Тип данных: long Синтаксис Automation: ``` ReserveStringCount = iObject.ReserveStringCount Получить свойство (* ) iObject.ReserveStringCount = ReserveStringCount Установить свойство (* ) ReserveStringCount = iObject.GetReserveStringCount() Получить свойство (**) iObject.SetReserveStringCount (ReserveStringCount) Установить свойство (**) ``` Синтаксис COM: ``` iObject->get_ReserveStringCount (&ReserveStringCount) Получить свойство iObject->put_ReserveStringCount (ReserveStringCount) Установить свойство ``` Примечание: Позволяет получить или указать количество резервных строк в разделе. ## SetSortColumn - Изменить параметры сортировки Синтаксис Automation: ``` BOOL SetSortColumn( long Level, ksSpecificationColumnTypeEnum ColumnType, long ColumnTypeNumber, ksSortTypeEnum SortType ); ``` Синтаксис COM: ``` HRESULT SetSortColumn( long Level, ksSpecificationColumnTypeEnum ColumnType, long ColumnTypeNumber, ksSortTypeEnum SortType, BOOL * Result ); Возвращаемое значение: TRUE - обновление прошло успешно, FALSE - обновить настройки не удалось. Входные параметры: Level - уровень сортировки, ColumnType - тип колонки из перечисления ksSpecificationColumnTypeEnum, ColumnTypeNumber - номер колонки, SortType - тип сортировки из перечисления ksSortTypeEnum. КOMPAS v24 ``` ## ShowDocumentCode - Показывать код документа Тип данных: BOOL Синтаксис Automation: ``` ShowDocumentCode = Object.ShowDocumentCode Получить свойство (* ) Object.ShowDocumentCode = ShowDocumentCode Установить свойство (* ) ShowShowDocumentCode = Object.GetShowDocumentCode() Получить свойство (**) Object.SetShowDocumentCode( ShowDocumentCode ) Установить свойство (**) ``` Синтаксис COM: ``` Object.get_ShowDocumentCode( &ShowDocumentCode ) Получить свойство Object.put_ShowDocumentCode( ShowDocumentCode ) Установить свойство ``` ## SortColumnCount - Количество колонок, участвующих в сортировке Тип данных: long Синтаксис Automation: ``` SortColumnCount = Object.SortColumnCount Получить свойство (* ) SortColumnCount = Object.GetSortColumnCount() Получить свойство (**) ``` Синтаксис COM: ``` Object.get_SortColumnCount( &SortColumnCount ) Получить свойство Object.put_ShowDocumentCode( ShowDocumentCode ) Установить свойство ``` Примечание: Свойство доступно только для чтения. КOMPAS v24 ## SortObjects - Сортировать объекты Тип данных: BOOL Синтаксис Automation: ``` SortObjects = iObject.SortObjects Получить свойство (* ) iObject.SortObjects = SortObjects Установить свойство (* ) SortObjects = iObject.GetSortObjects() Получить свойство (**) iObject.SetSortObjects (SortObjects) Установить свойство (**) ``` Синтаксис COM: ``` iObject->get_SortObjects (&SortObjects) Получить свойство iObject->put_SortObjects (SortObjects) Установить свойство Значения свойства: TRUE - сортировка объектов внутри раздела производится по предусмотренным стандартом правилам, FALSE - в разделе сортировка объектов не производится. ``` Примечание: Позволяет включать и отключать автоматическую сортировку объектов в разделе. Если сортировка выключена, объекты будут добавляться в конец раздела и их можно будет перемещать вверх или вниз. ## SubsectionOn - Деление на подразделы включено Тип данных: BOOL Синтаксис Automation: ``` SubsectionOn = iObject.SubsectionOn Получить свойство (* ) iObject.SubsectionOn = SubsectionOn Установить свойство (* ) SubsectionOn = iObject.GetSubsectionOn() Получить свойство (**) iObject.SetSubsectionOn (SubsectionOn) Установить свойство (**) ``` Синтаксис COM: ``` iObject->get_SubsectionOn (&SubsectionOn) Получить свойство iObject->put_SubsectionOn (SubsectionOn) Установить свойство Значения свойства: TRUE - деление на подразделы включено, FALSE - деление на подразделы выключено. ``` Примечание: Позволяет включать и отключать деление раздела на подразделы. Если деление на подразделы включено, объекты внутри раздела будут располагаться с учетом порядка подраздела. Подразделы располагаются в разделе в порядке возрастания номеров. ## Subsections - Подразделы Тип данных: указатель на интерфейс ISpecificationSubsections подразделов спецификации Синтаксис Automation: ``` Subsections = iObject.Subsections Получить свойство (* ) Subsections = iObject.GetSubsections() Получить свойство (**) ``` Синтаксис COM: ``` iObject->get_Subsections (&Subsections) Получить свойство ``` Примечание: 1. Позволяет получить коллекцию подразделов данного раздела спецификации. 2. Свойство доступно только для чтения. ## UseAdditionalBlocks - Использовать блоки вложенных разделов Тип данных: BOOL Синтаксис Automation: ``` UseAdditionalBlocks = iObject.UseAdditionalBlocks Получить свойство (* ) iObject.UseAdditionalBlocks = UseAdditionalBlocks Установить свойство (* ) UseAdditionalBlocks = iObject.GetUseAdditionalBlocks() Получить свойство (**) iObject.SetUseAdditionalBlocks (UseAdditionalBlocks) Установить свойство (**) ``` Синтаксис COM: ``` iObject->get_UseAdditionalBlocks (&UseAdditionalBlocks) Получить свойство iObject->put_UseAdditionalBlocks (UseAdditionalBlocks) Установить свойство Значения свойства: TRUE - использовать блоки вложенных разделов, FALSE - блоки вложенных разделов использоваться не будут. ``` Примечание: Позволяет получить или указать количество резервных строк в разделе.