Поделиться через

Objects (Visual Basic Add-In Model)

  • Статья

Надстройка

Объект AddIn предоставляет информацию о надстройке в другие надстройки.

Синтаксис

object. Надстройка

Замечания

Объект AddIn создается для каждой надстройки, которая отображается в диспетчере надстроек.

CodeModule

Представляет код, связанный с компонентом, например, с формой, классом или документом.

Замечания

Объект CodeModule используется для изменения (добавления, удаления или правки) кода, связанного с компонентом. Каждый компонент связан с одним объектом CodeModule . Однако объект CodeModule можно связать с несколькими панелями кода.

Методы, связанные с объектом CodeModule, позволяют построчно обрабатывать и возвращать сведения о тексте кода. Например, можно использовать метод AddFromString для добавления текста в модуль. Метод AddFromString размещает текст над первой процедурой в модуле или в конце модуля, если процедуры отсутствуют.

Используйте свойство Parent , чтобы вернуть объект VBComponent , связанный с модулем кода.

CodePane

Представляет область кода.

Замечания

Объект CodePane используется для изменения положения текста или выбранного фрагмента текста, который отображается в области кода.

Используйте метод Show , чтобы сделать указанную область кода видимой.

Используйте метод SetSelection , чтобы задать выделение в области кода.

Используйте метод GetSelection , чтобы вернуть расположение выделенного фрагмента в области кода.

CommandBar

Объект CommandBar содержит другие объекты CommandBar, которые могут действовать как кнопки или команды меню.

Синтаксис

CommandBar

CommandBarEvents

Возвращается свойством CommandBarEvents . Объект CommandBarEvents инициирует событие при нажатии элемента управления на панели команд.

Замечания

Объект CommandBarEvents возвращается свойством CommandBarEvents объекта Events .

Возвращаемый объект имеет одно событие в интерфейсе — событие Click . Это событие можно обработать с помощью объявления объекта WithEvents .

События

Предоставляет свойства, которые включают надстройки для подключения всех событий в Visual Basic для приложений.

Замечания

Объект Events предоставляет свойства, которые возвращают источники событий. Эти свойства используются для возврата источников событий, которые уведомляют об изменениях в среде Visual Basic для приложений.

Свойства объекта Events возвращают объекты того же типа, что и имя свойства. Например, свойство CommandBarEvents возвращает объект CommandBarEvents.

Свойство

Представляет свойства объекта, которые видимы в окне свойств для любого заданного компонента.

Замечания

Используйте свойство Value объекта Property , чтобы вернуть или задать значение свойства компонента.

Как минимум, все компоненты имеют свойство Name . Свойство Value возвращает вариант соответствующего типа. Если возвращаемое значение является объектом, свойство Value возвращает коллекцию Properties , содержащую объекты Property , представляющие отдельные свойства объекта . Доступ к каждому из объектов Property можно получить с помощью метода Item в возвращаемой коллекции Properties .

Если значение, возвращаемое объектом Property , является объектом, можно использовать свойство Object , чтобы задать объект Property для нового объекта.

Ссылка

Отображает ссылку на библиотеку типов или проект.

Замечания

Используйте объект Reference, чтобы проверить, допустима ли ссылка.

Свойство IsBroken возвращает значение True , если ссылка больше не указывает на допустимую ссылку.

Свойство BuiltIn возвращает значение True , если ссылка является ссылкой по умолчанию, которую невозможно переместить или удалить.

Используйте свойство Name , чтобы определить, является ли ссылка, которую вы хотите добавить или удалить, правильной.

См. также свойства Описание и Тип .

ReferencesEvents

Возвращается свойством ReferencesEvents .

Замечания

Объект ReferencesEvents является источником событий, которые возникают при добавлении или удалении ссылки из проекта.

Событие ItemAdded активируется после добавления ссылки в проект.

Событие ItemRemoved активируется после удаления ссылки из проекта.

VBComponent

Представляет компонент, такой как модуль класса или стандартный модуль, содержащийся в проекте.

Замечания

Используйте объект VBComponent для доступа к объекту CodeModule, связанному с компонентом, или для изменения параметров свойств компонента.

Используйте свойство Type , чтобы узнать, к какому типу компонента относится объект VBComponent .

Используйте свойство Collection , чтобы узнать , в какой коллекции находится компонент.

VBE

Корневой объект, который содержит все другие объекты и коллекции, представленные в Visual Basic для приложений.

Замечания

Используйте следующие коллекции для доступа к объектам, содержащимся в объекте VBE :

  • Используйте коллекцию VBProjects для доступа к коллекции проектов.

  • Используйте коллекцию AddIns для доступа к коллекции надстроек.

  • Используйте коллекцию Windows для доступа к коллекции окон.

  • Используйте коллекцию CodePanes для доступа к коллекции областей кода.

  • Используйте коллекцию CommandBars для доступа к коллекции командных строк.

Используйте объект Events для доступа к свойствам, которые позволяют надстройкам подключаться ко всем событиям в Visual Basic для приложений. Свойства объекта Events возвращают объекты того же типа, что и имя свойства. Например, свойство CommandBarEvents возвращает объект CommandBarEvents.

Используйте свойство SelectedVBComponent , чтобы вернуть активный компонент. Активный компонент — это компонент, который отслеживается в окне проекта. Если выбранный элемент в окне проекта не является компонентом, SelectedVBComponent возвращает Nothing.

Примечание.

Все объекты в этой объектной модели имеют свойство VBE , указывающее на объект VBE .

VBProject

Представляет проект.

Замечания

Используйте объект VBProject , чтобы задать свойства проекта и получить доступ к коллекциям VBComponents и References .

Окно

Представляет окно в среде разработки.

Замечания

Используйте объект Window, чтобы показывать, скрывать или размещать окна.

Важно!

Объекты, свойства и методы для управления связанными окнами, связанными рамками окон и закрепленными окнами включены в систему Macintosh для обеспечения совместимости с кодом, написанным в Windows. Однако эти элементы языка будут создавать ошибки во время выполнения в системе Macintosh.

Используйте метод Close , чтобы закрыть окно в коллекции Windows . Метод Close влияет на различные типы окон следующим образом:

Окно Результат использования метода Close
Окно кода Удаляет окно из коллекции Windows.
Дизайнер Удаляет окно из коллекции Windows.
Объекты Window с типом Связанная рамка окна Окна становятся несвязанными отдельными окнами.

Примечание.

Использование метода Close с окнами кода и окнами конструктора фактически закрывает окно. Если для свойства Visible задано значение False , окно скрывается, но окно не закрывается. Использование метода Close с окнами среды разработки, такими как окно Проект или окно Свойства, аналогично заданию для свойства Visible значения False.

Используйте метод SetFocus для перемещения фокуса в окно.

Используйте свойство Visible , чтобы вернуть или задать видимость окна.

Чтобы узнать, с каким типом окна вы работаете, можно использовать свойство Type . Если у вас несколько окон типа, например несколько конструкторов, можно использовать свойство Caption , чтобы определить окно, с которым вы работаете.

Вы также можете найти окно, с которым нужно работать, с помощью свойства DesignerWindow объекта VBComponent или свойства Window объекта CodePane .

См. также

Поддержка и обратная связь

Есть вопросы или отзывы, касающиеся Office VBA или этой статьи? Руководство по другим способам получения поддержки и отправки отзывов см. в статье Поддержка Office VBA и обратная связь.