Set-SPExcelUserDefinedFunction
Задает свойства пользовательской функции в приложении служб Excel.
Синтаксис
Default (по умолчанию)
Set-SPExcelUserDefinedFunction
[-Identity] <SPExcelUDFPipeBind>
-ExcelServiceApplication <SPExcelServiceApplicationPipeBind>
[-Assembly <String>]
[-AssemblyLocation <AssemblyLocation>]
[-AssignmentCollection <SPAssignmentCollection>]
[-Confirm]
[-Description <String>]
[-Enable]
[-WhatIf]
[<CommonParameters>]
Описание
Командлет Set-SPExcelUserDefinedFunction задает свойства сборки определяемой пользователем функции.
приложение службы Excel использует только определяемые пользователем функции, которые имеют запись в списке определяемых пользователем функций.
Определяемые пользователем функции — это управляемые сборки кода, которые можно вызывать из книги приложения службы Excel с помощью стандартного синтаксиса формулы приложения службы Excel.
Сборки могут выполнять заданные пользователем логические и иные операции, например обновление данных.
Командлеты Windows PowerShell работают с записями в списке пользовательских функций, но не с самими сборками.
Сведения о разрешениях и актуальную информацию о Windows PowerShell для продуктов SharePoint см. в сетевой документации о командлетах SharePoint Server.
Примеры
ПРИМЕР 1
Set-SPExcelUserDefinedFunction -ExcelServiceApplication "My Excel Service" -Identity SampleCompany.SampleApplication.SampleUdf -Description "This is the new description for the sample UDF"
В этом примере описание определяемой пользователем функции (UDF) изменяется на файл UDF SampleCompany.SampleApplication.SampleUdf для приложения веб-службы приложения службы Excel с именем My Excel Service.
ПРИМЕР 2
Get-SPExcelServiceApplication "My Excel Service" | Set-SPExcelUserDefinedFunction -Identity SampleCompany.SampleApplication.SampleUdf -Enable: $false
В этом примере отключается пример файла UDF SampleCompany.SampleApplication.SampleUdf из приложения службы Excel с именем My Excel Service.
Параметры
-Assembly
Применимо: SharePoint Server 2010, SharePoint Server 2013
Указывает строго типизированное имя сборки. Имя должно быть уникальным в списке определяемых пользователем функций и не может содержать более 4096 буквенно-цифровых символов.
Типом должна быть строка буквенно-цифровых символов (например, SampleCompany.SampleApplication.SampleUdf, C:\UDFs\SampleUdf.dll или \\MyNetworkServer\UDFs\SampleUdf.dll).
Свойства параметра
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-AssemblyLocation
Применимо: SharePoint Server 2010, SharePoint Server 2013
Указывает расположение, где хранится сборка.
Типом должно быть одно из следующих значений: GAC или LocalFile.
Свойства параметра
| Тип: | AssemblyLocation |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-AssignmentCollection
Применимо: SharePoint Server 2010, SharePoint Server 2013
Позволяет корректно удалять объекты. При использовании объектов таких типов, как SPWeb или SPSite, возможен захват больших объемов памяти, и работа с такими объектами в скриптах Windows PowerShell требует точного управления памятью. С помощью объекта SPAssignment вы можете назначить объекты переменной и освободить память, удалив ненужные объекты. Объекты SPWeb, SPSite или SPSiteAdministration после использования удаляются автоматически, если коллекция назначения или параметр Global не применяются.
При использовании параметра Global все объекты содержатся в глобальном хранилище.
Если объекты не используются сразу или удаляются с помощью команды Stop-SPAssignment, может возникнуть нехватка памяти.
Свойства параметра
| Тип: | SPAssignmentCollection |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Confirm
Применимо: SharePoint Server 2010, SharePoint Server 2013
Предлагает подтвердить выполнение команды.
Чтобы получить дополнительные сведения, введите следующую команду: get-help about_commonparameters
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | cf |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Description
Применимо: SharePoint Server 2010, SharePoint Server 2013
Указывает отображаемое описание пользовательской функции. Имя может содержать не более 4096 буквенно-цифровых символов.
Типом должна быть строка буквенно-цифровых символов (например, "Пользовательская функция для консолидированных отчетов").
Свойства параметра
| Тип: | String |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Enable
Применимо: SharePoint Server 2010, SharePoint Server 2013
Активирует определяемую пользователем функцию для использования с приложением службы Excel.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-ExcelServiceApplication
Применимо: SharePoint Server 2010, SharePoint Server 2013
Указывает приложение веб-службы приложения службы Excel, содержащее объект списка SPExcelUserDefinedFunction.
Тип должен быть допустимым ИДЕНТИФИКАТОРом GUID в формате 12345678-90ab-cdef-1234-567890bcdefgh; допустимое имя приложения веб-службы приложения службы Excel в ферме (например, MyExcelService1) или экземпляр допустимого объекта SPExcelServiceApplication.
Свойства параметра
| Тип: | SPExcelServiceApplicationPipeBind |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-Identity
Применимо: SharePoint Server 2010, SharePoint Server 2013
Указывает объект SPExcelUserDefinedFunction, который необходимо обновить.
Типом должно быть действительное имя сборки кода (например, SampleCompany.SampleApplication.SampleUdf) или экземпляр действительного объекта SPExcelUDF.
Свойства параметра
| Тип: | SPExcelUDFPipeBind |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | 1 |
| Обязательно: | True |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-WhatIf
Применимо: SharePoint Server 2010, SharePoint Server 2013
Отображает описание команды. При этом сама команда не выполняется.
Чтобы получить дополнительные сведения, введите следующую команду: get-help about_commonparameters
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | wi |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в статье about_CommonParameters.