Looking up the value for MS Office Interop constants rather than hard coding them

Question

Using PowerShell, it is easy enough to create, say, an instance of the Excel Application class and start manipulating it:

$app = New-Object -ComObject "Excel.Application"

However, if I need to use the constants like xlDoubleQuote or xlDelimited - it seems like I am forced to hard code them. I would really like to be able to do something like:

$constants = New-Object -ComObject "Excel.Constants"
$constants.xlDoubleQuote

And see that it would return the value of 1. Unfortunately I can't create an instance of an enumeration, and there doesn't seem to be a way to reference it like you would a normal .NET class library:

[Excel.Constants]::xlDoubleQuote

Is there some way to dynamically import that enumeration into PowerShell? Maybe through the managed libraries rather than COM?

score 9 · Answer 1 · answered Nov 24 '10 at 23:33

9

Use the primary interop assembly for Excel. If you have Office installed these should be in the GAC. Use like so:

Add-Type -AssemblyName Microsoft.Office.Interop.Excel
[int][Microsoft.Office.Interop.Excel.Constants]::xlDoubleQuote

answered Nov 24 '10 at 23:33

Keith Hill

194,368
42
353
369

1

Or: [Microsoft.Office.Interop.Excel.Constants]::xlDoubleQuote.Value__ – Shay Levy Nov 25 '10 at 14:30
This is best, but it seems like Visio is not treated the same way. A barely acceptable work-around (takes around 12 seconds to populate the hash) is described in another answer below. – Justin Nov 19 '18 at 23:02

Shay Levy · Accepted Answer · 2010-11-26T14:55:43.353

Keith already gave you the answer, here's another option. You can use tab completion on the $xlConstants object to get the constants:

$xl = New-Object -ComObject Excel.Application
$constants = $xl.gettype().assembly.getexportedtypes() | where-object {$_.IsEnum -and $_.name -eq 'constants'}

$pso = new-object psobject
[enum]::getNames($constants) | foreach { $pso | Add-Member -MemberType NoteProperty $_ ($constants::$_) }
$xlConstants = $pso

score 1 · Answer 3 · edited May 23 '17 at 12:16

1

Keith and Shay gave perfect answers, however, note this:

When using Excel 2003 or Excel 2007, the Office Primary Interop Assemblies (PIAs) should be installed on the machine. There are redistributable versions available from Microsoft. See this stackoverflow.com posting here for more info:

Different Interop references on two different computers doesn't work

edited May 23 '17 at 12:16

Community

1
1

answered Jul 21 '11 at 09:29

knb

9,138
4
58
85

score 0 · Answer 4 · answered Nov 19 '18 at 23:13

Using Visio 2016 32-bit, I found that attempting to use Keith Hill's approach resulted in error message: "Add-Type : Cannot add type. The assembly 'Microsoft.Office.Interop.Visio' could not be found." Shay Levy's approach required a bit more modification to work with Visio. Here is what I was able to get working:

$visioApp = New-Object -ComObject Visio.Application 
$visioConstants = @{}

$visioEnums = $visioApp.gettype().assembly.getexportedtypes() | where-object {$_.IsEnum } #-and $_.name -eq 'constants'}

The answers of Keith Hill and Shay Levy are best, however, I found that Visio 
$visioEnums |%{
    $enumname = $_
    [enum]::getNames($enumname) | foreach {
        $val = invoke-expression "[$($enumname)]::$($_).value__"
        $visConstants.$_ = $val
    }
}
$visioApp.Quit()

echo $visConstants.visTopEdge

Disappointingly, it takes around 12 seconds to execute when I tested.

mklement0 · Answer 5 · 2019-03-24T15:49:30.127

To combine the technique from Keith Hill's helpful answer with the tab-completion idea from Shay Levy's answer:

# Instantiate Excel, which implicitly loads the interop
# assembly that contains the [enum] type of interest.
# Assign to $null, if you're not planning on using the object further.
$xl = New-Object -ComObject Excel.Application

# Store the [enum] type of interest in a variable for easier access.
$xlConstants = [Microsoft.Office.Interop.Excel.Constants]

Note: To find the full name of the Constants type, you can use tab completion: after having run New-Object -ComObject Excel.Application, type [constants<tab> (don't type the closing ]), which should expand to [Microsoft.Office.Interop.Excel.Constants; if a type from a namespace other than Microsoft.Office.Interop.Excel shows up, press the tab key until the desired type is found.

Now you can:

Access the individual enumeration values as static members of the type stored in $xlConstants, via the :: operator, which also works with tab completion; e.g.:
```
$xlConstants::xl3d<tab>  # -> expands to $xlConstants::xl3DBar
```
Get a specific value's underlying number by either casting to [int] or accessing the .Value__ property:
```
[int] $xlConstants::xl3DBar    # -> -4099

$xlConstants::xl3DBar.Value__  # ditto
```
Enumerate all symbolic names:
```
[enum]::GetNames($xlConstants)
```

Also show the numbers underlying the symbolic names:

PS> [enum]::GetNames($xlConstants) |
    Select @{ n='Name'; e={$_} }, @{ n='Number'; e={ $xlConstants::$_.Value__ } }

Name            Number
----            ------
xlAbove              0
xlFirst              0
xlDirect             1
# ...

Looking up the value for MS Office Interop constants rather than hard coding them

5 Answers5

Linked