WPS 基础接口 > 文字 API 参考 > Application > 方法 > Application.GetAddress 方法
返回默认通讯簿中的地址。

语法

表达式.GetAddress(Name, AddressProperties, UseAutoText, DisplaySelectDialog, SelectDialog, CheckNamesDialog, RecentAddressesChoice, UpdateRecentAddresses)

表达式   必选。一个代表 Application 对象的变量。

参数

名称 必选/可选 数据类型 说明
Name 可选 Variant 收件人姓名,与通讯簿中“查找姓名”对话框中所指定的相同。
AddressProperties 可选 Variant 如果 UseAutoTextTrue,则该参数代表定义通讯簿属性系列的“自动图文集”词条的名称。

如果 UseAutoTextFalse 或被省略,则该参数定义自定义布局。有效通讯簿属性名称或属性名称集合用尖括号(“<”和“>”)括起来并用空格或段落标记隔开(例如,“<PR_GIVEN_NAME> <PR_SURNAME>”& vbCr &“<PR_OFFICE_TELEPHONE_NUMBER>”)。

如果省略 AddressProperties 参数,则使用名为“AddressLayout”的默认“自动图文集”词条。如果还没有定义“AddressLayout”,则使用下面的地址布局定义:"<PR_GIVEN_NAME> <PR_SURNAME>" & vbCr & "<PR_STREET_ADDRESS>" & vbCr & "<PR_LOCALITY>" & ", " & "<PR_STATE_OR_PROVINCE>" & " " & "<PR_POSTAL_CODE>" & vbCr & "<PR_COUNTRY>"。

要获取有效的通讯簿属性名列表,请参阅 AddAddress 方法。

UseAutoText 可选 Variant 如果 AddressProperties 指定了定义通讯簿属性系列的“自动图文集”词条的名称,则为 True;如果它指定了一个自定义布局,则为 False
DisplaySelectDialog 可选 Variant 指定是否显示“选择姓名”对话框,如下表所示。
说明
0(零) 不显示“选择姓名”对话框。
1 或省略 显示“选择姓名”对话框。
2 不显示“选择姓名”对话框,并且不搜索指定的姓名。该方法返回的地址将是以前选择的地址。
SelectDialog 可选 Variant 指定“选择姓名”对话框的显示方式(即以何种模式显示),如下表所示。
显示模式
0(零)或省略 浏览模式
1 紧凑模式,只显示“收件人:”
2 紧凑模式,“收件人:”“抄送:”框都显示
CheckNamesDialog 可选 Variant 如果该属性值为 True,则在 Name 参数的值不够具体时显示“检查姓名”对话框。
RecentAddressesChoice 可选 Variant 如果该属性值为 True,则使用最近使用的回信地址列表。
UpdateRecentAddresses 可选 Variant 如果该属性值为 True,则向最近使用的地址列表中添加一个地址;如果该属性值为 False,则不添加地址。如果 SelectDialog 设置为 1 或 2,则忽略该参数。

返回值
String

说明

示例

本示例将 John Smith 的地址赋给变量 strAddress,将插入点移到文档的开头,并插入地址。插入的地址包括默认的通讯簿属性。

示例代码
let strAddress

strAddress = Application.GetAddress("John Smith",null,null,null,null,true)
ActiveDocument.Range(0,0).InsertAfter(strAddress)

以下示例返回 John Smith 的地址,使用“My Address Layout”自动图文集词条作为布局定义。“My Address Layout”在活动模板中定义,它包括一组指定给变量 text$ 的地址属性。本示例还将 John Smith 的地址添加到最近使用的地址列表中。

示例代码
let TagIDArray = [0,1,2,3]
let ValueArray = [0,1,2,3]
let strAddress 

TagIDArray[0] = "PR_DISPLAY_NAME"
TagIDArray[1] = "PR_GIVEN_NAME"
TagIDArray[2] = "PR_SURNAME"
TagIDArray[3] = "PR_COMMENT"
ValueArray[0] = "Display_Name"
ValueArray[1] = "John"
ValueArray[2] = "Smith"
ValueArray[3] = "This is a comment"

Application.AddAddress(TagIDArray,ValueArray)
strAddress = Application.GetAddress("John Smith",null,null,null,null,null,null,true)


请参阅