属性（Visual Basic 加载项模型）

项目
04/07/2023

ActiveCodePane

返回活动或最后一个活动 CodePane 对象，或设置活动的 CodePane 对象。读/写。

备注

您可以将 ActiveCodePane 属性设置为任何有效的 CodePane 对象，如以下示例中所示：

Set MyApp.VBE. ActiveCodePane = MyApp.VBE.CodePanes(1)

前面的示例将代码窗格集合中的第一个代码窗格设置为活动代码窗格。还可以使用 SetSelection 方法激活代码窗格。

ActiveVBProject

在项目窗口中返回活动的项目。只读。

备注

ActiveVBProject 属性返回项目窗口中选定的项目或选择了其组件的项目。对于后者，不必选择项目本身。无论是否显式选择项目，始终存在活动的项目。

ActiveWindow

返回开发环境中的活动窗口。只读。

备注

在开发环境中打开多个窗口时，ActiveWindow 属性设置是带焦点的窗口。如果主窗口具有焦点， 则 ActiveWindow 返回 Nothing。

AddIns

返回一个其中的加载项可用于将它们的自动化组件注册到可扩展性对象模型中的集合。

语法

对象。AddIns

对象占位符表示一个对象表达式，该表达式的计算结果为“应用于”列表中的对象。

BuildFileName

设置或返回在生成项目时将使用的 DLL 名称。

语法

对象。BuildFileName

对象占位符表示一个对象表达式，该表达式的计算结果为“应用于”列表中的对象。

内置

返回一个布尔值，该值指示 Reference 对象是否是无法删除的默认引用。只读。

BuiltIn 属性返回以下值：

值	说明
True	引用是无法删除的默认引用。
False	引用不是默认引用；可以将其删除。

Caption

返回包含活动窗口标题的字符串。只读。

备注

活动窗口的标题即为窗口标题栏中显示的文本。

CodeModule

返回表示组件隐藏代码的对象。只读。

备注

如果组件没有与之关联的代码模块，则 CodeModule 属性返回 Nothing。

注意

CodePane 对象表示可见的代码窗口。给定组件可包含若干 CodePane 对象。

CodeModule 对象表示组件中的代码。一个组件只能具有一个 CodeModule 对象。

CodePane

返回 CodePane 对象。只读。

备注

如果存在代码窗格，则它会成为活动的代码窗格，而包含该窗格的窗口将成为活动窗口。如果模块中不存在代码窗格，则 CodePane 属性会创建一个代码窗格。

CodePanes

返回活动 CodePane 对象的集合。只读。

CodePaneView

返回一个值，该值指示 CodePane 是位于“过程”视图还是“完整模块”视图中。只读。

CodePaneView 属性返回以下值：

常量	说明
vbext_cv_ProcedureView	指定的代码窗格位于过程视图中。
vbext_cv_FullModuleView	指定的项目位于完整模块视图中。

集合

返回包含正在使用的对象的集合。只读。

备注

此对象模型中的大多数对象都具有 Parent 属性或指向该对象的父对象的 Collection 属性。

使用 Collection 属性可访问对象所属的集合的属性、方法和控件。

CommandBarEvents

返回 CommandBarEvents 对象。只读。

设置

传递给 CommandBarEvents 属性的参数的设置是：

参数	Description
vbcontrol	必须是类型 CommandBarControl 的对象。

备注

使用 CommandBarEvents 属性可返回事件源对象，该对象将在用户单击命令栏按钮时触发事件。

传递给 CommandBarEvents 属性的参数是将为其触发 Click 事件的命令栏控件。

CommandBars

包含项目中的全部命令栏，包括支持快捷菜单的命令栏。

另请参阅菜单和命令以及工具栏。

连接

返回或设置加载项的连接状态。

备注

如果加载项已注册并且当前处于连接状态（活动），则返回 True。

如果加载项已注册但未连接（非活动），则返回 False。

记数

返回包含集合中的项目数的 Long。只读。

CountOfDeclarationLines

返回包含代码模块的声明部分中的代码行数的 Long。只读。

CountOfLines

返回包含代码模块中的代码行的数目的 Long。只读。

CountOfVisibleLines

返回包含代码窗格中可见的行的数目的 Long。只读。

Description

Returns or sets a string expression containing a descriptive string associated with an object. 对于 VBProject 对象，可读/写;对于 Reference 对象，为只读。

备注

对于 VBProject 对象，Description 属性会返回或设置与活动项目关联的描述性字符串。

对于 Reference 对象，Description 属性会返回引用的描述性名称。

设计器

返回允许您访问组件的设计特征的对象。

备注

如果对象具有打开的设计器， 则 Designer 属性返回打开的设计器;否则，将创建新的设计器。

设计器是某些 VBComponent 对象的一个特征。例如，创建某些类型的 VBComponent 对象时，设计器将随对象一起创建。一个组件只能有一个设计器，并且始终是同一设计器。

Designer 属性允许您访问组件特定的对象。有些情况下，例如在标准模块和类模块中，不会创建设计器，因为该类型的 VBComponent 对象不支持设计器。

如果 VBComponent 对象没有设计器，则 Designer 属性返回 Nothing。

DesignerID

返回 ActiveX 设计器的 ProgID 的只读属性。

事件

提供使加载项能够连接到Visual Basic for Applications中的所有事件的属性。

语法

对象。事件

对象占位符表示一个对象表达式，该表达式的计算结果为“应用于”列表中的对象。

FileName

返回项目文件或主机文档的完整路径名。

语法

对象。文件名

对象占位符表示一个对象表达式，该表达式的计算结果为“应用于”列表中的对象。

备注

项目没有除文件名之外的任何名称。返回的路径名始终作为绝对路径提供（例如，“c:\projects\myproject.vba”），即使它显示为相对路径（如“..\projects\myproject.vba”）也是如此。

FullPath

返回包括引用的类型库的路径和文件名的 String。只读。

GUID

返回包含对象的类标识符的字符串。只读。

HasOpenDesigner

返回一个布尔值，该值指示 VBComponent 对象是否具有打开的设计器。只读。

HasOpenDesigner 属性返回以下值：

值	说明
True	VBComponent 对象具有打开的“设计”窗口。
False	VBComponent 对象没有打开的“设计”窗口。

Height

返回或设置包含窗口高度（以缇为单位）的 Single。读/写。

备注

更改链接窗口或停靠窗口的 Height 属性对仍保持链接或停靠的窗口没有影响。

重要

[!重要信息] 在 Macintosh 上包含了用于控制链接窗口、链接窗口框架和停靠窗口的对象、属性和方法以便与在 Windows 中编写的代码兼容。但是，这些语言元素在 Macintosh 上运行时将会生成运行时错误。

HelpContextID

返回或设置包含 Microsoft Windows 帮助文件中的主题的上下文 ID 的 String。读/写。

HelpFile

返回或设置一个字符串，该字符串指定项目的 Microsoft Windows 帮助文件。读/写。

IndexedValue

为作为索引列表或数组的属性的成员返回或设置一个值。

备注

由 IndexedValue 属性返回或设置的值是一个计算结果为对象接受的类型的表达式。对于作为索引列表或数组的属性，必须使用 IndexedValue 属性而不是 Value 属性。索引列表是一个指定索引位置的数值表达式。使用单个索引设置或返回索引列表中的值。

IndexedValue 接受最多 4 个索引。 IndexedValue 接受的索引数是 NumIndices 属性返回的值。 IndexedValue 属性仅在 NumIndices 属性的值大于零时使用。

IsBroken

返回一个布尔值，该值指示 Reference 对象是否指向注册表中的有效引用。只读。

IsBroken 属性返回下列值：

值	说明
True	Reference 对象不再指向注册表中的有效引用。
False	Reference 对象指向注册表中的有效引用。

Left

返回或设置包含屏幕上窗口左边缘位置的 Single（以缇为单位）。读/写。

备注

Left 属性返回的值取决于窗口是链接还是停靠。

注意

[!注释] 只要窗口保持链接或停驻，则更改链接或停驻窗口的 Left 属性不会产生任何效果。

重要

Lines

Returns a string containing the specified number of lines of code.

语法

对象。行 (起始线，) 计数为字符串

“Lines”语法包含以下部分：

Part	说明
object	必填。一个对象表达式，该表达式的计算结果为“ 应用于 ”列表中的对象。
起始线	必填。指定开始的行号的Long。
count	必填。指定要返回的行数的Long。

备注

代码模块中的行号从 1 开始。

LinkedWindowFrame

返回表示包含窗口的框架的 Window 对象。只读。

备注

利用 LinkedWindowFrame 属性，您可以访问表示链接窗口框架的对象，该对象具有的属性与其包含的窗口的属性不同。如果未链接窗口， 则 LinkedWindowFrame 属性返回 Nothing。

重要

LinkedWindows

返回链接窗口框架中包含的所有链接窗口的集合。只读。

备注

LinkedWindows 属性是访问器属性（即，返回与属性名的类型相同的对象的属性）。

MainWindow

返回一个 Window 对象，该对象代表 Visual Basic 开发环境的主窗口。只读。

备注

使用 MainWindow 属性返回的 Window 对象可添加或删除停靠窗口，并最大化、最小化、隐藏或还原 Visual Basic 开发环境的主窗口。

重要

主要

返回包含引用的类型库的主版本号的 Long。只读。

备注

Major 属性返回的数字对应于您已对其设置引用的类型库中存储的主版本号。

次要

返回 Long，指示引用的类型库的次要版本号。只读。

备注

Minor 属性返回的数字对应于对其设置了引用的类型库中存储的次要版本号。

模式

返回一个包含指定的项目所处模式的值。只读。

Mode 属性返回以下值：

常量	说明
vbext_vm_Run	指定的项目处于运行模式。
vbext_vm_Break	指定的项目处于中断模式。
vbext_vm_Design	指定的项目处于设计模式。

名称

Returns or sets a String containing the name used in code to identify an object. 对于 VBProject 对象和 VBComponent 对象，可读/写。对于 Property 对象和 Reference 对象，只读。

备注

下表描述 Name 属性设置如何应用于不同对象。

Object	使用 Name 属性设置的结果
VBProject	返回或设置活动项目的名称。
VBComponent	返回或设置组件的名称。如果尝试将 Name 属性设置为已在使用的名称或无效的名称，则将发生错误。
属性	返回属性的名称，如“属性浏览器”中所示。此值用于为 Properties 集合编制索引。不可设置该名称。
Reference	返回代码中的引用的名称。不可设置该名称。

新对象的名称是对象的类型加上唯一整数。例如，第一个新的 Form 对象是 Form1，新的 Form 对象是 Form1，在窗体上创建的第三个 TextBox 控件是 TextBox3。

对象的 Name 属性必须以字母开始，且最多包含 40 个字符。它可以包含数字和下划线 (_) 字符，但不能包含标点符号或空格。

窗体和模块不可使用与其他公共对象相同的名称（如 Clipboard、Screen 或 App）。虽然 Name 属性设置可以是关键字、属性名称或另一个对象的名称，但这可造成代码冲突。

NumIndices

返回 Property 对象返回的属性上的索引数。

备注

NumIndices 属性的值可以是 0-4 的整数。对于大多数属性， NumIndices 返回 0。通常，经过索引的属性返回 1。属性数组可能返回 2。

Object

返回或设置由属性返回的对象的值。读/写。

备注

如果 Property 对象返回对象，则必须使用 Object 属性返回或设置该对象的值。

Parent

返回包含其他对象或集合的对象或集合。只读。

备注

大多数对象都有 一个 Parent 属性或一个 Collection 属性，该属性指向此对象模型中对象的父对象。如果父对象是一个集合，则使用 Collection 属性。

使用 Parent 属性可访问某对象的父对象的属性、方法和控件。

另请参阅CodeModule 对象

ProcBodyLine

返回过程的第一行。

语法

对象。ProcBodyLine (procname， prockind) Long

ProcBodyLine 语法包含下列部分：

Part	说明
object	必填。一个对象表达式，该表达式的计算结果为“ 应用于 ”列表中的对象。
procname	必填。包含过程名称的 String。
prockind	必填。指定要查找的过程的类型。因为 Property 过程在模块中可以具有多种表示形式，您必须指定要查找的过程的类型。除属性过程之外的所有过程 (，即 Sub 和 Function 过程) 使用 vbext_pk_Proc。

对 prockind参数使用以下常量之一。

常量	说明
vbext_pk_Get	指定返回属性值的过程。
vbext_pk_Let	指定为某个属性分配值的过程。
vbext_pk_Set	指定设置对某个对象的引用的过程。
vbext_pk_Proc	指定除 Property 过程之外的所有过程。

备注

过程的第一行是 Sub、 Function 或 Property 语句的显示行。

ProcCountLines

返回指定过程中的行数。

语法

对象。ProcCountLines (procname， prockind) As Long

ProcCountLines 的语法包含以下部分：

Part	说明
object	必填。一个对象表达式，该表达式的计算结果为“ 应用于 ”列表中的对象。
procname	必填。包含过程名称的 String。
prockind	必填。指定要查找的过程的类型。因为 Property 过程在模块中可以具有多种表示形式，您必须指定要查找的过程的类型。除属性过程之外的所有过程 (，即 Sub 和 Function 过程) 使用 vbext_pk_Proc。

对 prockind参数使用以下常量之一。

常量	说明
vbext_pk_Get	指定返回属性值的过程。
vbext_pk_Let	指定为某个属性分配值的过程。
vbext_pk_Set	指定设置对某个对象的引用的过程。
vbext_pk_Proc	指定除 Property 过程之外的所有过程。

备注

ProcCountLines 属性返回过程声明之前的所有空行或注释行的计数，如果过程是代码模块中的最后一个过程，则返回过程后面的所有空行数。

ProcOfLine

返回指定行所在的过程的名称。

语法

对象。ProcOfLine (行， prockind) 为字符串

ProcOfLine 语法具有以下部分：

Part	说明
object	必填。一个对象表达式，该表达式的计算结果为“ 应用于 ”列表中的对象。
line	必填。指定要检查的行的长整数。
prockind	必填。指定要查找的过程的类型。因为 Property 过程在模块中可以具有多种表示形式，您必须指定要查找的过程的类型。除属性过程之外的所有过程 (，即 Sub 和 Function 过程) 使用 vbext_pk_Proc。

对 prockind参数使用以下常量之一。

常量	说明
vbext_pk_Get	指定返回属性值的过程。
vbext_pk_Let	指定为某个属性分配值的过程。
vbext_pk_Set	指定设置对某个对象的引用的过程。
vbext_pk_Proc	指定除 Property 过程之外的所有过程。

备注

如果一个行是空白行或前面带有过程声明的注释行，则此行位于过程中；如果过程是代码模块中的最后一个过程，则为一个空白行或过程后面的行。

ProcStartLine

返回指定过程开始的行。

语法

对象。ProcStartLine (procname， prockind) As Long

ProcStartLine 语法包含以下部分：

Part	说明
object	必填。一个对象表达式，该表达式的计算结果为“ 应用于 ”列表中的对象。
procname	必填。包含过程名称的 String。
prockind	必填。指定要查找的过程的类型。因为 Property 过程在模块中可以具有多种表示形式，您必须指定要查找的过程的类型。除属性过程之外的所有过程 (，即 Sub 和 Function 过程) 使用 vbext_pk_Proc。

对 prockind参数使用以下常量之一。

常量	说明
vbext_pk_Get	指定返回某个属性值的过程。
vbext_pk_Let	指定为某个属性分配值的过程。
vbext_pk_Set	指定设置对某个对象的引用的过程。
vbext_pk_Proc	指定除 Property 过程之外的所有过程。

备注

过程从前一过程的 End Sub 语句下面的第一行开始。如果该过程是第一个过程，则它开始于常规 Declarations 部分的末尾。

编程标识符

返回由 VBControl 对象表示的控件的 ProgID（编程 ID）。

语法

对象。ProgID

对象占位符表示一个对象表达式，该表达式的计算结果为“应用于”列表中的对象。

属性

返回对象的属性。只读。

备注

Properties 属性是访问器属性（即，返回与属性名的类型相同的对象的属性）。

保护

Returns a value indicating the state of protection of a project. 只读。

Protection 属性返回以下值：

常量	说明
vbext_pp_locked	指定项目已被锁定。
vbext_pp_none	指定项目未受保护。

参考

返回项目中的引用集。只读。

备注

References 属性是一个访问器属性（即，返回与该属性名称类型相同的对象的属性）。

ReferencesEvents

返回 ReferencesEvents 对象。只读。

设置

您传递到 ReferencesEvents 属性的参数的设置为：

参数	Description
vbproject	如果 vbproject 指向 Nothing，则返回的对象将为 VBProjects 集合中所有 VBProject 对象的 References 集合提供事件。如果 vbproject 指向一个有效 VBProject 对象，则返回的对象将仅为该项目的 References 集合提供事件。

备注

ReferencesEvents 属性获得一个参数并返回一个事件源对象。 ReferencesEvents 对象是在添加或删除引用时触发的事件的源。

Saved

返回一个布尔值，该值指示对象自上次保存以来是否被编辑过。读/写。

“Saved”属性返回以下值：

值	说明
True	最后一次保存对象之后，没有编辑该对象。
False	最后一次保存对象之后，编辑了该对象。

备注

SaveAs 方法将 Saved 属性设置为 True。

注意

If you set the Saved property to False in code, it returns False, and the object is marked as if it were edited since the last time it was saved.

SelectedVBComponent

Returns the selected component. 只读。

备注

SelectedVBComponent 属性返回“项目”窗口中的选定组件。如果“项目”窗口中的选定项不是组件， 则 SelectedVBComponent 返回 Nothing。

另请参阅VBE 对象。

顶部

返回或设置用于指定窗口顶部在屏幕上的位置的 Single（以缇为单位）。读/写。

备注

Top 属性返回的值取决于窗口是停靠的、链接的还是停靠视图中的。

注意

[!注释] 只要窗口保持链接或停靠状态，则更改链接的或停靠的窗口的 Top 属性设置没有影响。

重要

TopLine

返回一个 Long 类型的值，指定代码窗格顶部的行号，或设置代码窗格顶部显示的行。读/写。

备注

使用 TopLine 属性可返回或设置在代码窗格顶部显示的行。例如，如果您希望第 25 行是在代码窗口中显示的第一行，则您可将 TopLine 属性设置为 25。

TopLine 属性设置必须是正数。如果 TopLine 属性设置大于代码窗格中的实际行数，则设置将是代码窗格中的最后一行。

类型

返回包含对象类型的数字或字符串值。只读。

下表介绍了 Window 对象的 Type 属性设置。

常量	值	Description
vbext_wt_CodeWindow	0	“代码”窗口
vbext_wt_Designer	1	Designer
vbext_wt_Browser	2	对象浏览器
vbext_wt_Immediate	5	“即时”窗口
vbext_wt_ProjectWindow	6	项目窗口
vbext_wt_PropertyWindow	7	“属性”窗口
vbext_wt_Find	8	“查找 ”对话框
vbext_wt_FindReplace	9	“搜索和替换 ”对话框
vbext_wt_LinkedWindowFrame	11	链接窗口框架
vbext_wt_MainWindow	12	主窗口
vbext_wt_Watch	3	“监视”窗口
vbext_wt_Locals	4	“局部变量”窗口
vbext_wt_Toolbox	10	工具箱
vbext_wt_ToolWindow	15	工具窗口

重要

下表介绍了 VBComponent 对象的 Type 属性设置。

常量	值	Description
vbext_ct_StdModule	1	标准模块
vbext_ct_ClassModule	2	类模块
vbext_ct_MSForm	3	Microsoft 窗体
vbext_ct_ActiveXDesigner	11	ActiveX 设计器
vbext_ct_Document	100	文档模块

下表介绍了 Reference 对象的 Type 属性设置。

常量	值	Description
vbext_rk_TypeLib	0	类型库
vbext_rk_Project	1	项目

下表介绍了 VBProject 对象的 Type 属性设置。

常量	值	Description
vbext_pt_HostProject	100	宿主项目
vbext_pt_StandAlone	101	独立项目

值

返回或设置指定属性的值的变量。读/写。

备注

由于 Value 属性返回 Variant，因此，您可以访问任何属性。若要访问列表，请使用 IndexedValue 属性。

如果 Property 对象表示的属性是读/写，则 Value 属性为可读/写。如果属性是只读的，则尝试设置 Value 属性将导致出现错误。如果属性是只写的，则尝试返回 Value 属性将导致出现错误。

Value 属性为 Property 对象的默认属性。

VBComponents

返回项目所包含组件的集合。

备注

使用 VBComponents 集合访问、添加或删除项目中的组件。组件可以是窗体、模块或类。 VBComponents 集合是可在 For... 中使用的标准集合。每个块。

使用 Parent 属性可返回 VBComponents 集合中的项目。

在 Visual Basic for Applications中，可以使用 Import 方法从文件向项目添加组件。

有关详细信息，请参阅 VBComponent 对象和 SelectedVBComponent 属性。

VBE

返回 VBE 对象的根。只读。

备注

所有对象都具有指向 VBE 对象的根的 VBE 属性。

VBProjects

返回 VBProjects 集合，该集合代表 Visual Basic IDE 中当前打开的所有项目。

语法

对象。VBProjects

对象占位符表示一个对象表达式，该表达式的计算结果为“应用于”列表中的对象。

版本

返回一个包含应用程序正在使用的 Visual Basic for Applications 版本的字符串。只读。

备注

Version 属性值是以一个或两个数字、一个句点和两个数字开头的字符串；字符串的其余部分未定义，可能包含文本或数字。

Visible

对于 Window 对象，返回或设置一个布尔值，该值指定窗口的可见性。读/写。

对于 CodePane 对象，返回一个布尔值，该值指示代码窗格在窗口中是否可见。只读。

Visible 属性返回以下值：

值	说明
True	（默认）显示对象。
False	对象隐藏。

Width

返回或设置 Single，其中包含用二十分之一磅表示的窗口宽度。读/写。

备注

更改链接窗口或停靠窗口的 Width 属性设置在该窗口保持链接或停靠状态时不起作用。

重要

Window

返回其中显示代码窗格的窗口。只读。

Windows

返回 Window 对象，该对象表示 Visual Basic IDE 中的窗口。

语法

对象。窗口

对象占位符表示一个对象表达式，该表达式的计算结果为“应用于”列表中的对象。

WindowState

返回或设置一个数值，该值指定窗口的视觉状态。读/写。

设置

WindowState 属性返回或设置以下值：

常量	值	Description
vbext_ws_Normal	0	（默认）正常
vbext_ws_Minimize	1	最小化（最小化为图标）
vbext_ws_Maximize	2	最大化（放大为最大大小）

另请参阅

支持和反馈

有关于 Office VBA 或本文档的疑问或反馈？请参阅 Office VBA 支持和反馈，获取有关如何接收支持和提供反馈的指南。