_Application.GetAddress Method

Definition

Namespace:

Microsoft.Office.Interop.Word

Assembly:

Microsoft.Office.Interop.Word.dll

Returns an address from the default address book.

public string GetAddress (ref object Name, ref object AddressProperties, ref object UseAutoText, ref object DisplaySelectDialog, ref object SelectDialog, ref object CheckNamesDialog, ref object RecentAddressesChoice, ref object UpdateRecentAddresses);

abstract member GetAddress : obj * obj * obj * obj * obj * obj * obj * obj -> string

Public Function GetAddress (Optional ByRef Name As Object, Optional ByRef AddressProperties As Object, Optional ByRef UseAutoText As Object, Optional ByRef DisplaySelectDialog As Object, Optional ByRef SelectDialog As Object, Optional ByRef CheckNamesDialog As Object, Optional ByRef RecentAddressesChoice As Object, Optional ByRef UpdateRecentAddresses As Object) As String

Parameters

Name

Object

Optional Object. The name of the addressee, as specified in the Search Name dialog box in the address book.

AddressProperties

Object

Optional Object. If UseAutoText is True, this argument denotes the name of an AutoText entry that defines a sequence of address book properties. If UseAutoText is False or omitted, this argument defines a custom layout. Valid address book property names or sets of property names are surrounded by angle brackets ("<" and ">") and separated by a space or a paragraph mark (for example, "<PR_GIVEN_NAME> <PR_SURNAME>" & vbCr & "<PR_OFFICE_TELEPHONE_NUMBER>").If this argument is omitted, a default AutoText entry named "AddressLayout" is used. If "AddressLayout" hasn't been defined, the following address layout definition is used: "<PR_GIVEN_NAME> <PR_SURNAME>" & vbCr & "<PR_STREET_ADDRESS>" & vbCr & "<PR_LOCALITY>" & ", " & "<PR_STATE_OR_PROVINCE>" & " " & "<PR_POSTAL_CODE>" & vbCr & "<PR_COUNTRY>".For a list of the valid address book property names, see the AddAddress(Array, Array) method.

UseAutoText

Object

Optional Object. True if AddressProperties specifies the name of an AutoText entry that defines a sequence of address book properties; False if it specifies a custom layout.

DisplaySelectDialog

Object

Optional Object. Specifies whether the Select Name dialog box is displayed, as shown in the following table.ValueResult0 (zero)The Select Name dialog box isn't displayed.1 or omittedThe Select Name dialog box is displayed.2The Select Name dialog box isn't displayed, and no search for a specific name is performed. The address returned by this method will be the previously selected address.

SelectDialog

Object

Optional Object. Specifies how the Select Name dialog box should be displayed (that is, in what mode), as shown in the following table.ValueDisplay mode0 (zero) or omittedBrowse mode1Compose mode, with only the To: box2Compose mode, with both the To: and CC: boxes

CheckNamesDialog

Object

Optional Object. True to display the Check Names dialog box when the value of the Name argument isn't specific enough.

RecentAddressesChoice

Object

Optional Object. True to use the list of recently used return addresses.

UpdateRecentAddresses

Object

Optional Object. True to add an address to the list of recently used addresses; False to not add the address. If SelectDialog is set to 1 or 2, this argument is ignored.

Returns

String