ActionParameterCollection.Create Method (String, Boolean, Byte)

Creates an ActionParameter object in the collection.

Namespace:  Microsoft.Office.Server.ApplicationRegistry.Administration
Assembly:  Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)

Syntax

'Declaration
Public Function Create ( _
    name As String, _
    isCached As Boolean, _
    index As Byte _
) As ActionParameter

'Usage
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
)

Parameters

• name
  Type: System.String
  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
  Type: System.Boolean
  true if this parameter should be cached; otherwise, false.

• index
  Type: System.Byte
  The ordinal number of this parameter in the action URL.

Return Value

Type: Microsoft.Office.Server.ApplicationRegistry.Administration.ActionParameter
An ActionParameter object.

Remarks

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

Examples

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 How to: Create an LobSystem Using the Administration Object Model.

• Create the ProductModel entity as shown in How to: Create an Entity Using the Administration Object Model

• Create a Finder method as shown in How to: Create a Method and Filters Using the Administration Object Model

• 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.");
        }
    }
}

See Also

Reference

ActionParameterCollection Class

ActionParameterCollection Members

Create Overload

Microsoft.Office.Server.ApplicationRegistry.Administration Namespace