FormatAddress

Formats the address of a range according to specified options. Effectively does the formatting part of the Copy Address function provided by the OAK user interface, but does not copy the result to the clipboard.

Applies to

IOAKAPI

SYNTAX

expression.FormatAddress (source, prefixAllRegions, bookPrefix, sheetPrefix, a1, absolute, delimiterType, extraSpace)

expression   Required.  An expression that returns an IOAKAPI object.

result   An OAKResult enumeration indicating the success or otherwise of the action.

source                        Required Range.  The cells that supply the address. This can be a multi-area range.

prefixAllRegions        Required Boolean.  Specifies whether to prefix all areas in the source range.

bookPrefix                Required Boolean.  Specifies whether to include the workbook in the prefix.

sheetPrefix                Required Boolean.  Specifies whether to include the worksheet in the prefix.

a1                        Required Boolean.  Specifies A1 notation (true) or RC notation (false).

absolute                Required Boolean.  Specifies whether addresses will be absolute.

delimiter                Required FormatAddressDelimiter.  Specifies the delimiter used in the result.

extraSpace                Required Boolean.  Specifies if a space should be added after the delimiter..

Remarks

The FormatAddress function acts on the current selection in the same way as the Copy Address command does.

The equivalent method in the IOAKAddIn interface is IOAKAddIn.CopyAddress. This method activates the CopyAddress user interface.