Add 方法

创建自定义文档属性。然后返回一个 DocumentProperty 对象。

要使用此方法，必须用“工具”菜单上的“引用”命令建立对 Microsoft Office 95 对象库的引用。

句法

object.Add(name, linkToContent, type, value, linkSource)

object

必须的。为 DocumentProperties 集合对象。

name

必须的。属性名称。

linkToContent

必须的，指定属性是否与文档内容链接。如果为 True，则必须指定 linkSource 参数，如果为 False，必须指定 value 参数。

type

必须的。属性的数据类型（可为下列之一：offPropertyTypeBoolean、offPropertyTypeDate、offPropertyTypeFloat、offPropertyTypeString 或offPropertyTypeNumber）。

value

可选的。如果属性不与宿主文档的内容链接，则为属性的值。如果可能，此值被转换成与 type 参数指定的类型相一致的类型，否则将产生错误。如果 linkToContent 为 True，这个参数被忽略，新文档属性将采用默认值，直到链接的属性值被宿主应用程序更新（通常发生在保存文档时）。

linkSource

可选的。如果 linkToContent 为 False，为链接属性的源。宿主应用程序将决定运行哪一种源链接。要了解有关详细内容，可单击本主题上方的“规范”。

说明

本方法不能与内置文档属性对象一起使用。


Add 方法示例

本示例添加一个新的自定义文档属性。 您必须向此函数传递一个自定义的 DocumentProperties 集合对象。

Sub AddCustomProperty(dp As DocumentProperties)

    dp.Add name:="Complete", linkToContent:=False, _

        type:=offPropertyTypeBoolean, value:=False

End Sub


Count 属性

返回 DocumentProperties 集合中的文档属性数目。只读。

要使用本属性，必须用“工具”菜单上的“引用”命令建立对 Microsoft Office 95 对象库的引用。


Count 属性示例

本示例显示集合中的属性数，您必须向该函数传递一个  DocumentProperties 集合。

Sub CountDocumentProperties(dp As DocumentProperties)

    MsgBox "There are " & dp.Count & " properties in the collection."

End Sub


Delete 方法

删除自定义的文档属性（内置属性不能删除）。

要使用此方法，必须用“工具”菜单上的“引用”命令建立对 Microsoft Office 95 对象库的引用。


Delete 方法示例

本示例删除一个自定义的文档属性。您必须向该函数传递一个 DocumentProperty 对象。

Sub DeleteCustomDocumentProperty(dp As DocumentProperty)

    dp.Delete

End Sub


DocumentProperties 集合对象

代表一个文档属性的集合。每一个文档属性由 DocumentProperty 对象来表示。

要使用此对象，必须用“工具”菜单上的“引用”命令建立对 Microsoft Office 95 对象库的引用。

用 BuiltinDocumentProperties 属性可返回内部文档属性集合，用 CustomDocumentProperties 属性可返回自定义文档属性集合。要了解有关如何从宿主应用程序中返回文档属性的详细内容，请单击本主题上方的“规范”。

用 Add 方法可以创建新的自定义文档属性，并添加到集合中（您不能创建内置文档属性）。


DocumentProperty 对象

代表某个文档属性。DocumentProperty 对象是 DocumentProperties 集合的成员。

要使用此方法，必须用“工具”菜单上的“引用”命令建立对 Microsoft Office 95 对象库的引用。

用 BuiltinDocumentProperties 属性可返回内置文档属性的集合，用 CustomDocumentProperties 属性可返回自定义文档属性的集合。用 Item 方法可返回集合中的成员。要了解有关从宿主程序中返回单个文档属性的详细内容，请单击本主题顶端的“规范”。


Item 方法

从文档属性集合中返回单个 DocumentProperty 对象。

要使用此方法，必须用“工具”菜单上的“引用”命令建立对 Microsoft Office 95 对象库的引用。

说明

Item 方法是 DocumentProperties 集合对象的默认方法，下列语句是等效的。

CustomDocumentProperties.Item(1)

CustomDocumentProperties(1)

用索引号和名称都可以引用文档属性。下面列出可用的内置文档属性名称。

Title, Subject, Author, Keywords, Comments, Template, Last Author, Revision Number, Application Name, Last Print Date, Creation Date, Last Save Time, Total Editing Time, Number of Pages, Number of Words, Number of Characters, Security, Category, Format, Manager, Company, Number of Bytes, Number of Lines, Number of Paragraphs, Number of Slides, Number of Notes, Number of Hidden Slides, Number of Multimedia Clips.

宿主应用程序不要求定义每一个内置文档属性的值。如果应用程序未定义某个内置文档属性的值，用 Value 属性读取该值将导致错误。


Item 方法示例

本示例显示集合中的文档属性名称。您必须向该函数传递一个 DocumentProperties 集合。

Sub DisplayPropertyNames(dp As DocumentProperties)

    Dim i As Integer

    For i = 1 To dp.Count

        MsgBox dp.Item(i).Name

    Next

End Sub


LinkToContent 属性

如果自定义文档属性与宿主文档的内容链接，为 True ，如果值是静态的，为 False。只写。

要使用此属性，必须用“工具”菜单上的“引用”命令建立对 Microsoft Office 95 对象库的引用。

说明

本属性只适用于自定义文档属性。对内置文档属性，此属性总为 False。

用 LinkSource 属性可设置链接属性的源。如果设置了 LinkSource 属性，则 LinkToContent 属性将为 True。

要了解有关在宿主程序中设置本属性的详细内容，请单击本主题顶端的“规范”。


LinkToContent 属性示例

本示例显示自定义文档属性的链接情况。您必须向该函数传递一个 DocumentProperty 对象。

Sub DisplayLinkStatus(dp As DocumentProperty)

    Dim stat As String, tf As String

    If dp.LinkToContent Then

        tf = ""

    Else

        tf = "not "

    End If

    stat = "This property is " & tf & "linked"

    If dp.LinkToContent Then

        stat = stat + Chr(13) & "The link source is " & dp.LinkSource

    End If

    MsgBox stat

End Sub


LinkSource 属性

返回或设置指定的链接属性的源。只写。

要使用此属性，必须用“工具”菜单上的“引用”命令建立对 Microsoft Office 95 对象库的引用。

说明

链接的源由宿主应用程序定义。有关链接源的详细内容，请单击本主题上方的“规范”。

这个属性不能用于内置文档属性。

设置 LinkSource 属性，将使 LinkToContent 属性为 True。


LinkSource 属性示例

本示例显示自定义文档属性的链接状态。您必须向该函数传递一个 DocumentProperty 对象。

Sub DisplayLinkStatus(dp As DocumentProperty)

    Dim stat As String, tf As String

    If dp.LinkToContent Then

        tf = ""

    Else

        tf = "not "

    End If

    stat = "This property is " & tf & "linked"

    If dp.LinkToContent Then

        stat = stat + Chr(13) & "The link source is " & dp.LinkSource

    End If

    MsgBox stat

End Sub


Name 属性

返回或设置文档属性的名称。对内置文档属性，只读；对自定义文档属性，只写。

要使用此属性，必须用“工具”菜单上的“引用”命令建立对 Microsoft Office 95 对象库的引用。

要查阅内置文档属性的列表，请参阅 Item 方法。


Name Property Example
Name Property 示例

本示例显示文档属性的名称、类型和值。您必须向该函数传递一个 DocumentProperty 对象。

Sub DisplayPropertyInfo(dp As DocumentProperty)

    MsgBox "value = " & dp.Value & Chr(13) & _

        "type = " & dp.Type & Chr(13) & _

        "name = " & dp.Name

End Sub


Parent 属性

存取器。返回指定对象的父对象。只读。

要使用此属性，必须用“工具”菜单上的“引用”命令建立对 Microsoft Office 95 对象库的引用。


Parent 属性示例

本示例显示文档属性的父对象的名称。您必须向此函数传递一个 DocumentProperty 对象。

Sub DisplayParent(dp as DocumentProperty)

MsgBox dp.Parent.Name

End Sub


Type 属性

返回或设置文档属性的类型（可为 offPropertyTypeBoolean、offPropertyTypeDate, offPropertyTypeFloat、offPropertyTypeNumber、或 offPropertyTypeString）。对内置文档属性，只读。对自定义文档属性，只写。

要使用此属性，必须用“工具”菜单上的“引用”命令建立对 Microsoft Office 95 对象库的引用。


Type 属性示例

本示例显示文档属性的名称、类型和取值。您必须向该函数传递一个 DocumentProperty 对象。

Sub DisplayPropertyInfo(dp As DocumentProperty)

    MsgBox "value = " & dp.Value & Chr(13) & _

        "type = " & dp.Type & Chr(13) & _

        "name = " & dp.Name

End Sub


Value 属性

返回或设置文档属性的值。只写。

要使用此属性须用“工具”菜单上的“引用”命令建立对 Microsoft Office 95 对象库的引用。

说明

如果应用程序没有为某个内置属性定义取值，读取该文档属性的 Value 属性将导致错误。


Value 属性示例

本示例显示文档属性的名称、类型和取值。您必须向该函数传递一个 DocumentProperty 对象。

Sub DisplayPropertyInfo(dp As DocumentProperty)

    MsgBox "value = " & dp.Value & Chr(13) & _

        "type = " & dp.Type & Chr(13) & _

        "name = " & dp.Name

End Sub


 使用 Microsoft Office 95 对象库

在 Visual Basic 中使用自定义或内置的文档属性时，必须用“工具”菜单中的“引用”命令建立对 Microsoft Office 95 对象库的引用。在“引用”对话框中，选中对象库名称旁边的复选框。

这个对象库中定义了 Visual Basic 对象及其属性、方法，还有操作文档属性的常量。在 Visual Basic 中，不需要引用 Microsoft Office 95 对象库就可以使用文档属性，但不能使用已命名的常量或句法检查，以及声明类型为 DocumentProperty 或 DocumentProperties 的对象变量，或使用对象浏览器及正文帮助。