ActionParameterCollection.Create, méthode (String, Boolean, Byte) (Microsoft.Office.Server.ApplicationRegistry.Administration)

Article
02/01/2010

Creates an ActionParameter object in the collection.

Espace de noms : Microsoft.Office.Server.ApplicationRegistry.Administration
Assembly : Microsoft.SharePoint.Portal (dans microsoft.sharepoint.portal.dll)

Syntaxe

'Déclaration
Public Function Create ( _
    name As String, _
    isCached As Boolean, _
    index As Byte _
) As ActionParameter
'Utilisation
Dim instance As ActionParameterCollection
Dim name As String
Dim isCached As Boolean
Dim index As Byte
Dim returnValue As ActionParameter

returnValue = instance.Create(name, isCached, index)

public ActionParameter Create (
    string name,
    bool isCached,
    byte index
)

Paramètres

name
The name of the action parameter. It should correspond to the name of a TypeDescriptor in SpecificFinder view of the entity. In the event of multiple type descriptors with same name, the parameter will be bound to the first TypeDescriptor with the specified name in the SpecificFinder View.

isCached
true if this parameter should be cached; otherwise, false.

index
The ordinal number of this parameter in the action URL.

Valeur de retour

An ActionParameter object.

Remarques

This method will throw an exception if the entity does not have a SpecificFinder defined.

Exemple

The following code example adds an action and updates the ProductModel entity.

Prerequisites

Ensure a Shared Service Provider is already created.
Create an LobSystemInstance object and set connection parameters as shown in Procédure : créer un objet LobSystem à l'aide du modèle objet Administration.
Create the ProductModel entity as shown in Procédure : créer une entité à l'aide du modèle objet Administration
Create a Finder method as shown in Procédure : créer une méthode et des filtres à l'aide du modèle d'objet d'administration
Replace the constant value EnterYourSSPNameHere in the code with the name of your Shared Resource Provider.

Project References

Add the following Project References in your console application code project before running this sample:

Microsoft.SharePoint
Microsoft.SharePoint.Portal
Microsoft.Office.Server

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Office.Server.ApplicationRegistry.Administration;
using Microsoft.Office.Server.ApplicationRegistry.Infrastructure;
using WSSAdmin = Microsoft.SharePoint.Administration;
using OSSAdmin = Microsoft.Office.Server.Administration;

namespace Microsoft.SDK.SharePointServer.Samples
{
    class GetStartedAndCreateSystem
    {
        const string yourSSPName ="EnterYourSSPNameHere";

        static void Main(string[] args)
        {
            SetupBDC();
            UpdateEntity();
            Console.WriteLine("Press any key to exit...");
            Console.Read();
        }
        static void SetupBDC()
        {
            SqlSessionProvider.Instance().SetSharedResourceProviderToUse(yourSSPName);
        }
        static void UpdateEntity()
        {
            LobSystemInstance mySysInstance = null;
            LobSystemInstanceCollection sysInsCollection = ApplicationRegistry.Instance.GetLobSystemInstancesLikeName("AdventureWorksSampleFromCode");
            foreach (LobSystemInstance sysInstance in sysInsCollection)
            {
                if (sysInstance.Name == "AdventureWorksSampleFromCode")
                {
                    mySysInstance = sysInstance;
                    break;
                }
            }
            IList<Entity> entityCollection = new List<Entity>(mySysInstance.LobSystem.Entities);
            Entity e = entityCollection[0];
            Action pmaction = e.Actions.Create("Search on MSN", true, 1, true, "https://www.msn.com?q={0}", null);
            pmaction.ActionParameters.Create("Name", true, 0);
            Console.WriteLine("Added an action and updated the entity successfully.");
        }
    }
}

Voir aussi

Référence

ActionParameterCollection, classe
Membres ActionParameterCollection
Microsoft.Office.Server.ApplicationRegistry.Administration, espace de noms

Partager via