Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

New-SPExcelUserDefinedFunction

Published: May 12, 2010

Adds a new user-defined function to Excel Services Application.

New-SPExcelUserDefinedFunction -Assembly <String> -ExcelServiceApplication <SPExcelServiceApplicationPipeBind> [-AssemblyLocation <GAC | LocalFile>] [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Description <String>] [-Enable <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Parameters

 

Parameter Required Type Description

Assembly

Required

System.String

Specifies the strongly typed name of the assembly. The name must be unique in the list of user-defined functions. The name can be a maximum of 4096 alphanumeric characters.

The type must be a string of alphanumeric characters; for example:

-- SampleCompany.SampleApplication.SampleUdf

-- C:\UDFs\SampleUdf.dll

-- \\MyNetworkServer\UDFs\SampleUdf.dll

ExcelServiceApplication

Required

Microsoft.Office.Excel.Server.Cmdlet.SPExcelServiceApplicationPipeBind

Specifies the Excel Services Application Web service application that contains the list of user-defined functions.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of an Excel Services Application Web service application in the farm (for example, MyExcelService1); or an instance of a valid SPExcelServiceApplication object.

AssemblyLocation

Optional

Microsoft.Office.Excel.Server.AssemblyLocation

Specifies the location where the assembly is stored. The default value is GAC.

The type must be one of the following: GAC or LocalFile.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

note Note:

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Confirm

Optional

System.Management.Automation.SwitchParameter

Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters

Description

Optional

System.String

Specifies a friendly description for the user-defined function. The name can be a maximum of 4096 alphanumeric characters. The default value is an empty string.

The type must be a valid string of alphanumeric characters; for example, this is the user-defined function for consolidation reports.

Enable

Optional

System.Management.Automation.SwitchParameter

Activates the user-defined function for use with Excel Services Application. The default value is True.

WhatIf

Optional

System.Management.Automation.SwitchParameter

Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters

Detailed Description

The New-SPExcelUserDefinedFunction cmdlet adds a user-defined function to an Excel Services Application Web service application. Excel Services Application uses only user-defined functions that have an entry in the list of user-defined functions. User-defined functions are managed code assemblies that can be called from an Excel Services Application workbook by using standard Excel Services Application formula syntax. The assemblies can perform custom logic or other actions, such as refresh data. Windows PowerShell cmdlets operate on the entries that are in the list of user-defined functions, but they do not operate on the assemblies.

Input Types

 

Return Types

 

--------------EXAMPLE 1--------------

New-SPExcelUserDefinedFunction –ExcelServiceApplication "MyExcelService" –Assembly "SampleCompany.SampleApplication.SampleUdf" –AssemblyLocation GAC

This example adds the SampleComany.SampleApplication.SampleUdf file to the Excel Services Application Web service application named MyExcelService as a new user-defined function.

The user-defined function assembly is deployed to the global assembly cache (GAC).

--------------EXAMPLE 2--------------

Get-SPExcelServiceApplication | New-SPExcelUserDefinedFunction –Assembly "SampleCompany.SampleApplication.SampleUdf" –AssemblyLocation GAC

This example adds the SampleComany.SampleApplication.SampleUdf file to every Excel Services Application Web service application in the farm.

The user-defined function assembly is deployed to the global assembly cache (GAC).

Change History

 

Date Description Reason

May 12, 2010

Initial publication

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.