New-SPExcelUserDefinedFunction
Adiciona uma nova função definida pelo usuário ao Aplicativo de Serviços do Excel.
Sintaxe
Default (Default)
New-SPExcelUserDefinedFunction
-Assembly <String>
-ExcelServiceApplication <SPExcelServiceApplicationPipeBind>
[-AssemblyLocation <AssemblyLocation>]
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-Description <String>]
[-Enable]
[-WhatIf]
[<CommonParameters>]
Description
O New-SPExcelUserDefinedFunction cmdlet adiciona uma função definida pelo usuário a um aplicativo de serviço Web do Aplicativo de Serviços do Excel.
O Aplicativo de Serviços do Excel usa apenas funções definidas pelo usuário que têm uma entrada na lista de funções definidas pelo usuário.
As funções definidas pelo usuário são assemblies de código gerenciados que podem ser chamados de uma pasta de trabalho do Aplicativo de Serviços do Excel usando a sintaxe de fórmula padrão do Aplicativo de Serviços do Excel.
Os assemblies podem executar ações lógicas personalizadas ou outras ações, como atualizar dados.
Os cmdlets do Windows PowerShell operam nas entradas na lista de funções definidas pelo usuário, e não nos assemblies.
Para obter as permissões e informações mais recentes sobre o Windows PowerShell para Produtos SharePoint, confira a documentação online em Cmdlets do SharePoint Server.
Exemplos
EXEMPLO
Get-SPExcelServiceApplication | New-SPExcelUserDefinedFunction -Assembly "SampleCompany.SampleApplication.SampleUdf" -AssemblyLocation GAC
Este exemplo adiciona o arquivo SampleComany.SampleApplication.SampleUdf a todos os aplicativos de serviço Web do aplicativo de Serviços do Excel no farm.
O assembly de função definida pelo usuário é implantado no GAC (cache de assembly global).
Parâmetros
-Assembly
Aplicável: SharePoint Server 2010, SharePoint Server 2013
Especifica o nome fortemente tipado do assembly. O nome deve ser exclusivo na lista de funções definidas pelo usuário. O nome pode ter, no máximo, 4096 caracteres alfanuméricos.
O tipo deve ser uma cadeia de caracteres alfanuméricos; por exemplo:
-- SampleCompany.SampleApplication.SampleUdf -- C:\UDFs\SampleUdf.dll -- \\MyNetworkServer\UDFs\SampleUdf.dll
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-AssemblyLocation
Aplicável: SharePoint Server 2010, SharePoint Server 2013
Especifica o local em que o assembly é armazenado. O valor padrão é GAC.
O tipo deve ser um dos seguintes: GAC ou LocalFile.
Propriedades do parâmetro
| Tipo: | AssemblyLocation |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-AssignmentCollection
Aplicável: SharePoint Server 2010, SharePoint Server 2013
Gerencia objetos para o devido descarte. O uso de objetos como SPWeb ou SPSite pode consumir grandes quantidades de memória e o uso desses objetos em scripts do Windows PowerShell requer gerenciamento de memória adequado. Usando o objeto SPAssignment, você poderá atribuir objetos a uma variável e descartar os objetos após o uso para liberar memória. Quando objetos SPWeb, SPSite ou SPSiteAdministration são usados, os objetos são automaticamente descartados se um conjunto de atribuições ou o parâmetro Global não forem usados.
Quando o parâmetro Global é usado, todos os objetos estão contidos no repositório global.
Quando os objetos não são usados imediatamente ou são descartados com o uso do comando Stop-SPAssignment, pode ocorrer um cenário de memória insuficiente.
Propriedades do parâmetro
| Tipo: | SPAssignmentCollection |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Confirm
Aplicável: SharePoint Server 2010, SharePoint Server 2013
Solicita sua confirmação antes de executar o comando.
Para saber mais, digite o seguinte comando: get-help about_commonparameters
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | cf |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Description
Aplicável: SharePoint Server 2010, SharePoint Server 2013
Especifica uma descrição amigável para a função definida pelo usuário. O nome pode conter no máximo 4096 caracteres alfanuméricos. O valor padrão é uma cadeia de caracteres vazia.
O tipo deve ser uma cadeia válida de caracteres alfanuméricos; por exemplo, a função definida pelo usuário para a consolidação de relatórios.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Enable
Aplicável: SharePoint Server 2010, SharePoint Server 2013
Ativa a função definida pelo usuário para uso com o Aplicativo de Serviços do Excel. O valor padrão é True.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ExcelServiceApplication
Aplicável: SharePoint Server 2010, SharePoint Server 2013
Especifica o aplicativo de serviços da Web do aplicativo de Serviços do Excel que contém a lista de funções definidas pelo usuário.
O tipo deve ser um GUID válido, no formato 12345678-90ab-cdef-1234-567890bcdefgh; um nome válido de um aplicativo de serviço Web do aplicativo de Serviços do Excel no farm (por exemplo, MyExcelService1); ou uma instância de um objeto SPExcelServiceApplication válido.
Propriedades do parâmetro
| Tipo: | SPExcelServiceApplicationPipeBind |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-WhatIf
Aplicável: SharePoint Server 2010, SharePoint Server 2013
Exibe uma mensagem que descreve o efeito do comando em vez de executar o comando.
Para saber mais, digite o seguinte comando: get-help about_commonparameters
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | wi |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet dá suporte aos parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, confira about_CommonParameters.